diff --git a/src/components/Releases/index.tsx b/src/components/Releases/index.tsx index b5384cf346..468d4b0af8 100644 --- a/src/components/Releases/index.tsx +++ b/src/components/Releases/index.tsx @@ -1,6 +1,7 @@ import React from "react"; const versions = [ + '4.23.0.0', '4.22.1.1', '4.22.1.0', '4.22.0.1', diff --git a/src/pages/api.md b/src/pages/api.md index 28246614a6..3eb074fd19 100644 --- a/src/pages/api.md +++ b/src/pages/api.md @@ -13,6 +13,10 @@ would welcome your help, please file an issue in the CloudStack [GitHub repo](https://github.com/apache/cloudstack) or by submitting a [pull request](https://github.com/apache/cloudstack-www/pulls/new) for this site. +# 4.23.x + +- All APIs + # 4.22.x - All APIs diff --git a/src/pages/downloads.mdx b/src/pages/downloads.mdx index efc8389d6d..d764bfda62 100644 --- a/src/pages/downloads.mdx +++ b/src/pages/downloads.mdx @@ -28,8 +28,25 @@ $ sha512sum --check .sha512 ### Source Releases -Apache CloudStack's most recent release is `4.22.1.1`. This is current -CloudStack LTS release. +Apache CloudStack's most recent release is `4.23.0.0`. This is a CloudStack Regular release. + +Get the 4.23.0.0 Source  +KEYS  +PGP  +SHA512 +

+ +Full release notes can be found in the version [4.23.0.0 Release +Notes](https://docs.cloudstack.apache.org/en/4.23.0.0/releasenotes/) website. + +Instructions for building from source and installing Apache CloudStack can be +found in the [Installation +Guide](https://docs.cloudstack.apache.org/en/4.23.0.0/installguide/). +Instructions for building from source and upgrading from a previous version of +CloudStack to Apache CloudStack 4.23.0.0 can be found in the upgrade section of +the Release Notes (see above). + +Apache CloudStack's current LTS release is `4.22.1.1`. Get the 4.22.1.1 Source  KEYS  diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 727dbdd9b7..ece9469652 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -26,8 +26,8 @@ Apache CloudStack™ is an open-source software system designed to deploy and m
Download   - Documentation -

Apache CloudStack 4.22.1.0 is out!

+ Documentation +

Apache CloudStack 4.23.0.0 is out!

@@ -219,10 +219,10 @@ specific infrastructure.

Latest Release

-

Apache CloudStack 4.22.1.0 is out!
This is the latest LTS release.

+

Apache CloudStack 4.23.0.0 is out!
This is the latest Regular release.

Download   - Documentation + Documentation
diff --git a/static/api/apidocs-4.23/apis/acquirePodIpAddress.html b/static/api/apidocs-4.23/apis/acquirePodIpAddress.html new file mode 100644 index 0000000000..67b918f2bb --- /dev/null +++ b/static/api/apidocs-4.23/apis/acquirePodIpAddress.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

acquirePodIpAddress

+

Allocates IP addresses in respective Pod of a Zone

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
zoneidThe ID of the zonetrue
podidPod IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the pod the IP address
cidrCIDR of the Pod
gatewayGateway for Pod
hostmacMAC address of the pod the IP
ipaddressAllocated IP address
nicidThe ID of the NIC
podidThe ID of the pod the IP address belongs to
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/activateProject.html b/static/api/apidocs-4.23/apis/activateProject.html new file mode 100644 index 0000000000..a1d5002cc7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/activateProject.html @@ -0,0 +1,300 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

activateProject

+

Activates a project

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the project to be modifiedtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the project
backupavailablethe total number of backups available to this project
backuplimitthe total number of backups which can be stored by this project
backupstorageavailablethe total backup storage space (in GiB) available to the project
backupstoragelimitthe total backup storage space (in GiB) the project can own
backupstoragetotalthe total backup storage space (in GiB) owned by the project
backuptotalthe total number of backups stored by this project
bucketavailablethe total number of buckets available to this project
bucketlimitthe total number of buckets which can be stored by this project
buckettotalthe total number of buckets stored by this project
cpuavailableThe total number of CPU cores available to be created for this project
cpulimitThe total number of CPU cores the project can own
cputotalThe total number of CPU cores owned by project
createdThe date this project was created
displaytextThe displaytext of the project
domainThe domain name where the project belongs to
domainidThe domain ID the project belongs to
gpuavailablethe total number of gpus available to be created for this project
gpulimitthe total number of gpus the project can own
gputotalthe total number of gpus owned by project
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this project to acquire
iplimitThe total number of public IP addresses this project can acquire
iptotalThe total number of public IP addresses allocated for this project
memoryavailableThe total memory (in MB) available to be created for this project
memorylimitThe total memory (in MB) the project can own
memorytotalThe total memory (in MB) owned by project
nameThe name of the project
networkavailableThe total number of Networks available to be created for this project
networklimitThe total number of Networks the project can own
networktotalThe total number of Networks owned by project
objectstorageavailablethe total object storage space (in GiB) available to the project
objectstoragelimitthe total object storage space (in GiB) the project can own
objectstoragetotalthe total object storage space (in GiB) owned by the project
ownerThe Account name of the project's owners
primarystorageavailableThe total primary storage space (in GiB) available to be used for this project
primarystoragelimitThe total primary storage space (in GiB) the project can own
primarystoragetotalThe total primary storage space (in GiB) owned by project
projectaccountnameThe project Account name of the project
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this project
secondarystoragelimitThe total secondary storage space (in GiB) the project can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by project
snapshotavailableThe total number of Snapshots available for this project
snapshotlimitThe total number of Snapshots which can be stored by this project
snapshottotalThe total number of Snapshots stored by this project
stateThe state of the project
taggedresourcesThe tagged resource limit and count for the project
templateavailableThe total number of Templates available to be created by this project
templatelimitThe total number of Templates which can be created by this project
templatetotalThe total number of Templates which have been created by this project
vmavailableThe total number of Instances available for this project to acquire
vmlimitThe total number of Instances that can be deployed by this project
vmrunningThe total number of Instances running for this project
vmstoppedThe total number of Instances stopped for this project
vmtotalThe total number of Instances deployed by this project
volumeavailableThe total volume available for this project
volumelimitThe total volume which can be used by this project
volumetotalThe total volume being used by this project
vpcavailableThe total number of VPCs available to be created for this project
vpclimitThe total number of VPCs the project can own
vpctotalThe total number of VPCs owned by project
tags(*)The list of resource tags associated with Instance
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addAccountToProject.html b/static/api/apidocs-4.23/apis/addAccountToProject.html new file mode 100644 index 0000000000..6d63c07e2b --- /dev/null +++ b/static/api/apidocs-4.23/apis/addAccountToProject.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addAccountToProject

+

Adds Account to a project

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
projectidID of the project to add the Account totrue
accountName of the Account to be added to the projectfalse
emailEmail to which invitation to the project is going to be sentfalse
projectroleidID of the project rolefalse
roletypeProject role type to be assigned to the User - Admin/Regular; default: Regularfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addAnnotation.html b/static/api/apidocs-4.23/apis/addAnnotation.html new file mode 100644 index 0000000000..6a40967c5e --- /dev/null +++ b/static/api/apidocs-4.23/apis/addAnnotation.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addAnnotation

+

Add an annotation.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
adminsonlyThe annotation is visible for admins onlyfalse
annotationThe annotation textfalse
entityidThe ID of the entity to annotatefalse
entitytypeThe 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_SERVERfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe UUID of the annotation
adminsonlyTrue if the annotation is available for admins only
annotationThe contents of the annotation
createdThe creation timestamp for this annotation
entityidThe UUID of the entity to which this annotation pertains
entitynameThe name of the entity to which this annotation pertains
entitytypeThe type of the annotated entity
removedThe removal timestamp for this annotation
useridThe UUID of the User that entered the annotation
usernameThe username of the User that entered the annotation
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addBackupRepository.html b/static/api/apidocs-4.23/apis/addBackupRepository.html new file mode 100644 index 0000000000..8a9452bf62 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addBackupRepository.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addBackupRepository

+

Adds a backup repository to store NAS backups

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
addressaddress of the backup repositorytrue
namename of the backup repositorytrue
typetype of the backup repository storage. Supported values: nfs, cephfs, cifstrue
zoneidID of the zone where the backup repository is to be added for taking backupstrue
capacitybytescapacity of this backup repositoryfalse
crosszoneinstancecreationbackups on this repository can be used to create Instances on all Zonesfalse
mountoptsshared storage mount optionsfalse
providerbackup repository providerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the backup repository
addressthe address / url of the backup repository
capacitybytescapacity of the backup repository
createdthe date and time the backup repository was added
crosszoneinstancecreationthe backups in this repository can be used to create Instances on all Zones
mountoptsmount options
namethe name of the backup repository
providername of the provider
typebackup type
zoneidthe Zone ID of the backup repository
zonenamethe Zone name of the backup repository
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addBaremetalDhcp.html b/static/api/apidocs-4.23/apis/addBaremetalDhcp.html new file mode 100644 index 0000000000..6cf379f5ad --- /dev/null +++ b/static/api/apidocs-4.23/apis/addBaremetalDhcp.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addBaremetalDhcp

+

Adds a baremetal DHCP server

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
dhcpservertypeType of dhcp devicetrue
passwordCredentials to reach external dhcp devicetrue
physicalnetworkidThe Physical Network IDtrue
urlURL of the external dhcp appliance.true
usernameCredentials to reach external dhcp devicetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idDevice ID of
dhcpservertypeName of the provider
physicalnetworkidThe physical network to which this external dhcp device belongs to
providerName of the provider
urlURL
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addBaremetalHost.html b/static/api/apidocs-4.23/apis/addBaremetalHost.html new file mode 100644 index 0000000000..2279184016 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addBaremetalHost.html @@ -0,0 +1,381 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addBaremetalHost

+

Add a baremetal host

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hypervisorHypervisor type of the hosttrue
podidThe Pod ID for the hosttrue
urlThe host URL, optionally add ssh port (format: 'host:port') for KVM hosts, otherwise falls back to the port defined at the config 'kvm.host.discovery.ssh.port'true
zoneidThe Zone ID for the hosttrue
allocationstateAllocation state of this Host for allocation of new resourcesfalse
clusteridThe cluster ID for the hostfalse
clusternameThe cluster name for the hostfalse
externaldetailsDetails in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvaluefalse
hosttagsList of tags to be added to the hostfalse
ipaddressIP address intentionally allocated to this host after provisioningfalse
passwordThe password for the host; required to be passed for hypervisors other than VMWarefalse
storageaccessgroupscomma separated list of storage access groups for the hostfalse
usernameThe username for the host; required to be passed for hypervisors other than VMWarefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the host
annotationThe last annotation set on this host by an admin
archCPU Arch of the host
capabilitiesCapabilities of the host
clusteridThe cluster ID of the host
clusternameThe cluster name of the host
clusterstorageaccessgroupscomma-separated list of storage access groups on the cluster
clustertypeThe cluster type of the cluster that host belongs to
cpuallocatedThe amount of the host's CPU currently allocated
cpuallocatedpercentageThe amount of the host's CPU currently allocated in percentage
cpuallocatedvalueThe amount of the host's CPU currently allocated in MHz
cpuallocatedwithoverprovisioningThe amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor
cpuloadaverageThe average CPU load on the host
cpunumberThe CPU number of the host
cpusocketsThe number of CPU sockets on the host
cpuspeedThe CPU speed of the host
cpuusedThe amount of the host's CPU currently used
cpuwithoverprovisioningThe amount of the host's CPU after applying the cpu.overprovisioning.factor
createdThe date and time the host was created
detailsHost details in key/value pairs.
disconnectedTrue if the host is disconnected. False otherwise.
disksizeallocatedThe host's currently allocated disk size
disksizetotalThe total disk size of the host
encryptionsupportedTrue if the host supports encryption
eventsEvents available for the host
explicithosttagscomma-separated list of explicit host tags for the host
extensionidThe ID of extension for this cluster
extensionnameThe name of extension for this cluster
gputotalTotal GPUs on the Host
gpuusedUsed GPUs on the Host
guestosrulethe guest OS rule
hahostTrue if the host is Ha host (dedicated to Instances started by HA process; false otherwise
hasenoughcapacityTrue if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise
hosthaThe host HA information information
hosttagsComma-separated list of tags for the host
hypervisorThe host hypervisor
hypervisorversionThe hypervisor version
implicithosttagscomma-separated list of implicit host tags for the host
instanceconversionsupportedtrue if the host supports instance conversion (using virt-v2v)
ipaddressThe IP address of the host
islocalstorageactiveTrue if local storage is active, false otherwise
istagaruleWhether the informed tag is a JS interpretable rule or not.
lastannotatedThe last time this host was annotated
lastpingedThe date and time the host was last pinged
managementserveridThe management server ID of the host
managementservernamethe management server name of the host
memoryallocatedThe amount of the host's memory currently allocated
memoryallocatedbytesThe amount of the host's memory currently allocated in bytes
memoryallocatedpercentageThe amount of the host's memory currently allocated in percentage
memorytotalThe memory total of the host, this parameter is deprecated use memorywithoverprovisioning
memoryusedThe amount of the host's memory currently used
memorywithoverprovisioningThe amount of the host's memory after applying the mem.overprovisioning.factor
msid(only for details=core) the msid of the host's management server
nameThe name of the host
networkkbsreadThe incoming Network traffic on the host
networkkbswriteThe outgoing Network traffic on the host
oscategoryidThe OS category ID of the host
oscategorynameThe OS category name of the host
outofbandmanagementThe host out-of-band management information
podidThe Pod ID of the host
podnameThe Pod name of the host
podstorageaccessgroupscomma-separated list of storage access groups on the pod
removedThe date and time the host was removed
resourcestateThe resource state of the host
stateThe state of the host
storageaccessgroupscomma-separated list of storage access groups for the host
suitableformigrationTrue if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise
typeThe host type
ueficapabilityTrue if the host has capability to support UEFI boot
usernameThe admin that annotated this host
versionThe host version
virtualmachineidthe virtual machine id for host type ConsoleProxy and SecondaryStorageVM
zoneidThe Zone ID of the host
zonenameThe Zone name of the host
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
gpugroup(*)GPU cards present in the host
gpugroupnameGPU cards present in the host
vgpu(*)The list of enabled vGPUs
maxcapacityMaximum vGPU can be created with this vGPU type on the given GPU group
maxheadsMaximum displays per user
maxresolutionxMaximum X resolution per display
maxresolutionyMaximum Y resolution per display
maxvgpuperpgpuMaximum no. of vGPU per GPU card (pgpu)
remainingcapacityRemaining capacity in terms of no. of more Instances that can be deployed with this vGPU type
vgputypeModel Name of vGPU
videoramVideo RAM for this vGPU type
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addBaremetalPxeKickStartServer.html b/static/api/apidocs-4.23/apis/addBaremetalPxeKickStartServer.html new file mode 100644 index 0000000000..038ee3bc89 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addBaremetalPxeKickStartServer.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addBaremetalPxeKickStartServer

+

Add a baremetal PXE server

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
passwordCredentials to reach external pxe devicetrue
physicalnetworkidThe Physical Network IDtrue
pxeservertypeType of pxe devicetrue
tftpdirTFTP root directory of the PXE servertrue
urlURL of the external pxe devicetrue
usernameCredentials to reach external pxe devicetrue
podidPod Idfalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
tftpdirTftp root directory of PXE server
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addBaremetalPxePingServer.html b/static/api/apidocs-4.23/apis/addBaremetalPxePingServer.html new file mode 100644 index 0000000000..e7300c9d8a --- /dev/null +++ b/static/api/apidocs-4.23/apis/addBaremetalPxePingServer.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addBaremetalPxePingServer

+

Add a baremetal ping PXE server

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
passwordCredentials to reach external pxe devicetrue
physicalnetworkidThe Physical Network IDtrue
pingdirRoot directory on PING storage servertrue
pingstorageserveripPING storage server IPtrue
pxeservertypeType of pxe devicetrue
tftpdirTFTP root directory of PXE servertrue
urlURL of the external pxe devicetrue
usernameCredentials to reach external pxe devicetrue
pingcifspasswordPassword of PING storage serverfalse
pingcifsusernameUsername of PING storage serverfalse
podidPod Idfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
pingdirRoot directory on PING storage server
pingstorageserveripPING storage server ip
tftpdirTftp root directory of PXE server
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addBaremetalRct.html b/static/api/apidocs-4.23/apis/addBaremetalRct.html new file mode 100644 index 0000000000..59d01b7cb1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addBaremetalRct.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addBaremetalRct

+

Adds baremetal rack configuration text

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
baremetalrcturlHTTP URL to baremetal RCT configurationtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
idID of RCT
urlURL
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addBigSwitchBcfDevice.html b/static/api/apidocs-4.23/apis/addBigSwitchBcfDevice.html new file mode 100644 index 0000000000..8f8d793853 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addBigSwitchBcfDevice.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addBigSwitchBcfDevice

+

Adds a BigSwitch BCF Controller device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hostnameHostname of ip address of the BigSwitch BCF Controller.true
natNAT support of the BigSwitch BCF Controller.true
passwordPassword of the BigSwitch BCF Controller.true
physicalnetworkidThe Physical Network IDtrue
usernameUsername of the BigSwitch BCF Controller.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
bcfdeviceidDevice ID of the BigSwitch BCF Controller
bigswitchdevicenameDevice name
hostnameThe controller IP address
natNAT support
passwordThe controller password
physicalnetworkidThe physical Network to which this BigSwitch BCF segment belongs to
providerName of the provider
usernameThe controller username
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addBrocadeVcsDevice.html b/static/api/apidocs-4.23/apis/addBrocadeVcsDevice.html new file mode 100644 index 0000000000..632c4b7134 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addBrocadeVcsDevice.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addBrocadeVcsDevice

+

Adds a Brocade VCS Switch

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hostnameHostname of IP address of the Brocade VCS Switch.true
passwordCredentials to access the Brocade VCS Switch APItrue
physicalnetworkidThe Physical Network IDtrue
usernameCredentials to access the Brocade VCS Switch APItrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
brocadedevicenameDevice name
hostnameThe principal switch IP address
physicalnetworkidThe physical Network to which this Brocade VCS belongs to
providerName of the provider
vcsdeviceidDevice ID of the Brocade Vcs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addCiscoAsa1000vResource.html b/static/api/apidocs-4.23/apis/addCiscoAsa1000vResource.html new file mode 100644 index 0000000000..2599c2bac7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addCiscoAsa1000vResource.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addCiscoAsa1000vResource

+

Adds a Cisco Asa 1000v appliance

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
clusteridThe Cluster IDtrue
hostnameHostname or ip address of the Cisco ASA 1000v appliance.true
insideportprofileNexus port profile associated with inside interface of ASA 1000vtrue
physicalnetworkidThe Physical Network IDtrue
+
+
+

Response Tags

+ + + + +
Response NameDescription
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addCiscoVnmcResource.html b/static/api/apidocs-4.23/apis/addCiscoVnmcResource.html new file mode 100644 index 0000000000..736254da1f --- /dev/null +++ b/static/api/apidocs-4.23/apis/addCiscoVnmcResource.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addCiscoVnmcResource

+

Adds a Cisco Vnmc Controller

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hostnameHostname or ip address of the Cisco VNMC Controller.true
passwordCredentials to access the Cisco VNMC Controller APItrue
physicalnetworkidThe Physical Network IDtrue
usernameCredentials to access the Cisco VNMC Controller APItrue
+
+
+

Response Tags

+ + + + +
Response NameDescription
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addCluster.html b/static/api/apidocs-4.23/apis/addCluster.html new file mode 100644 index 0000000000..08363da47c --- /dev/null +++ b/static/api/apidocs-4.23/apis/addCluster.html @@ -0,0 +1,249 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addCluster

+

Adds a new cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
clusternameThe cluster nametrue
clustertypeType of the cluster: CloudManaged, ExternalManagedtrue
hypervisorHypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3,Externaltrue
podidThe Pod ID for the hosttrue
zoneidThe Zone ID for the clustertrue
allocationstateAllocation state of this cluster for allocation of new resourcesfalse
archThe CPU arch of the cluster. Valid options are: x86_64, aarch64, s390xfalse
extensionidUUID of the extensionfalse
externaldetailsDetails in key/value pairs to be added to the extension-resource mapping. Use the format externaldetails[i].<key>=<value>. Example: externaldetails[0].endpoint.url=https://example.comfalse
guestvswitchnameName of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.false
guestvswitchtypeType 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
ovm3clusterOvm3 native OCFS2 clustering enabled for clusterfalse
ovm3poolOvm3 native pooling enabled for clusterfalse
ovm3vipOvm3 vip to use for pool (and cluster)false
passwordThe password for the hostfalse
publicvswitchnameName of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.false
publicvswitchtypeType 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
storageaccessgroupscomma separated list of storage access groups for the hosts in the clusterfalse
urlThe URLfalse
usernameThe username for the clusterfalse
vsmipaddressThe IP address of the VSM associated with this clusterfalse
vsmpasswordThe password for the VSM associated with this clusterfalse
vsmusernameThe username for the VSM associated with this clusterfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe cluster ID
allocationstateThe allocation state of the cluster
archCPU Arch of the hosts in the cluster
clustertypeThe type of the cluster
cpuovercommitratioThe CPU overcommit ratio of the cluster
extensionidThe ID of extension for this cluster
extensionnameThe name of extension for this cluster
hypervisortypeThe hypervisor type of the cluster
managedstateWhether this cluster is managed by Cloudstack
memoryovercommitratioThe memory overcommit ratio of the cluster
nameThe cluster name
ovm3vipOvm3 VIP to use for pooling and/or clustering
podidThe Pod ID of the cluster
podnameThe Pod name of the cluster
podstorageaccessgroupscomma-separated list of storage access groups on the pod
resourcedetailsMeta data associated with the zone (key/value pairs)
storageaccessgroupscomma-separated list of storage access groups for the host
zoneidThe Zone ID of the cluster
zonenameThe Zone name of the cluster
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
capacity(*)The capacity of the Cluster
capacityallocatedThe capacity currently in allocated
capacitytotalThe total capacity available
capacityusedThe capacity currently in use
clusteridThe Cluster ID
clusternameThe Cluster name
nameThe capacity name
percentusedThe percentage of capacity currently in use
podidThe Pod ID
podnameThe Pod name
tagThe tag for the capacity type
typeThe capacity type
zoneidThe Zone ID
zonenameThe Zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addCustomAction.html b/static/api/apidocs-4.23/apis/addCustomAction.html new file mode 100644 index 0000000000..46aa576b2f --- /dev/null +++ b/static/api/apidocs-4.23/apis/addCustomAction.html @@ -0,0 +1,168 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addCustomAction

+

Add a custom action for an extension

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
extensionidThe ID of the extension to associate the action withtrue
nameName of the actiontrue
allowedroletypesList of role types allowed for the actionfalse
descriptionDescription of the actionfalse
detailsDetails in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0false
enabledWhether the action is enabled or not. Default is disabled.false
errormessageError message that will be used on failure during execution of the action. Name of the action, extension, resource can be used as - actionName, extensionName, resourceName. Example: Failed to complete {{actionName}} for {{resourceName}} with {{extensionName}}false
parametersParameters mapping for the action using keys - name, type, required. 'name' is mandatory. If 'type' is not specified then STRING will be used. If 'required' is not specified then false will be used. Example: parameters[0].name=xxx&parameters[0].type=BOOLEAN&parameters[0].required=truefalse
resourcetypeResource type for which the action is availablefalse
successmessageSuccess message that will be used on successful execution of the action. Name of the action, extension, resource can be used as - actionName, extensionName, resourceName. Example: Successfully complete {{actionName}} for {{resourceName}} with {{extensionName}}false
timeoutSpecifies the timeout in seconds to wait for the action to complete before failing. Default value is 5 secondsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the custom action
allowedroletypesList of role types allowed for the custom action
createdCreation timestamp of the custom action
descriptionDescription of the custom action
detailsDetails of the custom action
enabledWhether the custom action is enabled or not
errormessageMessage that will be used on failure during execution of the action
extensionidID of the extension that this custom action belongs to
extensionnameName of the extension that this custom action belongs to
nameName of the custom action
resourcetypeResource type for which the action is available
successmessageMessage that will be used on successful execution of the action
timeoutSpecifies the timeout in seconds to wait for the action to complete before failing
parameters(*)List of the parameters for the action
nameName of the parameter
requiredWhether the parameter is required or not
typeType of the parameter
validationformatValidation format for value of the parameter. Available for specific types
valueoptionsComma-separated list of options for value of the parameter
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addDnsServer.html b/static/api/apidocs-4.23/apis/addDnsServer.html new file mode 100644 index 0000000000..0974dfaa24 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addDnsServer.html @@ -0,0 +1,144 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addDnsServer

+

Adds a new external DNS server

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
dnsapikeyAPI key or token for the DNS providertrue
nameName of the DNS servertrue
nameserversComma separated list of name servers; used to create NS records for the DNS Zone (for example, ns1.example.com, ns2.example.com)true
providerProvider type (e.g., PowerDNS)true
urlAPI URL of the providertrue
detailsDetails in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].pdnsServerId=localhostfalse
dnsusernameUsername or email associated with the DNS provider account (used for authentication)false
ispublicWhether this DNS server can be used by accounts other than the owner to create and manage DNS zonesfalse
portPort number of the external DNS serverfalse
publicdomainsuffixDomain suffix that restricts DNS zones created by non-owner accounts to subdomains of this suffix (for example, sub.example.com under example.com)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the DNS server
accountthe account associated with the DNS server
domainthe name of the domain associated with the DNS server
domainidthe ID of the domain associated with the DNS server
ispublicIs the DNS server publicly available
nameName of the DNS server
nameserversName servers entries associated to DNS server
portThe port of the DNS server
providerThe provider type of the DNS server
publicdomainsuffixThe public domain suffix for the DNS server
stateThe state of the account
urlURL of the DNS server API
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addGloboDnsHost.html b/static/api/apidocs-4.23/apis/addGloboDnsHost.html new file mode 100644 index 0000000000..410d508dc0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addGloboDnsHost.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addGloboDnsHost

+

Adds the GloboDNS external host

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
passwordPassword for GloboDNStrue
physicalnetworkidThe Physical Network IDtrue
urlGloboDNS urltrue
usernameUsername for GloboDNStrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addGuestOs.html b/static/api/apidocs-4.23/apis/addGuestOs.html new file mode 100644 index 0000000000..88bc3cc402 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addGuestOs.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addGuestOs

+

Add a new guest OS type

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
oscategoryidID of Guest OS categorytrue
osdisplaynameUnique display name for Guest OStrue
detailsMap of (key/value pairs)false
forDisplaywhether this guest OS is available for end usersfalse
nameOptional name for Guest OSfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the OS type
descriptionThe name/description of the OS type
fordisplayIs the guest OS visible for the users
isuserdefinedIs the guest OS user defined
nameThe name of the OS type
oscategoryidThe ID of the OS category
oscategorynameThe name of the OS category
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addGuestOsMapping.html b/static/api/apidocs-4.23/apis/addGuestOsMapping.html new file mode 100644 index 0000000000..6f7159d338 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addGuestOsMapping.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addGuestOsMapping

+

Adds a guest OS name to hypervisor OS name mapping

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hypervisorHypervisor type. One of : XenServer, KVM, VMWaretrue
hypervisorversionHypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct versiontrue
osnameforhypervisorOS name specific to the hypervisortrue
forcedForces add user defined guest os mapping, overrides any existing user defined mappingfalse
osdisplaynameDisplay Name of Guest OS standard type. Either Display Name or UUID must be passedfalse
osmappingcheckenabledWhen 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
ostypeidUUID of Guest OS type. Either the UUID or Display Name must be passedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Guest OS mapping
hypervisorThe hypervisor
hypervisorversionVersion of the hypervisor for mapping
isuserdefinedIs the mapping user defined
osdisplaynameStandard display name for the Guest OS
osnameforhypervisorHypervisor specific name for the Guest OS
ostypeidThe ID of the Guest OS type
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addHost.html b/static/api/apidocs-4.23/apis/addHost.html new file mode 100644 index 0000000000..f6fb1003ab --- /dev/null +++ b/static/api/apidocs-4.23/apis/addHost.html @@ -0,0 +1,378 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addHost

+

Adds a new host.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hypervisorHypervisor type of the hosttrue
podidThe Pod ID for the hosttrue
urlThe host URL, optionally add ssh port (format: 'host:port') for KVM hosts, otherwise falls back to the port defined at the config 'kvm.host.discovery.ssh.port'true
zoneidThe Zone ID for the hosttrue
allocationstateAllocation state of this Host for allocation of new resourcesfalse
clusteridThe cluster ID for the hostfalse
clusternameThe cluster name for the hostfalse
externaldetailsDetails in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvaluefalse
hosttagsList of tags to be added to the hostfalse
passwordThe password for the host; required to be passed for hypervisors other than VMWarefalse
storageaccessgroupscomma separated list of storage access groups for the hostfalse
usernameThe username for the host; required to be passed for hypervisors other than VMWarefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the host
annotationThe last annotation set on this host by an admin
archCPU Arch of the host
capabilitiesCapabilities of the host
clusteridThe cluster ID of the host
clusternameThe cluster name of the host
clusterstorageaccessgroupscomma-separated list of storage access groups on the cluster
clustertypeThe cluster type of the cluster that host belongs to
cpuallocatedThe amount of the host's CPU currently allocated
cpuallocatedpercentageThe amount of the host's CPU currently allocated in percentage
cpuallocatedvalueThe amount of the host's CPU currently allocated in MHz
cpuallocatedwithoverprovisioningThe amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor
cpuloadaverageThe average CPU load on the host
cpunumberThe CPU number of the host
cpusocketsThe number of CPU sockets on the host
cpuspeedThe CPU speed of the host
cpuusedThe amount of the host's CPU currently used
cpuwithoverprovisioningThe amount of the host's CPU after applying the cpu.overprovisioning.factor
createdThe date and time the host was created
detailsHost details in key/value pairs.
disconnectedTrue if the host is disconnected. False otherwise.
disksizeallocatedThe host's currently allocated disk size
disksizetotalThe total disk size of the host
encryptionsupportedTrue if the host supports encryption
eventsEvents available for the host
explicithosttagscomma-separated list of explicit host tags for the host
extensionidThe ID of extension for this cluster
extensionnameThe name of extension for this cluster
gputotalTotal GPUs on the Host
gpuusedUsed GPUs on the Host
guestosrulethe guest OS rule
hahostTrue if the host is Ha host (dedicated to Instances started by HA process; false otherwise
hasenoughcapacityTrue if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise
hosthaThe host HA information information
hosttagsComma-separated list of tags for the host
hypervisorThe host hypervisor
hypervisorversionThe hypervisor version
implicithosttagscomma-separated list of implicit host tags for the host
instanceconversionsupportedtrue if the host supports instance conversion (using virt-v2v)
ipaddressThe IP address of the host
islocalstorageactiveTrue if local storage is active, false otherwise
istagaruleWhether the informed tag is a JS interpretable rule or not.
lastannotatedThe last time this host was annotated
lastpingedThe date and time the host was last pinged
managementserveridThe management server ID of the host
managementservernamethe management server name of the host
memoryallocatedThe amount of the host's memory currently allocated
memoryallocatedbytesThe amount of the host's memory currently allocated in bytes
memoryallocatedpercentageThe amount of the host's memory currently allocated in percentage
memorytotalThe memory total of the host, this parameter is deprecated use memorywithoverprovisioning
memoryusedThe amount of the host's memory currently used
memorywithoverprovisioningThe amount of the host's memory after applying the mem.overprovisioning.factor
msid(only for details=core) the msid of the host's management server
nameThe name of the host
networkkbsreadThe incoming Network traffic on the host
networkkbswriteThe outgoing Network traffic on the host
oscategoryidThe OS category ID of the host
oscategorynameThe OS category name of the host
outofbandmanagementThe host out-of-band management information
podidThe Pod ID of the host
podnameThe Pod name of the host
podstorageaccessgroupscomma-separated list of storage access groups on the pod
removedThe date and time the host was removed
resourcestateThe resource state of the host
stateThe state of the host
storageaccessgroupscomma-separated list of storage access groups for the host
suitableformigrationTrue if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise
typeThe host type
ueficapabilityTrue if the host has capability to support UEFI boot
usernameThe admin that annotated this host
versionThe host version
virtualmachineidthe virtual machine id for host type ConsoleProxy and SecondaryStorageVM
zoneidThe Zone ID of the host
zonenameThe Zone name of the host
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
gpugroup(*)GPU cards present in the host
gpugroupnameGPU cards present in the host
vgpu(*)The list of enabled vGPUs
maxcapacityMaximum vGPU can be created with this vGPU type on the given GPU group
maxheadsMaximum displays per user
maxresolutionxMaximum X resolution per display
maxresolutionyMaximum Y resolution per display
maxvgpuperpgpuMaximum no. of vGPU per GPU card (pgpu)
remainingcapacityRemaining capacity in terms of no. of more Instances that can be deployed with this vGPU type
vgputypeModel Name of vGPU
videoramVideo RAM for this vGPU type
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addImageStore.html b/static/api/apidocs-4.23/apis/addImageStore.html new file mode 100644 index 0000000000..50ec0800fb --- /dev/null +++ b/static/api/apidocs-4.23/apis/addImageStore.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addImageStore

+

Adds backup image store.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
providerThe image store provider nametrue
detailsThe details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsssfalse
nameThe name for the image storefalse
urlThe URL for the image storefalse
zoneidThe Zone ID for the image storefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the image store
disksizetotalThe total disk size of the host
disksizeusedThe host's currently used disk size
nameThe name of the image store
protocolThe protocol of the image store
providernameThe provider name of the image store
readonlyDefines if store is read-only
scopeThe scope of the image store
urlThe URL of the image store
zoneidThe Zone ID of the image store
zonenameThe Zone name of the image store
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addImageStoreS3.html b/static/api/apidocs-4.23/apis/addImageStoreS3.html new file mode 100644 index 0000000000..c055fcc997 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addImageStoreS3.html @@ -0,0 +1,144 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addImageStoreS3

+

Adds S3 Image Store

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accesskeyS3 access keytrue
bucketName of the storage buckettrue
endpointS3 endpointtrue
secretkeyS3 secret keytrue
connectiontimeoutConnection timeout (milliseconds)false
connectionttlConnection TTL (milliseconds)false
maxerrorretryMaximum number of times to retry on errorfalse
s3signerSigner Algorithm to use, either S3SignerType or AWSS3V4SignerTypefalse
sockettimeoutSocket timeout (milliseconds)false
usehttpsUse HTTPS instead of HTTPfalse
usetcpkeepaliveWhether TCP keep-alive is usedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the image store
disksizetotalThe total disk size of the host
disksizeusedThe host's currently used disk size
nameThe name of the image store
protocolThe protocol of the image store
providernameThe provider name of the image store
readonlyDefines if store is read-only
scopeThe scope of the image store
urlThe URL of the image store
zoneidThe Zone ID of the image store
zonenameThe Zone name of the image store
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addIpToNic.html b/static/api/apidocs-4.23/apis/addIpToNic.html new file mode 100644 index 0000000000..622f2f6f00 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addIpToNic.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addIpToNic

+

Assigns secondary IP to NIC

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nicidThe ID of the NIC to which you want to assign private IPtrue
descriptionDescription of the secondary IP addressfalse
ipaddressSecondary IP Addressfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the secondary private IP addr
descriptionDescription of the secondary IP address
ipaddressSecondary IP address
networkidThe ID of the Network
nicidThe ID of the NIC
secondaryipThe list of Secondary IPv4 addr of NIC
virtualmachineidThe ID of the Instance
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addKubernetesSupportedVersion.html b/static/api/apidocs-4.23/apis/addKubernetesSupportedVersion.html new file mode 100644 index 0000000000..0ec11164c1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addKubernetesSupportedVersion.html @@ -0,0 +1,161 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addKubernetesSupportedVersion

+

Add a supported Kubernetes version

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
mincpunumberThe minimum number of CPUs to be set with the Kubernetes versiontrue
minmemoryThe minimum RAM size in MB to be set with the Kubernetes versiontrue
semanticversionThe semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH formattrue
archthe CPU arch of the Kubernetes ISO. Valid options are: x86_64, aarch64, s390xfalse
checksumThe 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
directdownloadIf set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is falsefalse
nameThe name of the Kubernetes supported versionfalse
urlThe URL of the binaries ISO for Kubernetes supported versionfalse
zoneidThe ID of the zone in which Kubernetes supported version will be availablefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Kubernetes supported version
archthe arch of the binaries ISO for Kubernetes supported version
createdThe date when this Kubernetes supported version was created
directdownloadKVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage
isoidThe ID of the binaries ISO for Kubernetes supported version
isonameThe name of the binaries ISO for Kubernetes supported version
isostateThe state of the binaries ISO for Kubernetes supported version
isourlthe URL of the binaries ISO for Kubernetes supported version
mincpunumberThe minimum number of CPUs needed for the Kubernetes supported version
minmemoryThe minimum RAM size in MB needed for the Kubernetes supported version
nameName of the Kubernetes supported version
semanticversionKubernetes semantic version
stateThe enabled or disabled state of the Kubernetes supported version
supportsautoscalingWhether Kubernetes supported version supports Autoscaling
supportshaWhether Kubernetes supported version supports HA, multi-control nodes
zoneidThe ID of the zone in which Kubernetes supported version is available
zonenameThe name of the zone in which Kubernetes supported version is available
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addLdapConfiguration.html b/static/api/apidocs-4.23/apis/addLdapConfiguration.html new file mode 100644 index 0000000000..8117857312 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addLdapConfiguration.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addLdapConfiguration

+

Add a new Ldap Configuration

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hostnameHostnametrue
portPorttrue
domainidLinked Domainfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the LDAP configuration
domainidLinked domain
hostnameName of the host running the LDAP server
portPort the LDAP server is running on
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addNetrisProvider.html b/static/api/apidocs-4.23/apis/addNetrisProvider.html new file mode 100644 index 0000000000..b268b9b113 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addNetrisProvider.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addNetrisProvider

+

Add Netris Provider to CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameNetris provider nametrue
netristagNetris tag for vNetstrue
netrisurlNetris provider URLtrue
passwordPassword to login into Netristrue
sitenameNetris Site nametrue
tenantnameNetris Tenant nametrue
usernameUsername to login into Netristrue
zoneidthe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameNetris Provider name
netristagNetris Tag for vNets
netrisurlNetris Provider URL
sitenameNetris Provider site
tenantnameNetris Admin tenant name
uuidNetris provider uuid
zoneidZone ID to which the Netris Provider is associated with
zonenameZone name to which the Netris Provider is associated with
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addNetscalerLoadBalancer.html b/static/api/apidocs-4.23/apis/addNetscalerLoadBalancer.html new file mode 100644 index 0000000000..32590c4211 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addNetscalerLoadBalancer.html @@ -0,0 +1,150 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addNetscalerLoadBalancer

+

Adds a netscaler load balancer device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
networkdevicetypeNetscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancertrue
passwordCredentials to reach netscaler load balancer devicetrue
physicalnetworkidThe Physical Network IDtrue
urlURL of the netscaler load balancer appliance.true
usernameCredentials to reach netscaler load balancer devicetrue
gslbproviderTrue if NetScaler device being added is for providing GSLB servicefalse
gslbproviderprivateipPrivate IP of the sitefalse
gslbproviderpublicipPublic IP of the sitefalse
isexclusivegslbproviderTrue if NetScaler device being added is for providing GSLB service exclusively and can not be used for LBfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
gslbproviderTrue if NetScaler device is provisioned to be a GSLB service provider
gslbproviderprivateipPrivate IP of the NetScaler representing GSLB site
gslbproviderpublicipPublic IP of the NetScaler representing GSLB site
ipaddressThe management IP address of the external load balancer
isexclusivegslbproviderTrue if NetScaler device is provisioned exclusively to be a GSLB service provider
lbdevicecapacityDevice capacity
lbdevicededicatedTrue if device is dedicated for an account
lbdeviceidDevice ID of the netscaler load balancer
lbdevicenameDevice name
lbdevicestateDevice state
physicalnetworkidThe physical Network to which this netscaler device belongs to
podidsUsed 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.
privateinterfaceThe private interface of the load balancer
providerName of the provider
publicinterfaceThe public interface of the load balancer
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addNetworkDevice.html b/static/api/apidocs-4.23/apis/addNetworkDevice.html new file mode 100644 index 0000000000..d95dc01573 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addNetworkDevice.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addNetworkDevice

+

Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
networkdeviceparameterlistParameters for network devicefalse
networkdevicetypeNetwork device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewallfalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
idThe ID of the Network device
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addNetworkServiceProvider.html b/static/api/apidocs-4.23/apis/addNetworkServiceProvider.html new file mode 100644 index 0000000000..d34fb30d37 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addNetworkServiceProvider.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addNetworkServiceProvider

+

Adds a network serviceProvider to a physical network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name for the physical network service providertrue
physicalnetworkidThe Physical Network ID to add the provider totrue
destinationphysicalnetworkidThe destination Physical Network ID to bridge tofalse
servicelistThe list of services to be enabled for this physical network service providerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addNicToVirtualMachine.html b/static/api/apidocs-4.23/apis/addNicToVirtualMachine.html new file mode 100644 index 0000000000..d5b9fcc6f8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addNicToVirtualMachine.html @@ -0,0 +1,708 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addNicToVirtualMachine

+

Adds Instance to specified network by creating a NIC

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
networkidNetwork IDtrue
virtualmachineidInstance IDtrue
dhcpoptionsDHCP options which are passed to the NIC Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.comfalse
ipaddressIP Address for the new Networkfalse
macaddressMac Address for the new Networkfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addNiciraNvpDevice.html b/static/api/apidocs-4.23/apis/addNiciraNvpDevice.html new file mode 100644 index 0000000000..ce3470b577 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addNiciraNvpDevice.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addNiciraNvpDevice

+

Adds a Nicira NVP device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hostnameHostname of ip address of the Nicira NVP Controller.true
passwordCredentials to access the Nicira Controller APItrue
physicalnetworkidThe Physical Network IDtrue
transportzoneuuidThe Transportzone UUID configured on the Nicira Controllertrue
usernameCredentials to access the Nicira Controller APItrue
l2gatewayserviceuuidThe L2 Gateway Service UUID configured on the Nicira Controllerfalse
l3gatewayserviceuuidThe L3 Gateway Service UUID configured on the Nicira Controllerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
hostnameThe controller IP address
l2gatewayserviceuuidThis L2 gateway service UUID
l3gatewayserviceuuidThis L3 gateway service UUID
niciradevicenameDevice name
nvpdeviceidDevice ID of the Nicire Nvp
physicalnetworkidThe physical Network to which this Nirica Nvp belongs to
providerName of the provider
transportzoneuuidThe transport zone UUID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addNodesToKubernetesCluster.html b/static/api/apidocs-4.23/apis/addNodesToKubernetesCluster.html new file mode 100644 index 0000000000..207837f80e --- /dev/null +++ b/static/api/apidocs-4.23/apis/addNodesToKubernetesCluster.html @@ -0,0 +1,249 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addNodesToKubernetesCluster

+

Add nodes as workers to an existing CKS cluster.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the Kubernetes clustertrue
nodeidscomma separated list of (external) node (physical or virtual machines) IDs that need to beadded as worker nodes to an existing managed Kubernetes cluster (CKS)true
manualupgrade(optional) indicates if the node is marked for manual upgrade and excluded from the Kubernetes cluster upgrade operationfalse
mountcksisoonvr(optional) Vmware only, uses the CKS cluster network VR to mount the CKS ISOfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Kubernetes cluster
accountThe Account associated with the Kubernetes cluster
associatednetworknameThe name of the network of the Kubernetes cluster
autoscalingenabledWhether autoscaling is enabled for the cluster
clustertypeThe type of the cluster
cniconfignameName of CNI Configuration associated with the cluster
cniconfigurationidID of CNI Configuration associated with the cluster
consoleendpointURL end point for the Kubernetes cluster dashboard UI
controlaffinitygroupidsThe IDs of affinity groups associated with control nodes
controlaffinitygroupnamesThe names of affinity groups associated with control nodes
controlnodesThe control nodes count for the Kubernetes cluster
controlofferingidthe ID of the service offering of the control nodes on the Kubernetes cluster
controlofferingnamethe name of the service offering of the control nodes on the Kubernetes cluster
cpunumberThe cpu cores of the Kubernetes cluster
createdThe date when this Kubernetes cluster was created
csienabledIndicates if the CloudStack CSI driver has been setup in the cluster
descriptionThe description of the Kubernetes cluster
domainThe name of the domain in which the Kubernetes cluster exists
domainidThe ID of the domain in which the Kubernetes cluster exists
domainpathPath of the domain to which the Kubernetes cluster belongs
endpointURL end point for the Kubernetes cluster
etcdaffinitygroupidsThe IDs of affinity groups associated with etcd nodes
etcdaffinitygroupnamesThe names of affinity groups associated with etcd nodes
etcdipsPublic IP Addresses of the etcd nodes
etcdnodesthe number of the etcd nodes on the Kubernetes cluster
etcdofferingidthe ID of the service offering of the etcd nodes on the Kubernetes cluster
etcdofferingnamethe name of the service offering of the etcd nodes on the Kubernetes cluster
ipaddressPublic IP Address of the cluster
ipaddressidPublic IP Address ID of the cluster
keypairKeypair details
kubernetesversionidThe ID of the Kubernetes version for the Kubernetes cluster
kubernetesversionnameThe name of the Kubernetes version for the Kubernetes cluster
masternodesThe master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.
maxsizeMaximum size of the cluster
memoryThe memory the Kubernetes cluster
minsizeMinimum size of the cluster
nameThe name of the Kubernetes cluster
networkidThe ID of the network of the Kubernetes cluster
projectThe project name of the Kubernetes cluster
projectidThe project id of the Kubernetes cluster
serviceofferingidThe ID of the service offering of the Kubernetes cluster
serviceofferingnameThe name of the service offering of the Kubernetes cluster
sizeThe size (worker nodes count) of the Kubernetes cluster
stateThe state of the Kubernetes cluster
templateidThe ID of the Template of the Kubernetes cluster
templatenamethe name of the template of the Kubernetes cluster
virtualmachinesThe list of virtualmachines associated with this Kubernetes cluster
workeraffinitygroupidsThe IDs of affinity groups associated with worker nodes
workeraffinitygroupnamesThe names of affinity groups associated with worker nodes
workerofferingidthe ID of the service offering of the worker nodes on the Kubernetes cluster
workerofferingnamethe name of the service offering of the worker nodes on the Kubernetes cluster
zoneidThe name of the zone of the Kubernetes cluster
zonenameThe name of the zone of the Kubernetes cluster
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addNsxController.html b/static/api/apidocs-4.23/apis/addNsxController.html new file mode 100644 index 0000000000..ccb9a73302 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addNsxController.html @@ -0,0 +1,132 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addNsxController

+

Add NSX Controller to CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
edgeclusterEdge Cluster nametrue
nameNSX controller / provider nametrue
nsxproviderhostnameNSX controller hostname / IP addresstrue
passwordPassword to login into NSX controllertrue
tier0gatewayTier-0 Gateway addresstrue
transportzoneTransport Zone controls to which hosts a logical switch can reachtrue
usernameUsername to log into NSX controllertrue
zoneidthe ID of zonetrue
nsxproviderportNSX controller portfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
edgeclusterThe name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX
hostnameNSX controller hostname or IP address
nameNSX controller name
nsxprovideruuidNSX controller ID
portNSX controller port
tier0gatewayThe tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks
transportzoneThe name of the transport zone. A transport zone controls to which hosts a logical switch can reach
zoneidZone ID to which the NSX controller is associated with
zonenameZone name to which the NSX controller is associated with
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addObjectStoragePool.html b/static/api/apidocs-4.23/apis/addObjectStoragePool.html new file mode 100644 index 0000000000..e9f5fed24a --- /dev/null +++ b/static/api/apidocs-4.23/apis/addObjectStoragePool.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addObjectStoragePool

+

Adds a object storage pool

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
namethe name for the object storetrue
providerthe object store provider nametrue
urlthe URL for the object storetrue
detailsthe details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsssfalse
sizethe total size of the object store in GiB. Used for tracking capacity and sending alertsfalse
tagsthe tags for the storage poolfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the object store
namethe name of the object store
providernamethe provider name of the object store
storageallocatedthe allocated size of the object store
storagetotalthe total size of the object store
storageusedthe object store currently used size
urlthe url of the object store
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addOpenDaylightController.html b/static/api/apidocs-4.23/apis/addOpenDaylightController.html new file mode 100644 index 0000000000..3070789246 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addOpenDaylightController.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addOpenDaylightController

+

Adds an OpenDyalight controler

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
passwordCredential to access the OpenDaylight APItrue
physicalnetworkidThe Physical Network IDtrue
urlApi URL of the OpenDaylight Controller.true
usernameUsername to access the OpenDaylight APItrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idDevice ID of the controller
nameThe name assigned to the controller
physicalnetworkidThe physical Network to which this controller belongs to
urlThe URL of the controller API
usernameThe username to authenticate to the controller
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addOsCategory.html b/static/api/apidocs-4.23/apis/addOsCategory.html new file mode 100644 index 0000000000..70ae08f8f1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addOsCategory.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addOsCategory

+

Adds a new OS category

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of the OS categorytrue
isfeaturedWhether the category is featured or notfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the OS category
createdDate when the OS category was created.
iconBase64 string representation of the resource icon
isfeaturedWhether the OS category is featured
nameThe name of the OS category
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addPaloAltoFirewall.html b/static/api/apidocs-4.23/apis/addPaloAltoFirewall.html new file mode 100644 index 0000000000..328789afd7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addPaloAltoFirewall.html @@ -0,0 +1,141 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addPaloAltoFirewall

+

Adds a Palo Alto firewall device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
networkdevicetypeSupports only PaloAltoFirewalltrue
passwordCredentials to reach Palo Alto firewall devicetrue
physicalnetworkidThe Physical Network IDtrue
urlURL of the Palo Alto appliance.true
usernameCredentials to reach Palo Alto firewall devicetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
fwdevicecapacityDevice capacity
fwdeviceidDevice ID of the Palo Alto firewall
fwdevicenameDevice name
fwdevicestateDevice state
ipaddressThe management IP address of the external firewall
numretriesThe number of times to retry requests to the external firewall
physicalnetworkidThe physical Network to which this Palo Alto firewall belongs to
privateinterfaceThe private interface of the external firewall
privatezoneThe private security zone of the external firewall
providerName of the provider
publicinterfaceThe public interface of the external firewall
publiczoneThe public security zone of the external firewall
timeoutThe timeout (in seconds) for requests to the external firewall
usageinterfaceThe usage interface of the external firewall
usernameThe username that's used to log in to the external firewall
zoneidThe zone ID of the external firewall
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addRegion.html b/static/api/apidocs-4.23/apis/addRegion.html new file mode 100644 index 0000000000..cfa4a592f0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addRegion.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addRegion

+

Adds a Region

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idId of the Regiontrue
endpointRegion service endpointtrue
nameName of the regiontrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the region
endpointThe end point of the region
gslbserviceenabledTrue if GSLB service is enabled in the region, false otherwise
nameThe name of the region
portableipserviceenabledTrue if security groups support is enabled, false otherwise
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addResourceDetail.html b/static/api/apidocs-4.23/apis/addResourceDetail.html new file mode 100644 index 0000000000..1f2d099567 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addResourceDetail.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addResourceDetail

+

Adds detail for the Resource.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
detailsMap of (key/value pairs)true
resourceidResource ID to create the details fortrue
resourcetypeType of the resourcetrue
fordisplayPass false if you want this detail to be disabled for the regular User. True by defaultfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addSecondaryStorage.html b/static/api/apidocs-4.23/apis/addSecondaryStorage.html new file mode 100644 index 0000000000..452b2b5341 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addSecondaryStorage.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addSecondaryStorage

+

Adds secondary storage.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
urlThe URL for the secondary storagetrue
detailsDetails in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].copytemplatesfromothersecondarystorages=truefalse
zoneidThe Zone ID for the secondary storagefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the image store
disksizetotalThe total disk size of the host
disksizeusedThe host's currently used disk size
nameThe name of the image store
protocolThe protocol of the image store
providernameThe provider name of the image store
readonlyDefines if store is read-only
scopeThe scope of the image store
urlThe URL of the image store
zoneidThe Zone ID of the image store
zonenameThe Zone name of the image store
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addStratosphereSsp.html b/static/api/apidocs-4.23/apis/addStratosphereSsp.html new file mode 100644 index 0000000000..a4b0e988f7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addStratosphereSsp.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addStratosphereSsp

+

Adds stratosphere ssp server

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameStratosphere ssp API nametrue
urlStratosphere ssp server URLtrue
zoneidThe zone IDtrue
passwordStratosphere ssp API passwordfalse
tenantuuidStratosphere ssp tenant UUIDfalse
usernameStratosphere ssp API usernamefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
hostidServer ID of the stratosphere ssp server
nameName
urlURL of ssp endpoint
zoneidZone which this ssp controls
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addSwift.html b/static/api/apidocs-4.23/apis/addSwift.html new file mode 100644 index 0000000000..29a7ca1666 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addSwift.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addSwift

+

Adds Swift.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
urlThe URL for swifttrue
accountThe account for swiftfalse
key key for the user for swiftfalse
usernameThe username for swiftfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the image store
disksizetotalThe total disk size of the host
disksizeusedThe host's currently used disk size
nameThe name of the image store
protocolThe protocol of the image store
providernameThe provider name of the image store
readonlyDefines if store is read-only
scopeThe scope of the image store
urlThe URL of the image store
zoneidThe Zone ID of the image store
zonenameThe Zone name of the image store
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addTrafficMonitor.html b/static/api/apidocs-4.23/apis/addTrafficMonitor.html new file mode 100644 index 0000000000..75acebade3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addTrafficMonitor.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addTrafficMonitor

+

Adds Traffic Monitor Host for Direct Network Usage

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
urlURL of the traffic monitor Hosttrue
zoneidZone in which to add the external firewall appliance.true
excludezonesTraffic going into the listed zones will not be meteredfalse
includezonesTraffic going into the listed zones will be meteredfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the external firewall
ipaddressThe management IP address of the external firewall
numretriesThe number of times to retry requests to the external firewall
timeoutThe timeout (in seconds) for requests to the external firewall
zoneidThe zone ID of the external firewall
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addTrafficType.html b/static/api/apidocs-4.23/apis/addTrafficType.html new file mode 100644 index 0000000000..a71e583d99 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addTrafficType.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addTrafficType

+

Adds traffic type to a physical network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
physicalnetworkidThe Physical Network IDtrue
traffictypeThe trafficType to be added to the physical networktrue
hypervnetworklabelThe network name label of the physical device dedicated to this traffic on a Hyperv hostfalse
isolationmethodUsed 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
kvmnetworklabelThe network name label of the physical device dedicated to this traffic on a KVM hostfalse
ovm3networklabelThe network name of the physical device dedicated to this traffic on an OVM3 hostfalse
vlanThe VLAN id to be used for Management traffic by VMware hostfalse
vmwarenetworklabelThe network name label of the physical device dedicated to this traffic on a VMware hostfalse
xennetworklabelThe network name label of the physical device dedicated to this traffic on a XenServer hostfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the Network provider
hypervnetworklabelThe Network name label of the physical device dedicated to this traffic on a HyperV host
isolationmethodsisolation methods for the physical network traffic
kvmnetworklabelThe Network name label of the physical device dedicated to this traffic on a KVM host
ovm3networklabelThe Network name of the physical device dedicated to this traffic on an OVM3 host
physicalnetworkidThe physical Network this belongs to
traffictypeThe trafficType to be added to the physical Network
vlanThe VLAN id to be used for Management traffic by VMware host
vmwarenetworklabelThe Network name label of the physical device dedicated to this traffic on a VMware host
xennetworklabelThe Network name label of the physical device dedicated to this traffic on a XenServer host
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addTungstenFabricNetworkGatewayToLogicalRouter.html b/static/api/apidocs-4.23/apis/addTungstenFabricNetworkGatewayToLogicalRouter.html new file mode 100644 index 0000000000..d3398e1116 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addTungstenFabricNetworkGatewayToLogicalRouter.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addTungstenFabricNetworkGatewayToLogicalRouter

+

Add Tungsten-Fabric network gateway to logical router

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
logicalrouteruuidTungsten-Fabric logical router uuidtrue
networkuuidTungsten-Fabric network uuidtrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric logical router name
networkList Tungsten-Fabric policy network name
uuidTungsten-Fabric logical router uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addTungstenFabricPolicyRule.html b/static/api/apidocs-4.23/apis/addTungstenFabricPolicyRule.html new file mode 100644 index 0000000000..cc8afcf054 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addTungstenFabricPolicyRule.html @@ -0,0 +1,174 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addTungstenFabricPolicyRule

+

Add Tungsten-Fabric policy rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
actionTungsten-Fabric policy rule actiontrue
destendportTungsten-Fabric policy rule destination end porttrue
destipprefixTungsten-Fabric policy rule destination ip prefixtrue
destipprefixlenTungsten-Fabric policy rule destination ip prefix lengthtrue
destnetworkTungsten-Fabric policy rule destination networktrue
deststartportTungsten-Fabric policy rule destination start porttrue
directionTungsten-Fabric policy rule directiontrue
policyuuidThe UUID of Tungsten-Fabric policytrue
protocolTungsten-Fabric policy rule protocoltrue
srcendportTungsten-Fabric policy rule source end porttrue
srcipprefixTungsten-Fabric policy rule source ip prefixtrue
srcipprefixlenTungsten-Fabric policy rule source ip prefix lengthtrue
srcnetworkTungsten-Fabric policy rule source networktrue
srcstartportTungsten-Fabric policy rule source start porttrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
actionTungsten-Fabric policy action
destendportTungsten-Fabric policy destination end port
destipprefixTungsten-Fabric policy destination ip prefix
destipprefixlenTungsten-Fabric policy destination ip prefix length
destnetworkTungsten-Fabric policy destination network
deststartportTungsten-Fabric policy destination start port
directionTungsten-Fabric policy name
policyuuidTungsten-Fabric policy uuid
protocolTungsten-Fabric policy protocol
srcendportTungsten-Fabric policy source end port
srcipprefixTungsten-Fabric policy source ip prefix
srcipprefixlenTungsten-Fabric policy source ip prefix length
srcnetworkTungsten-Fabric policy source network
srcstartportTungsten-Fabric policy source start port
uuidTungsten-Fabric rule uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addUcsManager.html b/static/api/apidocs-4.23/apis/addUcsManager.html new file mode 100644 index 0000000000..ae702ea507 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addUcsManager.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addUcsManager

+

Adds a Ucs manager

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
passwordThe password of UCStrue
urlThe name of UCS URLtrue
usernameThe username of UCStrue
zoneidThe Zone ID for the ucs managertrue
nameThe name of UCS managerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the UCS manager
nameThe name of UCS manager
urlThe URL of UCS manager
zoneidThe zone ID of UCS manager
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addUserToProject.html b/static/api/apidocs-4.23/apis/addUserToProject.html new file mode 100644 index 0000000000..73f44ee5ff --- /dev/null +++ b/static/api/apidocs-4.23/apis/addUserToProject.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addUserToProject

+

Adds User to a project

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
projectidID of the project to add the User totrue
usernameName of the User to be added to the projecttrue
emailEmail ID of User to which invitation to the project is going to be sentfalse
projectroleidID of the project rolefalse
roletypeProject role type to be assigned to the User - Admin/Regularfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addVirtualMachinesToKubernetesCluster.html b/static/api/apidocs-4.23/apis/addVirtualMachinesToKubernetesCluster.html new file mode 100644 index 0000000000..4c5bb3db34 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addVirtualMachinesToKubernetesCluster.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addVirtualMachinesToKubernetesCluster

+

Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Kubernetes clustertrue
virtualmachineidsThe IDs of the VMs to add to the clustertrue
iscontrolnodeIs control node or not? Defaults to false.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addVmwareDc.html b/static/api/apidocs-4.23/apis/addVmwareDc.html new file mode 100644 index 0000000000..50f6b041b0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addVmwareDc.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addVmwareDc

+

Adds a VMware datacenter to specified zone

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of VMware datacenter to be added to specified zone.true
vcenterThe name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.true
zoneidThe Zone ID.true
passwordThe password for specified username.false
usernameThe Username required to connect to resource.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idThe VMware Datacenter ID
nameThe VMware Datacenter name
vcenterThe VMware vCenter name/ip
zoneidThe Zone ID associated with this VMware Datacenter
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addVpnUser.html b/static/api/apidocs-4.23/apis/addVpnUser.html new file mode 100644 index 0000000000..06703315b2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/addVpnUser.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addVpnUser

+

Adds VPN Users

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
passwordPassword for the usernametrue
usernameUsername for the VPN Usertrue
accountAn optional Account for the VPN User. Must be used with domainId.false
domainidAn optional domainId for the VPN User. If the account parameter is used, domainId must also be used.false
projectidAdd VPN User to the specific projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe VPN user ID
accountThe Account of the remote access VPN
domainThe domain name of the Account of the remote access VPN
domainidThe domain ID of the Account of the remote access VPN
domainpathPath of the domain to which the remote access VPN belongs
projectThe project name of the VPN
projectidThe project ID of the VPN
stateThe state of the VPN User, can be 'Add', 'Revoke' or 'Active'.
usernameThe username of the VPN user
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/addWebhookFilter.html b/static/api/apidocs-4.23/apis/addWebhookFilter.html new file mode 100644 index 0000000000..089d80baca --- /dev/null +++ b/static/api/apidocs-4.23/apis/addWebhookFilter.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

addWebhookFilter

+

Adds a Webhook filter

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
valueValue for the Webhook which that will be matchedtrue
webhookidID for the Webhooktrue
matchtypeMatch type for the Webhook filter - Exact, Prefix, Suffix or Containsfalse
modeMode for the Webhook filter - Include or Excludefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Webhook
accountThe account associated with the Webhook
createdThe date when this Webhook was created
descriptionThe description of the Webhook
domainThe name of the domain in which the Webhook exists
domainidThe ID of the domain in which the Webhook exists
domainpathpath of the domain to which the Webhook belongs
nameThe name of the Webhook
payloadurlThe payload URL end point for the Webhook
projectthe project name of the Kubernetes cluster
projectidthe project id of the Kubernetes cluster
scopeThe scope of the Webhook
secretkeyThe secret key for the Webhook
sslverificationWhether SSL verification is enabled for the Webhook
stateThe state of the Webhook
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/applyTungstenFabricPolicy.html b/static/api/apidocs-4.23/apis/applyTungstenFabricPolicy.html new file mode 100644 index 0000000000..eb28db36bf --- /dev/null +++ b/static/api/apidocs-4.23/apis/applyTungstenFabricPolicy.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

applyTungstenFabricPolicy

+

Apply Tungsten-Fabric policy

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
majorsequenceThe major sequence of Tungsten-Fabric policytrue
minorsequenceThe minor sequence of Tungsten-Fabric policytrue
networkuuidThe UUID of networktrue
policyuuidThe UUID of Tungsten-Fabric policytrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric policy name
networkList Tungsten-Fabric policy network name
uuidTungsten-Fabric tag type uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/applyTungstenFabricTag.html b/static/api/apidocs-4.23/apis/applyTungstenFabricTag.html new file mode 100644 index 0000000000..4f42640e8f --- /dev/null +++ b/static/api/apidocs-4.23/apis/applyTungstenFabricTag.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

applyTungstenFabricTag

+

Apply Tungsten-Fabric tag

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
taguuidThe UUID of Tungsten-Fabric tagtrue
zoneidThe ID of zonetrue
applicationpolicysetuuidThe UUID of Tungsten-Fabric application policy setfalse
networkuuidThe UUID of networksfalse
nicuuidThe UUID of NICsfalse
policyuuidThe UUID of Tungsten-Fabric policyfalse
vmuuidThe UUID of Instancesfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric tag name
networkList Tungsten-Fabric network
nicList Tungsten-Fabric NIC
policyList Tungsten-Fabric policy
uuidTungsten-Fabric tag type uuid
vmList Tungsten-Fabric Instance
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/archiveAlerts.html b/static/api/apidocs-4.23/apis/archiveAlerts.html new file mode 100644 index 0000000000..e702d546e5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/archiveAlerts.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

archiveAlerts

+

Archive one or more alerts.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enddateEnd date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")false
idsThe IDs of the alertsfalse
startdateStart date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")false
typeArchive by alert typefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/archiveEvents.html b/static/api/apidocs-4.23/apis/archiveEvents.html new file mode 100644 index 0000000000..481bed6f40 --- /dev/null +++ b/static/api/apidocs-4.23/apis/archiveEvents.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

archiveEvents

+

Archive one or more events.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enddateEnd date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")false
idsThe IDs of the eventsfalse
startdateStart date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")false
typeArchive by event typefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/archiveSnapshot.html b/static/api/apidocs-4.23/apis/archiveSnapshot.html new file mode 100644 index 0000000000..bfda156052 --- /dev/null +++ b/static/api/apidocs-4.23/apis/archiveSnapshot.html @@ -0,0 +1,186 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

archiveSnapshot

+

Archives (moves) a Snapshot on primary storage to secondary storage

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Snapshottrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the Snapshot
accountThe Account associated with the Snapshot
chainsizechain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true
createdThe date the Snapshot was created
datastoreidID of the datastore for the snapshot entry
datastorenamename of the datastore for the snapshot entry
datastorestatestate of the snapshot on the datastore
datastoretypetype of the datastore for the snapshot entry
domainThe domain name of the Snapshot's Account
domainidThe domain ID of the Snapshot's Account
domainpathpath of the Domain the snapshot's account belongs to
downloaddetailsdownload progress of a snapshot
intervaltypeValid types are hourly, daily, weekly, monthy, Template, and none.
locationtypeValid location types are primary and secondary.
nameName of the Snapshot
osdisplaynameDisplay name of the os on volume
ostypeidID of the os on volume
parentThe parent ID of the Snapshot
parentnameThe parent name of the Snapshot
physicalsizePhysical size of backed up Snapshot on image store
projectThe project name of the Snapshot
projectidThe project id of the Snapshot
revertableIndicates whether the underlying storage supports reverting the volume to this Snapshot
snapshottypeThe type of the Snapshot
stateThe 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
statusthe status of the template
virtualsizeVirtual size of backedup Snapshot on image store
volumeidID of the disk volume
volumenameName of the disk volume
volumestatestate of the disk volume
volumetypeType of the disk volume
zoneidID of the availability zone
zonenamename of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/assignCertToLoadBalancer.html b/static/api/apidocs-4.23/apis/assignCertToLoadBalancer.html new file mode 100644 index 0000000000..0819aa881f --- /dev/null +++ b/static/api/apidocs-4.23/apis/assignCertToLoadBalancer.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

assignCertToLoadBalancer

+

Assigns a certificate to a load balancer rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
certidThe ID of the certificatetrue
lbruleidThe ID of the load balancer ruletrue
forcedForce assign the certificate. If there is a certificate assigned to the LB, it will be removed at first.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/assignToGlobalLoadBalancerRule.html b/static/api/apidocs-4.23/apis/assignToGlobalLoadBalancerRule.html new file mode 100644 index 0000000000..16d401cff9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/assignToGlobalLoadBalancerRule.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

assignToGlobalLoadBalancerRule

+

Assign load balancer rule or list of load balancer rules to a global load balancer rules.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the global load balancer ruletrue
loadbalancerrulelistThe list load balancer rules that will be assigned to global load balancer ruletrue
gslblbruleweightsmapMap 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
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/assignToLoadBalancerRule.html b/static/api/apidocs-4.23/apis/assignToLoadBalancerRule.html new file mode 100644 index 0000000000..fddcc38586 --- /dev/null +++ b/static/api/apidocs-4.23/apis/assignToLoadBalancerRule.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

assignToLoadBalancerRule

+

Assigns an Instance or a list of Instances to a load balancer rule.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the load balancer ruletrue
virtualmachineidsThe list of IDs of the Instance that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)false
vmidipmapVM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75. (Optional, for VPC Conserve Mode) Pass vmnetworkid. Example: vmidipmap[0].vmnetworkid=NETWORK_TIER_UUIDfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/assignVirtualMachine.html b/static/api/apidocs-4.23/apis/assignVirtualMachine.html new file mode 100644 index 0000000000..bfc8f7f3a6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/assignVirtualMachine.html @@ -0,0 +1,711 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

assignVirtualMachine

+

Change ownership of an Instance 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 an Instance from any account to any other account in any domain. A domain administrator can reassign an Instance to any account in the same domain.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidID of the Instance to be movedtrue
accountAccount name of the new Instance owner.false
domainidDomain id of the new Instance owner.false
networkidsList of new network IDs in which the moved Instance will participate. In case no network ids are provided the Instance 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
projectidAn optional project for the new Instance owner.false
securitygroupidsList of security group ids to be applied on the Instance. In case no security groups are provided the Instance is part of the default security group.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/assignVirtualMachineToBackupOffering.html b/static/api/apidocs-4.23/apis/assignVirtualMachineToBackupOffering.html new file mode 100644 index 0000000000..0c5b0a3bb6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/assignVirtualMachineToBackupOffering.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

assignVirtualMachineToBackupOffering

+

Assigns an Instance to a backup offering

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
backupofferingidID of the backup offeringtrue
virtualmachineidID of the Instancetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/assignVolume.html b/static/api/apidocs-4.23/apis/assignVolume.html new file mode 100644 index 0000000000..31c6aa5c51 --- /dev/null +++ b/static/api/apidocs-4.23/apis/assignVolume.html @@ -0,0 +1,309 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

assignVolume

+

Changes ownership of a Volume from one Account to another.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
volumeidThe ID of the volume to be reassigned.true
accountidThe ID of the Account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.false
projectidThe ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the disk volume
accountThe Account associated with the disk volume
attachedThe date the volume was attached to an Instance
chaininfoThe chain info of the volume
clusteridCluster id of the volume
clusternameCluster name where the volume is allocated
createdThe date the disk volume was created
deleteprotectiontrue if volume has delete protection.
destroyedThe boolean state of whether the volume is destroyed or not
deviceidThe ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
diskBytesReadRateBytes read rate of the disk volume
diskBytesWriteRateBytes write rate of the disk volume
diskIopsReadRateIO requests read rate of the disk volume per the disk offering
diskIopsWriteRateIO requests write rate of the disk volume per the disk offering
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingdisplaytextThe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnameName of the disk offering
displayvolumeAn optional field whether to the display the volume to the end User or not.
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathpath of the Domain the disk volume belongs to
encryptformatthe format of the disk encryption if applicable
externaluuidVolume UUID that is given by virtualisation provider (only for VMware)
hypervisorHypervisor the volume belongs to
isextractableTrue if the volume is extractable, false otherwise
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isonameThe name of the ISO attached to the Instance
kmskeyKMS key name of the volume
kmskeyidKMS key id of the volume
kmskeyversionVersion number of the KMS key used for disk encryption if applicable
maxiopsMax IOPS of the disk volume
miniopsMin IOPS of the disk volume
nameName of the disk volume
pathThe path of the volume
physicalsizeThe bytes actually consumed on disk
podidPod id of the volume
podnamePod name of the volume
projectThe project name of the VPN
projectidThe project id of the VPN
provisioningtypeProvisioning type used to create volumes.
quiescevmNeed quiesce Instance or not when taking Snapshot
serviceofferingdisplaytextThe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnameName of the service offering for root disk
sizeSize of the disk volume
snapshotidID of the Snapshot from which this volume was created
stateThe state of the disk volume
statusThe status of the volume
storageName of the primary storage hosting the disk volume
storageidID of the primary storage hosting the disk volume; returned to admin User only
storagetypeShared or local storage
supportsstoragesnapshotTrue if storage Snapshot is supported for the volume, false otherwise
templatedisplaytextAn alternate display text of the Template for the Instance
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
typeType of the disk volume (ROOT or DATADISK)
utilizationThe disk utilization
virtualmachineidID of the Instance
virtualsizeThe bytes allocated
vmdisplaynameDisplay name of the Instance
vmnameName of the Instance
vmstateState of the Instance
vmtypeType of the Instance
volumecheckresultdetails for the volume check result, they may vary for different hypervisors
volumerepairresultdetails for the volume repair result, they may vary for different hypervisors
zoneidID of the availability zone
zonenameName of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/associateDnsZoneToNetwork.html b/static/api/apidocs-4.23/apis/associateDnsZoneToNetwork.html new file mode 100644 index 0000000000..f22dc7bc00 --- /dev/null +++ b/static/api/apidocs-4.23/apis/associateDnsZoneToNetwork.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

associateDnsZoneToNetwork

+

Associates a DNS Zone with a Network for VM auto-registration

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
dnszoneidThe ID of the DNS zonetrue
networkidThe ID of the networktrue
subdomainOptional subdomain to append (e.g., 'dev' creates vm1.dev.example.com)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the mapping
dnszoneidThe ID of the DNS zone
networkidThe ID of the Network
subdomainThe sub domain name of the auto-registered DNS record
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/associateIpAddress.html b/static/api/apidocs-4.23/apis/associateIpAddress.html new file mode 100644 index 0000000000..bcb79152a8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/associateIpAddress.html @@ -0,0 +1,258 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

associateIpAddress

+

Acquires and associates a public IP to an Account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountThe Account to associate with this IP addressfalse
domainidThe ID of the domain to associate with this IP addressfalse
fordisplayAn optional field, whether to the display the IP to the end User or notfalse
ipaddressIP Address to be associatedfalse
isportableShould be set to true if public IP is required to be transferable across zones, if not specified defaults to falsefalse
networkidThe Network this IP address should be associated to.false
projectidDeploy Instance for the projectfalse
regionidRegion ID from where portable IP is to be associated.false
vpcidThe VPC you want the IP address to be associated withfalse
zoneidThe ID of the availability zone you want to acquire an public IP address fromfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idPublic IP address ID
accountThe Account the public IP address is associated with
allocatedDate the public IP address was acquired
associatednetworkidThe ID of the Network associated with the IP address
associatednetworknameThe name of the Network associated with the IP address
domainThe domain the public IP address is associated with
domainidThe domain ID the public IP address is associated with
domainpathpath of the domain to which the public IP address belongs
fordisplayIs public IP for display to the regular user
forprovidertrue if range is dedicated for external network providers
forsystemvmstrue if range is dedicated for System VMs
forvirtualnetworkThe virtual Network for the IP address
hasrulesWhether the IP address has Firewall/PortForwarding/LoadBalancing rules defined
ipaddressPublic IP address
isportableIs public IP portable across the zones
issourcenatTrue if the IP address is a source NAT address, false otherwise
isstaticnatTrue if this IP is for static NAT, false otherwise
issystemTrue if this IP is system IP (was allocated as a part of deployVm or createLbRule)
networkidThe ID of the Network where IP belongs to
networknameThe name of the Network where IP belongs to
physicalnetworkidThe physical Network this belongs to
projectThe project name of the address
projectidThe project id of the IP address
purposePurpose of the IP address. In Acton this value is not null for IPs with isSystem=true, and can have either StaticNat or LB value
stateState of the IP address. Can be: Allocating, Allocated, Releasing, Reserved and Free
virtualmachinedisplaynameInstance display name the IP address is assigned to (not null only for static NAT IP)
virtualmachineidInstance id the IP address is assigned to
virtualmachinenameInstance name the IP address is assigned to
virtualmachinetypeInstance type the IP address is assigned to
vlanidThe ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only
vlannameThe VLAN associated with the IP address
vmipaddressInstance (DNAT) IP address (not null only for static NAT IP)
vpcidVPC ID the IP belongs to
vpcnameVPC name the IP belongs to
zoneidThe ID of the zone the public IP address belongs to
zonenameThe name of the zone the public IP address belongs to
tags(*)The list of resource tags associated with IP address
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/associateUcsProfileToBlade.html b/static/api/apidocs-4.23/apis/associateUcsProfileToBlade.html new file mode 100644 index 0000000000..5551af61f2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/associateUcsProfileToBlade.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

associateUcsProfileToBlade

+

Associate a profile to a blade

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
bladeidBlade IDtrue
profilednProfile dntrue
ucsmanageridUCS manager IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idUCS blade ID
bladednUCS blade dn
hostidCloudStack host ID this blade associates to
profilednAssociated UCS profile dn
ucsmanageridUCS manager ID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/attachIso.html b/static/api/apidocs-4.23/apis/attachIso.html new file mode 100644 index 0000000000..b2b2754b96 --- /dev/null +++ b/static/api/apidocs-4.23/apis/attachIso.html @@ -0,0 +1,702 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

attachIso

+

Attaches an ISO to an Instance.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the ISO filetrue
virtualmachineidThe ID of the Instancetrue
forcedIf true, ejects existing ISO before attaching on VMware. Default: falsefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/attachVolume.html b/static/api/apidocs-4.23/apis/attachVolume.html new file mode 100644 index 0000000000..f3e4aa5507 --- /dev/null +++ b/static/api/apidocs-4.23/apis/attachVolume.html @@ -0,0 +1,309 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

attachVolume

+

Attaches a disk volume to an Instance.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the disk volumetrue
virtualmachineid the ID of the Instancetrue
deviceidThe 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the disk volume
accountThe Account associated with the disk volume
attachedThe date the volume was attached to an Instance
chaininfoThe chain info of the volume
clusteridCluster id of the volume
clusternameCluster name where the volume is allocated
createdThe date the disk volume was created
deleteprotectiontrue if volume has delete protection.
destroyedThe boolean state of whether the volume is destroyed or not
deviceidThe ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
diskBytesReadRateBytes read rate of the disk volume
diskBytesWriteRateBytes write rate of the disk volume
diskIopsReadRateIO requests read rate of the disk volume per the disk offering
diskIopsWriteRateIO requests write rate of the disk volume per the disk offering
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingdisplaytextThe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnameName of the disk offering
displayvolumeAn optional field whether to the display the volume to the end User or not.
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathpath of the Domain the disk volume belongs to
encryptformatthe format of the disk encryption if applicable
externaluuidVolume UUID that is given by virtualisation provider (only for VMware)
hypervisorHypervisor the volume belongs to
isextractableTrue if the volume is extractable, false otherwise
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isonameThe name of the ISO attached to the Instance
kmskeyKMS key name of the volume
kmskeyidKMS key id of the volume
kmskeyversionVersion number of the KMS key used for disk encryption if applicable
maxiopsMax IOPS of the disk volume
miniopsMin IOPS of the disk volume
nameName of the disk volume
pathThe path of the volume
physicalsizeThe bytes actually consumed on disk
podidPod id of the volume
podnamePod name of the volume
projectThe project name of the VPN
projectidThe project id of the VPN
provisioningtypeProvisioning type used to create volumes.
quiescevmNeed quiesce Instance or not when taking Snapshot
serviceofferingdisplaytextThe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnameName of the service offering for root disk
sizeSize of the disk volume
snapshotidID of the Snapshot from which this volume was created
stateThe state of the disk volume
statusThe status of the volume
storageName of the primary storage hosting the disk volume
storageidID of the primary storage hosting the disk volume; returned to admin User only
storagetypeShared or local storage
supportsstoragesnapshotTrue if storage Snapshot is supported for the volume, false otherwise
templatedisplaytextAn alternate display text of the Template for the Instance
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
typeType of the disk volume (ROOT or DATADISK)
utilizationThe disk utilization
virtualmachineidID of the Instance
virtualsizeThe bytes allocated
vmdisplaynameDisplay name of the Instance
vmnameName of the Instance
vmstateState of the Instance
vmtypeType of the Instance
volumecheckresultdetails for the volume check result, they may vary for different hypervisors
volumerepairresultdetails for the volume repair result, they may vary for different hypervisors
zoneidID of the availability zone
zonenameName of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/authorizeSamlSso.html b/static/api/apidocs-4.23/apis/authorizeSamlSso.html new file mode 100644 index 0000000000..a2d540dbca --- /dev/null +++ b/static/api/apidocs-4.23/apis/authorizeSamlSso.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

authorizeSamlSso

+

Allow or disallow a user to use SAML SSO

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enableIf true, authorizes user to be able to use SAML for Single Sign. If False, disable user to user SAML SSO.true
useridUser uuidtrue
entityidThe Identity Provider ID the user is allowed to get single signed on fromfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/authorizeSecurityGroupEgress.html b/static/api/apidocs-4.23/apis/authorizeSecurityGroupEgress.html new file mode 100644 index 0000000000..660bbabab0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/authorizeSecurityGroupEgress.html @@ -0,0 +1,177 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

authorizeSecurityGroupEgress

+

Authorizes a particular egress rule for this security group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountAn optional account for the security group. Must be used with domainId.false
cidrlistThe CIDR list associated. Multiple entries must be separated by a single comma character (,).false
domainidAn optional domainId for the security group. If the account parameter is used, domainId must also be used.false
endportEnd port for this egress rulefalse
icmpcodeError code for this icmp messagefalse
icmptypeType of the ICMP message being sentfalse
projectidAn optional project of the security groupfalse
protocolTCP is default. UDP is the other supported protocolfalse
securitygroupidThe ID of the security group. Mutually exclusive with securityGroupName parameterfalse
securitygroupnameThe name of the security group. Mutually exclusive with securityGroupId parameterfalse
startportStart port for this egress rulefalse
usersecuritygrouplistUser to security group mappingfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/authorizeSecurityGroupIngress.html b/static/api/apidocs-4.23/apis/authorizeSecurityGroupIngress.html new file mode 100644 index 0000000000..5d84c920c0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/authorizeSecurityGroupIngress.html @@ -0,0 +1,177 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

authorizeSecurityGroupIngress

+

Authorizes a particular ingress rule for this security group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountAn optional account for the security group. Must be used with domainId.false
cidrlistThe cidr list associated. Multiple entries must be separated by a single comma character (,).false
domainidAn optional domainId for the security group. If the account parameter is used, domainId must also be used.false
endportEnd port for this ingress rulefalse
icmpcodeError code for this icmp messagefalse
icmptypeType of the icmp message being sentfalse
projectidAn optional project of the security groupfalse
protocolThe protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.false
securitygroupidThe ID of the security group. Mutually exclusive with securityGroupName parameterfalse
securitygroupnameThe name of the security group. Mutually exclusive with securityGroupId parameterfalse
startportStart port for this ingress rulefalse
usersecuritygrouplistUser to security group mappingfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/cancelHostAsDegraded.html b/static/api/apidocs-4.23/apis/cancelHostAsDegraded.html new file mode 100644 index 0000000000..4f2421d72e --- /dev/null +++ b/static/api/apidocs-4.23/apis/cancelHostAsDegraded.html @@ -0,0 +1,345 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

cancelHostAsDegraded

+

Cancel host status from 'Degraded'. Host will transit back to status 'Enabled'.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idHost IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the host
annotationThe last annotation set on this host by an admin
archCPU Arch of the host
capabilitiesCapabilities of the host
clusteridThe cluster ID of the host
clusternameThe cluster name of the host
clusterstorageaccessgroupscomma-separated list of storage access groups on the cluster
clustertypeThe cluster type of the cluster that host belongs to
cpuallocatedThe amount of the host's CPU currently allocated
cpuallocatedpercentageThe amount of the host's CPU currently allocated in percentage
cpuallocatedvalueThe amount of the host's CPU currently allocated in MHz
cpuallocatedwithoverprovisioningThe amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor
cpuloadaverageThe average CPU load on the host
cpunumberThe CPU number of the host
cpusocketsThe number of CPU sockets on the host
cpuspeedThe CPU speed of the host
cpuusedThe amount of the host's CPU currently used
cpuwithoverprovisioningThe amount of the host's CPU after applying the cpu.overprovisioning.factor
createdThe date and time the host was created
detailsHost details in key/value pairs.
disconnectedTrue if the host is disconnected. False otherwise.
disksizeallocatedThe host's currently allocated disk size
disksizetotalThe total disk size of the host
encryptionsupportedTrue if the host supports encryption
eventsEvents available for the host
explicithosttagscomma-separated list of explicit host tags for the host
extensionidThe ID of extension for this cluster
extensionnameThe name of extension for this cluster
gputotalTotal GPUs on the Host
gpuusedUsed GPUs on the Host
guestosrulethe guest OS rule
hahostTrue if the host is Ha host (dedicated to Instances started by HA process; false otherwise
hasenoughcapacityTrue if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise
hosthaThe host HA information information
hosttagsComma-separated list of tags for the host
hypervisorThe host hypervisor
hypervisorversionThe hypervisor version
implicithosttagscomma-separated list of implicit host tags for the host
instanceconversionsupportedtrue if the host supports instance conversion (using virt-v2v)
ipaddressThe IP address of the host
islocalstorageactiveTrue if local storage is active, false otherwise
istagaruleWhether the informed tag is a JS interpretable rule or not.
lastannotatedThe last time this host was annotated
lastpingedThe date and time the host was last pinged
managementserveridThe management server ID of the host
managementservernamethe management server name of the host
memoryallocatedThe amount of the host's memory currently allocated
memoryallocatedbytesThe amount of the host's memory currently allocated in bytes
memoryallocatedpercentageThe amount of the host's memory currently allocated in percentage
memorytotalThe memory total of the host, this parameter is deprecated use memorywithoverprovisioning
memoryusedThe amount of the host's memory currently used
memorywithoverprovisioningThe amount of the host's memory after applying the mem.overprovisioning.factor
msid(only for details=core) the msid of the host's management server
nameThe name of the host
networkkbsreadThe incoming Network traffic on the host
networkkbswriteThe outgoing Network traffic on the host
oscategoryidThe OS category ID of the host
oscategorynameThe OS category name of the host
outofbandmanagementThe host out-of-band management information
podidThe Pod ID of the host
podnameThe Pod name of the host
podstorageaccessgroupscomma-separated list of storage access groups on the pod
removedThe date and time the host was removed
resourcestateThe resource state of the host
stateThe state of the host
storageaccessgroupscomma-separated list of storage access groups for the host
suitableformigrationTrue if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise
typeThe host type
ueficapabilityTrue if the host has capability to support UEFI boot
usernameThe admin that annotated this host
versionThe host version
virtualmachineidthe virtual machine id for host type ConsoleProxy and SecondaryStorageVM
zoneidThe Zone ID of the host
zonenameThe Zone name of the host
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
gpugroup(*)GPU cards present in the host
gpugroupnameGPU cards present in the host
vgpu(*)The list of enabled vGPUs
maxcapacityMaximum vGPU can be created with this vGPU type on the given GPU group
maxheadsMaximum displays per user
maxresolutionxMaximum X resolution per display
maxresolutionyMaximum Y resolution per display
maxvgpuperpgpuMaximum no. of vGPU per GPU card (pgpu)
remainingcapacityRemaining capacity in terms of no. of more Instances that can be deployed with this vGPU type
vgputypeModel Name of vGPU
videoramVideo RAM for this vGPU type
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/cancelHostMaintenance.html b/static/api/apidocs-4.23/apis/cancelHostMaintenance.html new file mode 100644 index 0000000000..92f9e03e1b --- /dev/null +++ b/static/api/apidocs-4.23/apis/cancelHostMaintenance.html @@ -0,0 +1,345 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

cancelHostMaintenance

+

Cancels host maintenance.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe host IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the host
annotationThe last annotation set on this host by an admin
archCPU Arch of the host
capabilitiesCapabilities of the host
clusteridThe cluster ID of the host
clusternameThe cluster name of the host
clusterstorageaccessgroupscomma-separated list of storage access groups on the cluster
clustertypeThe cluster type of the cluster that host belongs to
cpuallocatedThe amount of the host's CPU currently allocated
cpuallocatedpercentageThe amount of the host's CPU currently allocated in percentage
cpuallocatedvalueThe amount of the host's CPU currently allocated in MHz
cpuallocatedwithoverprovisioningThe amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor
cpuloadaverageThe average CPU load on the host
cpunumberThe CPU number of the host
cpusocketsThe number of CPU sockets on the host
cpuspeedThe CPU speed of the host
cpuusedThe amount of the host's CPU currently used
cpuwithoverprovisioningThe amount of the host's CPU after applying the cpu.overprovisioning.factor
createdThe date and time the host was created
detailsHost details in key/value pairs.
disconnectedTrue if the host is disconnected. False otherwise.
disksizeallocatedThe host's currently allocated disk size
disksizetotalThe total disk size of the host
encryptionsupportedTrue if the host supports encryption
eventsEvents available for the host
explicithosttagscomma-separated list of explicit host tags for the host
extensionidThe ID of extension for this cluster
extensionnameThe name of extension for this cluster
gputotalTotal GPUs on the Host
gpuusedUsed GPUs on the Host
guestosrulethe guest OS rule
hahostTrue if the host is Ha host (dedicated to Instances started by HA process; false otherwise
hasenoughcapacityTrue if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise
hosthaThe host HA information information
hosttagsComma-separated list of tags for the host
hypervisorThe host hypervisor
hypervisorversionThe hypervisor version
implicithosttagscomma-separated list of implicit host tags for the host
instanceconversionsupportedtrue if the host supports instance conversion (using virt-v2v)
ipaddressThe IP address of the host
islocalstorageactiveTrue if local storage is active, false otherwise
istagaruleWhether the informed tag is a JS interpretable rule or not.
lastannotatedThe last time this host was annotated
lastpingedThe date and time the host was last pinged
managementserveridThe management server ID of the host
managementservernamethe management server name of the host
memoryallocatedThe amount of the host's memory currently allocated
memoryallocatedbytesThe amount of the host's memory currently allocated in bytes
memoryallocatedpercentageThe amount of the host's memory currently allocated in percentage
memorytotalThe memory total of the host, this parameter is deprecated use memorywithoverprovisioning
memoryusedThe amount of the host's memory currently used
memorywithoverprovisioningThe amount of the host's memory after applying the mem.overprovisioning.factor
msid(only for details=core) the msid of the host's management server
nameThe name of the host
networkkbsreadThe incoming Network traffic on the host
networkkbswriteThe outgoing Network traffic on the host
oscategoryidThe OS category ID of the host
oscategorynameThe OS category name of the host
outofbandmanagementThe host out-of-band management information
podidThe Pod ID of the host
podnameThe Pod name of the host
podstorageaccessgroupscomma-separated list of storage access groups on the pod
removedThe date and time the host was removed
resourcestateThe resource state of the host
stateThe state of the host
storageaccessgroupscomma-separated list of storage access groups for the host
suitableformigrationTrue if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise
typeThe host type
ueficapabilityTrue if the host has capability to support UEFI boot
usernameThe admin that annotated this host
versionThe host version
virtualmachineidthe virtual machine id for host type ConsoleProxy and SecondaryStorageVM
zoneidThe Zone ID of the host
zonenameThe Zone name of the host
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
gpugroup(*)GPU cards present in the host
gpugroupnameGPU cards present in the host
vgpu(*)The list of enabled vGPUs
maxcapacityMaximum vGPU can be created with this vGPU type on the given GPU group
maxheadsMaximum displays per user
maxresolutionxMaximum X resolution per display
maxresolutionyMaximum Y resolution per display
maxvgpuperpgpuMaximum no. of vGPU per GPU card (pgpu)
remainingcapacityRemaining capacity in terms of no. of more Instances that can be deployed with this vGPU type
vgputypeModel Name of vGPU
videoramVideo RAM for this vGPU type
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/cancelMaintenance.html b/static/api/apidocs-4.23/apis/cancelMaintenance.html new file mode 100644 index 0000000000..b5bb33bcfa --- /dev/null +++ b/static/api/apidocs-4.23/apis/cancelMaintenance.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

cancelMaintenance

+

Cancels maintenance of the management server

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
managementserveridThe UUID of the management servertrue
rebalanceRebalance agents (applicable for indirect agents, ensure the settings 'host' and 'indirect.agent.lb.algorithm' are properly configured) after cancelling maintenance, default is truefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
agentsThe host agents this management server is responsible for
agentscountThe number of host agents this management server is responsible for
maintenanceinitiatedIndicates whether maintenance has been initiated
managementserveridThe id of the management server
pendingjobscountThe number of jobs in progress
readyforshutdownIndicates whether CloudStack is ready to shutdown
shutdowntriggeredIndicates whether a shutdown has been triggered
statethe state of the management server
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/cancelShutdown.html b/static/api/apidocs-4.23/apis/cancelShutdown.html new file mode 100644 index 0000000000..1d3c58637e --- /dev/null +++ b/static/api/apidocs-4.23/apis/cancelShutdown.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

cancelShutdown

+

Cancels a triggered shutdown

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
managementserveridThe UUID of the management servertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
agentsThe host agents this management server is responsible for
agentscountThe number of host agents this management server is responsible for
maintenanceinitiatedIndicates whether maintenance has been initiated
managementserveridThe id of the management server
pendingjobscountThe number of jobs in progress
readyforshutdownIndicates whether CloudStack is ready to shutdown
shutdowntriggeredIndicates whether a shutdown has been triggered
statethe state of the management server
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/cancelStorageMaintenance.html b/static/api/apidocs-4.23/apis/cancelStorageMaintenance.html new file mode 100644 index 0000000000..8a5ae118ba --- /dev/null +++ b/static/api/apidocs-4.23/apis/cancelStorageMaintenance.html @@ -0,0 +1,186 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

cancelStorageMaintenance

+

Cancels maintenance for primary storage

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe primary storage IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the storage pool
allocatediopsTotal min IOPS currently in use by volumes
capacitybytesbytes CloudStack can provision from this storage pool
capacityiopsIOPS CloudStack can provision from this storage pool
clusteridThe ID of the cluster for the storage pool
clusternameThe name of the cluster for the storage pool
createdThe date and time the storage pool was created
detailsthe storage pool details
disksizeallocatedThe pool's currently allocated disk size
disksizetotalThe total disk size of the storage pool
disksizeusedThe pool's currently used disk size
hypervisorThe hypervisor type of the storage pool
ipaddressThe IP address of the storage pool
istagaruleWhether the informed tag is a JS interpretable rule or not.
managedwhether this pool is managed or not
nameThe name of the storage pool
nfsmountoptsthe nfs mount options for the storage pool
overprovisionfactorThe overprovisionfactor for the storage pool
pathThe storage pool path
podidThe Pod ID of the storage pool
podnameThe Pod name of the storage pool
providerStorage provider for this pool
scopeThe scope of the storage pool
stateThe state of the storage pool
storageaccessgroupsthe storage access groups for the storage pool
storagecapabilitiesThe storage pool capabilities
storagecustomstatsthe storage pool custom stats
suitableformigrationTrue if this pool is suitable to migrate a volume, false otherwise
tagsThe tags for the storage pool
typeThe storage pool type
usediopstotal IOPS currently in use
zoneidThe Zone ID of the storage pool
zonenameThe Zone name of the storage pool
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/changeBgpPeersForNetwork.html b/static/api/apidocs-4.23/apis/changeBgpPeersForNetwork.html new file mode 100644 index 0000000000..5932e94a65 --- /dev/null +++ b/static/api/apidocs-4.23/apis/changeBgpPeersForNetwork.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

changeBgpPeersForNetwork

+

Change the BGP peers for a network.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
networkidUUID of the network which the Bgp Peers are associated to.true
bgppeeridsIds of the Bgp Peer. If it is empty, all BGP peers will be unlinked.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idid of the bgp peer
accountthe account of the bgp peer
asnumberAS number of bgp peer
createddate when this bgp peer was created.
detailsadditional key/value details of the bgp peer
domainthe domain name of the bgp peer
domainidthe domain ID of the bgp peer
ip6addressIPv6 address of bgp peer
ipaddressIPv4 address of bgp peer
passwordpassword of bgp peer
projectthe project name of the bgp peer
projectidthe project id of the bgp peer
zoneidid of zone to which the bgp peer belongs to.
zonenamename of zone to which the bgp peer belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/changeBgpPeersForVpc.html b/static/api/apidocs-4.23/apis/changeBgpPeersForVpc.html new file mode 100644 index 0000000000..9b1efa768a --- /dev/null +++ b/static/api/apidocs-4.23/apis/changeBgpPeersForVpc.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

changeBgpPeersForVpc

+

Change the BGP peers for a VPC.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
vpcidUUID of the VPC which the Bgp Peers are associated to.true
bgppeeridsIds of the Bgp Peer. If it is empty, all BGP peers will be unlinked.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idid of the bgp peer
accountthe account of the bgp peer
asnumberAS number of bgp peer
createddate when this bgp peer was created.
detailsadditional key/value details of the bgp peer
domainthe domain name of the bgp peer
domainidthe domain ID of the bgp peer
ip6addressIPv6 address of bgp peer
ipaddressIPv4 address of bgp peer
passwordpassword of bgp peer
projectthe project name of the bgp peer
projectidthe project id of the bgp peer
zoneidid of zone to which the bgp peer belongs to.
zonenamename of zone to which the bgp peer belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/changeOfferingForVolume.html b/static/api/apidocs-4.23/apis/changeOfferingForVolume.html new file mode 100644 index 0000000000..8daf1870ff --- /dev/null +++ b/static/api/apidocs-4.23/apis/changeOfferingForVolume.html @@ -0,0 +1,321 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

changeOfferingForVolume

+

Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the volumetrue
diskofferingidNew disk offering IDtrue
automigrateFlag for automatic migration of the volume with new disk offering whenever migration is required to apply the offeringfalse
maxiopsNew maximum number of IOPS for the custom disk offeringfalse
miniopsNew minimum number of IOPS for the custom disk offeringfalse
shrinkokVerify OK to Shrinkfalse
sizeNew volume size in GB for the custom disk offeringfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the disk volume
accountThe Account associated with the disk volume
attachedThe date the volume was attached to an Instance
chaininfoThe chain info of the volume
clusteridCluster id of the volume
clusternameCluster name where the volume is allocated
createdThe date the disk volume was created
deleteprotectiontrue if volume has delete protection.
destroyedThe boolean state of whether the volume is destroyed or not
deviceidThe ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
diskBytesReadRateBytes read rate of the disk volume
diskBytesWriteRateBytes write rate of the disk volume
diskIopsReadRateIO requests read rate of the disk volume per the disk offering
diskIopsWriteRateIO requests write rate of the disk volume per the disk offering
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingdisplaytextThe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnameName of the disk offering
displayvolumeAn optional field whether to the display the volume to the end User or not.
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathpath of the Domain the disk volume belongs to
encryptformatthe format of the disk encryption if applicable
externaluuidVolume UUID that is given by virtualisation provider (only for VMware)
hypervisorHypervisor the volume belongs to
isextractableTrue if the volume is extractable, false otherwise
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isonameThe name of the ISO attached to the Instance
kmskeyKMS key name of the volume
kmskeyidKMS key id of the volume
kmskeyversionVersion number of the KMS key used for disk encryption if applicable
maxiopsMax IOPS of the disk volume
miniopsMin IOPS of the disk volume
nameName of the disk volume
pathThe path of the volume
physicalsizeThe bytes actually consumed on disk
podidPod id of the volume
podnamePod name of the volume
projectThe project name of the VPN
projectidThe project id of the VPN
provisioningtypeProvisioning type used to create volumes.
quiescevmNeed quiesce Instance or not when taking Snapshot
serviceofferingdisplaytextThe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnameName of the service offering for root disk
sizeSize of the disk volume
snapshotidID of the Snapshot from which this volume was created
stateThe state of the disk volume
statusThe status of the volume
storageName of the primary storage hosting the disk volume
storageidID of the primary storage hosting the disk volume; returned to admin User only
storagetypeShared or local storage
supportsstoragesnapshotTrue if storage Snapshot is supported for the volume, false otherwise
templatedisplaytextAn alternate display text of the Template for the Instance
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
typeType of the disk volume (ROOT or DATADISK)
utilizationThe disk utilization
virtualmachineidID of the Instance
virtualsizeThe bytes allocated
vmdisplaynameDisplay name of the Instance
vmnameName of the Instance
vmstateState of the Instance
vmtypeType of the Instance
volumecheckresultdetails for the volume check result, they may vary for different hypervisors
volumerepairresultdetails for the volume repair result, they may vary for different hypervisors
zoneidID of the availability zone
zonenameName of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/changeOutOfBandManagementPassword.html b/static/api/apidocs-4.23/apis/changeOutOfBandManagementPassword.html new file mode 100644 index 0000000000..a242b557b2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/changeOutOfBandManagementPassword.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

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

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
hostidThe ID of the hosttrue
passwordThe new host management interface password of maximum length 16, if none is provided a random password would be usedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
actionThe out-of-band management action (if issued)
addressThe out-of-band management interface address
descriptionThe operation result description
driverThe out-of-band management driver for the host
enabledTrue if out-of-band management is enabled for the host
hostidThe ID of the host
passwordThe out-of-band management interface password
portThe out-of-band management interface port
powerstateThe out-of-band management interface powerState of the host
statusThe operation result
usernameThe out-of-band management interface username
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/changeServiceForRouter.html b/static/api/apidocs-4.23/apis/changeServiceForRouter.html new file mode 100644 index 0000000000..0eca363eba --- /dev/null +++ b/static/api/apidocs-4.23/apis/changeServiceForRouter.html @@ -0,0 +1,363 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

changeServiceForRouter

+

Upgrades domain router to a new service offering

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the routertrue
serviceofferingidThe service offering ID to apply to the domain routertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the router
accountThe Account associated with the router
archCPU arch of the router
createdThe date and time the router was created
dns1The first DNS for the router
dns2The second DNS for the router
domainThe domain associated with the router
domainidThe domain ID associated with the router
domainpathpath of the Domain the router belongs to
gatewayThe gateway for the router
guestipaddressThe guest IP address for the router
guestmacaddressThe guest MAC address for the router
guestnetmaskThe guest netmask for the router
guestnetworkidThe ID of the corresponding guest Network
guestnetworknameThe name of the corresponding guest Network
healthchecksfailedTrue if any health checks had failed
hostcontrolstateThe control state of the host for the router
hostidThe host ID for the router
hostnameThe hostname for the router
hypervisorThe hypervisor on which the Template runs
ip6dns1The first IPv6 DNS for the router
ip6dns2The second IPv6 DNS for the router
isredundantrouterIf this router is an redundant virtual router
linklocalipThe Control IP address for the router
linklocalmacaddressThe link local MAC address for the router
linklocalnetmaskThe link local netmask for the router
linklocalnetworkidThe ID of the corresponding link local Network
nameThe name of the router
networkdomainThe Network domain for the router
podidThe Pod ID for the router
podnameThe Pod name for the router
projectThe project name of the address
projectidThe project id of the IP address
publicipThe public IP address for the router
publicmacaddressThe public MAC address for the router
publicnetmaskThe public netmask for the router
publicnetworkidThe ID of the corresponding public Network
redundantstateThe state of redundant virtual router
requiresupgradeTrue if the router Template requires upgrade
roleRole of the domain router
scriptsversionThe version of scripts
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
softwareversionThe version of the code / software in the router
stateThe state of the router
templateidThe Template ID for the router
templatenameThe Template name for the router
versionThe version of Template
vpcidVPC the router belongs to
vpcnameThe name of VPC the router belongs to
zoneidThe Zone ID for the router
zonenameThe Zone name for the router
healthcheckresults(*)Last executed health check result for the router
checknameThe name of the health check on the router
checktypeThe type of the health check - basic or advanced
detailsDetailed response generated on running health check
lastupdatedThe date this VPC was created
statusthe result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}
successThe result of the health check if available
nic(*)The list of NICs associated with the router
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/changeServiceForSystemVm.html b/static/api/apidocs-4.23/apis/changeServiceForSystemVm.html new file mode 100644 index 0000000000..062a81fe79 --- /dev/null +++ b/static/api/apidocs-4.23/apis/changeServiceForSystemVm.html @@ -0,0 +1,204 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

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.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the System VMtrue
serviceofferingidThe service offering ID to apply to the System VMtrue
detailsName value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=valuefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the System VM
activeviewersessionsThe number of active console sessions for the console proxy System VM
agentstateThe agent state of the System VM
archCPU arch of the system VM
createdThe date and time the System VM was created
disconnectedThe last disconnected date of host
dns1The first DNS for the System VM
dns2The second DNS for the System VM
gatewayThe gateway for the System VM
guestvlanGuest VLAN range
hostcontrolstateThe control state of the host for the System VM
hostidThe host ID for the System VM
hostnameThe hostname for the System VM
hypervisorThe hypervisor on which the Template runs
isdynamicallyscalableTrue if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
linklocalipThe Control IP address for the System VM
linklocalmacaddressThe link local MAC address for the System VM
linklocalnetmaskThe link local netmask for the System VM
nameThe name of the System VM
networkdomainThe Network domain for the System VM
podidThe Pod ID for the System VM
podnameThe Pod name for the System VM
privateipThe private IP address for the System VM
privatemacaddressThe private MAC address for the System VM
privatenetmaskThe private netmask for the System VM
publicipThe public IP address for the System VM
publicmacaddressThe public MAC address for the System VM
publicnetmaskThe public netmask for the System VM
publicvlanPublic VLAN range
serviceofferingidthe ID of the service offering of the system virtual machine.
serviceofferingnamethe name of the service offering of the system virtual machine.
stateThe state of the System VM
storageipthe ip address for the system VM on the storage network
systemvmtypeThe System VM type
templateidThe Template ID for the System VM
templatenameThe Template name for the System VM
versionThe systemvm agent version
zoneidThe Zone ID for the System VM
zonenameThe Zone name for the System VM
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/changeServiceForVirtualMachine.html b/static/api/apidocs-4.23/apis/changeServiceForVirtualMachine.html new file mode 100644 index 0000000000..d1ece1cca5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/changeServiceForVirtualMachine.html @@ -0,0 +1,714 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

changeServiceForVirtualMachine

+

(This API is deprecated, use scaleVirtualMachine API)Changes the service offering for an Instance. The Instance must be in a "Stopped" state for this command to take effect.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instancetrue
serviceofferingidThe service offering ID to apply to the Instancetrue
automigrateFlag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offeringfalse
detailsName value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=valuefalse
maxiopsNew maximum number of IOPS for the custom disk offeringfalse
miniopsNew minimum number of IOPS for the custom disk offeringfalse
shrinkokVerify OK to Shrinkfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/changeSharedFileSystemDiskOffering.html b/static/api/apidocs-4.23/apis/changeSharedFileSystemDiskOffering.html new file mode 100644 index 0000000000..2ec3d358d1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/changeSharedFileSystemDiskOffering.html @@ -0,0 +1,312 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

changeSharedFileSystemDiskOffering

+

Change Disk offering of a Shared FileSystem

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the shared filesystemtrue
diskofferingidthe disk offering to use for the underlying storagefalse
maxiopsmax iopsfalse
miniopsmin iopsfalse
sizethe size of the shared filesystem in GiBfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the shared filesystem
accountthe account associated with the shared filesystem
descriptiondescription of the shared filesystem
diskioreadthe read (IO) of disk on the shared filesystem
diskiowritethe write (IO) of disk on the shared filesystem
diskkbsreadthe shared filesystem's disk read in KiB
diskkbswritethe shared filesystem's disk write in KiB
diskofferingdisplaytextdisk offering display text for the shared filesystem
diskofferingiddisk offering ID for the shared filesystem
diskofferingnamedisk offering for the shared filesystem
domainthe domain associated with the shared filesystem
domainidthe ID of the domain associated with the shared filesystem
domainpathpath of the domain to which the shared filesystem
filesystemthe filesystem format
iscustomdiskofferingdisk offering for the shared filesystem has custom size
namename of the shared filesystem
networkidNetwork ID of the shared filesystem
networknameNetwork name of the shared filesystem
pathpath to mount the shared filesystem
physicalsizethe bytes actually consumed on disk
projectthe project name of the shared filesystem
projectidthe project ID of the shared filesystem
providerthe shared filesystem provider
provisioningtypeprovisioning type used in the shared filesystem
serviceofferingidservice offering ID for the shared filesystem
serviceofferingnameservice offering for the shared filesystem
sizesize of the shared filesystem
sizegbsize of the shared filesystem in GiB
statethe state of the shared filesystem
storagename of the storage pool hosting the data volume
storageidID of the storage pool hosting the data volume
utilizationthe disk utilization
virtualmachineidID of the storage fs vm
virtualsizethe bytes allocated
vmstateID of the storage fs vm
volumeidID of the storage fs data volume
volumenamename of the storage fs data volume
zoneidID of the availability zone
zonenameName of the availability zone
nic(*)the list of nics associated with the shared filesystem
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/changeSharedFileSystemServiceOffering.html b/static/api/apidocs-4.23/apis/changeSharedFileSystemServiceOffering.html new file mode 100644 index 0000000000..228982cbbd --- /dev/null +++ b/static/api/apidocs-4.23/apis/changeSharedFileSystemServiceOffering.html @@ -0,0 +1,303 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

changeSharedFileSystemServiceOffering

+

Change Service offering of a Shared FileSystem

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the shared filesystemtrue
serviceofferingidthe offering to use for the shared filesystem instancetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the shared filesystem
accountthe account associated with the shared filesystem
descriptiondescription of the shared filesystem
diskioreadthe read (IO) of disk on the shared filesystem
diskiowritethe write (IO) of disk on the shared filesystem
diskkbsreadthe shared filesystem's disk read in KiB
diskkbswritethe shared filesystem's disk write in KiB
diskofferingdisplaytextdisk offering display text for the shared filesystem
diskofferingiddisk offering ID for the shared filesystem
diskofferingnamedisk offering for the shared filesystem
domainthe domain associated with the shared filesystem
domainidthe ID of the domain associated with the shared filesystem
domainpathpath of the domain to which the shared filesystem
filesystemthe filesystem format
iscustomdiskofferingdisk offering for the shared filesystem has custom size
namename of the shared filesystem
networkidNetwork ID of the shared filesystem
networknameNetwork name of the shared filesystem
pathpath to mount the shared filesystem
physicalsizethe bytes actually consumed on disk
projectthe project name of the shared filesystem
projectidthe project ID of the shared filesystem
providerthe shared filesystem provider
provisioningtypeprovisioning type used in the shared filesystem
serviceofferingidservice offering ID for the shared filesystem
serviceofferingnameservice offering for the shared filesystem
sizesize of the shared filesystem
sizegbsize of the shared filesystem in GiB
statethe state of the shared filesystem
storagename of the storage pool hosting the data volume
storageidID of the storage pool hosting the data volume
utilizationthe disk utilization
virtualmachineidID of the storage fs vm
virtualsizethe bytes allocated
vmstateID of the storage fs vm
volumeidID of the storage fs data volume
volumenamename of the storage fs data volume
zoneidID of the availability zone
zonenameName of the availability zone
nic(*)the list of nics associated with the shared filesystem
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/changeStoragePoolScope.html b/static/api/apidocs-4.23/apis/changeStoragePoolScope.html new file mode 100644 index 0000000000..9300ad20f6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/changeStoragePoolScope.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

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.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe Id of the storage pooltrue
scopethe scope of the storage: cluster or zonetrue
clusteridthe Id of the cluster to use if scope is being set to Clusterfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/checkVolume.html b/static/api/apidocs-4.23/apis/checkVolume.html new file mode 100644 index 0000000000..e19a0c5c23 --- /dev/null +++ b/static/api/apidocs-4.23/apis/checkVolume.html @@ -0,0 +1,306 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

checkVolume

+

Check the volume for any errors or leaks and also repairs when repair parameter is passed, this is currently supported for KVM only

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the volumetrue
repairparameter to repair the volume, leaks or all are the possible valuesfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the disk volume
accountThe Account associated with the disk volume
attachedThe date the volume was attached to an Instance
chaininfoThe chain info of the volume
clusteridCluster id of the volume
clusternameCluster name where the volume is allocated
createdThe date the disk volume was created
deleteprotectiontrue if volume has delete protection.
destroyedThe boolean state of whether the volume is destroyed or not
deviceidThe ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
diskBytesReadRateBytes read rate of the disk volume
diskBytesWriteRateBytes write rate of the disk volume
diskIopsReadRateIO requests read rate of the disk volume per the disk offering
diskIopsWriteRateIO requests write rate of the disk volume per the disk offering
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingdisplaytextThe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnameName of the disk offering
displayvolumeAn optional field whether to the display the volume to the end User or not.
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathpath of the Domain the disk volume belongs to
encryptformatthe format of the disk encryption if applicable
externaluuidVolume UUID that is given by virtualisation provider (only for VMware)
hypervisorHypervisor the volume belongs to
isextractableTrue if the volume is extractable, false otherwise
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isonameThe name of the ISO attached to the Instance
kmskeyKMS key name of the volume
kmskeyidKMS key id of the volume
kmskeyversionVersion number of the KMS key used for disk encryption if applicable
maxiopsMax IOPS of the disk volume
miniopsMin IOPS of the disk volume
nameName of the disk volume
pathThe path of the volume
physicalsizeThe bytes actually consumed on disk
podidPod id of the volume
podnamePod name of the volume
projectThe project name of the VPN
projectidThe project id of the VPN
provisioningtypeProvisioning type used to create volumes.
quiescevmNeed quiesce Instance or not when taking Snapshot
serviceofferingdisplaytextThe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnameName of the service offering for root disk
sizeSize of the disk volume
snapshotidID of the Snapshot from which this volume was created
stateThe state of the disk volume
statusThe status of the volume
storageName of the primary storage hosting the disk volume
storageidID of the primary storage hosting the disk volume; returned to admin User only
storagetypeShared or local storage
supportsstoragesnapshotTrue if storage Snapshot is supported for the volume, false otherwise
templatedisplaytextAn alternate display text of the Template for the Instance
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
typeType of the disk volume (ROOT or DATADISK)
utilizationThe disk utilization
virtualmachineidID of the Instance
virtualsizeThe bytes allocated
vmdisplaynameDisplay name of the Instance
vmnameName of the Instance
vmstateState of the Instance
vmtypeType of the Instance
volumecheckresultdetails for the volume check result, they may vary for different hypervisors
volumerepairresultdetails for the volume repair result, they may vary for different hypervisors
zoneidID of the availability zone
zonenameName of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/cleanVMReservations.html b/static/api/apidocs-4.23/apis/cleanVMReservations.html new file mode 100644 index 0000000000..c665e2404f --- /dev/null +++ b/static/api/apidocs-4.23/apis/cleanVMReservations.html @@ -0,0 +1,84 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

cleanVMReservations

+

Cleanups Instance reservations in the database.

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/cloneBackupOffering.html b/static/api/apidocs-4.23/apis/cloneBackupOffering.html new file mode 100644 index 0000000000..e32424f343 --- /dev/null +++ b/static/api/apidocs-4.23/apis/cloneBackupOffering.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

cloneBackupOffering

+

Clones a backup offering from an existing offering

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name of the cloned offeringtrue
sourceofferingidThe ID of the source backup offering to clone fromtrue
allowuserdrivenbackupsWhether users are allowed to create adhoc backups and backup schedulesfalse
descriptionThe description of the cloned offeringfalse
domainidthe ID of the containing domain(s) as comma separated string, public for public offeringsfalse
externalidThe backup offering ID (from backup provider side)false
zoneidThe zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the backup offering
allowuserdrivenbackupsWhether the offering allows User driven ad-hoc/scheduled backups
backupofferingdetailsDetails for the backup offering
createdThe date this backup offering was created
crosszoneinstancecreationthe backups with this offering can be used to create Instances on all Zones
descriptionDescription for the backup offering
domainthe domain name(s) this backup offering belongs to.
domainidthe domain ID(s) this backup offering belongs to.
externalidExternal ID on the provider side
nameName for the backup offering
providerprovider name
zoneidZone ID
zonenameZone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/cloneDiskOffering.html b/static/api/apidocs-4.23/apis/cloneDiskOffering.html new file mode 100644 index 0000000000..f274b2142c --- /dev/null +++ b/static/api/apidocs-4.23/apis/cloneDiskOffering.html @@ -0,0 +1,285 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

cloneDiskOffering

+

Clones a disk offering. All parameters from createDiskOffering are available. If not specified, values will be copied from the source offering.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of the disk offeringtrue
sourceofferingidThe ID of the source disk offering to clone fromtrue
bytesreadrateBytes read rate of the disk offeringfalse
bytesreadratemaxBurst bytes read rate of the disk offeringfalse
bytesreadratemaxlengthLength (in seconds) of the burstfalse
byteswriterateBytes write rate of the disk offeringfalse
byteswriteratemaxBurst bytes write rate of the disk offeringfalse
byteswriteratemaxlengthLength (in seconds) of the burstfalse
cachemodeThe cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache modefalse
customizedWhether disk offering size is custom or notfalse
customizediopsWhether disk offering IOPS is custom or notfalse
detailsDetails to specify disk offering parametersfalse
disksizeSize of the disk offering in GB (1GB = 1,073,741,824 bytes)false
disksizestrictnessTo allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowedfalse
displayofferingAn optional field, whether to display the offering to the end user or not.false
displaytextAn alternate display text of the disk offering, defaults to 'name'.false
domainidThe ID of the containing domain(s), null for public offeringsfalse
encryptVolumes using this offering should be encryptedfalse
hypervisorsnapshotreserveHypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)false
iopsreadrateI/O requests read rate of the disk offeringfalse
iopsreadratemaxBurst requests read rate of the disk offeringfalse
iopsreadratemaxlengthLength (in seconds) of the burstfalse
iopswriterateI/O requests write rate of the disk offeringfalse
iopswriteratemaxBurst I/O requests write rate of the disk offeringfalse
iopswriteratemaxlengthLength (in seconds) of the burstfalse
maxiopsMax IOPS of the disk offeringfalse
miniopsMin IOPS of the disk offeringfalse
provisioningtypeProvisioning type used to create volumes. Valid values are thin, sparse, fat.false
storagepolicyName of the storage policy defined at vCenter, this is applicable only for VMwarefalse
storagetypeThe storage type of the disk offering. Values are local and shared.false
tagsTags for the disk offeringfalse
zoneidThe ID of the containing zone(s), null for public offeringsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idUnique ID of the disk offering
cacheModeThe cache mode to use for this disk offering. none, writeback or writethrough
createdThe date this disk offering was created
detailsAdditional key/value details tied with this disk offering
diskBytesReadRateBytes read rate of the disk offering
diskBytesReadRateMaxBurst bytes read rate of the disk offering
diskBytesReadRateMaxLengthLength (in seconds) of the burst
diskBytesWriteRateBytes write rate of the disk offering
diskBytesWriteRateMaxBurst bytes write rate of the disk offering
diskBytesWriteRateMaxLengthLength (in seconds) of the burst
diskIopsReadRateI/O requests read rate of the disk offering
diskIopsReadRateMaxBurst io requests read rate of the disk offering
diskIopsReadRateMaxLengthLength (in second) of the burst
diskIopsWriteRateI/O requests write rate of the disk offering
diskIopsWriteRateMaxBurst io requests write rate of the disk offering
diskIopsWriteRateMaxLengthLength (in seconds) of the burst
disksizeThe size of the disk offering in GB
disksizestrictnessTo allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed
displayofferingWhether to display the offering to the end user or not.
displaytextAn alternate display text of the disk offering.
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
encryptWhether disks using this offering will be encrypted on primary storage
hypervisorsnapshotreserveHypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
iscustomizedTrue if disk offering uses custom size, false otherwise
iscustomizediopsTrue if disk offering uses custom IOPS, false otherwise
maxiopsThe max IOPS of the disk offering
miniopsThe min IOPS of the disk offering
nameThe name of the disk offering
provisioningtypeProvisioning type used to create volumes. Valid values are thin, sparse, fat.
statestate of the disk offering
storagetypeThe storage type for this disk offering
suitableforvirtualmachineReturns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false
tagsThe tags for the disk offering
vspherestoragepolicyThe vsphere storage policy tagged to the disk offering in case of VMware
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/cloneNetworkOffering.html b/static/api/apidocs-4.23/apis/cloneNetworkOffering.html new file mode 100644 index 0000000000..24601054bd --- /dev/null +++ b/static/api/apidocs-4.23/apis/cloneNetworkOffering.html @@ -0,0 +1,324 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

cloneNetworkOffering

+

Clones a network offering. All parameters are copied from the source offering unless explicitly overridden. Use 'addServices' and 'dropServices' to modify the service list without respecifying everything.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name of the network offeringtrue
sourceofferingidThe ID of the source network offering to clone fromtrue
addservicesServices to add to the cloned offering (in addition to source offering services). If specified along with 'supportedservices', this parameter is ignored.false
availabilityThe 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
conservemodeTrue if the network offering is IP conserve mode enabledfalse
detailsNetwork 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/portgroupfalse
displaytextThe display text of the network offering, defaults to the value of 'name'.false
domainidThe ID of the containing domain(s), null for public offeringsfalse
dropservicesServices to remove from the cloned offering (that exist in source offering). If specified along with 'supportedservices', this parameter is ignored.false
egressdefaultpolicyTrue if guest network default egress policy is allow; false if default egress policy is denyfalse
enableSet to true if the offering is to be enabled during creation. Default is falsefalse
fornsxtrue if network offering is meant to be used for NSX, false otherwise.false
fortungstenTrue if network offering is meant to be used for Tungsten-Fabric, false otherwise.false
forvpcTrue if network offering is meant to be used for VPC, false otherwise.false
guestiptypeGuest type of the network offering: Shared or Isolatedfalse
internetprotocolThe internet protocol of network offering. Options are IPv4 and dualstack. Default is IPv4. dualstack will create a network offering that supports both IPv4 and IPv6false
ispersistentTrue if network offering supports persistent networks; defaulted to false if not specifiedfalse
keepaliveenabledIf 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
maxconnectionsMaximum number of concurrent connections supported by the Network offeringfalse
networkmodeIndicates the mode with which the network will operate. Valid option: NATTED or ROUTEDfalse
networkrateData transfer rate in megabits per second allowedfalse
nsxsupportlbTrue if network offering for NSX network offering supports Load balancer service.false
nsxsupportsinternallbTrue if network offering for NSX network offering supports Internal Load balancer service.false
providerName of the provider providing the servicefalse
routingmodethe routing mode for the network offering. Supported types are: Static or Dynamic.false
servicecapabilitylistDesired service capabilities as part of network offeringfalse
serviceofferingidThe service offering ID used by virtual router providerfalse
serviceproviderlistProvider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical networkfalse
specifyasnumbertrue if network offering supports choosing AS numberfalse
specifyiprangesTrue if network offering supports specifying ip ranges; defaulted to false if not specifiedfalse
specifyvlanTrue if network offering supports VLANsfalse
supportedservicesServices supported by the network offeringfalse
tagsThe tags for the network offering.false
traffictypeThe traffic type for the network offering. Supported type in current release is GUEST onlyfalse
zoneidThe ID of the containing zone(s), null for public offeringsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Network offering
availabilityAvailability of the Network offering
conservemodeTrue if Network offering is IP conserve mode enabled
createdThe date this Network offering was created
detailsAdditional key/value details tied with network offering
displaytextAn alternate display text of the Network offering.
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
egressdefaultpolicyTrue if guest network default egress policy is allow; false if default egress policy is deny
fornsxtrue if network offering can be used by NSX networks only
fortungstenTrue if Network offering can be used by Tungsten-Fabric Networks only
forvpcTrue if Network offering can be used by VPC Networks only
guestiptypeGuest type of the Network offering, can be Shared or Isolated
internetprotocolThe internet protocol of the network offering
isdefaultTrue if Network offering is default, false otherwise
ispersistentTrue if Network offering supports persistent networks, false otherwise
maxconnectionsMaximum number of concurrent connections to be handled by LB
nameThe name of the Network offering
networkmodeMode in which the network will operate. The valid values are NATTED and ROUTED
networkrateData transfer rate in megabits per second allowed.
routingmodethe routing mode for the network offering, supported types are Static or Dynamic.
serviceofferingidThe ID of the service offering used by virtual router provider
specifyasnumbertrue if network offering supports choosing AS numbers
specifyiprangesTrue if Network offering supports specifying IP ranges, false otherwise
specifyvlanTrue if Network offering supports VLANs, false otherwise
stateState of the Network offering. Can be Disabled/Enabled/Inactive
supportsinternallbtrue if network offering supports public access for guest networks
supportspublicaccessTrue if network offering supports public access for guest networks
supportsstrechedl2subnetTrue if network offering supports network that span multiple zones
tagsThe tags for the Network offering
traffictypeThe traffic type for the Network offering, supported types are Public, Management, Control, Guest, VLAN or Storage.
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
service(*)The list of supported services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/cloneServiceOffering.html b/static/api/apidocs-4.23/apis/cloneServiceOffering.html new file mode 100644 index 0000000000..a15064414c --- /dev/null +++ b/static/api/apidocs-4.23/apis/cloneServiceOffering.html @@ -0,0 +1,436 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

cloneServiceOffering

+

Clones a service offering. All parameters from createServiceOffering are available. If not specified, values will be copied from the source offering.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name of the service offeringtrue
sourceofferingidThe ID of the source service offering to clone fromtrue
bytesreadrateBytes read rate of the disk offeringfalse
bytesreadratemaxBurst bytes read rate of the disk offeringfalse
bytesreadratemaxlengthLength (in seconds) of the burstfalse
byteswriterateBytes write rate of the disk offeringfalse
byteswriteratemaxBurst bytes write rate of the disk offeringfalse
byteswriteratemaxlengthLength (in seconds) of the burstfalse
cachemodeThe cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache modefalse
cpunumberThe CPU number of the service offeringfalse
cpuspeedFor 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 Instance 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 Instances. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.false
customizedWhether service offering size is custom or notfalse
customizediopsWhether compute offering iops is custom or notfalse
deploymentplannerThe deployment planner heuristics used to deploy an Instance of this offering. If null, value of global config vm.deployment.planner is usedfalse
diskofferingidThe ID of the disk offering to which service offering should be mappedfalse
diskofferingstrictnessTrue/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 deployedfalse
displaytextThe display text of the service offering, defaults to 'name'.false
domainidThe ID of the containing domain(s), null for public offeringsfalse
dynamicscalingenabledTrue if Instance needs to be dynamically scalable of cpu or memoryfalse
encryptrootVMs using this offering require root volume encryptionfalse
externaldetailsDetails in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvaluefalse
gpucountCount of GPUs to be used with this service offering. This is applicable only when passed with vGPU profile.false
gpudisplayWhether to enable GPU display for this service offering. This is applicable only when passed with vGPU profile. Defaults to false.false
hosttagsThe host tag for this service offering.false
hypervisorsnapshotreserveHypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)false
iopsreadrateI/O requests read rate of the disk offeringfalse
iopsreadratemaxBurst requests read rate of the disk offeringfalse
iopsreadratemaxlengthLength (in seconds) of the burstfalse
iopswriterateI/O requests write rate of the disk offeringfalse
iopswriteratemaxBurst io requests write rate of the disk offeringfalse
iopswriteratemaxlengthLength (in seconds) of the burstfalse
issystemIs this a system vm offeringfalse
isvolatileTrue if the Instance needs to be volatile so that on every reboot, the original root disk is detached, then destroyed and a fresh root disk is created and attached to the Instancefalse
leasedurationNumber of days instance is leased for.false
leaseexpiryactionLease expiry action, valid values are STOP and DESTROYfalse
limitcpuuseRestrict the CPU usage to committed service offeringfalse
maxcpunumberThe maximum number of CPUs to be set with Custom Computer Offeringfalse
maxiopsMax iops of the compute offeringfalse
maxmemoryThe maximum memory size of the custom service offering in MBfalse
memoryThe total memory of the service offering in MBfalse
mincpunumberThe minimum number of CPUs to be set with Custom Computer Offeringfalse
miniopsMin iops of the compute offeringfalse
minmemoryThe minimum memory size of the custom service offering in MBfalse
networkrateData transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having "domainrouter" systemvmtypefalse
offerhaThe HA for the service offeringfalse
provisioningtypeProvisioning type used to create volumes. Valid values are thin, sparse, fat.false
purgeresourcesWhether to cleanup instance and its associated resource from database upon expunge of the instancefalse
rootdisksizeThe Root disk size in GB.false
serviceofferingdetailsDetails for planner, used to store specific parametersfalse
storagepolicyName of the storage policy defined at vCenter, this is applicable only for VMwarefalse
storagetypeThe storage type of the service offering. Values are local and shared.false
systemvmtypeThe system VM type. Possible types are "domainrouter", "consoleproxy" and "secondarystoragevm".false
tagsThe tags for this service offering.false
vgpuprofileidthe ID of the vGPU profile to which service offering should be mappedfalse
zoneidThe ID of the containing zone(s), null for public offeringsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the service offering
cacheModeThe cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default
cpunumberThe number of CPU
cpuspeedThe clock rate CPU speed in Mhz
createdThe date this service offering was created
defaultuseIs this a default System VM offering
deploymentplannerDeployment strategy used to deploy Instance.
diskBytesReadRateBytes read rate of the service offering
diskBytesReadRateMaxBurst bytes read rate of the disk offering
diskBytesReadRateMaxLengthLength (in seconds) of the burst
diskBytesWriteRateBytes write rate of the service offering
diskBytesWriteRateMaxBurst bytes write rate of the disk offering
diskBytesWriteRateMaxLengthLength (in seconds) of the burst
diskIopsReadRateI/O requests read rate of the service offering
diskIopsReadRateMaxBurst io requests read rate of the disk offering
diskIopsReadRateMaxLengthLength (in second) of the burst
diskIopsWriteRateI/O requests write rate of the service offering
diskIopsWriteRateMaxBurst I/O requests write rate of the disk offering
diskIopsWriteRateMaxLengthLength (in seconds) of the burst
diskofferingdisplaytextThe display text of the disk offering
diskofferingidThe ID of the disk offering to which service offering is linked
diskofferingnameName of the disk offering
diskofferingstrictnessTrue/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 Instance is deployed and change disk offering is not allowed for the ROOT disk after the Instance is deployed
displaytextAn alternate display text of the service offering.
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
dynamicscalingenabledTrue if Instance needs to be dynamically scalable of CPU or memory
encryptrootTrue if Instance root disk will be encrypted on storage
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs to attach
gpudisplaywhether GPU device is used for display or not
hosttagsThe host tag for the service offering
hypervisorsnapshotreserveHypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
iscustomizedIs true if the offering is customized
iscustomizediopsTrue if disk offering uses custom IOPS, false otherwise
issystemIs this a System VM offering
isvolatileTrue if the Instance needs to be volatile, i.e., on every reboot of Instance from API root disk is discarded and creates a new root disk
leasedurationInstance lease duration (in days) for service offering
leaseexpiryactionAction to be taken once lease is over
limitcpuuseRestrict the CPU usage to committed service offering
maxheadsthe maximum number of display heads
maxiopsThe max IOPS of the disk offering
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory in MB
miniopsThe min IOPS of the disk offering
nameThe name of the service offering
networkrateData transfer rate in megabits per second allowed.
offerhaThe HA support in the service offering
provisioningtypeProvisioning type used to create volumes. Valid values are thin, sparse, fat.
purgeresourcesWhether to cleanup VM and its associated resource upon expunge
rootdisksizeRoot disk size in GB
serviceofferingdetailsAdditional key/value details tied with this service offering
stateState of the service offering
storagetagsThe tags for the service offering
storagetypeThe storage type for this service offering
systemvmtypeIs this a the System VM type for System VM offering
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vspherestoragepolicyThe vsphere storage policy tagged to the service offering in case of VMware
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/cloneVPCOffering.html b/static/api/apidocs-4.23/apis/cloneVPCOffering.html new file mode 100644 index 0000000000..ea3cf2bab1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/cloneVPCOffering.html @@ -0,0 +1,234 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

cloneVPCOffering

+

Clones an existing VPC offering. All parameters are copied from the source offering unless explicitly overridden. Use 'addServices' and 'dropServices' to modify the service list without respecifying everything.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name of the VPC offeringtrue
sourceofferingidThe ID of the source VPC offering to clone fromtrue
addservicesServices to add to the cloned offering (in addition to source offering services). If specified along with 'supportedservices', this parameter is ignored.false
conservemodeTrue if the VPC offering is IP conserve mode enabled, allowing public IPs to be used across multiple VPC tiers. Default value is falsefalse
displaytextThe display text of the VPC offering, defaults to the 'name'false
domainidThe ID of the containing domain(s), null for public offeringsfalse
dropservicesServices to remove from the cloned offering (that exist in source offering). If specified along with 'supportedservices', this parameter is ignored.false
enableSet to true if the offering is to be enabled during creation. Default is falsefalse
fornsxtrue if network offering is meant to be used for NSX, false otherwise.false
internetprotocolThe internet protocol of the offering. Options are IPv4 and dualstack. Default is IPv4. dualstack will create an offering that supports both IPv4 and IPv6false
networkmodeIndicates the mode with which the network will operate. Valid option: NATTED or ROUTEDfalse
nsxsupportlbtrue if network offering for NSX VPC offering supports Load balancer service.false
providerName of the provider providing the servicefalse
routingmodethe routing mode for the VPC offering. Supported types are: Static or Dynamic.false
servicecapabilitylistDesired service capabilities as part of VPC offeringfalse
serviceofferingidThe ID of the service offering for the VPC router appliancefalse
serviceproviderlistProvider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical networkfalse
specifyasnumbertrue if the VPC offering supports choosing AS numberfalse
supportedservicesServices supported by the VPC offeringfalse
zoneidThe ID of the containing zone(s), null for public offeringsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the VPC offering
conservemodeTrue if the VPC offering is IP conserve mode enabled, allowing public IP services to be used across multiple VPC tiers.
createdThe date this VPC offering was created
displaytextAn alternate display text of the VPC offering.
distributedvpcrouterIndicates if the VPC offering supports distributed router for one-hop forwarding
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
fornsxTrue if VPC offering can be used by NSX networks only
internetprotocolThe internet protocol of the VPC offering
isdefaultTrue if VPC offering is default, false otherwise
nameThe name of the VPC offering
networkmodeMode in which the network will operate. The valid values are NATTED and ROUTED
routingmodeThe routing mode for the network offering, supported types are Static or Dynamic.
specifyasnumberTrue if network offering supports choosing AS numbers
stateState of the VPC offering. Can be Disabled/Enabled
supportsregionLevelvpcIndicated if the offering can support region level VPC
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
service(*)The list of supported services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/cloudianIsEnabled.html b/static/api/apidocs-4.23/apis/cloudianIsEnabled.html new file mode 100644 index 0000000000..1edee3d4b2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/cloudianIsEnabled.html @@ -0,0 +1,84 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

cloudianIsEnabled

+

Checks if the Cloudian Connector is enabled

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
enabledThe Cloudian connector enabled state
urlThe Cloudian Management Console base URL
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/cloudianSsoLogin.html b/static/api/apidocs-4.23/apis/cloudianSsoLogin.html new file mode 100644 index 0000000000..bcb168e7a0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/cloudianSsoLogin.html @@ -0,0 +1,81 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

cloudianSsoLogin

+

Generates single-sign-on login url for logged-in CloudStack user to access the Cloudian Management Console

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
urlThe SSO redirect URL
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/configTungstenFabricService.html b/static/api/apidocs-4.23/apis/configTungstenFabricService.html new file mode 100644 index 0000000000..f34fc5daf3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/configTungstenFabricService.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

configTungstenFabricService

+

Config Tungsten-Fabric service

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
physicalnetworkidThe ID of physical networktrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/configureHAForHost.html b/static/api/apidocs-4.23/apis/configureHAForHost.html new file mode 100644 index 0000000000..f5d3d7f3c4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/configureHAForHost.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

configureHAForHost

+

Configures HA for a host

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
hostidID of the hosttrue
providerHA providertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
haenableIf host HA is enabled for the host
haproviderThe host HA provider
hastateThe HA state of the host
hostidThe ID of the host
statusOperation status
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/configureInternalLoadBalancerElement.html b/static/api/apidocs-4.23/apis/configureInternalLoadBalancerElement.html new file mode 100644 index 0000000000..2c42193a75 --- /dev/null +++ b/static/api/apidocs-4.23/apis/configureInternalLoadBalancerElement.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

configureInternalLoadBalancerElement

+

Configures an Internal Load Balancer element.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the internal lb providertrue
enabledEnables/Disables the Internal Load Balancer elementtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
idThe ID of the internal Load balancer element
enabledEnabled/Disabled the element
nspidThe physical Network service provider ID of the element
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/configureNetscalerLoadBalancer.html b/static/api/apidocs-4.23/apis/configureNetscalerLoadBalancer.html new file mode 100644 index 0000000000..1be27f9b3a --- /dev/null +++ b/static/api/apidocs-4.23/apis/configureNetscalerLoadBalancer.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

configureNetscalerLoadBalancer

+

Configures a netscaler load balancer device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
lbdeviceidNetscaler load balancer device IDtrue
inlineTrue if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewallfalse
lbdevicecapacityCapacity of the device, Capacity will be interpreted as number of networks device can handlefalse
lbdevicededicatedTrue if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accountsfalse
podidsUsed 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
gslbproviderTrue if NetScaler device is provisioned to be a GSLB service provider
gslbproviderprivateipPrivate IP of the NetScaler representing GSLB site
gslbproviderpublicipPublic IP of the NetScaler representing GSLB site
ipaddressThe management IP address of the external load balancer
isexclusivegslbproviderTrue if NetScaler device is provisioned exclusively to be a GSLB service provider
lbdevicecapacityDevice capacity
lbdevicededicatedTrue if device is dedicated for an account
lbdeviceidDevice ID of the netscaler load balancer
lbdevicenameDevice name
lbdevicestateDevice state
physicalnetworkidThe physical Network to which this netscaler device belongs to
podidsUsed 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.
privateinterfaceThe private interface of the load balancer
providerName of the provider
publicinterfaceThe public interface of the load balancer
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/configureOutOfBandManagement.html b/static/api/apidocs-4.23/apis/configureOutOfBandManagement.html new file mode 100644 index 0000000000..25799b90b1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/configureOutOfBandManagement.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

configureOutOfBandManagement

+

Configures a host's out-of-band management interface

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
addressThe host management interface IP addresstrue
driverThe host management interface driver, for example: ipmitooltrue
hostidThe ID of the hosttrue
passwordThe host management interface passwordtrue
portThe host management interface porttrue
usernameThe host management interface usertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
actionThe out-of-band management action (if issued)
addressThe out-of-band management interface address
descriptionThe operation result description
driverThe out-of-band management driver for the host
enabledTrue if out-of-band management is enabled for the host
hostidThe ID of the host
passwordThe out-of-band management interface password
portThe out-of-band management interface port
powerstateThe out-of-band management interface powerState of the host
statusThe operation result
usernameThe out-of-band management interface username
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/configureOvsElement.html b/static/api/apidocs-4.23/apis/configureOvsElement.html new file mode 100644 index 0000000000..89fa6e618c --- /dev/null +++ b/static/api/apidocs-4.23/apis/configureOvsElement.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

configureOvsElement

+

Configures an ovs element.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the ovs providertrue
enabledEnabled/Disabled the service providertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the ovs
accountThe Account associated with the provider
domainThe domain associated with the provider
domainidThe domain ID associated with the provider
domainpathPath of the domain to which the provider belongs
enabledEnabled/Disabled the service provider
nspidThe physical Network service provider id of the provider
projectThe project name of the address
projectidThe project ID of the IP address
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/configurePaloAltoFirewall.html b/static/api/apidocs-4.23/apis/configurePaloAltoFirewall.html new file mode 100644 index 0000000000..5b44d43420 --- /dev/null +++ b/static/api/apidocs-4.23/apis/configurePaloAltoFirewall.html @@ -0,0 +1,132 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

configurePaloAltoFirewall

+

Configures a Palo Alto firewall device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
fwdeviceidPalo Alto firewall device IDtrue
fwdevicecapacityCapacity of the firewall device, Capacity will be interpreted as number of networks device can handlefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
fwdevicecapacityDevice capacity
fwdeviceidDevice ID of the Palo Alto firewall
fwdevicenameDevice name
fwdevicestateDevice state
ipaddressThe management IP address of the external firewall
numretriesThe number of times to retry requests to the external firewall
physicalnetworkidThe physical Network to which this Palo Alto firewall belongs to
privateinterfaceThe private interface of the external firewall
privatezoneThe private security zone of the external firewall
providerName of the provider
publicinterfaceThe public interface of the external firewall
publiczoneThe public security zone of the external firewall
timeoutThe timeout (in seconds) for requests to the external firewall
usageinterfaceThe usage interface of the external firewall
usernameThe username that's used to log in to the external firewall
zoneidThe zone ID of the external firewall
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/configureStorageAccess.html b/static/api/apidocs-4.23/apis/configureStorageAccess.html new file mode 100644 index 0000000000..c62c654dce --- /dev/null +++ b/static/api/apidocs-4.23/apis/configureStorageAccess.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

configureStorageAccess

+

Configure the storage access groups on zone/pod/cluster/host and storage, accordingly connections to the storage pools

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
clusteridUUID of the clusterfalse
hostidUUID of the hostfalse
podidUUID of the podfalse
storageaccessgroupscomma separated list of storage access groups for connecting the storage pools and the hostsfalse
storageidUUID of the Storage Poolfalse
zoneidUUID of the zonefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/configureVirtualRouterElement.html b/static/api/apidocs-4.23/apis/configureVirtualRouterElement.html new file mode 100644 index 0000000000..2282ced8c0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/configureVirtualRouterElement.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

configureVirtualRouterElement

+

Configures a virtual router element.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the virtual router providertrue
enabledEnabled/Disabled the service providertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the router
accountThe Account associated with the provider
domainThe domain associated with the provider
domainidThe domain ID associated with the provider
domainpathPath of the domain to which the provider belongs
enabledEnabled/Disabled the service provider
nspidThe physical Network service provider ID of the provider
projectThe project name of the address
projectidThe project ID of the IP address
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/copyIso.html b/static/api/apidocs-4.23/apis/copyIso.html new file mode 100644 index 0000000000..640f352a8f --- /dev/null +++ b/static/api/apidocs-4.23/apis/copyIso.html @@ -0,0 +1,261 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

copyIso

+

Copies an ISO from one zone to another.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idTemplate ID.true
destzoneidID of the zone the Template is being copied to.false
destzoneidsA 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
sourcezoneidID 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe Account name to which the Template belongs
accountidThe Account id to which the Template belongs
archCPU Arch of the template
bitsThe processor bit size
bootableTrue if the ISO is bootable, false otherwise
checksumChecksum of the Template
childtemplatesIf root disk Template, then IDs of the datas disk Templates this Template owns
createdThe date this Template was created
crossZonesTrue if the Template is managed across all Zones, false otherwise
deployasisVMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is Template
detailsAdditional key/value details tied with Template
directdownloadKVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextThe Template display text
domainThe name of the domain to which the Template belongs
domainidThe ID of the domain to which the Template belongs
domainpathPath of the Domain the template belongs to
downloaddetailsLists the download progress of a Template across all secondary storages
extensionidThe ID of extension linked to this template
extensionnameThe name of extension linked to this template
forcksIf true it indicates that the template can be used for CKS cluster deployments
formatThe format of the Template.
hostidThe ID of the secondary storage host for the Template
hostnameThe name of the secondary storage host for the Template
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
isextractableTrue if the Template is extractable, false otherwise
isfeaturedTrue if this Template is a featured Template, false otherwise
ispublicTrue if this Template is a public Template, false otherwise
isreadyTrue if the Template is ready to be deployed from, false otherwise.
nameThe Template name
ostypeidThe ID of the OS type for this Template.
ostypenameThe name of the OS type for this Template.
parenttemplateidIf Datadisk Template, then id of the root disk Template this Template belongs to
passwordenabledTrue if the reset password feature is enabled, false otherwise
physicalsizeThe physical size of the Template
projectThe project name of the Template
projectidThe project ID of the Template
removedThe date this Template was removed
requireshvmTrue if Template requires HVM enabled, false otherwise
sizeThe size of the Template
sourcetemplateidThe Template ID of the parent Template if present
sshkeyenabledTrue if Template is sshkey enabled, false otherwise
statusThe status of the Template
templatetagThe tag of this Template
templatetypeThe type of the Template
urlThe URL which the Template/ISO is registered from
userdataidThe id of userdata linked to this Template
userdatanameThe name of userdata linked to this Template
userdataparamsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
zoneidThe ID of the zone for this Template
zonenameThe name of the zone for this Template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/copySnapshot.html b/static/api/apidocs-4.23/apis/copySnapshot.html new file mode 100644 index 0000000000..b536175d17 --- /dev/null +++ b/static/api/apidocs-4.23/apis/copySnapshot.html @@ -0,0 +1,201 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

copySnapshot

+

Copies a snapshot from one zone to another.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the snapshot.true
destzoneidThe ID of the zone the snapshot is being copied to.false
destzoneidsA 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
sourcezoneidThe 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
storageidsA comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present. Currently supported for StorPool onlyfalse
usestoragereplicationEnables the snapshot to be copied to the supported primary storages when the config 'use.storage.replication' is set to true for the storage or globally. This is supported only for StorPool storage for now.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the Snapshot
accountThe Account associated with the Snapshot
chainsizechain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true
createdThe date the Snapshot was created
datastoreidID of the datastore for the snapshot entry
datastorenamename of the datastore for the snapshot entry
datastorestatestate of the snapshot on the datastore
datastoretypetype of the datastore for the snapshot entry
domainThe domain name of the Snapshot's Account
domainidThe domain ID of the Snapshot's Account
domainpathpath of the Domain the snapshot's account belongs to
downloaddetailsdownload progress of a snapshot
intervaltypeValid types are hourly, daily, weekly, monthy, Template, and none.
locationtypeValid location types are primary and secondary.
nameName of the Snapshot
osdisplaynameDisplay name of the os on volume
ostypeidID of the os on volume
parentThe parent ID of the Snapshot
parentnameThe parent name of the Snapshot
physicalsizePhysical size of backed up Snapshot on image store
projectThe project name of the Snapshot
projectidThe project id of the Snapshot
revertableIndicates whether the underlying storage supports reverting the volume to this Snapshot
snapshottypeThe type of the Snapshot
stateThe 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
statusthe status of the template
virtualsizeVirtual size of backedup Snapshot on image store
volumeidID of the disk volume
volumenameName of the disk volume
volumestatestate of the disk volume
volumetypeType of the disk volume
zoneidID of the availability zone
zonenamename of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/copyTemplate.html b/static/api/apidocs-4.23/apis/copyTemplate.html new file mode 100644 index 0000000000..be42627816 --- /dev/null +++ b/static/api/apidocs-4.23/apis/copyTemplate.html @@ -0,0 +1,261 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

copyTemplate

+

Copies a Template from one zone to another.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idTemplate ID.true
destzoneidID of the zone the Template is being copied to.false
destzoneidsA 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
sourcezoneidID 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe Account name to which the Template belongs
accountidThe Account id to which the Template belongs
archCPU Arch of the template
bitsThe processor bit size
bootableTrue if the ISO is bootable, false otherwise
checksumChecksum of the Template
childtemplatesIf root disk Template, then IDs of the datas disk Templates this Template owns
createdThe date this Template was created
crossZonesTrue if the Template is managed across all Zones, false otherwise
deployasisVMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is Template
detailsAdditional key/value details tied with Template
directdownloadKVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextThe Template display text
domainThe name of the domain to which the Template belongs
domainidThe ID of the domain to which the Template belongs
domainpathPath of the Domain the template belongs to
downloaddetailsLists the download progress of a Template across all secondary storages
extensionidThe ID of extension linked to this template
extensionnameThe name of extension linked to this template
forcksIf true it indicates that the template can be used for CKS cluster deployments
formatThe format of the Template.
hostidThe ID of the secondary storage host for the Template
hostnameThe name of the secondary storage host for the Template
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
isextractableTrue if the Template is extractable, false otherwise
isfeaturedTrue if this Template is a featured Template, false otherwise
ispublicTrue if this Template is a public Template, false otherwise
isreadyTrue if the Template is ready to be deployed from, false otherwise.
nameThe Template name
ostypeidThe ID of the OS type for this Template.
ostypenameThe name of the OS type for this Template.
parenttemplateidIf Datadisk Template, then id of the root disk Template this Template belongs to
passwordenabledTrue if the reset password feature is enabled, false otherwise
physicalsizeThe physical size of the Template
projectThe project name of the Template
projectidThe project ID of the Template
removedThe date this Template was removed
requireshvmTrue if Template requires HVM enabled, false otherwise
sizeThe size of the Template
sourcetemplateidThe Template ID of the parent Template if present
sshkeyenabledTrue if Template is sshkey enabled, false otherwise
statusThe status of the Template
templatetagThe tag of this Template
templatetypeThe type of the Template
urlThe URL which the Template/ISO is registered from
userdataidThe id of userdata linked to this Template
userdatanameThe name of userdata linked to this Template
userdataparamsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
zoneidThe ID of the zone for this Template
zonenameThe name of the zone for this Template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createASNRange.html b/static/api/apidocs-4.23/apis/createASNRange.html new file mode 100644 index 0000000000..39f288b916 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createASNRange.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createASNRange

+

Creates a range of Autonomous Systems for BGP Dynamic Routing

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
endasnthe end AS Numbertrue
startasnthe start AS Numbertrue
zoneidthe zone IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the AS Number Range
createdCreated date
endasnEnd AS Number
startasnStart AS Number
zoneidZone ID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createAccount.html b/static/api/apidocs-4.23/apis/createAccount.html new file mode 100644 index 0000000000..810445e636 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createAccount.html @@ -0,0 +1,423 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createAccount

+

Creates an account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
emailE-mailtrue
firstnameFirst nametrue
lastnameLast nametrue
passwordClear 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
usernameUnique username.true
accountName 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
accountdetailsDetails for Account used to store specific parametersfalse
accountidAccount UUID, required for adding Account from external provisioning systemfalse
accounttypeType of the account. Specify 0 for user, 1 for root admin, and 2 for domain adminfalse
domainidCreates the user under the specified domain.false
networkdomainNetwork domain for the Account's Networksfalse
roleidCreates the account under the specified role.false
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.false
useridUser UUID, required for adding Account from external provisioning systemfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Account
accountdetailsDetails for the account
accounttypeAccount type (admin, domain-admin, user)
apikeyaccesswhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
backupavailablethe total number of backups available to this account
backuplimitthe total number of backups which can be stored by this account
backupstorageavailablethe total backup storage space (in GiB) available to the account
backupstoragelimitthe total backup storage space (in GiB) the account can own
backupstoragetotalthe total backup storage space (in GiB) owned by the account
backuptotalthe total number of backups stored by this account
bucketavailablethe total number of buckets available to this account
bucketlimitthe total number of buckets which can be stored by this account
buckettotalthe total number of buckets stored by this account
cpuavailableThe total number of CPU cores available to be created for this account
cpulimitThe total number of CPU cores the account can own
cputotalThe total number of CPU cores owned by account
createdThe date when this account was created
defaultzoneidThe default zone of the Account
domainName of the Domain the Account belongs to
domainidID of the Domain the Account belongs to
domainpathPath of the Domain the Account belongs to
gpuavailablethe total number of gpus available to be created for this account
gpulimitthe total number of gpus the account can own
gputotalthe total number of gpus owned by account
groupsThe list of ACL groups that account belongs to
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this Account to acquire
iplimitThe total number of public IP addresses this Account can acquire
iptotalThe total number of public IP addresses allocated for this Account
iscleanuprequiredTrue if the account requires cleanup
isdefaultTrue if account is default, false otherwise
memoryavailableThe total memory (in MB) available to be created for this account
memorylimitThe total memory (in MB) the account can own
memorytotalThe total memory (in MB) owned by account
nameThe name of the Account
networkavailableThe total number of Networks available to be created for this Account
networkdomainThe Network domain
networklimitThe total number of Networks the Account can own
networktotalThe total number of Networks owned by Account
objectstorageavailablethe total object storage space (in GiB) available to the account
objectstoragelimitthe total object storage space (in GiB) the account can own
objectstoragetotalthe total object storage space (in GiB) owned by the account
primarystorageavailableThe total primary storage space (in GiB) available to be used for this account
primarystoragelimitThe total primary storage space (in GiB) the account can own
primarystoragetotalThe total primary storage space (in GiB) owned by account
projectavailableThe total number of projects available for administration by this Account
projectlimitThe total number of projects the Account can own
projecttotalThe total number of projects being administrated by this Account
receivedbytesThe total number of Network traffic bytes received
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role (Admin, ResourceAdmin, DomainAdmin, User)
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this account
secondarystoragelimitThe total secondary storage space (in GiB) the account can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by account
sentbytesThe total number of Network traffic bytes sent
snapshotavailableThe total number of Snapshots available for this Account
snapshotlimitThe total number of Snapshots which can be stored by this Account
snapshottotalThe total number of Snapshots stored by this Account
stateThe state of the account
taggedresourcesThe tagged resource limit and count for the account
templateavailableThe total number of Templates available to be created by this Account
templatelimitThe total number of Templates which can be created by this Account
templatetotalThe total number of Templates which have been created by this Account
vmavailableThe total number of Instances available for this Account to acquire
vmlimitThe total number of Instances that can be deployed by this Account
vmrunningThe total number of Instances running for this Account
vmstoppedThe total number of Instances stopped for this Account
vmtotalThe total number of Instances deployed by this Account
volumeavailableThe total volume available for this Account
volumelimitThe total volume which can be used by this Account
volumetotalThe total volume being used by this Account
vpcavailableThe total number of VPCs available to be created for this account
vpclimitThe total number of VPCs the Account can own
vpctotalThe total number of VPCs owned by account
user(*)The list of users associated with account
idThe user ID
accountThe Account name of the user
accountidThe Account ID of the user
accounttypeThe Account type of the user
apikeyThe API key of the user
apikeyaccessWhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
createdThe date and time the user Account was created
domainThe domain name of the user
domainidThe domain ID of the user
emailThe user email address
firstnameThe user firstname
iconBase64 string representation of the resource icon
is2faenabledTrue if user has two factor authentication enabled
is2famandatedTrue if user has two factor authentication is mandated
iscallerchilddomainThe boolean value representing if the updating target is in caller's child domain
isdefaultTrue if user is default, false otherwise
lastnameThe user lastname
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role
secretkeyThe secret key of the user
stateThe user state
timezoneThe timezone user was created in
usernameThe user name
usersourceThe source type of the user in lowercase, such as native, ldap, saml2
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createAffinityGroup.html b/static/api/apidocs-4.23/apis/createAffinityGroup.html new file mode 100644 index 0000000000..760e52508a --- /dev/null +++ b/static/api/apidocs-4.23/apis/createAffinityGroup.html @@ -0,0 +1,132 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createAffinityGroup

+

Creates an affinity/anti-affinity group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of the affinity grouptrue
typeType of the affinity group from the available affinity/anti-affinity group typestrue
accountAn account for the affinity group. Must be used with domainId.false
descriptionOptional description of the affinity groupfalse
domainidDomainId of the account owning the affinity groupfalse
projectidCreate affinity group for projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createAutoScalePolicy.html b/static/api/apidocs-4.23/apis/createAutoScalePolicy.html new file mode 100644 index 0000000000..989425697c --- /dev/null +++ b/static/api/apidocs-4.23/apis/createAutoScalePolicy.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

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 Instance group.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
actionThe action to be executed if all the conditions evaluate to true for the specified duration.true
conditionidsThe list of IDs of the conditions that are being evaluated on every intervaltrue
durationThe duration in which the conditions have to be true before action is takentrue
nameThe name of the autoscale policyfalse
quiettimeThe cool down period in which the policy should not be evaluated after the action has been takenfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe autoscale policy ID
accountThe Account owning the autoscale policy
actionThe action to be executed if all the conditions evaluate to true for the specified duration.
conditionsThe list of IDs of the conditions that are being evaluated on every interval
domainThe domain name of the autoscale policy
domainidThe domain ID of the autoscale policy
domainpathpath of the domain to which the autoscale policy belongs
durationThe duration for which the conditions have to be true before action is taken
nameName of the autoscale policy
projectThe project name of the autoscale policy
projectidThe project id autoscale policy
quiettimeThe cool down period for which the policy should not be evaluated after the action has been taken
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createAutoScaleVmGroup.html b/static/api/apidocs-4.23/apis/createAutoScaleVmGroup.html new file mode 100644 index 0000000000..1f5e2d66e8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createAutoScaleVmGroup.html @@ -0,0 +1,183 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createAutoScaleVmGroup

+

Creates and automatically starts an Instance based on a service offering, disk offering, and Template.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
lbruleidThe ID of the load balancer ruletrue
maxmembersThe maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.true
minmembersThe minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.true
scaledownpolicyidsList of scaledown autoscale policiestrue
scaleuppolicyidsList of scaleup autoscale policiestrue
vmprofileidThe autoscale profile that contains information about the Instances in the Instance group.true
fordisplayAn optional field, whether to the display the group to the end user or notfalse
intervalThe frequency in which the performance counters to be collectedfalse
nameThe name of the autoscale Instance Groupfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe autoscale Instance group ID
accountThe Account owning the Instance group
associatednetworkidThe id of the guest Network the LB rule belongs to
associatednetworknameThe name of the guest Network the LB rule belongs to
availablevirtualmachinecountThe number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group
createdThe date when this Instance group was created
domainThe domain name of the Instance group
domainidThe domain ID of the Instance group
domainpathpath of the domain to which the vm group belongs
fordisplayIs group for display to the regular User
intervalThe frequency at which the conditions have to be evaluated
lbproviderThe LB provider of the guest Network the LB rule belongs to
lbruleidThe Load balancer rule ID
maxmembersThe maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.
minmembersThe minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.
nameThe name of the autoscale Instance group
privateportThe private port
projectThe project name of the Instance group
projectidThe project id of the Instance group
publicipThe public IP address
publicipidThe public IP address ID
publicportThe public port
scaledownpoliciesList of scaledown autoscale policies
scaleuppoliciesList of scaleup autoscale policies
stateThe current state of the AutoScale Instance Group
vmprofileidThe autoscale profile that contains information about the Instances in the Instance group.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createAutoScaleVmProfile.html b/static/api/apidocs-4.23/apis/createAutoScaleVmProfile.html new file mode 100644 index 0000000000..1d15201fcf --- /dev/null +++ b/static/api/apidocs-4.23/apis/createAutoScaleVmProfile.html @@ -0,0 +1,179 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createAutoScaleVmProfile

+

Creates a profile that contains information about the Instance which will be provisioned automatically by autoscale feature.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
serviceofferingidThe service offering of the auto deployed Instancetrue
templateidThe Template of the auto deployed Instancetrue
zoneidAvailability zone for the auto deployed Instancetrue
accountAccount that will own the autoscale Instance profilefalse
autoscaleuseridThe ID of the user used to launch and destroy the Instancesfalse
counterparamcounterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161false
domainidDomain ID of the Account owning an autoscale Instance profilefalse
expungevmgraceperiodThe time allowed for existing connections to get closed before an Instance is expungedfalse
fordisplayAn optional field, whether to the display the profile to the end user or notfalse
otherdeployparamsParameters other than zoneId/serviceOfferringId/templateId of the auto deployed Instance. +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
projectidAn optional project for the autoscale Instance profilefalse
userdataAn optional binary data that can be sent to the Instance 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 valuefalse
userdatadetailsused to specify the parameters values for the variables in userdata.false
userdataidthe ID of the Userdatafalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe autoscale Instance profile ID
accountThe Account owning the Instance group
autoscaleuseridThe ID of the User used to launch and destroy the Instances
domainThe domain name of the Instance profile
domainidThe domain ID of the Instance profile
domainpathpath of the domain to which the vm profile belongs
expungevmgraceperiodThe time allowed for existing connections to get closed before an Instance is destroyed
fordisplayIs profile for display to the regular User
otherdeployparamsParameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance
projectThe project name of the Instance profile
projectidThe project id Instance profile
serviceofferingidThe service offering to be used while deploying an Instance
templateidThe Template to be used while deploying an Instance
userdataBase64 encoded Instance user data
userdatadetailslist of variables and values for the variables declared in userdata
userdataidthe id of userdata used for the VM
userdatanamethe name of userdata used for the VM
userdatapolicythe userdata override policy with the userdata provided while deploying VM
zoneidThe availability zone to be used while deploying an Instance
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createBackup.html b/static/api/apidocs-4.23/apis/createBackup.html new file mode 100644 index 0000000000..52cb33f2b7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createBackup.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createBackup

+

Create Instance backup

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidID of the Instancetrue
descriptionthe description for the backupfalse
isolatedWhether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.false
namethe name of the backupfalse
quiescevmQuiesce the instance before checkpointing the disks for backup. Applicable only to NAS and KBOSS backup providers. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createBackupOffering.html b/static/api/apidocs-4.23/apis/createBackupOffering.html new file mode 100644 index 0000000000..ecce7e824e --- /dev/null +++ b/static/api/apidocs-4.23/apis/createBackupOffering.html @@ -0,0 +1,153 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createBackupOffering

+

Creates a backup offering

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
allowuserdrivenbackupsWhether users are allowed to create ad-hoc backups and backup schedules when using this offering.true
descriptionThe description of the backup offeringtrue
nameBackup offering name.true
zoneidRestrict the backup offering to the Zone identified by this ID.true
allowextractfileWhether files may be extracted from backups or not.false
allowquickrestoreWhether quick restore is enabled for the backups or not.false
backupchainsizeBackup chain size for backups created with this offering.false
compressWhether the backups should be compressed or not.false
compressionlibraryCompression library, for offerings that support compression. Accepted values are zstd and zlib. By default, zstd is used for images that support it. If the image only supports zlib, it will be used regardless of this parameter.false
domainidRestrict the backup offering to the Domains identified by these IDs.false
validateWhether the backups should be validated or not.false
validationstepsWhich validation steps should be performed. Accepts a comma-separated list of steps. Accepted values are: wait_for_boot, screenshot and execute_command.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the backup offering
allowuserdrivenbackupsWhether the offering allows User driven ad-hoc/scheduled backups
backupofferingdetailsDetails for the backup offering
createdThe date this backup offering was created
crosszoneinstancecreationthe backups with this offering can be used to create Instances on all Zones
descriptionDescription for the backup offering
domainthe domain name(s) this backup offering belongs to.
domainidthe domain ID(s) this backup offering belongs to.
externalidExternal ID on the provider side
nameName for the backup offering
providerprovider name
zoneidZone ID
zonenameZone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createBackupSchedule.html b/static/api/apidocs-4.23/apis/createBackupSchedule.html new file mode 100644 index 0000000000..896042cfd0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createBackupSchedule.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createBackupSchedule

+

Creates a User-defined Instance backup schedule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
intervaltypeValid values are HOURLY, DAILY, WEEKLY, and MONTHLYtrue
scheduleCustom 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
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.true
virtualmachineidID of the Instance for which schedule is to be definedtrue
isolatedWhether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.false
maxbackupsThe maximum number of backups to keep for a VM. If "0", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.false
quiescevmQuiesce the Instance before checkpointing the disks for backup. Applicable only to NAS and KBOSS backup providers. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the backup schedule.
intervaltypeThe interval type of the backup schedule
isolatedWhether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.
maxbackupsmaximum number of backups retained
quiescevmquiesce the instance before checkpointing the disks for backup
scheduleThe time the backup is scheduled to be taken.
timezoneThe time zone of the backup schedule
virtualmachineidID of the Instance
virtualmachinenameName of the Instance
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createBgpPeer.html b/static/api/apidocs-4.23/apis/createBgpPeer.html new file mode 100644 index 0000000000..6c74d868b6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createBgpPeer.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createBgpPeer

+

Creates a Bgp Peer for a zone.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
asnumberThe AS number of the Bgp Peer.true
zoneidUUID of the zone which the Bgp Peer belongs to.true
accountaccount who will own the Bgp Peerfalse
detailsBGP peer details in key/value pairs.false
domainiddomain ID of the account owning the Bgp Peerfalse
ip6addressThe IPv6 address of the Bgp Peer.false
ipaddressThe IPv4 address of the Bgp Peer.false
passwordThe password of the Bgp Peer.false
projectidproject who will own the Bgp Peerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idid of the bgp peer
accountthe account of the bgp peer
asnumberAS number of bgp peer
createddate when this bgp peer was created.
detailsadditional key/value details of the bgp peer
domainthe domain name of the bgp peer
domainidthe domain ID of the bgp peer
ip6addressIPv6 address of bgp peer
ipaddressIPv4 address of bgp peer
passwordpassword of bgp peer
projectthe project name of the bgp peer
projectidthe project id of the bgp peer
zoneidid of zone to which the bgp peer belongs to.
zonenamename of zone to which the bgp peer belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createBucket.html b/static/api/apidocs-4.23/apis/createBucket.html new file mode 100644 index 0000000000..641d6b4252 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createBucket.html @@ -0,0 +1,174 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createBucket

+

Creates a bucket in the specified object storage pool.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
namethe name of the buckettrue
objectstorageidId of the Object Storage Pool where bucket is createdtrue
quotaBucket Quota in GiBtrue
accountthe account associated with the bucket. Must be used with the domainId parameter.false
domainidthe domain ID associated with the bucket. If used with the account parameter returns the bucket associated with the account for the specified domain.false
encryptionEnable bucket encryptionfalse
objectlockingEnable object locking in bucketfalse
policyThe Bucket access policyfalse
projectidthe project associated with the bucket. Mutually exclusive with account parameterfalse
versioningEnable bucket versioningfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the Bucket
accesskeyBucket Access Key
accountthe account associated with the Bucket
createdthe date the Bucket was created
domainthe domain associated with the bucket
domainidthe ID of the domain associated with the bucket
domainpathpath of the domain to which the bucket belongs
encryptionBucket Encryption
namename of the Bucket
objectlockingBucket Object Locking
objectstorageidid of the object storage hosting the Bucket; returned to admin user only
objectstoreName of the object storage hosting the Bucket; returned to admin user only
policyBucket Access Policy
projectthe project name of the bucket
projectidthe project id of the bucket
providerObject storage provider
quotaBucket Quota in GiB
sizeTotal size of objects in Bucket
stateState of the Bucket
urlBucket URL
usersecretkeyBucket Secret Key
versioningBucket Versioning
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createCondition.html b/static/api/apidocs-4.23/apis/createCondition.html new file mode 100644 index 0000000000..4fca98b21b --- /dev/null +++ b/static/api/apidocs-4.23/apis/createCondition.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createCondition

+

Creates a condition for Instance auto scaling

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
counteridID of the Counter.true
relationaloperatorRelational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.true
thresholdValue for which the Counter will be evaluated with the Operator selected.true
accountThe account of the condition. Must be used with the domainId parameter.false
domainidThe domain ID of the account.false
projectidAn optional project for conditionfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Condition
accountThe owner of the Condition.
counterDetails of the Counter.
counteridThe ID of the Counter.
counternameThe Name of the Counter.
domainThe domain name of the owner.
domainidThe domain ID of the Condition owner
domainpathpath of the domain to which the Condition owner belongs
projectThe project name of the Condition
projectidThe project ID of the Condition.
relationaloperatorRelational Operator to be used with threshold.
thresholdThreshold Value for the counter.
zoneidZone ID of counter
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createConsoleEndpoint.html b/static/api/apidocs-4.23/apis/createConsoleEndpoint.html new file mode 100644 index 0000000000..cf6c975982 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createConsoleEndpoint.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createConsoleEndpoint

+

Create a console endpoint to connect to a Instance console

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidID of the Instancetrue
token(optional) extra security token, valid when the extra validation is enabledfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
detailsDetails in case of an error
successTrue if the console endpoint is generated properly
urlThe console url
websocketThe console websocket options
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createCounter.html b/static/api/apidocs-4.23/apis/createCounter.html new file mode 100644 index 0000000000..2f53e74235 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createCounter.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createCounter

+

Adds metric counter for Instance auto scaling

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of the counter.true
providerNetwork provider of the counter.true
sourceSource of the counter.true
valueValue of the counter e.g. oid in case of snmp.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Counter
nameName of the counter.
providerProvider of the counter.
sourceSource of the counter.
valueValue in case of snmp or other specific counters.
zoneidZone ID of counter
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createDiskOffering.html b/static/api/apidocs-4.23/apis/createDiskOffering.html new file mode 100644 index 0000000000..be1d843d29 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createDiskOffering.html @@ -0,0 +1,282 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createDiskOffering

+

Creates a disk offering.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of the disk offeringtrue
bytesreadrateBytes read rate of the disk offeringfalse
bytesreadratemaxBurst bytes read rate of the disk offeringfalse
bytesreadratemaxlengthLength (in seconds) of the burstfalse
byteswriterateBytes write rate of the disk offeringfalse
byteswriteratemaxBurst bytes write rate of the disk offeringfalse
byteswriteratemaxlengthLength (in seconds) of the burstfalse
cachemodeThe cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache modefalse
customizedWhether disk offering size is custom or notfalse
customizediopsWhether disk offering IOPS is custom or notfalse
detailsDetails to specify disk offering parametersfalse
disksizeSize of the disk offering in GB (1GB = 1,073,741,824 bytes)false
disksizestrictnessTo allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowedfalse
displayofferingAn optional field, whether to display the offering to the end user or not.false
displaytextAn alternate display text of the disk offering, defaults to 'name'.false
domainidThe ID of the containing domain(s), null for public offeringsfalse
encryptVolumes using this offering should be encryptedfalse
hypervisorsnapshotreserveHypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)false
iopsreadrateI/O requests read rate of the disk offeringfalse
iopsreadratemaxBurst requests read rate of the disk offeringfalse
iopsreadratemaxlengthLength (in seconds) of the burstfalse
iopswriterateI/O requests write rate of the disk offeringfalse
iopswriteratemaxBurst I/O requests write rate of the disk offeringfalse
iopswriteratemaxlengthLength (in seconds) of the burstfalse
maxiopsMax IOPS of the disk offeringfalse
miniopsMin IOPS of the disk offeringfalse
provisioningtypeProvisioning type used to create volumes. Valid values are thin, sparse, fat.false
storagepolicyName of the storage policy defined at vCenter, this is applicable only for VMwarefalse
storagetypeThe storage type of the disk offering. Values are local and shared.false
tagsTags for the disk offeringfalse
zoneidThe ID of the containing zone(s), null for public offeringsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idUnique ID of the disk offering
cacheModeThe cache mode to use for this disk offering. none, writeback or writethrough
createdThe date this disk offering was created
detailsAdditional key/value details tied with this disk offering
diskBytesReadRateBytes read rate of the disk offering
diskBytesReadRateMaxBurst bytes read rate of the disk offering
diskBytesReadRateMaxLengthLength (in seconds) of the burst
diskBytesWriteRateBytes write rate of the disk offering
diskBytesWriteRateMaxBurst bytes write rate of the disk offering
diskBytesWriteRateMaxLengthLength (in seconds) of the burst
diskIopsReadRateI/O requests read rate of the disk offering
diskIopsReadRateMaxBurst io requests read rate of the disk offering
diskIopsReadRateMaxLengthLength (in second) of the burst
diskIopsWriteRateI/O requests write rate of the disk offering
diskIopsWriteRateMaxBurst io requests write rate of the disk offering
diskIopsWriteRateMaxLengthLength (in seconds) of the burst
disksizeThe size of the disk offering in GB
disksizestrictnessTo allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed
displayofferingWhether to display the offering to the end user or not.
displaytextAn alternate display text of the disk offering.
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
encryptWhether disks using this offering will be encrypted on primary storage
hypervisorsnapshotreserveHypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
iscustomizedTrue if disk offering uses custom size, false otherwise
iscustomizediopsTrue if disk offering uses custom IOPS, false otherwise
maxiopsThe max IOPS of the disk offering
miniopsThe min IOPS of the disk offering
nameThe name of the disk offering
provisioningtypeProvisioning type used to create volumes. Valid values are thin, sparse, fat.
statestate of the disk offering
storagetypeThe storage type for this disk offering
suitableforvirtualmachineReturns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false
tagsThe tags for the disk offering
vspherestoragepolicyThe vsphere storage policy tagged to the disk offering in case of VMware
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createDnsRecord.html b/static/api/apidocs-4.23/apis/createDnsRecord.html new file mode 100644 index 0000000000..6dda4cec7c --- /dev/null +++ b/static/api/apidocs-4.23/apis/createDnsRecord.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createDnsRecord

+

Creates a DNS record directly on the provider

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
contentsThe content of the record (IP address for A/AAAA, FQDN for CNAME/NS, quoted string for TXT, etc.)true
dnszoneidID of the DNS zonetrue
nameDNS record nametrue
typeDNS record type (e.g., A, AAAA, CNAME, MX, TXT, etc.)true
ttlTime to livefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
contentsThe contents of the record (IP address or target)
nameThe record name (e.g., www.example.com.)
ttlTime to live (TTL) in seconds
typeThe record type (e.g., A, CNAME, TXT)
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createDnsZone.html b/static/api/apidocs-4.23/apis/createDnsZone.html new file mode 100644 index 0000000000..a5a7db1e35 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createDnsZone.html @@ -0,0 +1,132 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createDnsZone

+

Creates a new DNS Zone on a specific server

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
dnsserveridThe ID of the DNS server to host this zonetrue
nameThe name of the DNS zone (e.g. example.com)true
descriptionThe description of the DNS zonefalse
existingIf true, imports an existing DNS zone from the DNS provider into CloudStack. If false, creates the zone in the DNS provider and registers it in CloudStack. Default is falsefalse
typeThe type of zone (Public, Private). Defaults to Public.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the DNS zone
accountthe account associated with the DNS zone
descriptionDescription for the DNS zone
dnsserveraccountthe account name of the DNS server owner
dnsserveridID of the DNS server this zone belongs to
dnsservernamethe name of the DNS server hosting this zone
domainthe name of the domain associated with the DNS zone
domainidthe ID of the domain associated with the DNS server
nameName of the DNS zone
networkidID of the network this zone is associated with
networknameName of the network this zone is associated with
stateThe state of the zone (Active/Inactive)
typeThe type of the zone (Public/Private)
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createDomain.html b/static/api/apidocs-4.23/apis/createDomain.html new file mode 100644 index 0000000000..35accd1103 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createDomain.html @@ -0,0 +1,282 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createDomain

+

Creates a domain

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameCreates domain with this nametrue
domainidDomain UUID, required for adding domain from another Regionfalse
networkdomainNetwork domain for networks in the domainfalse
parentdomainidAssigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the domain
backupavailablethe total number of backups available to this domain
backuplimitthe total number of backups which can be stored by this domain
backupstorageavailablethe total backup storage space (in GiB) available to the domain
backupstoragelimitthe total backup storage space (in GiB) the domain can own
backupstoragetotalthe total backup storage space (in GiB) owned by the domain
backuptotalthe total number of backups stored by this domain
bucketavailablethe total number of buckets available to this domain
bucketlimitthe total number of buckets which can be stored by this domain
buckettotalthe total number of buckets stored by this domain
cpuavailableThe total number of CPU cores available to be created for this domain
cpulimitThe total number of CPU cores the domain can own
cputotalThe total number of CPU cores owned by domain
createdThe date when this domain was created
domaindetailsDetails for the domain
gpuavailablethe total number of gpus available to be created for this domain
gpulimitthe total number of gpus the domain can own
gputotalthe total number of gpus owned by domain
haschildWhether the domain has one or more sub-domains
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this domain to acquire
iplimitThe total number of public IP addresses this domain can acquire
iptotalThe total number of public IP addresses allocated for this domain
levelThe level of the domain
memoryavailableThe total memory (in MB) available to be created for this domain
memorylimitThe total memory (in MB) the domain can own
memorytotalThe total memory (in MB) owned by domain
nameThe name of the domain
networkavailableThe total number of Networks available to be created for this domain
networkdomainThe Network domain
networklimitThe total number of Networks the domain can own
networktotalThe total number of Networks owned by domain
objectstorageavailablethe total object storage space (in GiB) available to the domain
objectstoragelimitthe total object storage space (in GiB) the domain can own
objectstoragetotalthe total object storage space (in GiB) owned by the domain
parentdomainidThe domain ID of the parent domain
parentdomainnameThe domain name of the parent domain
pathThe path of the domain
primarystorageavailableThe total primary storage space (in GiB) available to be used for this domain
primarystoragelimitThe total primary storage space (in GiB) the domain can own
primarystoragetotalThe total primary storage space (in GiB) owned by domain
projectavailableThe total number of projects available for administration by this domain
projectlimitThe total number of projects the domain can own
projecttotalThe total number of projects being administrated by this domain
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this domain
secondarystoragelimitThe total secondary storage space (in GiB) the domain can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by domain
snapshotavailableThe total number of Snapshots available for this domain
snapshotlimitThe total number of Snapshots which can be stored by this domain
snapshottotalThe total number of Snapshots stored by this domain
stateThe state of the domain
taggedresourcesThe tagged resource limit and count for the domain
templateavailableThe total number of Templates available to be created by this domain
templatelimitThe total number of Templates which can be created by this domain
templatetotalThe total number of Templates which have been created by this domain
vmavailableThe total number of Instances available for this domain to acquire
vmlimitThe total number of Instances that can be deployed by this domain
vmtotalThe total number of Instances deployed by this domain
volumeavailableThe total volume available for this domain
volumelimitThe total volume which can be used by this domain
volumetotalThe total volume being used by this domain
vpcavailableThe total number of VPCs available to be created for this domain
vpclimitThe total number of VPCs the domain can own
vpctotalThe total number of VPCs owned by domain
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createEgressFirewallRule.html b/static/api/apidocs-4.23/apis/createEgressFirewallRule.html new file mode 100644 index 0000000000..982adfcc40 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createEgressFirewallRule.html @@ -0,0 +1,189 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createEgressFirewallRule

+

Creates a egress firewall rule for a given network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
networkidThe Network ID of the port forwarding ruletrue
protocolThe protocol for the firewall rule. Valid values are TCP/UDP/ICMP.true
cidrlistThe CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).false
destcidrlistThe CIDR list to forward traffic to. Multiple entries must be separated by a single comma character (,).false
endportThe ending port of firewall rulefalse
fordisplayAn optional field, whether to the display the rule to the end user or notfalse
icmpcodeError code for this ICMP messagefalse
icmptypeType of the ICMP message being sentfalse
startportThe starting port of firewall rulefalse
typeType of firewallrule: system/userfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the firewall rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
destcidrlistThe CIDR list to forward traffic to. Multiple entries are separated by a single comma character (,).
endportThe ending port of firewall rule's port range
fordisplayIs rule for display to the regular user
icmpcodeError code for this ICMP message
icmptypeType of the ICMP message being sent
ipaddressThe public IP address for the firewall rule
ipaddressidThe public IP address ID for the firewall rule
networkidThe Network ID of the firewall rule
protocolThe protocol of the firewall rule
startportThe starting port of firewall rule's port range
stateThe state of the rule
traffictypeThe traffic type for the firewall rule
vpcidThe VPC ID of the firewall rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createExtension.html b/static/api/apidocs-4.23/apis/createExtension.html new file mode 100644 index 0000000000..39e5a31d44 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createExtension.html @@ -0,0 +1,156 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createExtension

+

Create an extension

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of the extensiontrue
typeType of the extensiontrue
descriptionDescription of the extensionfalse
detailsDetails in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvaluefalse
orchestratorrequirespreparevmOnly honored when type is Orchestrator. Whether prepare VM is needed or notfalse
pathRelative path for the extensionfalse
reservedresourcedetailsResource detail names as comma separated string that should be reserved and not visible to end usersfalse
stateState of the extensionfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the extension
createdCreation timestamp of the extension
descriptionDescription of the extension
detailsThe details of the extension
isuserdefinedTrue if the extension is added by admin
nameName of the extension
pathThe path of the entry point fo the extension
pathreadyTrue if the extension path is in ready state across management servers
removedRemoval timestamp of the extension, if applicable
reservedresourcedetailsResource detail names as comma separated string that should be reserved and not visible to end users
stateThe state of the extension
typeType of the extension
resources(*)List of resources to which extension is registered to
idID of the resource associated with the extension
createdCreation timestamp of the mapping
detailsthe details of the resource map
nameName of the resource associated with this mapping
typeType of the resource
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createFirewallRule.html b/static/api/apidocs-4.23/apis/createFirewallRule.html new file mode 100644 index 0000000000..1faf086a31 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createFirewallRule.html @@ -0,0 +1,186 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createFirewallRule

+

Creates a firewall rule for a given IP address

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
ipaddressidThe IP address ID of the port forwarding ruletrue
protocolThe protocol for the firewall rule. Valid values are TCP/UDP/ICMP.true
cidrlistThe CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).false
endportThe ending port of firewall rulefalse
fordisplayAn optional field, whether to the display the rule to the end User or notfalse
icmpcodeError code for this icmp messagefalse
icmptypeType of the ICMP message being sentfalse
startportThe starting port of firewall rulefalse
typeType of firewallrule: system/userfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the firewall rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
destcidrlistThe CIDR list to forward traffic to. Multiple entries are separated by a single comma character (,).
endportThe ending port of firewall rule's port range
fordisplayIs rule for display to the regular user
icmpcodeError code for this ICMP message
icmptypeType of the ICMP message being sent
ipaddressThe public IP address for the firewall rule
ipaddressidThe public IP address ID for the firewall rule
networkidThe Network ID of the firewall rule
protocolThe protocol of the firewall rule
startportThe starting port of firewall rule's port range
stateThe state of the rule
traffictypeThe traffic type for the firewall rule
vpcidThe VPC ID of the firewall rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createGlobalLoadBalancerRule.html b/static/api/apidocs-4.23/apis/createGlobalLoadBalancerRule.html new file mode 100644 index 0000000000..094d26ec26 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createGlobalLoadBalancerRule.html @@ -0,0 +1,249 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createGlobalLoadBalancerRule

+

Creates a global load balancer rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
gslbdomainnameDomain name for the GSLB service.true
gslbservicetypeGSLB service type (tcp, udp, http)true
nameName of the load balancer ruletrue
regionidRegion where the global load balancer is going to be created.true
accountThe Account associated with the global load balancer. Must be used with the domainId parameter.false
descriptionThe description of the load balancer rulefalse
domainidThe domain ID associated with the load balancerfalse
gslblbmethodLoad 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
gslbstickysessionmethodnameSession sticky method (sourceip) if not specified defaults to sourceipfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idGlobal Load balancer rule ID
accountThe Account of the Load balancer rule
descriptionThe description of the global Load balancer rule
domainThe domain of the Load balancer rule
domainidThe domain ID of the Load balancer rule
domainpathpath of the domain to which the load balancer rule belongs
gslbdomainnameDNS domain name given for the global Load balancer
gslblbmethodLoad balancing method used for the global Load balancer
gslbservicetypeGSLB service type
gslbstickysessionmethodnameSession persistence method used for the global Load balancer
nameName of the global Load balancer rule
projectThe project name of the Load balancer
projectidThe project ID of the Load balancer
regionidRegion ID in which global Load balancer is created
loadbalancerrule(*)List of Load balancer rules that are part of GSLB rule
idThe Load balancer rule ID
accountThe Account of the Load balancer rule
algorithmThe Load balancer algorithm (source, roundrobin, leastconn)
cidrlistThe CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).
descriptionThe description of the Load balancer
domainThe domain of the Load balancer rule
domainidThe domain ID of the Load balancer rule
domainpathpath of the domain to which the load balancer rule belongs
fordisplayIs rule for display to the regular user
nameThe name of the Load balancer
networkidThe ID of the guest Network the LB rule belongs to
privateportThe private port
projectThe project name of the Load balancer
projectidThe project ID of the Load balancer
protocolThe protocol of the Load Balancer rule
publicipThe public IP address
publicipidThe public IP address ID
publicportThe public port
stateThe state of the rule
zoneidThe ID of the zone the rule belongs to
zonenameThe name of the zone the Load balancer rule belongs to
tags(*)The list of resource tags associated with Load balancer
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createGpuCard.html b/static/api/apidocs-4.23/apis/createGpuCard.html new file mode 100644 index 0000000000..d1fd4f967c --- /dev/null +++ b/static/api/apidocs-4.23/apis/createGpuCard.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createGpuCard

+

Creates a GPU card definition in the system

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
deviceidthe device ID of the GPU cardtrue
devicenamethe device name of the GPU cardtrue
namethe display name of the GPU cardtrue
vendoridthe vendor ID of the GPU cardtrue
vendornamethe vendor name of the GPU cardtrue
videoramthe video RAM size in MB for the passthrough vGPU profilefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the GPU card
deviceidthe device ID of the GPU card
devicenamethe device name of the GPU card
namethe display name of the GPU card
vendoridthe vendor ID of the GPU card
vendornamethe vendor name of the GPU card
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createGpuDevice.html b/static/api/apidocs-4.23/apis/createGpuDevice.html new file mode 100644 index 0000000000..1c44c46ea0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createGpuDevice.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createGpuDevice

+

Creates a GPU device manually on a host

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
busaddressPCI bus address of the GPU device (e.g., 0000:01:00.0) or UUID for MDEV devices.true
gpucardidID of the GPU card typetrue
hostidID of the host where the GPU device is locatedtrue
vgpuprofileidID of the vGPU profiletrue
numanodeNUMA node of the GPU device (e.g., 0, 1, etc.). This is optional and can be used to specify the NUMA node for the GPU device which is used during allocation. Defaults to -1false
parentgpudeviceidID of the parent GPU device (for virtual GPU devices)false
typeType of GPU device (PCI, MDEV, VGPUOnly). Defaults to PCI.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the GPU device
busaddressbus address of the GPU device or MDEV UUID for vGPU devices
gpucardidthe GPU card ID associated with this GPU device
gpucardnamethe GPU card name associated with this GPU device
gpudevicetypebus address of the GPU device
hostidthe host ID where the GPU device is attached
hostnamethe host name where the GPU device is attached
managedstatethe managed state of the GPU device (Enabled/Disabled)
numanodethe NUMA node where the GPU device is located
parentgpudeviceidthe ID of the parent GPU device, if this is a vGPU
statethe vGPU profile name assigned to this GPU device
vgpuprofileidthe vGPU profile ID assigned to this GPU device
vgpuprofilenamethe vGPU profile name assigned to this GPU device
virtualmachineidthe vGPU profile ID assigned to this GPU device
virtualmachinenamethe vGPU profile name assigned to this GPU device
vmstatethe state of the virtual machine to which this GPU device is allocated
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createGuestNetworkIpv6Prefix.html b/static/api/apidocs-4.23/apis/createGuestNetworkIpv6Prefix.html new file mode 100644 index 0000000000..e3eb236644 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createGuestNetworkIpv6Prefix.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createGuestNetworkIpv6Prefix

+

Creates a guest network IPv6 prefix.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
prefixThe /56 or higher IPv6 CIDR for network prefix.true
zoneidUUID of zone to which the IPv6 prefix belongs to.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the guest IPv6 prefix
availablesubnetsCount of the available IPv6 subnets for the prefix.
createdDate when this IPv6 prefix was created.
prefixGuest IPv6 prefix
totalsubnetsCount of the total IPv6 subnets for the prefix.
usedsubnetsCount of the used IPv6 subnets for the prefix.
zoneidID of zone to which the IPv6 prefix belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createGuiTheme.html b/static/api/apidocs-4.23/apis/createGuiTheme.html new file mode 100644 index 0000000000..53b498fc1c --- /dev/null +++ b/static/api/apidocs-4.23/apis/createGuiTheme.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createGuiTheme

+

Creates a customized GUI theme for a set of Common Names (fixed or wildcard), a set of domain UUIDs, and/or a set of account UUIDs.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameA name to identify the theme.true
accountidsA set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.false
commonnamesA set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.comfalse
cssThe CSS to be retrieved and imported into the GUI when matching the theme access configurations.false
descriptionA description for the theme.false
domainidsA set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.false
ispublicDefines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.false
jsonconfigurationThe JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.false
loginbasedomainThe ACS domain to be used as base for the login when accessing the GUI through the common name defined in the theme. If a common name is not defined, this parameter is ignored on the GUI.false
recursivedomainsDefines whether the subdomains of the informed domains are considered. Default value is false.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the custom GUI theme.
accountidsA set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.
commonnamesA set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com
createdWhen the GUI theme was created.
cssThe CSS to be retrieved and imported into the GUI when matching the theme access configurations.
descriptionDescription of the GUI theme.
domainidsA set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.
ispublicDefines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.
jsonconfigurationThe JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.
loginbasedomainThe ACS domain to be used as base for the login when accessing the GUI through the common name defined in the theme. If a common name is not defined, this parameter is ignored on the GUI.
nameName of the GUI theme.
recursivedomainsWhether to consider the subdomains of the informed domain IDs.
removedWhen the GUI theme was removed.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createHSMProfile.html b/static/api/apidocs-4.23/apis/createHSMProfile.html new file mode 100644 index 0000000000..eb5f2a71c5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createHSMProfile.html @@ -0,0 +1,159 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createHSMProfile

+

Creates a new HSM profile

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
namethe name of the HSM profiletrue
accountthe account name of the HSM profile owner. Must be used with domainId. Leave empty (with a domainId) to create a domain-scoped profile shared by all accounts in that domain.false
detailsHSM configuration details (protocol specific)false
domainidthe domain ID where the HSM profile is available. If specified without an account, the profile is domain-scoped and usable by all accounts directly in that domain.false
ispublicwhether this is a public HSM profile available to all users globally (root admin only). Default is falsefalse
projectidthe ID of the project to add the HSM profile forfalse
protocolthe protocol of the HSM profile (PKCS11, KMIP, etc.). Default is 'pkcs11'false
vendornamethe vendor name of the HSMfalse
zoneidthe zone ID where the HSM profile is available. If null, global scope (for admin only)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the HSM profile
accountthe account name of the HSM profile owner
accountidthe account ID of the HSM profile owner
createdthe date the HSM profile was created
detailsHSM configuration details (sensitive values are encrypted)
domainthe domain name of the HSM profile owner
domainidthe domain ID of the HSM profile owner
domainpaththe domain path of the HSM profile owner
enabledwhether the HSM profile is enabled
ispublicwhether this is a system HSM profile available to all users globally
namethe name of the HSM profile
projectthe project name of the HSM profile owner
projectidthe project ID of the HSM profile owner
protocolthe protocol of the HSM profile
statethe state of the HSM profile
vendorthe vendor name of the HSM profile
zoneidthe zone ID where the HSM profile is available
zonenamethe zone name where the HSM profile is available
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createImageTransfer.html b/static/api/apidocs-4.23/apis/createImageTransfer.html new file mode 100644 index 0000000000..b0d5545a59 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createImageTransfer.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createImageTransfer

+

Create image transfer for a disk in backup. This API is intended for testing only and is disabled by default.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
directionDirection of the transfer: upload, downloadtrue
volumeidID of the disk/volumetrue
backupidID of the backupfalse
formatFormat for the image transfer: raw/cow. 'raw' will create an NBD backend. 'cow' will use the File backend.For download, only the 'raw' format is supported. Default: rawfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the image transfer
backupidthe backup ID
createdthe date created
devicenamethe device name (vda, vdb, etc)
directionthe image transfer direction: upload / download
phasethe transfer phase
transferurlthe transfer URL
vmidthe VM ID
volumeidthe disk/volume ID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createInstanceGroup.html b/static/api/apidocs-4.23/apis/createInstanceGroup.html new file mode 100644 index 0000000000..441d1c9464 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createInstanceGroup.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createInstanceGroup

+

Creates an Instance group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name of the Instance grouptrue
accountThe account of the Instance group. The account parameter must be used with the domainId parameter.false
domainidThe domain ID of account owning the Instance groupfalse
projectidThe project of the Instance groupfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance group
accountThe Account owning the Instance group
createdTime and date the Instance group was created
domainThe domain name of the Instance group
domainidThe domain ID of the Instance group
domainpathpath of the Domain the instance group belongs to
nameThe name of the Instance group
projectThe project name of the Instance group
projectidThe project ID of the Instance group
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createInternalLoadBalancerElement.html b/static/api/apidocs-4.23/apis/createInternalLoadBalancerElement.html new file mode 100644 index 0000000000..ffdb5c89aa --- /dev/null +++ b/static/api/apidocs-4.23/apis/createInternalLoadBalancerElement.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createInternalLoadBalancerElement

+

Create an Internal Load Balancer element.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
nspidThe network service provider ID of the internal load balancer elementtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
idThe ID of the internal Load balancer element
enabledEnabled/Disabled the element
nspidThe physical Network service provider ID of the element
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createIpForwardingRule.html b/static/api/apidocs-4.23/apis/createIpForwardingRule.html new file mode 100644 index 0000000000..4d3826c6e1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createIpForwardingRule.html @@ -0,0 +1,183 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createIpForwardingRule

+

Creates an IP forwarding rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
ipaddressidThe public IP address ID of the forwarding rule, already associated via associateIptrue
protocolThe protocol for the rule. Valid values are TCP or UDP.true
startportThe start port for the ruletrue
cidrlistThe CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.false
endportThe end port for the rulefalse
openfirewallIf true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by defaultfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the port forwarding rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
fordisplayIs firewall for display to the regular user
ipaddressThe public IP address for the port forwarding rule
ipaddressidThe public IP address id for the port forwarding rule
networkidThe ID of the guest Network the port forwarding rule belongs to
networknameThe Name of the guest Network the port forwarding rule belongs to
privateendportThe ending port of port forwarding rule's private port range
privateportThe starting port of port forwarding rule's private port range
protocolThe protocol of the port forwarding rule
publicendportThe ending port of port forwarding rule's private port range
publicportThe starting port of port forwarding rule's public port range
stateThe state of the rule
virtualmachinedisplaynameThe Instance display name for the port forwarding rule
virtualmachineidThe Instance ID for the port forwarding rule
virtualmachinenameThe Instance name for the port forwarding rule
vmguestipThe Instance IP address for the port forwarding rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createIpv4SubnetForGuestNetwork.html b/static/api/apidocs-4.23/apis/createIpv4SubnetForGuestNetwork.html new file mode 100644 index 0000000000..d569ae8a5f --- /dev/null +++ b/static/api/apidocs-4.23/apis/createIpv4SubnetForGuestNetwork.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createIpv4SubnetForGuestNetwork

+

Creates a IPv4 subnet for guest networks.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
parentidThe zone Ipv4 subnet which the IPv4 subnet belongs to.true
cidrsizethe CIDR size of IPv4 network. This is mutually exclusive with subnet.false
subnetThe CIDR of this Ipv4 subnet.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idid of the IPv4 subnet for guest network
allocateddate when this IPv4 subnet was allocated.
createddate when this IPv4 subnet was created.
networkidid of network which the IPv4 subnet is associated with.
networknamename of network which the IPv4 subnet is associated with.
parentidid of the data center IPv4 subnet
parentsubnetsubnet of the data center IPv4 subnet
removeddate when this IPv4 subnet was removed.
statestate of subnet of the IPv4 network
subnetsubnet of the IPv4 network
vpcidId of the VPC which the IPv4 subnet is associated with.
vpcnameName of the VPC which the IPv4 subnet is associated with.
zoneidid of zone to which the IPv4 subnet belongs to.
zonenameid of zone to which the IPv4 subnet belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createIpv4SubnetForZone.html b/static/api/apidocs-4.23/apis/createIpv4SubnetForZone.html new file mode 100644 index 0000000000..9b439cc270 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createIpv4SubnetForZone.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createIpv4SubnetForZone

+

Creates a IPv4 subnet for a zone.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
subnetThe CIDR of the IPv4 subnet.true
zoneidUUID of the zone which the IPv4 subnet belongs to.true
accountaccount who will own the IPv4 subnetfalse
domainiddomain ID of the account owning the IPv4 subnetfalse
projectidproject who will own the IPv4 subnetfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idid of the guest IPv4 subnet
accountthe account of the IPv4 subnet
createddate when this IPv4 subnet was created.
domainthe domain name of the IPv4 subnet
domainidthe domain ID of the IPv4 subnet
projectthe project name of the IPv4 subnet
projectidthe project id of the IPv4 subnet
subnetguest IPv4 subnet
zoneidid of zone to which the IPv4 subnet belongs to.
zonenamename of zone to which the IPv4 subnet belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createIpv6FirewallRule.html b/static/api/apidocs-4.23/apis/createIpv6FirewallRule.html new file mode 100644 index 0000000000..c0e00c6a22 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createIpv6FirewallRule.html @@ -0,0 +1,195 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createIpv6FirewallRule

+

Creates an IPv6 firewall rule in the given Network (the Network must not belong to VPC)

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
networkidThe Network of the Instance the Ipv6 firewall rule will be created fortrue
protocolThe protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol numbertrue
cidrlistThe source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).false
destcidrlistThe destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).false
endportThe ending port of Ipv6 firewall rulefalse
fordisplayAn optional field, whether to the display the rule to the end User or notfalse
icmpcodeError code for this ICMP messagefalse
icmptypeType of the ICMP message being sentfalse
startportThe starting port of Ipv6 firewall rulefalse
traffictypeThe traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specifiedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the port forwarding rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
fordisplayIs firewall for display to the regular user
ipaddressThe public IP address for the port forwarding rule
ipaddressidThe public IP address id for the port forwarding rule
networkidThe ID of the guest Network the port forwarding rule belongs to
networknameThe Name of the guest Network the port forwarding rule belongs to
privateendportThe ending port of port forwarding rule's private port range
privateportThe starting port of port forwarding rule's private port range
protocolThe protocol of the port forwarding rule
publicendportThe ending port of port forwarding rule's private port range
publicportThe starting port of port forwarding rule's public port range
stateThe state of the rule
virtualmachinedisplaynameThe Instance display name for the port forwarding rule
virtualmachineidThe Instance ID for the port forwarding rule
virtualmachinenameThe Instance name for the port forwarding rule
vmguestipThe Instance IP address for the port forwarding rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createKMSKey.html b/static/api/apidocs-4.23/apis/createKMSKey.html new file mode 100644 index 0000000000..84cf2a77a7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createKMSKey.html @@ -0,0 +1,162 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createKMSKey

+

Creates a new KMS key (Key Encryption Key) for encryption

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hsmprofileidID of HSM profile to create key intrue
nameName of the KMS keytrue
zoneidZone ID where the key will be validtrue
accountAccount name (for creating keys for child accounts - requires domain admin or admin)false
descriptionDescription of the KMS keyfalse
domainidDomain ID (for creating keys for child accounts - requires domain admin or admin)false
keybitsKey size in bits: 128, 192, or 256 (default: 256)false
projectidID of the project to create the KMS key forfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe UUID of the key
accountthe account owning the key
accountidthe account ID owning the key
algorithmthe encryption algorithm
createdthe creation timestamp
descriptionthe description of the key
domainthe domain name of the key
domainidthe domain ID of the key
domainpaththe domain path of the key
enabledwhether the key is enabled
hsmprofilethe zone name where the key is valid
hsmprofileidthe zone ID where the key is valid
keklabelthe provider-specific KEK label (admin only)
keybitsthe key size in bits
namethe name of the key
projectthe project name of the key
projectidthe project ID of the key
versionthe key size in bits
zoneidthe zone ID where the key is valid
zonenamethe zone name where the key is valid
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createKubernetesCluster.html b/static/api/apidocs-4.23/apis/createKubernetesCluster.html new file mode 100644 index 0000000000..d4fa9b5a7f --- /dev/null +++ b/static/api/apidocs-4.23/apis/createKubernetesCluster.html @@ -0,0 +1,321 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createKubernetesCluster

+

Creates a Kubernetes cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName for the Kubernetes clustertrue
zoneidAvailability zone in which Kubernetes cluster to be launchedtrue
accountAn optional Account for the Instance. Must be used with domainId.false
asnumberthe AS Number of the networkfalse
clustertypeType of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.false
cniconfigdetailsused to specify the parameters values for the variables in userdata. Example: cniconfigdetails[0].key=accesskey&cniconfigdetails[0].value=s389ddssaa&cniconfigdetails[1].key=secretkey&cniconfigdetails[1].value=8dshfsssfalse
cniconfigurationidthe ID of the Userdatafalse
controlnodesNumber of Kubernetes cluster control nodes, default is 1false
descriptionDescription for the Kubernetes clusterfalse
dockerregistrypasswordPassword for the docker image private registryfalse
dockerregistryurlURL for the docker image private registryfalse
dockerregistryusernameUser name for the docker image private registryfalse
domainidAn optional domainId for the Instance. If the Account parameter is used, domainId must also be used. Hosts dedicated to the specified domain will be used for deploying the clusterfalse
enablecsiif true, setups up CloudStack CSI driverfalse
etcdnodes(Optional) Number of Kubernetes cluster etcd nodes, default is 0.In case the number is greater than 0, etcd nodes are separate from master nodes and are provisioned accordinglyfalse
externalloadbalanceripaddressExternal load balancer IP address while using shared network with Kubernetes HA clusterfalse
hypervisorthe hypervisor on which the CKS cluster is to be deployed. This is required if the zone in which the CKS cluster is being deployed has clusters with different hypervisor types.false
keypairName of the SSH key pair used to login to the Instancesfalse
kubernetesversionidKubernetes version with which cluster to be launchedfalse
masternodesNumber of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.false
networkidNetwork in which Kubernetes cluster is to be launchedfalse
nodeaffinitygroups(Optional) Node Type to Affinity Group ID mapping. If provided, VMs of each node type will be added to the specified affinity groupfalse
nodeofferings(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameterfalse
noderootdisksizeRoot disk size in GB for each nodefalse
nodetemplates(Optional) Node Type to Template ID mapping. If provided, it overrides the default template: System VM templatefalse
projectidDeploy cluster for the projectfalse
serviceofferingidThe ID of the service offering for the Instances in the cluster.false
sizeNumber of Kubernetes cluster worker nodesfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Kubernetes cluster
accountThe Account associated with the Kubernetes cluster
associatednetworknameThe name of the network of the Kubernetes cluster
autoscalingenabledWhether autoscaling is enabled for the cluster
clustertypeThe type of the cluster
cniconfignameName of CNI Configuration associated with the cluster
cniconfigurationidID of CNI Configuration associated with the cluster
consoleendpointURL end point for the Kubernetes cluster dashboard UI
controlaffinitygroupidsThe IDs of affinity groups associated with control nodes
controlaffinitygroupnamesThe names of affinity groups associated with control nodes
controlnodesThe control nodes count for the Kubernetes cluster
controlofferingidthe ID of the service offering of the control nodes on the Kubernetes cluster
controlofferingnamethe name of the service offering of the control nodes on the Kubernetes cluster
cpunumberThe cpu cores of the Kubernetes cluster
createdThe date when this Kubernetes cluster was created
csienabledIndicates if the CloudStack CSI driver has been setup in the cluster
descriptionThe description of the Kubernetes cluster
domainThe name of the domain in which the Kubernetes cluster exists
domainidThe ID of the domain in which the Kubernetes cluster exists
domainpathPath of the domain to which the Kubernetes cluster belongs
endpointURL end point for the Kubernetes cluster
etcdaffinitygroupidsThe IDs of affinity groups associated with etcd nodes
etcdaffinitygroupnamesThe names of affinity groups associated with etcd nodes
etcdipsPublic IP Addresses of the etcd nodes
etcdnodesthe number of the etcd nodes on the Kubernetes cluster
etcdofferingidthe ID of the service offering of the etcd nodes on the Kubernetes cluster
etcdofferingnamethe name of the service offering of the etcd nodes on the Kubernetes cluster
ipaddressPublic IP Address of the cluster
ipaddressidPublic IP Address ID of the cluster
keypairKeypair details
kubernetesversionidThe ID of the Kubernetes version for the Kubernetes cluster
kubernetesversionnameThe name of the Kubernetes version for the Kubernetes cluster
masternodesThe master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.
maxsizeMaximum size of the cluster
memoryThe memory the Kubernetes cluster
minsizeMinimum size of the cluster
nameThe name of the Kubernetes cluster
networkidThe ID of the network of the Kubernetes cluster
projectThe project name of the Kubernetes cluster
projectidThe project id of the Kubernetes cluster
serviceofferingidThe ID of the service offering of the Kubernetes cluster
serviceofferingnameThe name of the service offering of the Kubernetes cluster
sizeThe size (worker nodes count) of the Kubernetes cluster
stateThe state of the Kubernetes cluster
templateidThe ID of the Template of the Kubernetes cluster
templatenamethe name of the template of the Kubernetes cluster
virtualmachinesThe list of virtualmachines associated with this Kubernetes cluster
workeraffinitygroupidsThe IDs of affinity groups associated with worker nodes
workeraffinitygroupnamesThe names of affinity groups associated with worker nodes
workerofferingidthe ID of the service offering of the worker nodes on the Kubernetes cluster
workerofferingnamethe name of the service offering of the worker nodes on the Kubernetes cluster
zoneidThe name of the zone of the Kubernetes cluster
zonenameThe name of the zone of the Kubernetes cluster
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createLBHealthCheckPolicy.html b/static/api/apidocs-4.23/apis/createLBHealthCheckPolicy.html new file mode 100644 index 0000000000..236ffcb395 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createLBHealthCheckPolicy.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createLBHealthCheckPolicy

+

Creates a load balancer health check policy

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
lbruleidThe ID of the load balancer ruletrue
descriptionThe description of the load balancer health check policyfalse
fordisplayAn optional field, whether to the display the rule to the end user or notfalse
healthythresholdNumber of consecutive health check success before declaring an Instance healthyfalse
intervaltimeAmount of time between health checks (1 sec - 20940 sec)false
pingpathHTTP ping pathfalse
responsetimeoutTime to wait when receiving a response from the health check (2sec - 60 sec)false
unhealthythresholdNumber of consecutive health check failures before declaring an Instance unhealthyfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account of the HealthCheck policy
domainThe domain of the HealthCheck policy
domainidThe domain ID of the HealthCheck policy
lbruleidThe LB rule ID
zoneidThe ID of the zone the HealthCheck policy belongs to
healthcheckpolicy(*)The list of healthcheckpolicies
idThe LB HealthCheck policy ID
descriptionThe description of the healthcheck policy
fordisplayIs policy for display to the regular user
healthcheckintervalAmount of time between health checks
healthcheckthressholdNumber of consecutive health check success before declaring an Instance healthy
pingpathThe pingpath of the healthcheck policy
responsetimeTime to wait when receiving a response from the health check
stateThe state of the policy
unhealthcheckthressholdNumber of consecutive health check failures before declaring an Instance unhealthy.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createLBStickinessPolicy.html b/static/api/apidocs-4.23/apis/createLBStickinessPolicy.html new file mode 100644 index 0000000000..7a7d502370 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createLBStickinessPolicy.html @@ -0,0 +1,144 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createLBStickinessPolicy

+

Creates a load balancer stickiness policy

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
lbruleidThe ID of the load balancer ruletrue
methodnameName of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBasedtrue
nameName of the load balancer stickiness policytrue
descriptionThe description of the load balancer stickiness policyfalse
fordisplayAn optional field, whether to the display the rule to the end user or notfalse
paramParam list. Example: param[0].name=cookiename&param[0].value=LBCookie false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account of the Stickiness policy
descriptionThe description of the Stickiness policy
domainThe domain of the Stickiness policy
domainidThe domain ID of the Stickiness policy
lbruleidThe LB rule ID
nameThe name of the Stickiness policy
stateThe state of the policy
zoneidThe ID of the zone the Stickiness policy belongs to
stickinesspolicy(*)The list of stickinesspolicies
idThe LB Stickiness policy ID
descriptionThe description of the Stickiness policy
fordisplayIs policy for display to the regular user
methodnameThe method name of the Stickiness policy
nameThe name of the Stickiness policy
paramsThe params of the policy
stateThe state of the policy
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createLoadBalancer.html b/static/api/apidocs-4.23/apis/createLoadBalancer.html new file mode 100644 index 0000000000..fc75794de9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createLoadBalancer.html @@ -0,0 +1,213 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createLoadBalancer

+

Creates an internal load balancer

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
algorithmLoad balancer algorithm (source, roundrobin, leastconn)true
instanceportThe TCP port of the Instance where the network traffic will be load balanced totrue
nameName of the load balancertrue
networkidThe guest Network the load balancer will be created fortrue
schemeThe load balancer scheme. Supported value in this release is Internaltrue
sourceipaddressnetworkidThe Network ID of the source IP addresstrue
sourceportThe source port the Network traffic will be load balanced fromtrue
descriptionThe description of the load balancerfalse
fordisplayAn optional field, whether to the display the rule to the end user or notfalse
sourceipaddressThe source IP address the network traffic will be load balanced fromfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Load Balancer ID
accountThe Account of the Load Balancer
algorithmThe Load balancer algorithm (source, roundrobin, leastconn)
descriptionThe description of the Load Balancer
domainThe domain of the Load Balancer
domainidThe domain ID of the Load Balancer
domainpathpath of the domain to which the Load Balancer belongs
fordisplayIs rule for display to the regular User
nameThe name of the Load Balancer
networkidLoad Balancer Network id
projectThe project name of the Load Balancer
projectidThe project id of the Load Balancer
sourceipaddressLoad Balancer source IP
sourceipaddressnetworkidLoad Balancer source IP Network id
loadbalancerinstance(*)The list of Instances associated with the Load Balancer
idThe Instance ID
ipaddressThe IP address of the Instance
nameThe name of the Instance
stateThe state of the Instance
loadbalancerrule(*)The list of rules associated with the Load Balancer
instanceportInstance port of the Load balancer rule
sourceportSource port of the Load balancer rule
stateThe state of the Load balancer rule
tags(*)The list of resource tags associated with the Load Balancer
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createLoadBalancerRule.html b/static/api/apidocs-4.23/apis/createLoadBalancerRule.html new file mode 100644 index 0000000000..5cf047a198 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createLoadBalancerRule.html @@ -0,0 +1,219 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createLoadBalancerRule

+

Creates a load balancer rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
algorithmLoad balancer algorithm (source, roundrobin, leastconn)true
nameName of the load balancer ruletrue
privateportThe private port of the private IP address/Instance where the network traffic will be load balanced totrue
publicportThe public port from where the network traffic will be load balanced fromtrue
accountThe Account associated with the load balancer. Must be used with the domainId parameter.false
cidrlistThe 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
descriptionThe description of the load balancer rulefalse
domainidThe domain ID associated with the load balancerfalse
fordisplayAn optional field, whether to the display the rule to the end user or notfalse
networkidThe guest Network this rule will be created for. Required when public IP address is not associated with any Guest Network yet (VPC case)false
openfirewallIf 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 truefalse
protocolThe protocol for the LB such as TCP, UDP, TCP-proxy or SSL.false
publicipidPublic IP address ID from where the network traffic will be load balanced fromfalse
zoneidZone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVmfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Load balancer rule ID
accountThe Account of the Load balancer rule
algorithmThe Load balancer algorithm (source, roundrobin, leastconn)
cidrlistThe CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).
descriptionThe description of the Load balancer
domainThe domain of the Load balancer rule
domainidThe domain ID of the Load balancer rule
domainpathpath of the domain to which the load balancer rule belongs
fordisplayIs rule for display to the regular user
nameThe name of the Load balancer
networkidThe ID of the guest Network the LB rule belongs to
privateportThe private port
projectThe project name of the Load balancer
projectidThe project ID of the Load balancer
protocolThe protocol of the Load Balancer rule
publicipThe public IP address
publicipidThe public IP address ID
publicportThe public port
stateThe state of the rule
zoneidThe ID of the zone the rule belongs to
zonenameThe name of the zone the Load balancer rule belongs to
tags(*)The list of resource tags associated with Load balancer
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createManagementNetworkIpRange.html b/static/api/apidocs-4.23/apis/createManagementNetworkIpRange.html new file mode 100644 index 0000000000..380270e6e5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createManagementNetworkIpRange.html @@ -0,0 +1,201 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createManagementNetworkIpRange

+

Creates a Management network IP range.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
gatewayThe gateway for the management network.true
netmaskThe netmask for the management network.true
podidUUID of POD, where the IP range belongs to.true
startipThe starting IP address.true
endipThe ending IP address.false
forsystemvmsSpecify if range is dedicated for CPVM and SSVM.false
vlanOptional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlanfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Pod
allocationstateThe allocation state of the Pod
endipThe ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.
forsystemvmsIndicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.
gatewayThe gateway of the Pod
nameThe name of the Pod
netmaskThe netmask of the Pod
startipThe starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.
storageaccessgroupscomma-separated list of storage access groups for the pod
vlanidIndicates VLAN ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.
zoneidThe Zone ID of the Pod
zonenameThe Zone name of the Pod
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
capacity(*)The capacity of the Pod
capacityallocatedThe capacity currently in allocated
capacitytotalThe total capacity available
capacityusedThe capacity currently in use
clusteridThe Cluster ID
clusternameThe Cluster name
nameThe capacity name
percentusedThe percentage of capacity currently in use
podidThe Pod ID
podnameThe Pod name
tagThe tag for the capacity type
typeThe capacity type
zoneidThe Zone ID
zonenameThe Zone name
ipranges(*)The IP ranges for the Pod
cidrThe CIDR for the range
endipThe ending IP for the range
forsystemvmsIndicates if range is dedicated for CPVM and SSVM
gatewayThe gateway for the range
startipThe starting IP for the range
vlanidIndicates VLAN ID for the range
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createNetwork.html b/static/api/apidocs-4.23/apis/createNetwork.html new file mode 100644 index 0000000000..67dc846486 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createNetwork.html @@ -0,0 +1,511 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createNetwork

+

Creates a Network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name of the networktrue
networkofferingidThe network offering IDtrue
zoneidThe zone ID for the networktrue
accountAccount that will own the network. Account should be under the selected domainfalse
aclidNetwork ACL ID associated for the networkfalse
acltypeAccess 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 networkfalse
asnumberthe AS Number of the networkfalse
associatednetworkidThe network this network is associated to. only available if create a Shared networkfalse
bgppeeridsIDs of the Bgp Peer for the Networkfalse
bypassvlanoverlapcheckWhen true bypasses VLAN ID/range overlap check during Network creation for shared and L2 Networksfalse
cidrsizethe CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.false
displaynetworkAn optional field, whether to the display the network to the end User or not.false
displaytextThe display text of the networkfalse
dns1The first IPv4 DNS for the networkfalse
dns2The second IPv4 DNS for the networkfalse
domainidDomain 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
endipThe ending IP address in the Network IP range. If not specified, will be defaulted to startIPfalse
endipv6The ending IPv6 address in the IPv6 network rangefalse
externalidID of the network in an external system.false
gatewayThe gateway of the Network. Required for shared networks and isolated networks when it belongs to VPCfalse
hideipaddressusageWhen true IP address usage for the Network will not be exported by the listUsageRecords APIfalse
ip6cidrThe CIDR of IPv6 network, must be at least /64false
ip6dns1The first IPv6 DNS for the networkfalse
ip6dns2The second IPv6 DNS for the networkfalse
ip6gatewayThe gateway of the IPv6 network. Required for Shared networksfalse
isolatedpvlanThe isolated private VLAN for this Networkfalse
isolatedpvlantypeThe isolated private VLAN type for this networkfalse
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.false
netmaskThe netmask of the Network. Required for shared networks and isolated networks when it belongs to VPCfalse
networkdomainNetwork domainfalse
physicalnetworkidThe physical Network ID the network belongs tofalse
privatemtuMTU to be configured on the network VR's private interface(s)false
projectidAn optional project for the networkfalse
publicmtuMTU to be configured on the network VR's public facing interfacesfalse
routeripIPv4 address to be assigned to a router in a shared Networkfalse
routeripv6IPv6 address to be assigned to a router in a shared Networkfalse
sourcenatipaddressIPV4 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
startipThe beginning IP address in the Network IP rangefalse
startipv6The beginning IPv6 address in the IPv6 network rangefalse
subdomainaccessDefines 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 specifiedfalse
tungstenvirtualrouteruuidTungsten-Fabric virtual router the network belongs tofalse
vlanThe ID or VID of the networkfalse
vpcidThe VPC network belongs tofalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Network
accountThe owner of the Network
aclidACL ID associated with the VPC Network
aclnameACL name associated with the VPC Network
acltypeACL type - access type to the Network
asnumberAS NUMBER
asnumberidUUID of AS NUMBER
bgppeersThe BGP peers for the network
broadcastdomaintypeBroadcast domain type of the Network
broadcasturiBroadcast URI of the Network. This parameter is visible to ROOT admins only
canusefordeployList Networks available for Instance deployment
cidrCloudStack managed address space, all CloudStack managed Instances get IP address from CIDR
createdThe date this Network was created
detailsThe details of the Network
displaynetworkAn optional field, whether to the display the Network to the end user or not.
displaytextThe displaytext of the Network
dns1The first IPv4 DNS for the Network
dns2The second IPv4 DNS for the Network
dnssubdomainDNS subdomain associated to the network
dnszoneDNS zone associated to the network
domainThe domain name of the Network owner
domainidThe domain ID of the Network owner
domainpathPath of the Domain the network belongs to
egressdefaultpolicyTrue if guest Network default egress policy is allow; false if default egress policy is deny
externalidThe external ID of the Network
gatewayThe Network's gateway
iconBase64 string representation of the resource icon
internetprotocolThe internet protocol of Network offering
ip4routesThe routes for the network to ease adding route in upstream router
ip4routingThe IPv4 routing type of network
ip6cidrThe CIDR of IPv6 Network
ip6dns1The first IPv6 DNS for the network
ip6dns2The second IPv6 DNS for the network
ip6gatewayThe gateway of IPv6 Network
ip6routesThe routes for the Network to ease adding route in upstream router
ip6routingThe IPv6 routing type of network offering
isdefaultTrue if Network is default, false otherwise
ispersistentList Networks that are persistent
issystemTrue if Network is system, false otherwise
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.
nameThe name of the Network
netmaskThe Network's netmask
networkcidrThe Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE
networkdomainThe Network domain
networkofferingavailabilityAvailability of the Network offering the Network is created from
networkofferingconservemodeTrue if Network offering is IP conserve mode enabled
networkofferingdisplaytextDisplay text of the Network offering the Network is created from
networkofferingidNetwork offering ID the Network is created from
networkofferingnameName of the Network offering the Network is created from
physicalnetworkidThe physical Network id
privatemtuMTU configured on the network VR's private interfaces
projectThe project name of the address
projectidThe project ID of the IP address
publicmtuMTU configured on the Network VR's public facing interfaces
receivedbytesThe total number of Network traffic bytes received
redundantrouterIf the Network has redundant routers enabled
relatedRelated to what other Network configuration
reservediprangeThe Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes
restartrequiredTrue if Network requires restart
sentbytesThe total number of Network traffic bytes sent
specifyiprangesTrue if Network supports specifying IP ranges, false otherwise
specifyvlanTrue if network supports specifying vlan, false otherwise
stateState of the Network
strechedl2subnetTrue if Network can span multiple zones
subdomainaccessTrue if users from subdomains can access the domain level Network
supportsvmautoscalingIf Network offering supports Instance autoscaling feature
traffictypeThe traffic type of the Network
tungstenvirtualrouteruuidTungsten-Fabric virtual router the Network belongs to
typeThe type of the Network
vlanThe VLAN of the Network. This parameter is visible to ROOT admins only
vpcidVPC the Network belongs to
vpcnameName of the VPC to which this Network belongs
zoneidZone ID of the Network
zonenameThe name of the zone the Network belongs to
zonesnetworkspansIf a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans
service(*)The list of services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
tags(*)The list of resource tags associated with Network
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createNetworkACL.html b/static/api/apidocs-4.23/apis/createNetworkACL.html new file mode 100644 index 0000000000..4048a455f4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createNetworkACL.html @@ -0,0 +1,198 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createNetworkACL

+

Creates a ACL rule in the given Network (the Network has to belong to VPC)

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
protocolThe protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol numbertrue
aclidThe network of the Instance the ACL will be created forfalse
actionACL entry action, allow or denyfalse
cidrlistThe CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).false
endportThe ending port of ACLfalse
fordisplayAn optional field, whether to the display the rule to the end User or notfalse
icmpcodeError code for this ICMP messagefalse
icmptypeType of the ICMP message being sentfalse
networkidThe Network of the Instance the ACL will be created forfalse
numberThe number of the ACL item, its orderingfalse
reasonA description indicating why the ACL rule is required.false
startportThe starting port of ACLfalse
traffictypeThe traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specifiedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the ACL Item
aclidThe ID of the ACL this item belongs to
aclnameThe name of the ACL this item belongs to
actionAction of ACL Item. Allow/Deny
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
endportThe ending port of ACL's port range
fordisplayIs rule for display to the regular user
icmpcodeError code for this icmp message
icmptypeType of the icmp message being sent
numberNumber of the ACL Item
protocolThe protocol of the ACL
reasonAn explanation on why this ACL rule is being applied
startportThe starting port of ACL's port range
stateThe state of the rule
traffictypeThe traffic type for the ACL
tags(*)The list of resource tags associated with the Network ACLs
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createNetworkACLList.html b/static/api/apidocs-4.23/apis/createNetworkACLList.html new file mode 100644 index 0000000000..068cee583a --- /dev/null +++ b/static/api/apidocs-4.23/apis/createNetworkACLList.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createNetworkACLList

+

Creates a Network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of the Network ACL listtrue
descriptionDescription of the Network ACL listfalse
fordisplayAn optional field, whether to the display the list to the end User or notfalse
vpcidID of the VPC associated with this Network ACL listfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the ACL
descriptionDescription of the ACL
fordisplayIs ACL for display to the regular user
nameThe Name of the ACL
vpcidId of the VPC this ACL is associated with
vpcnameName of the VPC this ACL is associated with
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createNetworkOffering.html b/static/api/apidocs-4.23/apis/createNetworkOffering.html new file mode 100644 index 0000000000..aef93c8850 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createNetworkOffering.html @@ -0,0 +1,315 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createNetworkOffering

+

Creates a network offering.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
guestiptypeGuest type of the network offering: Shared or Isolatedtrue
nameThe name of the network offeringtrue
traffictypeThe traffic type for the network offering. Supported type in current release is GUEST onlytrue
availabilityThe 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
conservemodeTrue if the network offering is IP conserve mode enabledfalse
detailsNetwork 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/portgroupfalse
displaytextThe display text of the network offering, defaults to the value of 'name'.false
domainidThe ID of the containing domain(s), null for public offeringsfalse
egressdefaultpolicyTrue if guest network default egress policy is allow; false if default egress policy is denyfalse
enableSet to true if the offering is to be enabled during creation. Default is falsefalse
fornsxtrue if network offering is meant to be used for NSX, false otherwise.false
fortungstenTrue if network offering is meant to be used for Tungsten-Fabric, false otherwise.false
forvpcTrue if network offering is meant to be used for VPC, false otherwise.false
internetprotocolThe internet protocol of network offering. Options are IPv4 and dualstack. Default is IPv4. dualstack will create a network offering that supports both IPv4 and IPv6false
ispersistentTrue if network offering supports persistent networks; defaulted to false if not specifiedfalse
keepaliveenabledIf 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
maxconnectionsMaximum number of concurrent connections supported by the Network offeringfalse
networkmodeIndicates the mode with which the network will operate. Valid option: NATTED or ROUTEDfalse
networkrateData transfer rate in megabits per second allowedfalse
nsxsupportlbTrue if network offering for NSX network offering supports Load balancer service.false
nsxsupportsinternallbTrue if network offering for NSX network offering supports Internal Load balancer service.false
providerName of the provider providing the servicefalse
routingmodethe routing mode for the network offering. Supported types are: Static or Dynamic.false
servicecapabilitylistDesired service capabilities as part of network offeringfalse
serviceofferingidThe service offering ID used by virtual router providerfalse
serviceproviderlistProvider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical networkfalse
specifyasnumbertrue if network offering supports choosing AS numberfalse
specifyiprangesTrue if network offering supports specifying ip ranges; defaulted to false if not specifiedfalse
specifyvlanTrue if network offering supports VLANsfalse
supportedservicesServices supported by the network offeringfalse
tagsThe tags for the network offering.false
zoneidThe ID of the containing zone(s), null for public offeringsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Network offering
availabilityAvailability of the Network offering
conservemodeTrue if Network offering is IP conserve mode enabled
createdThe date this Network offering was created
detailsAdditional key/value details tied with network offering
displaytextAn alternate display text of the Network offering.
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
egressdefaultpolicyTrue if guest network default egress policy is allow; false if default egress policy is deny
fornsxtrue if network offering can be used by NSX networks only
fortungstenTrue if Network offering can be used by Tungsten-Fabric Networks only
forvpcTrue if Network offering can be used by VPC Networks only
guestiptypeGuest type of the Network offering, can be Shared or Isolated
internetprotocolThe internet protocol of the network offering
isdefaultTrue if Network offering is default, false otherwise
ispersistentTrue if Network offering supports persistent networks, false otherwise
maxconnectionsMaximum number of concurrent connections to be handled by LB
nameThe name of the Network offering
networkmodeMode in which the network will operate. The valid values are NATTED and ROUTED
networkrateData transfer rate in megabits per second allowed.
routingmodethe routing mode for the network offering, supported types are Static or Dynamic.
serviceofferingidThe ID of the service offering used by virtual router provider
specifyasnumbertrue if network offering supports choosing AS numbers
specifyiprangesTrue if Network offering supports specifying IP ranges, false otherwise
specifyvlanTrue if Network offering supports VLANs, false otherwise
stateState of the Network offering. Can be Disabled/Enabled/Inactive
supportsinternallbtrue if network offering supports public access for guest networks
supportspublicaccessTrue if network offering supports public access for guest networks
supportsstrechedl2subnetTrue if network offering supports network that span multiple zones
tagsThe tags for the Network offering
traffictypeThe traffic type for the Network offering, supported types are Public, Management, Control, Guest, VLAN or Storage.
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
service(*)The list of supported services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createNetworkPermissions.html b/static/api/apidocs-4.23/apis/createNetworkPermissions.html new file mode 100644 index 0000000000..208dccfa11 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createNetworkPermissions.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createNetworkPermissions

+

Updates network permissions.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
networkidThe network IDtrue
accountidsA comma delimited list of account IDs within owner's domain. If specified, "op" parameter has to be passed in.false
accountsA comma delimited list of accounts within owner's domain. If specified, "op" parameter has to be passed in.false
projectidsA comma delimited list of projects within owner's domain. If specified, "op" parameter has to be passed in.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createPhysicalNetwork.html b/static/api/apidocs-4.23/apis/createPhysicalNetwork.html new file mode 100644 index 0000000000..2ea118c066 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createPhysicalNetwork.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createPhysicalNetwork

+

Creates a physical Network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name of the physical Networktrue
zoneidThe Zone ID for the physical Networktrue
broadcastdomainrangeThe broadcast domain range for the physical Network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basicfalse
domainidDomain ID of the Account owning a physical Networkfalse
isolationmethodsThe isolation method for the physical Network[VLAN/VXLAN/GRE/STT/BCF_SEGMENT/SSP/ODL/L3VPN/VCS/NSX/NETRIS]false
networkspeedThe speed for the physical Network[1G/10G]false
tagsTag the physical Networkfalse
vlanThe VLAN for the physical Networkfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe UUID of the physical Network
broadcastdomainrangeBroadcast domain range of the physical Network
domainidThe domain ID of the physical Network owner
isolationmethodsIsolation methods
nameName of the physical Network
networkspeedThe speed of the physical Network
stateState of the physical Network
tagsComma separated tag
vlanThe VLAN of the physical Network
zoneidZone ID of the physical Network
zonenameZone name of the physical Network
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createPod.html b/static/api/apidocs-4.23/apis/createPod.html new file mode 100644 index 0000000000..a9f3b95719 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createPod.html @@ -0,0 +1,204 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createPod

+

Creates a new Pod.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name of the Podtrue
zoneidThe Zone ID in which the Pod will be createdtrue
allocationstateAllocation state of this Pod for allocation of new resourcesfalse
endipThe ending IP address for the Podfalse
gatewayThe gateway for the Podfalse
netmaskThe netmask for the Podfalse
startipThe starting IP address for the Podfalse
storageaccessgroupscomma separated list of storage access groups for the hosts in the podfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Pod
allocationstateThe allocation state of the Pod
endipThe ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.
forsystemvmsIndicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.
gatewayThe gateway of the Pod
nameThe name of the Pod
netmaskThe netmask of the Pod
startipThe starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.
storageaccessgroupscomma-separated list of storage access groups for the pod
vlanidIndicates VLAN ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.
zoneidThe Zone ID of the Pod
zonenameThe Zone name of the Pod
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
capacity(*)The capacity of the Pod
capacityallocatedThe capacity currently in allocated
capacitytotalThe total capacity available
capacityusedThe capacity currently in use
clusteridThe Cluster ID
clusternameThe Cluster name
nameThe capacity name
percentusedThe percentage of capacity currently in use
podidThe Pod ID
podnameThe Pod name
tagThe tag for the capacity type
typeThe capacity type
zoneidThe Zone ID
zonenameThe Zone name
ipranges(*)The IP ranges for the Pod
cidrThe CIDR for the range
endipThe ending IP for the range
forsystemvmsIndicates if range is dedicated for CPVM and SSVM
gatewayThe gateway for the range
startipThe starting IP for the range
vlanidIndicates VLAN ID for the range
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createPortForwardingRule.html b/static/api/apidocs-4.23/apis/createPortForwardingRule.html new file mode 100644 index 0000000000..c7f1002c2c --- /dev/null +++ b/static/api/apidocs-4.23/apis/createPortForwardingRule.html @@ -0,0 +1,201 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createPortForwardingRule

+

Creates a port forwarding rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
ipaddressidThe IP address ID of the port forwarding ruletrue
privateportThe starting port of port forwarding rule's private port rangetrue
protocolThe protocol for the port forwarding rule. Valid values are TCP or UDP.true
publicportThe starting port of port forwarding rule's public port rangetrue
virtualmachineidThe ID of the Instance for the port forwarding ruletrue
cidrlistThe 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
fordisplayAn optional field, whether to the display the rule to the end user or notfalse
networkidThe Network of the Instance the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).false
openfirewallIf 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 truefalse
privateendportThe ending port of port forwarding rule's private port rangefalse
publicendportThe ending port of port forwarding rule's private port rangefalse
vmguestipInstance guest NIC secondary IP address for the port forwarding rulefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the port forwarding rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
fordisplayIs firewall for display to the regular user
ipaddressThe public IP address for the port forwarding rule
ipaddressidThe public IP address id for the port forwarding rule
networkidThe ID of the guest Network the port forwarding rule belongs to
networknameThe Name of the guest Network the port forwarding rule belongs to
privateendportThe ending port of port forwarding rule's private port range
privateportThe starting port of port forwarding rule's private port range
protocolThe protocol of the port forwarding rule
publicendportThe ending port of port forwarding rule's private port range
publicportThe starting port of port forwarding rule's public port range
stateThe state of the rule
virtualmachinedisplaynameThe Instance display name for the port forwarding rule
virtualmachineidThe Instance ID for the port forwarding rule
virtualmachinenameThe Instance name for the port forwarding rule
vmguestipThe Instance IP address for the port forwarding rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createPortableIpRange.html b/static/api/apidocs-4.23/apis/createPortableIpRange.html new file mode 100644 index 0000000000..5302af9ff9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createPortableIpRange.html @@ -0,0 +1,150 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createPortableIpRange

+

Adds a range of portable public IP's to a region

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
endipThe ending IP address in the portable IP rangetrue
gatewayThe gateway for the portable IP rangetrue
netmaskThe netmask of the portable IP rangetrue
regionidId of the Regiontrue
startipThe beginning IP address in the portable IP rangetrue
vlanVLAN id, if not specified defaulted to untaggedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idPortable IP range ID
endipThe end IP of the portable IP range
gatewayThe gateway of the VLAN IP range
netmaskThe netmask of the VLAN IP range
regionidRegion ID in which portable IP range is provisioned
startipThe start IP of the portable IP range
vlanThe ID or VID of the VLAN.
portableipaddress(*)List of portable IP and association with zone/network/vpc details that are part of GSLB rule
accountidThe Account ID the portable IP address is associated with
allocatedDate the portal IP address was acquired
domainidThe domain ID the portable IP address is associated with
ipaddressPublic IP address
networkidThe ID of the Network where IP belongs to
physicalnetworkidThe physical Network this belongs to
regionidRegion ID in which global Load balancer is created
stateState of the IP address. Can be: Allocating, Allocated, Releasing and Free
vpcidVPC the IP belongs to
zoneidThe ID of the zone the public IP address belongs to
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createPrivateGateway.html b/static/api/apidocs-4.23/apis/createPrivateGateway.html new file mode 100644 index 0000000000..bee3d1b32a --- /dev/null +++ b/static/api/apidocs-4.23/apis/createPrivateGateway.html @@ -0,0 +1,171 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createPrivateGateway

+

Creates a private gateway

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
gatewayThe Gateway of the Private Gatewaytrue
ipaddressThe IP address of the Private Gatewaytrue
netmaskThe Netmask of the Private Gatewaytrue
vpcidThe VPC Network belongs totrue
aclidThe ID of the Network ACLfalse
associatednetworkidThe Isolated Network this private gateway is associated to.false
bypassvlanoverlapcheckWhen true bypasses VLAN id/range overlap check during private gateway creationfalse
networkofferingidThe UUID of the Network offering to use for the private gateways Network connectionfalse
physicalnetworkidThe Physical Network ID the network belongs tofalse
sourcenatsupportedSource NAT supported value. Default value: false. When 'true', the source NAT is enabled on the private gateway 'false': sourcenat is not supportedfalse
vlanThe network implementation uri for the private gatewayfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the private gateway
accountThe Account associated with the private gateway
aclidACL ID set for private gateway
aclnameACL name set for private gateway
domainThe domain associated with the private gateway
domainidThe ID of the domain associated with the private gateway
domainpathPath of the domain to which the private gateway belongs
gatewayThe gateway
ipaddressThe private gateway's IP address
netmaskThe private gateway's netmask
physicalnetworkidThe physical Network id
projectThe project name of the private gateway
projectidThe project ID of the private gateway
sourcenatsupportedSource Nat enable status
stateState of the gateway, can be Creating, Ready, Deleting
vlanThe Network implementation uri for the private gateway
vpcidVPC ID the private gateway belongs to
vpcnameVPC name the private gateway belongs to
zoneidZone ID of the private gateway
zonenameThe name of the zone the private gateway belongs to
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createProject.html b/static/api/apidocs-4.23/apis/createProject.html new file mode 100644 index 0000000000..7827c5d80c --- /dev/null +++ b/static/api/apidocs-4.23/apis/createProject.html @@ -0,0 +1,315 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createProject

+

Creates a project

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of the projecttrue
accountAccount who will be Admin for the projectfalse
accountidID of the Account owning a projectfalse
displaytextThe display text of the project, defaults to the 'name´.false
domainidDomain ID of the Account owning a projectfalse
useridUser ID of the Account to be assigned as owner of the project i.e., Project Adminfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the project
backupavailablethe total number of backups available to this project
backuplimitthe total number of backups which can be stored by this project
backupstorageavailablethe total backup storage space (in GiB) available to the project
backupstoragelimitthe total backup storage space (in GiB) the project can own
backupstoragetotalthe total backup storage space (in GiB) owned by the project
backuptotalthe total number of backups stored by this project
bucketavailablethe total number of buckets available to this project
bucketlimitthe total number of buckets which can be stored by this project
buckettotalthe total number of buckets stored by this project
cpuavailableThe total number of CPU cores available to be created for this project
cpulimitThe total number of CPU cores the project can own
cputotalThe total number of CPU cores owned by project
createdThe date this project was created
displaytextThe displaytext of the project
domainThe domain name where the project belongs to
domainidThe domain ID the project belongs to
gpuavailablethe total number of gpus available to be created for this project
gpulimitthe total number of gpus the project can own
gputotalthe total number of gpus owned by project
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this project to acquire
iplimitThe total number of public IP addresses this project can acquire
iptotalThe total number of public IP addresses allocated for this project
memoryavailableThe total memory (in MB) available to be created for this project
memorylimitThe total memory (in MB) the project can own
memorytotalThe total memory (in MB) owned by project
nameThe name of the project
networkavailableThe total number of Networks available to be created for this project
networklimitThe total number of Networks the project can own
networktotalThe total number of Networks owned by project
objectstorageavailablethe total object storage space (in GiB) available to the project
objectstoragelimitthe total object storage space (in GiB) the project can own
objectstoragetotalthe total object storage space (in GiB) owned by the project
ownerThe Account name of the project's owners
primarystorageavailableThe total primary storage space (in GiB) available to be used for this project
primarystoragelimitThe total primary storage space (in GiB) the project can own
primarystoragetotalThe total primary storage space (in GiB) owned by project
projectaccountnameThe project Account name of the project
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this project
secondarystoragelimitThe total secondary storage space (in GiB) the project can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by project
snapshotavailableThe total number of Snapshots available for this project
snapshotlimitThe total number of Snapshots which can be stored by this project
snapshottotalThe total number of Snapshots stored by this project
stateThe state of the project
taggedresourcesThe tagged resource limit and count for the project
templateavailableThe total number of Templates available to be created by this project
templatelimitThe total number of Templates which can be created by this project
templatetotalThe total number of Templates which have been created by this project
vmavailableThe total number of Instances available for this project to acquire
vmlimitThe total number of Instances that can be deployed by this project
vmrunningThe total number of Instances running for this project
vmstoppedThe total number of Instances stopped for this project
vmtotalThe total number of Instances deployed by this project
volumeavailableThe total volume available for this project
volumelimitThe total volume which can be used by this project
volumetotalThe total volume being used by this project
vpcavailableThe total number of VPCs available to be created for this project
vpclimitThe total number of VPCs the project can own
vpctotalThe total number of VPCs owned by project
tags(*)The list of resource tags associated with Instance
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createProjectRole.html b/static/api/apidocs-4.23/apis/createProjectRole.html new file mode 100644 index 0000000000..939f45596b --- /dev/null +++ b/static/api/apidocs-4.23/apis/createProjectRole.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createProjectRole

+

Creates a Project role

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameCreates a project role with this unique nametrue
projectidID of project where role is being createdtrue
descriptionThe description of the Project rolefalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
projectidThe ID of the project
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createProjectRolePermission.html b/static/api/apidocs-4.23/apis/createProjectRolePermission.html new file mode 100644 index 0000000000..4e60836273 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createProjectRolePermission.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createProjectRolePermission

+

Adds API permissions to a project role

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
permissionThe rule permission, allow or deny. Default: deny.true
projectidID of project where project role permission is to be createdtrue
projectroleidID of the project roletrue
ruleThe API name or wildcard rule such as list*true
descriptionThe description of the role permissionfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the project role permission
projectidThe ID of the project
projectroleidThe ID of the project role to which the role permission belongs
projectrolenameThe name of the project role to which the role permission belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createRemoteAccessVpn.html b/static/api/apidocs-4.23/apis/createRemoteAccessVpn.html new file mode 100644 index 0000000000..463d4df5e4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createRemoteAccessVpn.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createRemoteAccessVpn

+

Creates a l2tp/ipsec remote access VPN

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
publicipidPublic IP address id of the VPN servertrue
accountAn optional Account for the VPN. Must be used with domainId.false
domainidAn optional domainId for the VPN. If the account parameter is used, domainId must also be used.false
fordisplayAn optional field, whether to the display the VPN to the end User or notfalse
iprangeThe range of IP addresses to allocate to VPN clients. The first IP in the range will be taken by the VPN serverfalse
openfirewallIf true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by defaultfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the remote access VPN
accountThe Account of the remote access VPN
domainThe domain name of the Account of the remote access VPN
domainidThe domain ID of the Account of the remote access VPN
domainpathPath of the domain to which the remote access VPN belongs
fordisplayIs VPN for display to the regular user
iprangeThe range of IPs to allocate to the clients
presharedkeyThe IPSec preshared key
projectThe project name of the VPN
projectidThe project ID of the VPN
publicipThe public IP address of the VPN server
publicipidThe public IP address of the VPN server
stateThe state of the rule
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createResourceSchedule.html b/static/api/apidocs-4.23/apis/createResourceSchedule.html new file mode 100644 index 0000000000..f9b045724c --- /dev/null +++ b/static/api/apidocs-4.23/apis/createResourceSchedule.html @@ -0,0 +1,144 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createResourceSchedule

+

Create Resource Schedule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
actionAction to take on the resource.true
resourceidID of the resource for which schedule is to be definedtrue
resourcetypeType of the resourcetrue
scheduleSchedule for action on resource in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'true
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.true
descriptionDescription of the schedulefalse
detailsMap of (key/value pairs) details for the schedule.false
enabledEnable schedule. Defaults to truefalse
enddateEnd date after which the schedule becomes inactive. (Format "yyyy-MM-dd hh:mm:ss")false
startdateStart date from which the schedule becomes active. Defaults to current date plus 1 minute. (Format "yyyy-MM-dd hh:mm:ss")false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of resource schedule
actionAction
createdDate when the schedule was created
descriptionDescription of resource schedule
detailsSchedule details
enabledResource schedule is enabled
enddateDate after which the schedule becomes inactive
resourceidID of the resource
resourcetypeType of the resource
scheduleCron formatted resource schedule
startdateDate from which the schedule is active
timezoneTimezone of the schedule
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createRole.html b/static/api/apidocs-4.23/apis/createRole.html new file mode 100644 index 0000000000..5a694c455b --- /dev/null +++ b/static/api/apidocs-4.23/apis/createRole.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createRole

+

Creates a role

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameCreates a role with this unique nametrue
descriptionThe description of the rolefalse
ispublicIndicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.false
roleidID of the role to be cloned from. Either roleid or type must be passed infalse
typeThe type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, Userfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
isdefaultTrue if role is default, false otherwise
statethe state of the role
typeThe type of the role
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createRolePermission.html b/static/api/apidocs-4.23/apis/createRolePermission.html new file mode 100644 index 0000000000..44b07296e7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createRolePermission.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createRolePermission

+

Adds an API permission to a role

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
permissionThe rule permission, allow or deny. Default: deny.true
roleidID of the roletrue
ruleThe API name or wildcard rule such as list*true
descriptionThe description of the role permissionfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
idThe ID of the role permission
roleidThe ID of the role to which the role permission belongs
rolenameThe name of the role to which the role permission belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createRoutingFirewallRule.html b/static/api/apidocs-4.23/apis/createRoutingFirewallRule.html new file mode 100644 index 0000000000..b59f7ff4a4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createRoutingFirewallRule.html @@ -0,0 +1,195 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createRoutingFirewallRule

+

Creates a routing firewall rule in the given network in ROUTED mode

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
networkidThe network of the VM the firewall rule will be created fortrue
protocolthe protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol numbertrue
cidrlistthe source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).false
destcidrlistthe destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).false
endportthe ending port of firewall rulefalse
fordisplayan optional field, whether to the display the rule to the end user or notfalse
icmpcodeerror code for this ICMP messagefalse
icmptypetype of the ICMP message being sentfalse
startportthe starting port of firewall rulefalse
traffictypethe traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specifiedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the port forwarding rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
fordisplayIs firewall for display to the regular user
ipaddressThe public IP address for the port forwarding rule
ipaddressidThe public IP address id for the port forwarding rule
networkidThe ID of the guest Network the port forwarding rule belongs to
networknameThe Name of the guest Network the port forwarding rule belongs to
privateendportThe ending port of port forwarding rule's private port range
privateportThe starting port of port forwarding rule's private port range
protocolThe protocol of the port forwarding rule
publicendportThe ending port of port forwarding rule's private port range
publicportThe starting port of port forwarding rule's public port range
stateThe state of the rule
virtualmachinedisplaynameThe Instance display name for the port forwarding rule
virtualmachineidThe Instance ID for the port forwarding rule
virtualmachinenameThe Instance name for the port forwarding rule
vmguestipThe Instance IP address for the port forwarding rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createSSHKeyPair.html b/static/api/apidocs-4.23/apis/createSSHKeyPair.html new file mode 100644 index 0000000000..4eb1549285 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createSSHKeyPair.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createSSHKeyPair

+

Create a new keypair and returns the private key

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of the keypairtrue
accountAn optional Account for the SSH key. Must be used with domainId.false
domainidAn optional domainId for the SSH key. If the Account parameter is used, domainId must also be used.false
projectidAn optional project for the SSH keyfalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
privatekeyPrivate key
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createSecondaryStagingStore.html b/static/api/apidocs-4.23/apis/createSecondaryStagingStore.html new file mode 100644 index 0000000000..d23c1be9dd --- /dev/null +++ b/static/api/apidocs-4.23/apis/createSecondaryStagingStore.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createSecondaryStagingStore

+

Create secondary staging store.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
urlThe URL for the staging storetrue
detailsThe details for the staging storefalse
providerThe staging store provider namefalse
scopeThe scope of the staging store: zone only for nowfalse
zoneidThe Zone ID for the staging storefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the image store
disksizetotalThe total disk size of the host
disksizeusedThe host's currently used disk size
nameThe name of the image store
protocolThe protocol of the image store
providernameThe provider name of the image store
readonlyDefines if store is read-only
scopeThe scope of the image store
urlThe URL of the image store
zoneidThe Zone ID of the image store
zonenameThe Zone name of the image store
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createSecondaryStorageSelector.html b/static/api/apidocs-4.23/apis/createSecondaryStorageSelector.html new file mode 100644 index 0000000000..457ac77751 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createSecondaryStorageSelector.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createSecondaryStorageSelector

+

Creates a secondary storage selector, described by the heuristic rule.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
descriptionThe description of the heuristic rule.true
heuristicruleThe 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
nameThe name identifying the heuristic rule.true
typeThe resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, BACKUP, TEMPLATE and VOLUME.true
zoneidThe zone in which the heuristic rule will be applied.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the heuristic.
createdWhen the heuristic was created.
descriptionDescription of the heuristic.
heuristicruleThe heuristic rule, in JavaScript language, used to select a secondary storage to be directed.
nameName of the heuristic.
removedWhen the heuristic was removed.
typeThe resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, BACKUP, TEMPLATE and VOLUME.
zoneidThe zone which the heuristic is valid upon.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createSecurityGroup.html b/static/api/apidocs-4.23/apis/createSecurityGroup.html new file mode 100644 index 0000000000..acf400a394 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createSecurityGroup.html @@ -0,0 +1,300 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createSecurityGroup

+

Creates a security group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of the security grouptrue
accountAn optional account for the security group. Must be used with domainId.false
descriptionThe description of the security groupfalse
domainidAn optional domainId for the security group. If the account parameter is used, domainId must also be used.false
projectidCreate security group for projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createServiceInstance.html b/static/api/apidocs-4.23/apis/createServiceInstance.html new file mode 100644 index 0000000000..a81d45edc2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createServiceInstance.html @@ -0,0 +1,132 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createServiceInstance

+

Creates a system virtual-machine that implements network services

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
leftnetworkidThe left (inside) network for service instancetrue
nameThe name of the service instancetrue
rightnetworkidThe right (outside) network ID for the service instancetrue
serviceofferingidThe service offering ID that defines the resources consumed by the service appliancetrue
templateidThe template ID that specifies the image for the service appliancetrue
zoneidAvailability zone for the service instancetrue
accountAn optional account for the virtual machine. Must be used with domainId.false
domainidAn optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.false
projectidProject ID for the service instancefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe account associated with the Instance
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the Domain in which the Instance exists
nameThe name of the Instance
projectThe project name of the vm
projectidThe project ID of the Instance
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createServiceOffering.html b/static/api/apidocs-4.23/apis/createServiceOffering.html new file mode 100644 index 0000000000..a71087a9b0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createServiceOffering.html @@ -0,0 +1,433 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createServiceOffering

+

Creates a service offering.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name of the service offeringtrue
bytesreadrateBytes read rate of the disk offeringfalse
bytesreadratemaxBurst bytes read rate of the disk offeringfalse
bytesreadratemaxlengthLength (in seconds) of the burstfalse
byteswriterateBytes write rate of the disk offeringfalse
byteswriteratemaxBurst bytes write rate of the disk offeringfalse
byteswriteratemaxlengthLength (in seconds) of the burstfalse
cachemodeThe cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache modefalse
cpunumberThe CPU number of the service offeringfalse
cpuspeedFor 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 Instance 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 Instances. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.false
customizedWhether service offering size is custom or notfalse
customizediopsWhether compute offering iops is custom or notfalse
deploymentplannerThe deployment planner heuristics used to deploy an Instance of this offering. If null, value of global config vm.deployment.planner is usedfalse
diskofferingidThe ID of the disk offering to which service offering should be mappedfalse
diskofferingstrictnessTrue/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 deployedfalse
displaytextThe display text of the service offering, defaults to 'name'.false
domainidThe ID of the containing domain(s), null for public offeringsfalse
dynamicscalingenabledTrue if Instance needs to be dynamically scalable of cpu or memoryfalse
encryptrootVMs using this offering require root volume encryptionfalse
externaldetailsDetails in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvaluefalse
gpucountCount of GPUs to be used with this service offering. This is applicable only when passed with vGPU profile.false
gpudisplayWhether to enable GPU display for this service offering. This is applicable only when passed with vGPU profile. Defaults to false.false
hosttagsThe host tag for this service offering.false
hypervisorsnapshotreserveHypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)false
iopsreadrateI/O requests read rate of the disk offeringfalse
iopsreadratemaxBurst requests read rate of the disk offeringfalse
iopsreadratemaxlengthLength (in seconds) of the burstfalse
iopswriterateI/O requests write rate of the disk offeringfalse
iopswriteratemaxBurst io requests write rate of the disk offeringfalse
iopswriteratemaxlengthLength (in seconds) of the burstfalse
issystemIs this a system vm offeringfalse
isvolatileTrue if the Instance needs to be volatile so that on every reboot, the original root disk is detached, then destroyed and a fresh root disk is created and attached to the Instancefalse
leasedurationNumber of days instance is leased for.false
leaseexpiryactionLease expiry action, valid values are STOP and DESTROYfalse
limitcpuuseRestrict the CPU usage to committed service offeringfalse
maxcpunumberThe maximum number of CPUs to be set with Custom Computer Offeringfalse
maxiopsMax iops of the compute offeringfalse
maxmemoryThe maximum memory size of the custom service offering in MBfalse
memoryThe total memory of the service offering in MBfalse
mincpunumberThe minimum number of CPUs to be set with Custom Computer Offeringfalse
miniopsMin iops of the compute offeringfalse
minmemoryThe minimum memory size of the custom service offering in MBfalse
networkrateData transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having "domainrouter" systemvmtypefalse
offerhaThe HA for the service offeringfalse
provisioningtypeProvisioning type used to create volumes. Valid values are thin, sparse, fat.false
purgeresourcesWhether to cleanup instance and its associated resource from database upon expunge of the instancefalse
rootdisksizeThe Root disk size in GB.false
serviceofferingdetailsDetails for planner, used to store specific parametersfalse
storagepolicyName of the storage policy defined at vCenter, this is applicable only for VMwarefalse
storagetypeThe storage type of the service offering. Values are local and shared.false
systemvmtypeThe system VM type. Possible types are "domainrouter", "consoleproxy" and "secondarystoragevm".false
tagsThe tags for this service offering.false
vgpuprofileidthe ID of the vGPU profile to which service offering should be mappedfalse
zoneidThe ID of the containing zone(s), null for public offeringsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the service offering
cacheModeThe cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default
cpunumberThe number of CPU
cpuspeedThe clock rate CPU speed in Mhz
createdThe date this service offering was created
defaultuseIs this a default System VM offering
deploymentplannerDeployment strategy used to deploy Instance.
diskBytesReadRateBytes read rate of the service offering
diskBytesReadRateMaxBurst bytes read rate of the disk offering
diskBytesReadRateMaxLengthLength (in seconds) of the burst
diskBytesWriteRateBytes write rate of the service offering
diskBytesWriteRateMaxBurst bytes write rate of the disk offering
diskBytesWriteRateMaxLengthLength (in seconds) of the burst
diskIopsReadRateI/O requests read rate of the service offering
diskIopsReadRateMaxBurst io requests read rate of the disk offering
diskIopsReadRateMaxLengthLength (in second) of the burst
diskIopsWriteRateI/O requests write rate of the service offering
diskIopsWriteRateMaxBurst I/O requests write rate of the disk offering
diskIopsWriteRateMaxLengthLength (in seconds) of the burst
diskofferingdisplaytextThe display text of the disk offering
diskofferingidThe ID of the disk offering to which service offering is linked
diskofferingnameName of the disk offering
diskofferingstrictnessTrue/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 Instance is deployed and change disk offering is not allowed for the ROOT disk after the Instance is deployed
displaytextAn alternate display text of the service offering.
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
dynamicscalingenabledTrue if Instance needs to be dynamically scalable of CPU or memory
encryptrootTrue if Instance root disk will be encrypted on storage
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs to attach
gpudisplaywhether GPU device is used for display or not
hosttagsThe host tag for the service offering
hypervisorsnapshotreserveHypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
iscustomizedIs true if the offering is customized
iscustomizediopsTrue if disk offering uses custom IOPS, false otherwise
issystemIs this a System VM offering
isvolatileTrue if the Instance needs to be volatile, i.e., on every reboot of Instance from API root disk is discarded and creates a new root disk
leasedurationInstance lease duration (in days) for service offering
leaseexpiryactionAction to be taken once lease is over
limitcpuuseRestrict the CPU usage to committed service offering
maxheadsthe maximum number of display heads
maxiopsThe max IOPS of the disk offering
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory in MB
miniopsThe min IOPS of the disk offering
nameThe name of the service offering
networkrateData transfer rate in megabits per second allowed.
offerhaThe HA support in the service offering
provisioningtypeProvisioning type used to create volumes. Valid values are thin, sparse, fat.
purgeresourcesWhether to cleanup VM and its associated resource upon expunge
rootdisksizeRoot disk size in GB
serviceofferingdetailsAdditional key/value details tied with this service offering
stateState of the service offering
storagetagsThe tags for the service offering
storagetypeThe storage type for this service offering
systemvmtypeIs this a the System VM type for System VM offering
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vspherestoragepolicyThe vsphere storage policy tagged to the service offering in case of VMware
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createSharedFileSystem.html b/static/api/apidocs-4.23/apis/createSharedFileSystem.html new file mode 100644 index 0000000000..41cae9056b --- /dev/null +++ b/static/api/apidocs-4.23/apis/createSharedFileSystem.html @@ -0,0 +1,339 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createSharedFileSystem

+

Create a new Shared File System of specified size and disk offering, attached to the given network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
diskofferingidthe 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
filesystemthe filesystem format (XFS / EXT4) which will be installed on the shared filesystem.true
namethe name of the shared filesystem.true
networkidnetwork to attach the shared filesystem totrue
serviceofferingidthe 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 respectivelytrue
zoneidthe zone id.true
accountthe account associated with the shared filesystem. Must be used with the domainId parameter.false
descriptionthe description for the shared filesystem.false
domainidthe 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
maxiopsmax iopsfalse
miniopsmin iopsfalse
projectidthe project associated with the shared filesystem. Mutually exclusive with account parameterfalse
providerthe provider to be used for the shared filesystem. The list of providers can be fetched by using the listSharedFileSystemProviders API.false
sizethe size of the shared filesystem in GiBfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the shared filesystem
accountthe account associated with the shared filesystem
descriptiondescription of the shared filesystem
diskioreadthe read (IO) of disk on the shared filesystem
diskiowritethe write (IO) of disk on the shared filesystem
diskkbsreadthe shared filesystem's disk read in KiB
diskkbswritethe shared filesystem's disk write in KiB
diskofferingdisplaytextdisk offering display text for the shared filesystem
diskofferingiddisk offering ID for the shared filesystem
diskofferingnamedisk offering for the shared filesystem
domainthe domain associated with the shared filesystem
domainidthe ID of the domain associated with the shared filesystem
domainpathpath of the domain to which the shared filesystem
filesystemthe filesystem format
iscustomdiskofferingdisk offering for the shared filesystem has custom size
namename of the shared filesystem
networkidNetwork ID of the shared filesystem
networknameNetwork name of the shared filesystem
pathpath to mount the shared filesystem
physicalsizethe bytes actually consumed on disk
projectthe project name of the shared filesystem
projectidthe project ID of the shared filesystem
providerthe shared filesystem provider
provisioningtypeprovisioning type used in the shared filesystem
serviceofferingidservice offering ID for the shared filesystem
serviceofferingnameservice offering for the shared filesystem
sizesize of the shared filesystem
sizegbsize of the shared filesystem in GiB
statethe state of the shared filesystem
storagename of the storage pool hosting the data volume
storageidID of the storage pool hosting the data volume
utilizationthe disk utilization
virtualmachineidID of the storage fs vm
virtualsizethe bytes allocated
vmstateID of the storage fs vm
volumeidID of the storage fs data volume
volumenamename of the storage fs data volume
zoneidID of the availability zone
zonenameName of the availability zone
nic(*)the list of nics associated with the shared filesystem
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createSnapshot.html b/static/api/apidocs-4.23/apis/createSnapshot.html new file mode 100644 index 0000000000..dc79b7e1bf --- /dev/null +++ b/static/api/apidocs-4.23/apis/createSnapshot.html @@ -0,0 +1,219 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createSnapshot

+

Creates an instant Snapshot of a volume.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
volumeidThe ID of the disk volumetrue
accountThe Account of the Snapshot. The Account parameter must be used with the domainId parameter.false
asyncbackupAsynchronous backup if truefalse
domainidThe 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
locationtypeCurrently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.false
nameThe name of the Snapshotfalse
policyidPolicy ID of the Snapshot, if this is null, then use MANUAL_POLICY.false
quiescevmQuiesce Instance if truefalse
storageidsA comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.false
tagsMap of tags (key/value pairs)false
usestoragereplicationEnables the snapshot to be copied to the supported primary storages when the config 'use.storage.replication' is set to true for the storage or globally. This is supported only for StorPool storage for now.false
zoneidsA 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the Snapshot
accountThe Account associated with the Snapshot
chainsizechain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true
createdThe date the Snapshot was created
datastoreidID of the datastore for the snapshot entry
datastorenamename of the datastore for the snapshot entry
datastorestatestate of the snapshot on the datastore
datastoretypetype of the datastore for the snapshot entry
domainThe domain name of the Snapshot's Account
domainidThe domain ID of the Snapshot's Account
domainpathpath of the Domain the snapshot's account belongs to
downloaddetailsdownload progress of a snapshot
intervaltypeValid types are hourly, daily, weekly, monthy, Template, and none.
locationtypeValid location types are primary and secondary.
nameName of the Snapshot
osdisplaynameDisplay name of the os on volume
ostypeidID of the os on volume
parentThe parent ID of the Snapshot
parentnameThe parent name of the Snapshot
physicalsizePhysical size of backed up Snapshot on image store
projectThe project name of the Snapshot
projectidThe project id of the Snapshot
revertableIndicates whether the underlying storage supports reverting the volume to this Snapshot
snapshottypeThe type of the Snapshot
stateThe 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
statusthe status of the template
virtualsizeVirtual size of backedup Snapshot on image store
volumeidID of the disk volume
volumenameName of the disk volume
volumestatestate of the disk volume
volumetypeType of the disk volume
zoneidID of the availability zone
zonenamename of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createSnapshotFromVMSnapshot.html b/static/api/apidocs-4.23/apis/createSnapshotFromVMSnapshot.html new file mode 100644 index 0000000000..80563f2e66 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createSnapshotFromVMSnapshot.html @@ -0,0 +1,192 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createSnapshotFromVMSnapshot

+

Creates an instant Snapshot of a volume from existing Instance Snapshot.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
vmsnapshotidThe ID of the Instance Snapshottrue
volumeidThe ID of the disk volumetrue
nameThe name of the Snapshotfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the Snapshot
accountThe Account associated with the Snapshot
chainsizechain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true
createdThe date the Snapshot was created
datastoreidID of the datastore for the snapshot entry
datastorenamename of the datastore for the snapshot entry
datastorestatestate of the snapshot on the datastore
datastoretypetype of the datastore for the snapshot entry
domainThe domain name of the Snapshot's Account
domainidThe domain ID of the Snapshot's Account
domainpathpath of the Domain the snapshot's account belongs to
downloaddetailsdownload progress of a snapshot
intervaltypeValid types are hourly, daily, weekly, monthy, Template, and none.
locationtypeValid location types are primary and secondary.
nameName of the Snapshot
osdisplaynameDisplay name of the os on volume
ostypeidID of the os on volume
parentThe parent ID of the Snapshot
parentnameThe parent name of the Snapshot
physicalsizePhysical size of backed up Snapshot on image store
projectThe project name of the Snapshot
projectidThe project id of the Snapshot
revertableIndicates whether the underlying storage supports reverting the volume to this Snapshot
snapshottypeThe type of the Snapshot
stateThe 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
statusthe status of the template
virtualsizeVirtual size of backedup Snapshot on image store
volumeidID of the disk volume
volumenameName of the disk volume
volumestatestate of the disk volume
volumetypeType of the disk volume
zoneidID of the availability zone
zonenamename of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createSnapshotPolicy.html b/static/api/apidocs-4.23/apis/createSnapshotPolicy.html new file mode 100644 index 0000000000..a18fc936fe --- /dev/null +++ b/static/api/apidocs-4.23/apis/createSnapshotPolicy.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createSnapshotPolicy

+

Creates a Snapshot policy for the account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
intervaltypeValid values are HOURLY, DAILY, WEEKLY, and MONTHLYtrue
maxsnapsMaximum number of Snapshots to retaintrue
scheduleTime 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
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.true
volumeidThe ID of the disk volumetrue
fordisplayAn optional field, whether to the display the policy to the end user or notfalse
storageidsA comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.false
tagsMap of tags (key/value pairs)false
usestoragereplicationEnables the snapshot to be copied to the supported primary storages when the config 'use.storage.replication' is set to true for the storage or globally. This is supported only for StorPool storage for now.false
zoneidsA 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Snapshot policy
fordisplayIs this policy for display to the regular user
intervaltypeThe interval type of the Snapshot policy
maxsnapsMaximum number of Snapshots retained
scheduleTime the Snapshot is scheduled to be taken.
storageThe list of pools in which snapshot backup is scheduled
timezoneThe time zone of the Snapshot policy
volumeidThe ID of the disk volume
volumenamethe name of the disk volume
zoneThe list of zones in which snapshot backup is scheduled
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createStaticRoute.html b/static/api/apidocs-4.23/apis/createStaticRoute.html new file mode 100644 index 0000000000..7fce4637f5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createStaticRoute.html @@ -0,0 +1,165 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createStaticRoute

+

Creates a static route

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
cidrStatic route CIDRtrue
gatewayidThe gateway ID we are creating static route for. Mutually exclusive with the nexthop parameterfalse
nexthopthe next hop of static route. Mutually exclusive with the gatewayid parameterfalse
vpcidthe vpc id for which the static route is created. This is required for nexthop parameterfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of static route
accountThe Account associated with the static route
cidrStatic route CIDR
domainThe domain associated with the static route
domainidThe ID of the domain associated with the static route
domainpaththe domain path associated with the static route
nexthopNext hop of the static route
projectThe project name of the static route
projectidThe project ID of the static route
stateThe state of the static route
vpcgatewayidVPC gateway the route is created for
vpcgatewayipIP of VPC gateway the route is created for
vpcidVPC the static route belongs to
tags(*)The list of resource tags associated with static route
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createStorageNetworkIpRange.html b/static/api/apidocs-4.23/apis/createStorageNetworkIpRange.html new file mode 100644 index 0000000000..65fe6eb4b8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createStorageNetworkIpRange.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createStorageNetworkIpRange

+

Creates a Storage network IP range.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
gatewayThe gateway for storage networktrue
netmaskThe netmask for storage networktrue
podidID of pod where the IP range belongs totrue
startipThe starting IP addresstrue
endipThe ending IP addressfalse
vlanOptional. 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 tablefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe UUID of storage Network IP range.
endipThe end IP of the storage Network IP range
gatewayThe gateway of the storage Network IP range
netmaskThe netmask of the storage Network IP range
networkidThe Network UUID of storage Network IP range
podidThe Pod UUID for the storage Network IP range
startipThe start IP of the storage Network IP range
vlanThe ID or VID of the VLAN.
zoneidThe Zone UUID of the storage Network IP range
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createStoragePool.html b/static/api/apidocs-4.23/apis/createStoragePool.html new file mode 100644 index 0000000000..4e0fe901b9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createStoragePool.html @@ -0,0 +1,228 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createStoragePool

+

Creates a storage pool.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name for the storage pooltrue
urlThe URL of the storage pooltrue
zoneidThe Zone ID for the storage pooltrue
capacitybytesBytes CloudStack can provision from this storage poolfalse
capacityiopsIOPS CloudStack can provision from this storage poolfalse
clusteridThe cluster ID for the storage poolfalse
detailsThe details for the storage poolfalse
hypervisorHypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.false
istagaruleWhether the informed tag is a JS interpretable rule or not.false
managedWhether the storage should be managed by CloudStackfalse
podidThe Pod ID for the storage poolfalse
providerThe storage provider namefalse
scopeThe scope of the storage: cluster or zonefalse
storageaccessgroupscomma separated list of storage access groups for connecting to hosts having those specific groupsfalse
tagsThe tags for the storage poolfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the storage pool
allocatediopsTotal min IOPS currently in use by volumes
capacitybytesbytes CloudStack can provision from this storage pool
capacityiopsIOPS CloudStack can provision from this storage pool
clusteridThe ID of the cluster for the storage pool
clusternameThe name of the cluster for the storage pool
createdThe date and time the storage pool was created
detailsthe storage pool details
disksizeallocatedThe pool's currently allocated disk size
disksizetotalThe total disk size of the storage pool
disksizeusedThe pool's currently used disk size
hypervisorThe hypervisor type of the storage pool
ipaddressThe IP address of the storage pool
istagaruleWhether the informed tag is a JS interpretable rule or not.
managedwhether this pool is managed or not
nameThe name of the storage pool
nfsmountoptsthe nfs mount options for the storage pool
overprovisionfactorThe overprovisionfactor for the storage pool
pathThe storage pool path
podidThe Pod ID of the storage pool
podnameThe Pod name of the storage pool
providerStorage provider for this pool
scopeThe scope of the storage pool
stateThe state of the storage pool
storageaccessgroupsthe storage access groups for the storage pool
storagecapabilitiesThe storage pool capabilities
storagecustomstatsthe storage pool custom stats
suitableformigrationTrue if this pool is suitable to migrate a volume, false otherwise
tagsThe tags for the storage pool
typeThe storage pool type
usediopstotal IOPS currently in use
zoneidThe Zone ID of the storage pool
zonenameThe Zone name of the storage pool
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createTags.html b/static/api/apidocs-4.23/apis/createTags.html new file mode 100644 index 0000000000..489d46fe8b --- /dev/null +++ b/static/api/apidocs-4.23/apis/createTags.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createTags

+

Creates resource tag(s)

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
resourceidsList of resources to create the tags fortrue
resourcetypeType of the resourcetrue
tagsMap of tags (key/value pairs)true
customerIdentifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internallyfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createTemplate.html b/static/api/apidocs-4.23/apis/createTemplate.html new file mode 100644 index 0000000000..2c4d07b2ed --- /dev/null +++ b/static/api/apidocs-4.23/apis/createTemplate.html @@ -0,0 +1,312 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createTemplate

+

Creates a Template of an Instance. The Instance 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.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name of the Templatetrue
ostypeidThe ID of the OS Type that best represents the OS of this Template.true
accountan optional accountName. Must be used with domainId.false
archthe CPU arch of the template. Valid options are: x86_64, aarch64, s390x. Defaults to x86_64false
bits32 or 64 bitfalse
detailsTemplate details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61false
displaytextThe display text of the Template, defaults to the 'name'.false
domainidan optional domainId. If the account parameter is used, domainId must also be used.false
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memoryfalse
isfeaturedTrue if this Template is a featured Template, false otherwisefalse
ispublicTrue if this Template is a public Template, false otherwisefalse
passwordenabledTrue if the Template supports the password reset feature; default is falsefalse
projectidCreate Template for the projectfalse
requireshvmTrue if the Template requires HVM, false otherwisefalse
snapshotidThe ID of the Snapshot the Template is being created from. Either this parameter, or volumeId has to be passed infalse
sshkeyenabledTrue if the Template supports the SSHkey upload feature; default is falsefalse
templatetagThe tag for this Template.false
urlOptional, only for baremetal hypervisor. The directory name where Template stored on CIFS serverfalse
virtualmachineidOptional, Instance ID. If this presents, it is going to create a baremetal Template for Instance this ID refers to. This is only for Instance whose hypervisor type is BareMetalfalse
volumeidThe ID of the disk volume the Template is being created from. Either this parameter, or snapshotId has to be passed infalse
zoneidthe zone for the template. Can be specified with snapshot onlyfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe Account name to which the Template belongs
accountidThe Account id to which the Template belongs
archCPU Arch of the template
bitsThe processor bit size
bootableTrue if the ISO is bootable, false otherwise
checksumChecksum of the Template
childtemplatesIf root disk Template, then IDs of the datas disk Templates this Template owns
createdThe date this Template was created
crossZonesTrue if the Template is managed across all Zones, false otherwise
deployasisVMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is Template
detailsAdditional key/value details tied with Template
directdownloadKVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextThe Template display text
domainThe name of the domain to which the Template belongs
domainidThe ID of the domain to which the Template belongs
domainpathPath of the Domain the template belongs to
downloaddetailsLists the download progress of a Template across all secondary storages
extensionidThe ID of extension linked to this template
extensionnameThe name of extension linked to this template
forcksIf true it indicates that the template can be used for CKS cluster deployments
formatThe format of the Template.
hostidThe ID of the secondary storage host for the Template
hostnameThe name of the secondary storage host for the Template
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
isextractableTrue if the Template is extractable, false otherwise
isfeaturedTrue if this Template is a featured Template, false otherwise
ispublicTrue if this Template is a public Template, false otherwise
isreadyTrue if the Template is ready to be deployed from, false otherwise.
nameThe Template name
ostypeidThe ID of the OS type for this Template.
ostypenameThe name of the OS type for this Template.
parenttemplateidIf Datadisk Template, then id of the root disk Template this Template belongs to
passwordenabledTrue if the reset password feature is enabled, false otherwise
physicalsizeThe physical size of the Template
projectThe project name of the Template
projectidThe project ID of the Template
removedThe date this Template was removed
requireshvmTrue if Template requires HVM enabled, false otherwise
sizeThe size of the Template
sourcetemplateidThe Template ID of the parent Template if present
sshkeyenabledTrue if Template is sshkey enabled, false otherwise
statusThe status of the Template
templatetagThe tag of this Template
templatetypeThe type of the Template
urlThe URL which the Template/ISO is registered from
userdataidThe id of userdata linked to this Template
userdatanameThe name of userdata linked to this Template
userdataparamsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
zoneidThe ID of the zone for this Template
zonenameThe name of the zone for this Template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createTungstenFabricAddressGroup.html b/static/api/apidocs-4.23/apis/createTungstenFabricAddressGroup.html new file mode 100644 index 0000000000..f495497852 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createTungstenFabricAddressGroup.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createTungstenFabricAddressGroup

+

Create Tungsten-Fabric address group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
ipprefixTungsten-Fabric ip prefixtrue
ipprefixlenTungsten-Fabric ip prefix lengthtrue
nameTungsten-Fabric address group nametrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
ipprefixTungsten-Fabric address group IP prefix
ipprefixlenTungsten-Fabric address group IP prefix length
nameTungsten-Fabric address group name
uuidTungsten-Fabric address group UUID
zoneidTungsten-Fabric provider zone ID
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createTungstenFabricApplicationPolicySet.html b/static/api/apidocs-4.23/apis/createTungstenFabricApplicationPolicySet.html new file mode 100644 index 0000000000..4edb65f7e1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createTungstenFabricApplicationPolicySet.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createTungstenFabricApplicationPolicySet

+

Create Tungsten-Fabric application policy set

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
nameTungsten-Fabric application policy set nametrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
firewallpolicyList Tungsten-Fabric firewall policy
nameTungsten-Fabric policy name
tagList Tungsten-Fabric tag
uuidTungsten-Fabric application policy uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createTungstenFabricFirewallPolicy.html b/static/api/apidocs-4.23/apis/createTungstenFabricFirewallPolicy.html new file mode 100644 index 0000000000..6f7b947845 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createTungstenFabricFirewallPolicy.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createTungstenFabricFirewallPolicy

+

Create Tungsten-Fabric firewall policy

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameTungsten-Fabric firewall policy nametrue
sequenceThe sequence of Tungsten-Fabric firewall policytrue
zoneidThe ID of zonetrue
applicationpolicysetuuidThe UUID of Tungsten-Fabric application policy setfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
firewallruleList Tungsten-Fabric firewall rule
nameTungsten-Fabric firewall policy name
uuidTungsten-Fabric firewall policy uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createTungstenFabricFirewallRule.html b/static/api/apidocs-4.23/apis/createTungstenFabricFirewallRule.html new file mode 100644 index 0000000000..79cc72de94 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createTungstenFabricFirewallRule.html @@ -0,0 +1,162 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createTungstenFabricFirewallRule

+

Create Tungsten-Fabric firewall

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
actionTungsten-Fabric firewall rule actiontrue
directionTungsten-Fabric firewall rule directiontrue
firewallpolicyuuidThe UUID of Tungsten-Fabric firewall policytrue
nameTungsten-Fabric firewall rule nametrue
sequenceThe sequence of Tungsten-Fabric firewall ruletrue
servicegroupuuidTungsten-Fabric firewall rule service group uuidtrue
zoneidThe ID of zonetrue
destaddressgroupuuidTungsten-Fabric firewall rule destination address group uuidfalse
destnetworkuuidThe uuid of Tungsten-Fabric destination networkfalse
desttaguuidTungsten-Fabric firewall rule destination tag uuidfalse
srcaddressgroupuuidTungsten-Fabric firewall rule source address group uuidfalse
srcnetworkuuidThe UUID of Tungsten-Fabric source networkfalse
srctaguuidTungsten-Fabric firewall rule source tag uuidfalse
tagtypeuuidTungsten-Fabric firewall rule tag type uuidfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
actionTungsten-Fabric firewall rule action
destaddressgroupTungsten-Fabric firewall rule destination address group
destnetworkTungsten-Fabric firewall rule destination network
desttagTungsten-Fabric firewall rule destination tag
directionTungsten-Fabric firewall rule direction
nameTungsten-Fabric firewall rule name
servicegroupTungsten-Fabric firewall rule service group
srcaddressgroupTungsten-Fabric firewall rule source address group
srcnetworkTungsten-Fabric firewall rule source network
srctagTungsten-Fabric firewall rule source tag
tagtypeTungsten-Fabric firewall rule tag type
uuidTungsten-Fabric firewall rule uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createTungstenFabricLogicalRouter.html b/static/api/apidocs-4.23/apis/createTungstenFabricLogicalRouter.html new file mode 100644 index 0000000000..33927a7440 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createTungstenFabricLogicalRouter.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createTungstenFabricLogicalRouter

+

Create Tungsten-Fabric logical router

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
nameTungsten-Fabric logical router nametrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric logical router name
networkList Tungsten-Fabric policy network name
uuidTungsten-Fabric logical router uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createTungstenFabricManagementNetwork.html b/static/api/apidocs-4.23/apis/createTungstenFabricManagementNetwork.html new file mode 100644 index 0000000000..9658460639 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createTungstenFabricManagementNetwork.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createTungstenFabricManagementNetwork

+

Create Tungsten-Fabric management network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
podidThe ID of podtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createTungstenFabricPolicy.html b/static/api/apidocs-4.23/apis/createTungstenFabricPolicy.html new file mode 100644 index 0000000000..37ddfb3639 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createTungstenFabricPolicy.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createTungstenFabricPolicy

+

Create Tungsten-Fabric policy

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
nameTungsten-Fabric policy nametrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric policy name
networkList Tungsten-Fabric policy network name
uuidTungsten-Fabric tag type uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createTungstenFabricProvider.html b/static/api/apidocs-4.23/apis/createTungstenFabricProvider.html new file mode 100644 index 0000000000..32ceb90659 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createTungstenFabricProvider.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createTungstenFabricProvider

+

Create Tungsten-Fabric provider in cloudstack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameTungsten-Fabric provider nametrue
tungstengatewayTungsten-Fabric provider gatewaytrue
tungstenproviderhostnameTungsten-Fabric provider hostnametrue
zoneidThe ID of zonetrue
tungstenproviderintrospectportTungsten-Fabric provider introspect portfalse
tungstenproviderportTungsten-Fabric provider portfalse
tungstenprovidervrouterportTungsten-Fabric provider vrouter portfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric provider name
securitygroupsenabledTrue if security groups support is enabled, false otherwise
tungstengatewayTungsten-Fabric provider gateway
tungstenproviderhostnameTungsten-Fabric provider hostname
tungstenproviderintrospectportTungsten-Fabric provider introspect port
tungstenproviderportTungsten-Fabric provider port
tungstenprovideruuidTungsten-Fabric provider uuid
tungstenprovidervrouterportTungsten-Fabric provider vrouter port
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createTungstenFabricPublicNetwork.html b/static/api/apidocs-4.23/apis/createTungstenFabricPublicNetwork.html new file mode 100644 index 0000000000..511ed7eed6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createTungstenFabricPublicNetwork.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createTungstenFabricPublicNetwork

+

Create Tungsten-Fabric public network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createTungstenFabricServiceGroup.html b/static/api/apidocs-4.23/apis/createTungstenFabricServiceGroup.html new file mode 100644 index 0000000000..9bdb7b08da --- /dev/null +++ b/static/api/apidocs-4.23/apis/createTungstenFabricServiceGroup.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createTungstenFabricServiceGroup

+

Create Tungsten-Fabric service group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
endportTungsten-Fabric service group end porttrue
nameTungsten-Fabric service group nametrue
protocolTungsten-Fabric service group protocoltrue
startportTungsten-Fabric service group start porttrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
endportTungsten-Fabric service group end port
nameTungsten-Fabric service group name
protocolTungsten-Fabric service group protocol
startportTungsten-Fabric service group start port
uuidTungsten-Fabric service group uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createTungstenFabricTag.html b/static/api/apidocs-4.23/apis/createTungstenFabricTag.html new file mode 100644 index 0000000000..25e48273e7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createTungstenFabricTag.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createTungstenFabricTag

+

Create Tungsten-Fabric tag

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
tagtypeTungsten-Fabric tag typetrue
tagvalueTungsten-Fabric tag valuetrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric tag name
networkList Tungsten-Fabric network
nicList Tungsten-Fabric NIC
policyList Tungsten-Fabric policy
uuidTungsten-Fabric tag type uuid
vmList Tungsten-Fabric Instance
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createTungstenFabricTagType.html b/static/api/apidocs-4.23/apis/createTungstenFabricTagType.html new file mode 100644 index 0000000000..41a89a57b0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createTungstenFabricTagType.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createTungstenFabricTagType

+

Create Tungsten-Fabric tag type

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
nameTungsten-Fabric tag type nametrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric tag type name
uuidTungsten-Fabric tag type uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createUser.html b/static/api/apidocs-4.23/apis/createUser.html new file mode 100644 index 0000000000..80688aa464 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createUser.html @@ -0,0 +1,183 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createUser

+

Creates a user for an account that already exists

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountCreates the user under the specified account. If no account is specified, the username will be used as the account name.true
emailEmailtrue
firstnameFirstnametrue
lastnameLastnametrue
passwordClear 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
usernameUnique username.true
domainidCreates the user under the specified domain. Has to be accompanied with the account parameterfalse
passwordchangerequiredProvide true to mandate the User to reset password on next login.false
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.false
useridUser UUID, required for adding account from external provisioning systemfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe user ID
accountThe Account name of the user
accountidThe Account ID of the user
accounttypeThe Account type of the user
apikeyThe API key of the user
apikeyaccessWhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
createdThe date and time the user Account was created
domainThe domain name of the user
domainidThe domain ID of the user
emailThe user email address
firstnameThe user firstname
iconBase64 string representation of the resource icon
is2faenabledTrue if user has two factor authentication enabled
is2famandatedTrue if user has two factor authentication is mandated
iscallerchilddomainThe boolean value representing if the updating target is in caller's child domain
isdefaultTrue if user is default, false otherwise
lastnameThe user lastname
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role
secretkeyThe secret key of the user
stateThe user state
timezoneThe timezone user was created in
usernameThe user name
usersourceThe source type of the user in lowercase, such as native, ldap, saml2
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createVMFromBackup.html b/static/api/apidocs-4.23/apis/createVMFromBackup.html new file mode 100644 index 0000000000..436ac9122c --- /dev/null +++ b/static/api/apidocs-4.23/apis/createVMFromBackup.html @@ -0,0 +1,873 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createVMFromBackup

+

Creates and automatically starts a VM from a backup.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
backupidbackup ID to create the VM fromtrue
zoneidavailability zone for the virtual machinetrue
accountan optional account for the virtual machine. Must be used with domainId.false
affinitygroupidscomma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameterfalse
affinitygroupnamescomma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameterfalse
bootintosetupBoot into hardware setup or not (ignored if startVm = false, only valid for vmware)false
bootmodeBoot 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
boottypeGuest 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
clusteriddestination Cluster ID to deploy the VM to - parameter available for root admin onlyfalse
copyimagetagsif true the image tags (if any) will be copied to the VM, default value is falsefalse
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
datadiskofferinglistdatadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameterfalse
datadisksdetailsDisk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200&datadisksdetails[0].kmskeyid=<uuid>false
deploymentplannerDeployment planner to use for vm allocation. Available to ROOT admin onlyfalse
detailsused to specify the custom parameters. 'extraconfig' is not allowed to be passed in detailsfalse
dhcpoptionsnetworklistDHCP 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.comfalse
diskofferingidthe 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
displaynamean optional user generated name for the virtual machinefalse
displayvman optional field, whether to the display the vm to the end user or not.false
domainidan 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
dynamicscalingenabledtrue if virtual machine needs to be dynamically scalablefalse
externaldetailsDetails in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevaluefalse
extraconfigan optional URL encoded string that can be passed to the virtual machine upon successful deploymentfalse
groupan optional group for the virtual machinefalse
hostiddestination Host ID to deploy the VM to - parameter available for root admin onlyfalse
hypervisorthe 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 callfalse
iodriverpolicyControls specific policies on IOfalse
iothreadsenabledIOThreads 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
ip6addressthe ipv6 address for default vm's networkfalse
ipaddressthe ip address for default vm's networkfalse
iptonetworklistip 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=uuidfalse
keyboardan optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,es-latam,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,usfalse
keypairname of the ssh key pair used to login to the virtual machinefalse
keypairsnames of the ssh key pairs used to login to the virtual machinefalse
leasedurationNumber of days instance is leased for.false
leaseexpiryactionLease expiry action, valid values are STOP and DESTROYfalse
macaddressthe mac address for default vm's networkfalse
namehost name for the virtual machinefalse
networkidslist of network ids used by virtual machine. Can't be specified with ipToNetworkList parameterfalse
nicmultiqueuenumberThe number of queues for multiqueue NICs.false
nicnetworklistVMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuidfalse
nicpackedvirtqueuesenabledEnable packed virtqueues or not.false
overridediskofferingidthe 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 idfalse
passwordThe password of the virtual machine. If null, a random password will be generated for the VM.false
podiddestination Pod ID to deploy the VM to - parameter available for root admin onlyfalse
preserveipUse the same IP/MAC addresses as stored in the backup metadata. Works only if the original Instance is deleted and the IP/MAC address is available.false
projectidDeploy vm for the projectfalse
propertiesused to specify the vApp properties.false
quickrestoreWhether to use the quick restore process or not. Currently this parameter is only supported by the KBOSS provider.false
rootdiskkmskeyidID of the KMS Key to use for root disk encryptionfalse
rootdisksizeOptional 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 providedfalse
securitygroupidscomma 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 parameterfalse
securitygroupnamescomma 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 parameterfalse
serviceofferingidthe ID of the service offering for the virtual machinefalse
sizethe arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingIdfalse
startvmtrue if start vm after creating; defaulted to true if not specifiedfalse
templateidthe ID of the template for the virtual machinefalse
userdataan 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 valuefalse
userdatadetailsused to specify the parameters values for the variables in userdata.false
userdataidthe ID of the Userdatafalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createVMSchedule.html b/static/api/apidocs-4.23/apis/createVMSchedule.html new file mode 100644 index 0000000000..33410c853d --- /dev/null +++ b/static/api/apidocs-4.23/apis/createVMSchedule.html @@ -0,0 +1,132 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createVMSchedule

+

Create Instance Schedule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
actionAction to take on the Instance (start/stop/reboot/force_stop/force_reboot).true
scheduleSchedule for action on Instance in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'true
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.true
virtualmachineidID of the Instance for which schedule is to be definedtrue
descriptionDescription of the schedulefalse
enabledEnable Instance schedule. Defaults to truefalse
enddateEnd date after which the schedule becomes inactive(Format "yyyy-MM-dd hh:mm:ss")false
startdateStart date from which the schedule becomes active. Defaults to current date plus 1 minute.(Format "yyyy-MM-dd hh:mm:ss")false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of Instance schedule
actionAction
createdDate when the schedule was created
descriptionDescription of Instance schedule
enabledVM schedule is enabled
enddateDate after which the schedule becomes inactive
scheduleCron formatted Instance schedule
startdateDate from which the schedule is active
timezoneTimezone of the schedule
virtualmachineidID of Instance
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createVMSnapshot.html b/static/api/apidocs-4.23/apis/createVMSnapshot.html new file mode 100644 index 0000000000..4123379a46 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createVMSnapshot.html @@ -0,0 +1,156 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createVMSnapshot

+

Creates Snapshot for an Instance.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidThe ID of the Instancetrue
descriptionThe description of the Snapshotfalse
nameThe display name of the Snapshotfalse
quiescevmQuiesce Instance if truefalse
snapshotmemorySnapshot memory if truefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance Snapshot
accountThe Account associated with the disk volume
createdThe create date of the Instance Snapshot
currentIndicates if this is current Snapshot
descriptionThe description of the Instance Snapshot
displaynameThe display name of the Instance Snapshot
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathPath of the domain to which the disk volume belongs
hypervisorThe type of hypervisor on which Snapshot is stored
nameThe name of the Instance Snapshot
parentThe parent ID of the Instance Snapshot
parentNameThe parent displayName of the Instance Snapshot
projectThe project name of the VPN
projectidThe project ID of the VPN
stateThe state of the Instance Snapshot
typeInstance Snapshot type
virtualmachineidThe Instance ID of the Instance Snapshot
virtualmachinenameThe Instance name of the Instance Snapshot
zoneidThe Zone ID of the Instance Snapshot
zonenameThe Zone name of the Instance Snapshot
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createVPC.html b/static/api/apidocs-4.23/apis/createVPC.html new file mode 100644 index 0000000000..d0b8bea4ea --- /dev/null +++ b/static/api/apidocs-4.23/apis/createVPC.html @@ -0,0 +1,334 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createVPC

+

Creates a VPC

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name of the VPCtrue
vpcofferingidThe ID of the VPC offeringtrue
zoneidThe ID of the availability zonetrue
accountThe Account associated with the VPC. Must be used with the domainId parameter.false
asnumberthe AS Number of the VPC tiersfalse
bgppeeridsIds of the Bgp Peer for the VPCfalse
cidrThe CIDR of the VPC. All VPC Guest Network's CIDRs should be within this CIDRfalse
cidrsizethe CIDR size of VPC. For regular users, this is required for VPC with ROUTED mode.false
displaytextThe display text of the VPC, defaults to its 'name'.false
dns1The first IPv4 DNS for the VPCfalse
dns2The second IPv4 DNS for the VPCfalse
domainidThe domain ID associated with the VPC. If used with the Account parameter returns the VPC associated with the Account for the specified domain.false
fordisplayAn optional field, whether to the display the VPC to the end User or notfalse
ip6dns1The first IPv6 DNS for the VPCfalse
ip6dns2The second IPv6 DNS for the VPCfalse
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.false
networkdomainVPC Network domain. All Networks inside the VPC will belong to this domainfalse
projectidCreate VPC for the projectfalse
publicmtuMTU to be configured on the Network VR's public facing interfacesfalse
sourcenatipaddressIPv4 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
startIf set to false, the VPC won't start (VPC VR will not get allocated) until its first Network gets implemented. True by default.false
userouteripresolver(optional) for NSX based VPCs: when set to true, use the VR IP as nameserver, otherwise use DNS1 and DNS2false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the VPC
accountThe owner of the VPC
asnumberAS NUMBER
asnumberidUUID of AS NUMBER
bgppeersThe BGP peers for the VPC
cidrThe CIDR the VPC
createdThe date this VPC was created
displaytextAn alternate display text of the VPC.
distributedvpcrouterDoes VPC use distributed router for one hop forwarding and host based Network ACL's
dns1The first IPv4 DNS for the VPC
dns2The second IPv4 DNS for the VPC
domainThe domain name of the owner
domainidThe domain ID of the VPC owner
domainpathThe domain path of the owner
fordisplayIs VPC for display to the regular user
iconBase64 string representation of the resource icon
ip4routesThe routes for the VPC to ease adding route in upstream router
ip4routingThe IPv4 routing mode of VPC
ip6dns1The first IPv6 DNS for the VPC
ip6dns2The second IPv6 DNS for the VPC
ip6routesThe routes for the Network to ease adding route in upstream router
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.
nameThe name of the VPC
networkThe list of Networks belonging to the VPC
networkdomainThe Network domain of the VPC
projectThe project name of the VPC
projectidThe project ID of the VPC
publicmtuMTU configured on the public interfaces of the VPC VR
redundantvpcrouterIf this VPC has redundant router
regionlevelvpcTrue if VPC is region level
restartrequiredTrue VPC requires restart
stateState of the VPC. Can be Inactive/Enabled
vpcofferingconservemodetrue if VPC offering is ip conserve mode enabled
vpcofferingidVPC offering ID the VPC is created from
vpcofferingnameVPC offering name the VPC is created from
zoneidZone ID of the VPC
zonenameThe name of the zone the VPC belongs to
service(*)The list of supported services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
tags(*)The list of resource tags associated with the project
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createVPCOffering.html b/static/api/apidocs-4.23/apis/createVPCOffering.html new file mode 100644 index 0000000000..d4107fb5f2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createVPCOffering.html @@ -0,0 +1,225 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createVPCOffering

+

Creates VPC offering

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name of the VPC offeringtrue
conservemodeTrue if the VPC offering is IP conserve mode enabled, allowing public IPs to be used across multiple VPC tiers. Default value is falsefalse
displaytextThe display text of the VPC offering, defaults to the 'name'false
domainidThe ID of the containing domain(s), null for public offeringsfalse
enableSet to true if the offering is to be enabled during creation. Default is falsefalse
fornsxtrue if network offering is meant to be used for NSX, false otherwise.false
internetprotocolThe internet protocol of the offering. Options are IPv4 and dualstack. Default is IPv4. dualstack will create an offering that supports both IPv4 and IPv6false
networkmodeIndicates the mode with which the network will operate. Valid option: NATTED or ROUTEDfalse
nsxsupportlbtrue if network offering for NSX VPC offering supports Load balancer service.false
providerName of the provider providing the servicefalse
routingmodethe routing mode for the VPC offering. Supported types are: Static or Dynamic.false
servicecapabilitylistDesired service capabilities as part of VPC offeringfalse
serviceofferingidThe ID of the service offering for the VPC router appliancefalse
serviceproviderlistProvider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical networkfalse
specifyasnumbertrue if the VPC offering supports choosing AS numberfalse
supportedservicesServices supported by the VPC offeringfalse
zoneidThe ID of the containing zone(s), null for public offeringsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the VPC offering
conservemodeTrue if the VPC offering is IP conserve mode enabled, allowing public IP services to be used across multiple VPC tiers.
createdThe date this VPC offering was created
displaytextAn alternate display text of the VPC offering.
distributedvpcrouterIndicates if the VPC offering supports distributed router for one-hop forwarding
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
fornsxTrue if VPC offering can be used by NSX networks only
internetprotocolThe internet protocol of the VPC offering
isdefaultTrue if VPC offering is default, false otherwise
nameThe name of the VPC offering
networkmodeMode in which the network will operate. The valid values are NATTED and ROUTED
routingmodeThe routing mode for the network offering, supported types are Static or Dynamic.
specifyasnumberTrue if network offering supports choosing AS numbers
stateState of the VPC offering. Can be Disabled/Enabled
supportsregionLevelvpcIndicated if the offering can support region level VPC
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
service(*)The list of supported services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createVgpuProfile.html b/static/api/apidocs-4.23/apis/createVgpuProfile.html new file mode 100644 index 0000000000..621efcaf0e --- /dev/null +++ b/static/api/apidocs-4.23/apis/createVgpuProfile.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createVgpuProfile

+

Creates a vGPU profile in the system

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
gpucardidthe GPU card ID associated with this GPU devicetrue
namethe name of the vGPU profiletrue
descriptionthe description of the vGPU profilefalse
maxheadsthe maximum number of display headsfalse
maxresolutionxthe maximum X resolutionfalse
maxresolutionythe maximum Y resolutionfalse
maxvgpuperphysicalgpuMax vGPU per physical GPU. This is used to calculate capacity.false
videoramthe video RAM size in MBfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
descriptionthe description of the vGPU profile
gpucardidthe ID of the GPU card associated with this vGPU profile
gpucardnamethe name of the vGPU profile
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
maxvgpuperphysicalgputhe maximum number of vGPUs per physical GPU
videoramthe video RAM size in MB
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createVirtualRouterElement.html b/static/api/apidocs-4.23/apis/createVirtualRouterElement.html new file mode 100644 index 0000000000..c3b9e4a915 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createVirtualRouterElement.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createVirtualRouterElement

+

Create a virtual router element.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
nspidThe network service provider ID of the virtual router elementtrue
providertypeThe provider type. Supported types are VirtualRouter (default) and VPCVirtualRouterfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the router
accountThe Account associated with the provider
domainThe domain associated with the provider
domainidThe domain ID associated with the provider
domainpathPath of the domain to which the provider belongs
enabledEnabled/Disabled the service provider
nspidThe physical Network service provider ID of the provider
projectThe project name of the address
projectidThe project ID of the IP address
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createVlanIpRange.html b/static/api/apidocs-4.23/apis/createVlanIpRange.html new file mode 100644 index 0000000000..828627dea6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createVlanIpRange.html @@ -0,0 +1,213 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createVlanIpRange

+

Creates a VLAN IP range.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountAccount who will own the VLAN. If VLAN is Zone wide, this parameter should be omittedfalse
domainidDomain ID of the Account owning a VLANfalse
endipThe ending IP address in the VLAN IP rangefalse
endipv6The ending IPv6 address in the IPv6 network rangefalse
forsystemvmsTrue if IP range is set to System VMs, false if notfalse
forvirtualnetworkTrue if VLAN is of Virtual type, false if Directfalse
gatewayThe gateway of the VLAN IP rangefalse
ip6cidrThe CIDR of IPv6 network, must be at least /64false
ip6gatewayThe gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPCfalse
netmaskThe netmask of the VLAN IP rangefalse
networkidThe Network IDfalse
physicalnetworkidThe physical network IDfalse
podidOptional parameter. Have to be specified for Direct Untagged vlan only.false
projectidProject who will own the VLAN. If VLAN is Zone wide, this parameter should be omittedfalse
providerProvider name for which the IP range is reserved forfalse
startipThe beginning IP address in the VLAN IP rangefalse
startipv6The beginning IPv6 address in the IPv6 network rangefalse
vlanThe 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 Untaggedfalse
zoneidThe Zone ID of the VLAN IP rangefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the VLAN IP range
accountThe Account of the VLAN IP range
cidrThe CIDR of the VLAN IP range
descriptionThe description of the VLAN IP range
domainThe domain name of the VLAN IP range
domainidThe domain ID of the VLAN IP range
domainpathPath of the domain to which the VLAN IP range belongs
endipThe end IP of the VLAN IP range
endipv6The end IPv6 of the VLAN IP range
forsystemvmsIndicates whether VLAN IP range is dedicated to System VMs or not
forvirtualnetworkThe virtual Network for the VLAN IP range
gatewayThe gateway of the VLAN IP range
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
netmaskThe netmask of the VLAN IP range
networkidThe Network ID of VLAN range
physicalnetworkidThe physical Network this belongs to
podidThe Pod ID for the VLAN IP range
podnameThe Pod name for the VLAN IP range
projectThe project name of the VLAN range
projectidThe project ID of the VLAN range
providerindicates to which provider the IP range is dedicated to
startipThe start IP of the VLAN IP range
startipv6The start IPv6 of the VLAN IP range
vlanThe ID or VID of the VLAN.
zoneidThe Zone ID of the VLAN IP range
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createVolume.html b/static/api/apidocs-4.23/apis/createVolume.html new file mode 100644 index 0000000000..c617c3af8b --- /dev/null +++ b/static/api/apidocs-4.23/apis/createVolume.html @@ -0,0 +1,345 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createVolume

+

Creates a disk volume from a disk offering. This disk volume must still be attached to an Instance to make use of it.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountThe Account associated with the disk volume. Must be used with the domainId parameter.false
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
diskofferingidThe ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.false
displayvolumeAn optional field, whether to display the volume to the end User or not.false
domainidThe 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
kmskeyidID of the KMS Key for volume encryption (required if encryption enabled for zone)false
maxiopsMax IOPSfalse
miniopsMin IOPSfalse
nameThe name of the disk volumefalse
projectidThe project associated with the volume. Mutually exclusive with Account parameterfalse
sizeArbitrary volume sizefalse
snapshotidThe Snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.false
storageidStorage pool ID to create the volume in. Cannot be used with the snapshotid parameter.false
virtualmachineidThe ID of the Instance; to be used with snapshot Id, Instance to which the volume gets attached after creationfalse
zoneidThe ID of the availability zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the disk volume
accountThe Account associated with the disk volume
attachedThe date the volume was attached to an Instance
chaininfoThe chain info of the volume
clusteridCluster id of the volume
clusternameCluster name where the volume is allocated
createdThe date the disk volume was created
deleteprotectiontrue if volume has delete protection.
destroyedThe boolean state of whether the volume is destroyed or not
deviceidThe ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
diskBytesReadRateBytes read rate of the disk volume
diskBytesWriteRateBytes write rate of the disk volume
diskIopsReadRateIO requests read rate of the disk volume per the disk offering
diskIopsWriteRateIO requests write rate of the disk volume per the disk offering
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingdisplaytextThe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnameName of the disk offering
displayvolumeAn optional field whether to the display the volume to the end User or not.
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathpath of the Domain the disk volume belongs to
encryptformatthe format of the disk encryption if applicable
externaluuidVolume UUID that is given by virtualisation provider (only for VMware)
hypervisorHypervisor the volume belongs to
isextractableTrue if the volume is extractable, false otherwise
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isonameThe name of the ISO attached to the Instance
kmskeyKMS key name of the volume
kmskeyidKMS key id of the volume
kmskeyversionVersion number of the KMS key used for disk encryption if applicable
maxiopsMax IOPS of the disk volume
miniopsMin IOPS of the disk volume
nameName of the disk volume
pathThe path of the volume
physicalsizeThe bytes actually consumed on disk
podidPod id of the volume
podnamePod name of the volume
projectThe project name of the VPN
projectidThe project id of the VPN
provisioningtypeProvisioning type used to create volumes.
quiescevmNeed quiesce Instance or not when taking Snapshot
serviceofferingdisplaytextThe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnameName of the service offering for root disk
sizeSize of the disk volume
snapshotidID of the Snapshot from which this volume was created
stateThe state of the disk volume
statusThe status of the volume
storageName of the primary storage hosting the disk volume
storageidID of the primary storage hosting the disk volume; returned to admin User only
storagetypeShared or local storage
supportsstoragesnapshotTrue if storage Snapshot is supported for the volume, false otherwise
templatedisplaytextAn alternate display text of the Template for the Instance
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
typeType of the disk volume (ROOT or DATADISK)
utilizationThe disk utilization
virtualmachineidID of the Instance
virtualsizeThe bytes allocated
vmdisplaynameDisplay name of the Instance
vmnameName of the Instance
vmstateState of the Instance
vmtypeType of the Instance
volumecheckresultdetails for the volume check result, they may vary for different hypervisors
volumerepairresultdetails for the volume repair result, they may vary for different hypervisors
zoneidID of the availability zone
zonenameName of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createVpnConnection.html b/static/api/apidocs-4.23/apis/createVpnConnection.html new file mode 100644 index 0000000000..81853ba534 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createVpnConnection.html @@ -0,0 +1,168 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createVpnConnection

+

Create site to site VPN connection

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
s2scustomergatewayidID of the customer gatewaytrue
s2svpngatewayidID of the VPN gatewaytrue
fordisplayAn optional field, whether to the display the VPN to the end User or notfalse
passiveConnection is passive or notfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe connection ID
accountThe owner
cidrlistGuest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).
createdThe date and time the host was created
domainThe domain name of the owner
domainidThe domain id of the owner
domainpaththe domain path of the owner
dpdIf DPD is enabled for customer gateway
esplifetimeLifetime of ESP SA of customer gateway
esppolicyESP policy of the customer gateway
forceencapIf Force NAT Encapsulation is enabled for customer gateway
fordisplayIs connection for display to the regular user
gatewayPublic IP address id of the customer gateway
ikelifetimeLifetime of IKE SA of customer gateway
ikepolicyIKE policy of the customer gateway
ikeversionWhich IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike
ipsecpskIPsec Preshared-Key of the customer gateway
passiveState of VPN connection
projectThe project name
projectidThe project id
publicipThe public IP address
removedThe date and time the host was removed
s2scustomergatewayidThe customer gateway ID
s2svpngatewayidThe VPN gateway ID
splitconnectionsSplit multiple remote Networks into multiple phase 2 SAs. Often used with Cisco some products.
stateState of VPN connection
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createVpnCustomerGateway.html b/static/api/apidocs-4.23/apis/createVpnCustomerGateway.html new file mode 100644 index 0000000000..51f489fd34 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createVpnCustomerGateway.html @@ -0,0 +1,192 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createVpnCustomerGateway

+

Creates site to site VPN customer gateway

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
cidrlistGuest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).true
esppolicyESP policy of the customer gatewaytrue
gatewayPublic IP address id of the customer gatewaytrue
ikepolicyIKE policy of the customer gatewaytrue
ipsecpskIPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.true
accountThe Account associated with the gateway. Must be used with the domainId parameter.false
domainidThe domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the Account for the specified domain.false
dpdIf DPD is enabled for VPN connectionfalse
esplifetimeLifetime of phase 2 VPN connection to the customer gateway, in secondsfalse
forceencapForce Encapsulation for NAT traversalfalse
ikelifetimeLifetime of phase 1 VPN connection to the customer gateway, in secondsfalse
ikeversionWhich 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 ikefalse
nameName of this customer gatewayfalse
projectidCreate site-to-site VPN customer gateway for the projectfalse
splitconnectionsFor IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe VPN gateway ID
accountThe owner
cidrlistGuest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).
domainThe domain name of the owner
domainidThe domain ID of the owner
domainpathThe domain path of the owner
dpdIf DPD is enabled for customer gateway
esplifetimeLifetime of ESP SA of customer gateway
esppolicyIPsec policy of customer gateway
excludedparametersContains the list of excluded/not allowed cryptographic parameters that the vpn customer gateway is using.
forceencapIf Force NAT Encapsulation is enabled for customer gateway
gatewayPublic IP address ID of the customer gateway
ikelifetimeLifetime of IKE SA of customer gateway
ikepolicyIKE policy of customer gateway
ikeversionWhich IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike
ipaddressGuest IP of the customer gateway
ipsecpskIPsec preshared-key of customer gateway
nameName of the customer gateway
obsoleteparametersContains the list of obsolete/insecure cryptographic parameters that the vpn customer gateway is using.
projectThe project name
projectidThe project ID
removedThe date and time the host was removed
splitconnectionsFor IKEv2, whether to split multiple right subnet CIDRs into multiple connection statements.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createVpnGateway.html b/static/api/apidocs-4.23/apis/createVpnGateway.html new file mode 100644 index 0000000000..0f4684a021 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createVpnGateway.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createVpnGateway

+

Creates site to site VPN local gateway

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
vpcidPublic IP address id of the VPN gatewaytrue
fordisplayAn optional field, whether to the display the VPN to the end User or notfalse
ipaddressidthe public IP address ID for which VPN gateway is being enabled. By default the source NAT IP or router IP will be used.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe VPN gateway ID
accountThe owner
domainThe domain name of the owner
domainidThe domain id of the owner
domainpaththe domain path of the owner
fordisplayIs VPN gateway for display to the regular user
projectThe project name
projectidThe project id
publicipThe public IP address
removedThe date and time the host was removed
vpcidThe VPC id of this gateway
vpcnameThe VPC name of this gateway
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createWebhook.html b/static/api/apidocs-4.23/apis/createWebhook.html new file mode 100644 index 0000000000..225197bbdd --- /dev/null +++ b/static/api/apidocs-4.23/apis/createWebhook.html @@ -0,0 +1,153 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createWebhook

+

Creates a Webhook

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName for the Webhooktrue
payloadurlPayload URL of the Webhooktrue
accountAn optional account for the Webhook. Must be used with domainId.false
descriptionDescription for the Webhookfalse
domainidan optional domainId for the Webhook. If the account parameter is used, domainId must also be used.false
projectidProject for the Webhookfalse
scopeScope of the Webhookfalse
secretkeySecret key of the Webhookfalse
sslverificationIf set to true then SSL verification will be done for the Webhook otherwise notfalse
stateState of the Webhookfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Webhook
accountThe account associated with the Webhook
createdThe date when this Webhook was created
descriptionThe description of the Webhook
domainThe name of the domain in which the Webhook exists
domainidThe ID of the domain in which the Webhook exists
domainpathpath of the domain to which the Webhook belongs
nameThe name of the Webhook
payloadurlThe payload URL end point for the Webhook
projectthe project name of the Kubernetes cluster
projectidthe project id of the Kubernetes cluster
scopeThe scope of the Webhook
secretkeyThe secret key for the Webhook
sslverificationWhether SSL verification is enabled for the Webhook
stateThe state of the Webhook
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/createZone.html b/static/api/apidocs-4.23/apis/createZone.html new file mode 100644 index 0000000000..6704a884e3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/createZone.html @@ -0,0 +1,306 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

createZone

+

Creates a Zone.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
dns1The first DNS for the Zonetrue
internaldns1The first internal DNS for the Zonetrue
nameThe name of the Zonetrue
networktypeNetwork type of the zone, can be Basic or Advancedtrue
allocationstateAllocation state of this Zone for allocation of new resourcesfalse
dns2The second DNS for the Zonefalse
domainNetwork domain name for the networks in the zonefalse
domainidThe ID of the containing domain, null for public zonesfalse
guestcidraddressThe guest CIDR address for the Zonefalse
internaldns2The second internal DNS for the Zonefalse
ip6dns1The first DNS for IPv6 network in the Zonefalse
ip6dns2The second DNS for IPv6 network in the Zonefalse
isedgeTrue if the zone is an edge zone, false otherwisefalse
localstorageenabledTrue if local storage offering enabled, false otherwisefalse
securitygroupenabledTrue if network is security group enabled, false otherwisefalse
storageaccessgroupscomma separated list of storage access groups for the hosts in the zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idZone id
allocationstateThe allocation state of the cluster
allowuserspecifyvrmtuAllow end users to specify VR MTU
asnrangeAS Number Range
descriptionZone description
dhcpproviderThe DHCP Provider for the Zone
displaytextThe display text of the zone
dns1The first DNS for the Zone
dns2The second DNS for the Zone
domainNetwork domain name for the Networks in the zone
domainidThe UUID of the containing domain, null for public zones
domainnameThe name of the containing domain, null for public zones
gputotalTotal GPUs in the Zone
gpuusedUsed GPUs in the Zone
guestcidraddressThe guest CIDR address for the Zone
iconBase64 string representation of the resource icon
internaldns1The first internal DNS for the Zone
internaldns2The second internal DNS for the Zone
ip6dns1The first IPv6 DNS for the Zone
ip6dns2The second IPv6 DNS for the Zone
ismultiarchTrue, if zone contains clusters and hosts from different CPU architectures
isnsxenabledTrue, if zone is NSX enabled
localstorageenabledTrue if local storage offering enabled, false otherwise
nameZone name
networktypeThe Network type of the zone; can be Basic or Advanced
providerExternal network provider if any
resourcedetailsMeta data associated with the zone (key/value pairs)
routedmodeenabledTrue, if routed Network/VPC is enabled
routerprivateinterfacemaxmtuThe maximum value the MTU can have on the VR's private interfaces
routerpublicinterfacemaxmtuThe maximum value the MTU can have on the VR's public interfaces
securitygroupsenabledTrue if security groups support is enabled, false otherwise
storageaccessgroupscomma-separated list of storage access groups for the zone
typeThe type of the zone - core or edge
zonetokenZone Token
capacity(*)The capacity of the Zone
capacityallocatedThe capacity currently in allocated
capacitytotalThe total capacity available
capacityusedThe capacity currently in use
clusteridThe Cluster ID
clusternameThe Cluster name
nameThe capacity name
percentusedThe percentage of capacity currently in use
podidThe Pod ID
podnameThe Pod name
tagThe tag for the capacity type
typeThe capacity type
zoneidThe Zone ID
zonenameThe Zone name
tags(*)The list of resource tags associated with zone.
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/declareHostAsDegraded.html b/static/api/apidocs-4.23/apis/declareHostAsDegraded.html new file mode 100644 index 0000000000..9c7176c082 --- /dev/null +++ b/static/api/apidocs-4.23/apis/declareHostAsDegraded.html @@ -0,0 +1,345 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

declareHostAsDegraded

+

Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no Instances running on the respective host otherwise this command might corrupted Instances that were running on the 'Degraded' host.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idHost IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the host
annotationThe last annotation set on this host by an admin
archCPU Arch of the host
capabilitiesCapabilities of the host
clusteridThe cluster ID of the host
clusternameThe cluster name of the host
clusterstorageaccessgroupscomma-separated list of storage access groups on the cluster
clustertypeThe cluster type of the cluster that host belongs to
cpuallocatedThe amount of the host's CPU currently allocated
cpuallocatedpercentageThe amount of the host's CPU currently allocated in percentage
cpuallocatedvalueThe amount of the host's CPU currently allocated in MHz
cpuallocatedwithoverprovisioningThe amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor
cpuloadaverageThe average CPU load on the host
cpunumberThe CPU number of the host
cpusocketsThe number of CPU sockets on the host
cpuspeedThe CPU speed of the host
cpuusedThe amount of the host's CPU currently used
cpuwithoverprovisioningThe amount of the host's CPU after applying the cpu.overprovisioning.factor
createdThe date and time the host was created
detailsHost details in key/value pairs.
disconnectedTrue if the host is disconnected. False otherwise.
disksizeallocatedThe host's currently allocated disk size
disksizetotalThe total disk size of the host
encryptionsupportedTrue if the host supports encryption
eventsEvents available for the host
explicithosttagscomma-separated list of explicit host tags for the host
extensionidThe ID of extension for this cluster
extensionnameThe name of extension for this cluster
gputotalTotal GPUs on the Host
gpuusedUsed GPUs on the Host
guestosrulethe guest OS rule
hahostTrue if the host is Ha host (dedicated to Instances started by HA process; false otherwise
hasenoughcapacityTrue if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise
hosthaThe host HA information information
hosttagsComma-separated list of tags for the host
hypervisorThe host hypervisor
hypervisorversionThe hypervisor version
implicithosttagscomma-separated list of implicit host tags for the host
instanceconversionsupportedtrue if the host supports instance conversion (using virt-v2v)
ipaddressThe IP address of the host
islocalstorageactiveTrue if local storage is active, false otherwise
istagaruleWhether the informed tag is a JS interpretable rule or not.
lastannotatedThe last time this host was annotated
lastpingedThe date and time the host was last pinged
managementserveridThe management server ID of the host
managementservernamethe management server name of the host
memoryallocatedThe amount of the host's memory currently allocated
memoryallocatedbytesThe amount of the host's memory currently allocated in bytes
memoryallocatedpercentageThe amount of the host's memory currently allocated in percentage
memorytotalThe memory total of the host, this parameter is deprecated use memorywithoverprovisioning
memoryusedThe amount of the host's memory currently used
memorywithoverprovisioningThe amount of the host's memory after applying the mem.overprovisioning.factor
msid(only for details=core) the msid of the host's management server
nameThe name of the host
networkkbsreadThe incoming Network traffic on the host
networkkbswriteThe outgoing Network traffic on the host
oscategoryidThe OS category ID of the host
oscategorynameThe OS category name of the host
outofbandmanagementThe host out-of-band management information
podidThe Pod ID of the host
podnameThe Pod name of the host
podstorageaccessgroupscomma-separated list of storage access groups on the pod
removedThe date and time the host was removed
resourcestateThe resource state of the host
stateThe state of the host
storageaccessgroupscomma-separated list of storage access groups for the host
suitableformigrationTrue if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise
typeThe host type
ueficapabilityTrue if the host has capability to support UEFI boot
usernameThe admin that annotated this host
versionThe host version
virtualmachineidthe virtual machine id for host type ConsoleProxy and SecondaryStorageVM
zoneidThe Zone ID of the host
zonenameThe Zone name of the host
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
gpugroup(*)GPU cards present in the host
gpugroupnameGPU cards present in the host
vgpu(*)The list of enabled vGPUs
maxcapacityMaximum vGPU can be created with this vGPU type on the given GPU group
maxheadsMaximum displays per user
maxresolutionxMaximum X resolution per display
maxresolutionyMaximum Y resolution per display
maxvgpuperpgpuMaximum no. of vGPU per GPU card (pgpu)
remainingcapacityRemaining capacity in terms of no. of more Instances that can be deployed with this vGPU type
vgputypeModel Name of vGPU
videoramVideo RAM for this vGPU type
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/dedicateBgpPeer.html b/static/api/apidocs-4.23/apis/dedicateBgpPeer.html new file mode 100644 index 0000000000..bc406f0f07 --- /dev/null +++ b/static/api/apidocs-4.23/apis/dedicateBgpPeer.html @@ -0,0 +1,132 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

dedicateBgpPeer

+

Dedicates an existing Bgp Peer to an account or a domain.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idId of the Bgp Peertrue
accountaccount who will own the Bgp Peerfalse
domainiddomain ID of the account owning the Bgp Peerfalse
projectidproject who will own the Bgp Peerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idid of the bgp peer
accountthe account of the bgp peer
asnumberAS number of bgp peer
createddate when this bgp peer was created.
detailsadditional key/value details of the bgp peer
domainthe domain name of the bgp peer
domainidthe domain ID of the bgp peer
ip6addressIPv6 address of bgp peer
ipaddressIPv4 address of bgp peer
passwordpassword of bgp peer
projectthe project name of the bgp peer
projectidthe project id of the bgp peer
zoneidid of zone to which the bgp peer belongs to.
zonenamename of zone to which the bgp peer belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/dedicateCluster.html b/static/api/apidocs-4.23/apis/dedicateCluster.html new file mode 100644 index 0000000000..e273310233 --- /dev/null +++ b/static/api/apidocs-4.23/apis/dedicateCluster.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

dedicateCluster

+

Dedicate an existing cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
clusteridThe ID of the Clustertrue
domainidThe ID of the containing domaintrue
accountThe name of the account which needs dedication. Must be used with domainId.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the dedicated resource
accountidThe Account ID of the cluster
affinitygroupidThe Dedication Affinity Group ID of the cluster
clusteridThe ID of the cluster
clusternameThe name of the cluster
domainidThe domain ID of the cluster
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/dedicateGuestVlanRange.html b/static/api/apidocs-4.23/apis/dedicateGuestVlanRange.html new file mode 100644 index 0000000000..095c30d855 --- /dev/null +++ b/static/api/apidocs-4.23/apis/dedicateGuestVlanRange.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

dedicateGuestVlanRange

+

Dedicates a guest vlan range to an account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
physicalnetworkidPhysical Network ID of the VLANtrue
vlanrangeGuest VLAN range to be dedicatedtrue
accountAccount who will own the VLANfalse
domainidDomain ID of the Account owning a VLANfalse
projectidProject who will own the VLANfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the guest VLAN range
accountThe Account of the guest VLAN range
domainThe domain name of the guest VLAN range
domainidThe domain ID of the guest VLAN range
domainpathpath of the domain to which the guest VLAN range belongs
guestvlanrangeThe guest VLAN range
physicalnetworkidThe physical Network of the guest VLAN range
projectThe project name of the guest VLAN range
projectidThe project id of the guest VLAN range
zoneidThe zone of the guest VLAN range
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/dedicateHost.html b/static/api/apidocs-4.23/apis/dedicateHost.html new file mode 100644 index 0000000000..8a5b8a14e5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/dedicateHost.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

dedicateHost

+

Dedicates a host.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
domainidThe ID of the containing domaintrue
hostidThe ID of the host to updatetrue
accountThe name of the account which needs dedication. Must be used with domainId.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the dedicated resource
accountidThe Account ID of the host
affinitygroupidThe Dedication Affinity Group ID of the host
domainidThe domain ID of the host
hostidThe ID of the host
hostnameThe name of the host
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/dedicateIpv4SubnetForZone.html b/static/api/apidocs-4.23/apis/dedicateIpv4SubnetForZone.html new file mode 100644 index 0000000000..a642eefb9c --- /dev/null +++ b/static/api/apidocs-4.23/apis/dedicateIpv4SubnetForZone.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

dedicateIpv4SubnetForZone

+

Dedicates an existing IPv4 subnet for a zone to an account or a domain.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idId of the guest network IPv4 subnettrue
accountaccount who will own the IPv4 subnetfalse
domainiddomain ID of the account owning the IPv4 subnetfalse
projectidproject who will own the IPv4 subnetfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idid of the guest IPv4 subnet
accountthe account of the IPv4 subnet
createddate when this IPv4 subnet was created.
domainthe domain name of the IPv4 subnet
domainidthe domain ID of the IPv4 subnet
projectthe project name of the IPv4 subnet
projectidthe project id of the IPv4 subnet
subnetguest IPv4 subnet
zoneidid of zone to which the IPv4 subnet belongs to.
zonenamename of zone to which the IPv4 subnet belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/dedicatePod.html b/static/api/apidocs-4.23/apis/dedicatePod.html new file mode 100644 index 0000000000..00c8d72005 --- /dev/null +++ b/static/api/apidocs-4.23/apis/dedicatePod.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

dedicatePod

+

Dedicates a Pod.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
domainidThe ID of the containing domaintrue
podidThe ID of the Podtrue
accountThe name of the account which needs dedication. Must be used with domainId.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the dedicated resource
accountidThe Account Id to which the Pod is dedicated
affinitygroupidThe Dedication Affinity Group ID of the pod
domainidThe domain ID to which the Pod is dedicated
podidThe ID of the Pod
podnameThe Name of the Pod
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/dedicatePublicIpRange.html b/static/api/apidocs-4.23/apis/dedicatePublicIpRange.html new file mode 100644 index 0000000000..db6527dc04 --- /dev/null +++ b/static/api/apidocs-4.23/apis/dedicatePublicIpRange.html @@ -0,0 +1,168 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

dedicatePublicIpRange

+

Dedicates a Public IP range to an account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the VLAN IP rangetrue
domainidDomain ID of the account owning a VLANtrue
accountAccount who will own the VLANfalse
projectidProject who will own the VLANfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the VLAN IP range
accountThe Account of the VLAN IP range
cidrThe CIDR of the VLAN IP range
descriptionThe description of the VLAN IP range
domainThe domain name of the VLAN IP range
domainidThe domain ID of the VLAN IP range
domainpathPath of the domain to which the VLAN IP range belongs
endipThe end IP of the VLAN IP range
endipv6The end IPv6 of the VLAN IP range
forsystemvmsIndicates whether VLAN IP range is dedicated to System VMs or not
forvirtualnetworkThe virtual Network for the VLAN IP range
gatewayThe gateway of the VLAN IP range
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
netmaskThe netmask of the VLAN IP range
networkidThe Network ID of VLAN range
physicalnetworkidThe physical Network this belongs to
podidThe Pod ID for the VLAN IP range
podnameThe Pod name for the VLAN IP range
projectThe project name of the VLAN range
projectidThe project ID of the VLAN range
providerindicates to which provider the IP range is dedicated to
startipThe start IP of the VLAN IP range
startipv6The start IPv6 of the VLAN IP range
vlanThe ID or VID of the VLAN.
zoneidThe Zone ID of the VLAN IP range
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/dedicateZone.html b/static/api/apidocs-4.23/apis/dedicateZone.html new file mode 100644 index 0000000000..18f8f80354 --- /dev/null +++ b/static/api/apidocs-4.23/apis/dedicateZone.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

dedicateZone

+

Dedicates a zones.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
domainidThe ID of the containing domaintrue
zoneidThe ID of the zonetrue
accountThe name of the account which needs dedication. Must be used with domainId.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the dedicated resource
accountidThe Account ID to which the Zone is dedicated
affinitygroupidThe Dedication Affinity Group ID of the zone
domainidThe domain ID to which the Zone is dedicated
zoneidThe ID of the Zone
zonenameThe Name of the Zone
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteASNRange.html b/static/api/apidocs-4.23/apis/deleteASNRange.html new file mode 100644 index 0000000000..963f817e73 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteASNRange.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteASNRange

+

deletes a range of Autonomous Systems for BGP Dynamic Routing

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the AS rangetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteAccount.html b/static/api/apidocs-4.23/apis/deleteAccount.html new file mode 100644 index 0000000000..cbaf134a62 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteAccount.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteAccount

+

Deletes an Account and all Users associated with this Account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idAccount idtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteAccountFromProject.html b/static/api/apidocs-4.23/apis/deleteAccountFromProject.html new file mode 100644 index 0000000000..afddd96768 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteAccountFromProject.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteAccountFromProject

+

Deletes Account from the project

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
accountName of the Account to be removed from the projecttrue
projectidID of the project to remove the Account fromtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteAffinityGroup.html b/static/api/apidocs-4.23/apis/deleteAffinityGroup.html new file mode 100644 index 0000000000..e6d0967b72 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteAffinityGroup.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteAffinityGroup

+

Deletes affinity group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountThe account of the affinity group. Must be specified with domain IDfalse
domainidThe domain ID of account owning the affinity groupfalse
idThe ID of the affinity group. Mutually exclusive with name parameterfalse
nameThe name of the affinity group. Mutually exclusive with ID parameterfalse
projectidThe project of the affinity groupfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteAlerts.html b/static/api/apidocs-4.23/apis/deleteAlerts.html new file mode 100644 index 0000000000..d2abf11769 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteAlerts.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteAlerts

+

Delete one or more alerts.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enddateEnd date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")false
idsThe IDs of the alertsfalse
startdateStart date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")false
typeDelete by alert typefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteAutoScalePolicy.html b/static/api/apidocs-4.23/apis/deleteAutoScalePolicy.html new file mode 100644 index 0000000000..98e9f7f126 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteAutoScalePolicy.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteAutoScalePolicy

+

Deletes a autoscale policy.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the autoscale policytrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteAutoScaleVmGroup.html b/static/api/apidocs-4.23/apis/deleteAutoScaleVmGroup.html new file mode 100644 index 0000000000..4cb8065a74 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteAutoScaleVmGroup.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteAutoScaleVmGroup

+

Deletes an autoscale Instance group.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the autoscale grouptrue
cleanupTrue if all VMs have to be cleaned up, false otherwisefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteAutoScaleVmProfile.html b/static/api/apidocs-4.23/apis/deleteAutoScaleVmProfile.html new file mode 100644 index 0000000000..e12ce86b88 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteAutoScaleVmProfile.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteAutoScaleVmProfile

+

Deletes a autoscale Instance profile.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the autoscale profiletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteBackup.html b/static/api/apidocs-4.23/apis/deleteBackup.html new file mode 100644 index 0000000000..3e0c357f40 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteBackup.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteBackup

+

Delete Instance backup

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the Instance backuptrue
forcedForce the deletion of backup which removes the entire backup chain but keep Instance in Backup Offeringfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteBackupOffering.html b/static/api/apidocs-4.23/apis/deleteBackupOffering.html new file mode 100644 index 0000000000..68b65e9f12 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteBackupOffering.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteBackupOffering

+

Deletes a backup offering

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the backup offeringtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteBackupRepository.html b/static/api/apidocs-4.23/apis/deleteBackupRepository.html new file mode 100644 index 0000000000..257a44d9e4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteBackupRepository.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteBackupRepository

+

delete a backup repository

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the backup repository to be deletedtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteBackupSchedule.html b/static/api/apidocs-4.23/apis/deleteBackupSchedule.html new file mode 100644 index 0000000000..90ab78c683 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteBackupSchedule.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteBackupSchedule

+

Deletes the backup schedule of a Instance

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the backup schedule to be deleted. It has precedence over the 'virtualmachineid' parameter, i.e., when the 'id' parameter is specified, the 'virtualmachineid' parameter will be ignored.false
virtualmachineidID of the VM from which all backup schedules will be deleted.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteBaremetalRct.html b/static/api/apidocs-4.23/apis/deleteBaremetalRct.html new file mode 100644 index 0000000000..d8e51a0be0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteBaremetalRct.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteBaremetalRct

+

Deletes baremetal rack configuration text

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idRCT idtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteBgpPeer.html b/static/api/apidocs-4.23/apis/deleteBgpPeer.html new file mode 100644 index 0000000000..ce447e38a6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteBgpPeer.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteBgpPeer

+

Deletes an existing Bgp Peer.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idId of the Bgp Peertrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteBigSwitchBcfDevice.html b/static/api/apidocs-4.23/apis/deleteBigSwitchBcfDevice.html new file mode 100644 index 0000000000..f802b0ef2f --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteBigSwitchBcfDevice.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteBigSwitchBcfDevice

+

delete a BigSwitch BCF Controller device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
bcfdeviceidBigSwitch device IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteBrocadeVcsDevice.html b/static/api/apidocs-4.23/apis/deleteBrocadeVcsDevice.html new file mode 100644 index 0000000000..2895ced8ef --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteBrocadeVcsDevice.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteBrocadeVcsDevice

+

delete a Brocade VCS Switch

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
vcsdeviceidBrocade Switch IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteBucket.html b/static/api/apidocs-4.23/apis/deleteBucket.html new file mode 100644 index 0000000000..1d086aa027 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteBucket.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteBucket

+

Deletes an empty Bucket.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Buckettrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteCiscoAsa1000vResource.html b/static/api/apidocs-4.23/apis/deleteCiscoAsa1000vResource.html new file mode 100644 index 0000000000..3118624b06 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteCiscoAsa1000vResource.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteCiscoAsa1000vResource

+

Deletes a Cisco ASA 1000v appliance

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
resourceidCisco ASA 1000v resource IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteCiscoNexusVSM.html b/static/api/apidocs-4.23/apis/deleteCiscoNexusVSM.html new file mode 100644 index 0000000000..f4ede179c6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteCiscoNexusVSM.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteCiscoNexusVSM

+

delete a Cisco Nexus VSM device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idId of the Cisco Nexus 1000v VSM device to be deletedtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteCiscoVnmcResource.html b/static/api/apidocs-4.23/apis/deleteCiscoVnmcResource.html new file mode 100644 index 0000000000..5df0da2da6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteCiscoVnmcResource.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteCiscoVnmcResource

+

Deletes a Cisco Vnmc controller

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
resourceidCisco Vnmc resource IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteCluster.html b/static/api/apidocs-4.23/apis/deleteCluster.html new file mode 100644 index 0000000000..c6ce03bfa8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteCluster.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteCluster

+

Deletes a cluster.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe cluster IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteCniConfiguration.html b/static/api/apidocs-4.23/apis/deleteCniConfiguration.html new file mode 100644 index 0000000000..5a817941a7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteCniConfiguration.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteCniConfiguration

+

Deletes a CNI Configuration

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Userdatatrue
accountAn optional account for the userdata. Must be used with domainId.false
domainidAn optional domainId for the userdata. If the account parameter is used, domainId must also be used.false
projectidAn optional project for the userdatafalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteCondition.html b/static/api/apidocs-4.23/apis/deleteCondition.html new file mode 100644 index 0000000000..86d4626cc2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteCondition.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteCondition

+

Removes a condition for Instance auto scaling

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the condition.true
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteCounter.html b/static/api/apidocs-4.23/apis/deleteCounter.html new file mode 100644 index 0000000000..1c644126b1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteCounter.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteCounter

+

Deletes a counter for Instance auto scaling

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the countertrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteCustomAction.html b/static/api/apidocs-4.23/apis/deleteCustomAction.html new file mode 100644 index 0000000000..3b26571b66 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteCustomAction.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteCustomAction

+

Delete the custom action

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
iduuid of the custom actionfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteDiskOffering.html b/static/api/apidocs-4.23/apis/deleteDiskOffering.html new file mode 100644 index 0000000000..b12adab5ad --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteDiskOffering.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteDiskOffering

+

Updates a disk offering.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the disk offeringtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteDnsRecord.html b/static/api/apidocs-4.23/apis/deleteDnsRecord.html new file mode 100644 index 0000000000..b88eda8872 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteDnsRecord.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteDnsRecord

+

Deletes a DNS record from the external provider

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
dnszoneidThe ID of the DNS zonetrue
nametrue
typetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteDnsServer.html b/static/api/apidocs-4.23/apis/deleteDnsServer.html new file mode 100644 index 0000000000..f53ad80c4b --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteDnsServer.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteDnsServer

+

Removes a DNS server integration

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the DNS servertrue
cleanupIf true, all associated DNS zones will be cleaned up when the server is removed. Default: truefalse
unmanageIf true, the DNS zone is only removed from CloudStack (unmanaged); if false, it is removed from both CloudStack and the DNS provider. Default: falsefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteDnsZone.html b/static/api/apidocs-4.23/apis/deleteDnsZone.html new file mode 100644 index 0000000000..ecee5a0e65 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteDnsZone.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteDnsZone

+

Removes a DNS Zone from CloudStack and the external provider

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the DNS zonetrue
unmanageIf true, removes the DNS zone only from CloudStack; if false, removes it from both CloudStack and the DNS provider. Default: falsefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteDomain.html b/static/api/apidocs-4.23/apis/deleteDomain.html new file mode 100644 index 0000000000..359f39c990 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteDomain.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteDomain

+

Deletes a specified domain

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idID of domain to deletetrue
cleanupTrue if all domain resources (child domains, Accounts) have to be cleaned up, false otherwisefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteEgressFirewallRule.html b/static/api/apidocs-4.23/apis/deleteEgressFirewallRule.html new file mode 100644 index 0000000000..4fe93e426c --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteEgressFirewallRule.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteEgressFirewallRule

+

Deletes an egress firewall rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the firewall ruletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteEvents.html b/static/api/apidocs-4.23/apis/deleteEvents.html new file mode 100644 index 0000000000..7ec3657e25 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteEvents.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteEvents

+

Delete one or more events.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enddateEnd date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")false
idsThe IDs of the eventsfalse
startdateStart date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")false
typeDelete by event typefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteExtension.html b/static/api/apidocs-4.23/apis/deleteExtension.html new file mode 100644 index 0000000000..c6bfd1d377 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteExtension.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteExtension

+

Delete the extensions

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
cleanupWhether to cleanup files for the extension. If true, the extension files will be deleted from all the management servers.false
idID of the extensionfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the extension
createdCreation timestamp of the extension
descriptionDescription of the extension
detailsThe details of the extension
isuserdefinedTrue if the extension is added by admin
nameName of the extension
pathThe path of the entry point fo the extension
pathreadyTrue if the extension path is in ready state across management servers
removedRemoval timestamp of the extension, if applicable
reservedresourcedetailsResource detail names as comma separated string that should be reserved and not visible to end users
stateThe state of the extension
typeType of the extension
resources(*)List of resources to which extension is registered to
idID of the resource associated with the extension
createdCreation timestamp of the mapping
detailsthe details of the resource map
nameName of the resource associated with this mapping
typeType of the resource
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteFirewallRule.html b/static/api/apidocs-4.23/apis/deleteFirewallRule.html new file mode 100644 index 0000000000..84dfd26ecb --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteFirewallRule.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteFirewallRule

+

Deletes a firewall rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the firewall ruletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteGlobalLoadBalancerRule.html b/static/api/apidocs-4.23/apis/deleteGlobalLoadBalancerRule.html new file mode 100644 index 0000000000..308d61a57e --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteGlobalLoadBalancerRule.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteGlobalLoadBalancerRule

+

Deletes a global load balancer rule.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the global load balancer ruletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteGpuCard.html b/static/api/apidocs-4.23/apis/deleteGpuCard.html new file mode 100644 index 0000000000..3718877016 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteGpuCard.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteGpuCard

+

Deletes a GPU card definition from the system

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the GPU cardtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteGpuDevice.html b/static/api/apidocs-4.23/apis/deleteGpuDevice.html new file mode 100644 index 0000000000..511112ba4c --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteGpuDevice.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteGpuDevice

+

Deletes a vGPU profile from the system

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idscomma separated list of IDs of the GPU devicetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteGuestNetworkIpv6Prefix.html b/static/api/apidocs-4.23/apis/deleteGuestNetworkIpv6Prefix.html new file mode 100644 index 0000000000..65aca4819d --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteGuestNetworkIpv6Prefix.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteGuestNetworkIpv6Prefix

+

Deletes an existing guest network IPv6 prefix.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idId of the guest network IPv6 prefixtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteHSMProfile.html b/static/api/apidocs-4.23/apis/deleteHSMProfile.html new file mode 100644 index 0000000000..a376132149 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteHSMProfile.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteHSMProfile

+

Deletes an HSM profile

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the HSM profiletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteHost.html b/static/api/apidocs-4.23/apis/deleteHost.html new file mode 100644 index 0000000000..c191155afe --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteHost.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteHost

+

Deletes a host.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe host IDtrue
forcedForce delete the host. All HA enabled Instances running on the host will be put to HA; HA disabled ones will be stoppedfalse
forcedestroylocalstorageForce destroy local storage on this host. All Instances created on this local storage will be destroyedfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteImageStore.html b/static/api/apidocs-4.23/apis/deleteImageStore.html new file mode 100644 index 0000000000..f2a90bd798 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteImageStore.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteImageStore

+

Deletes an image store or Secondary Storage.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe image store ID or Secondary Storage ID.true
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteInstanceGroup.html b/static/api/apidocs-4.23/apis/deleteInstanceGroup.html new file mode 100644 index 0000000000..12078676de --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteInstanceGroup.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteInstanceGroup

+

Deletes an Instance group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instance grouptrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteIpForwardingRule.html b/static/api/apidocs-4.23/apis/deleteIpForwardingRule.html new file mode 100644 index 0000000000..29c1a9f8fe --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteIpForwardingRule.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteIpForwardingRule

+

Deletes an IP forwarding rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the forwarding ruletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteIpv4SubnetForGuestNetwork.html b/static/api/apidocs-4.23/apis/deleteIpv4SubnetForGuestNetwork.html new file mode 100644 index 0000000000..893be9e98d --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteIpv4SubnetForGuestNetwork.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteIpv4SubnetForGuestNetwork

+

Deletes an existing IPv4 subnet for guest network.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idId of the guest network IPv4 subnettrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteIpv4SubnetForZone.html b/static/api/apidocs-4.23/apis/deleteIpv4SubnetForZone.html new file mode 100644 index 0000000000..e53e99fb38 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteIpv4SubnetForZone.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteIpv4SubnetForZone

+

Deletes an existing IPv4 subnet for a zone.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idId of the guest network IPv4 subnettrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteIpv6FirewallRule.html b/static/api/apidocs-4.23/apis/deleteIpv6FirewallRule.html new file mode 100644 index 0000000000..f8e59bb900 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteIpv6FirewallRule.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteIpv6FirewallRule

+

Deletes a IPv6 firewall rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the IPv6 firewall ruletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteIso.html b/static/api/apidocs-4.23/apis/deleteIso.html new file mode 100644 index 0000000000..ad8d643aae --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteIso.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteIso

+

Deletes an ISO file.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the ISO filetrue
zoneidThe ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zonesfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteKMSKey.html b/static/api/apidocs-4.23/apis/deleteKMSKey.html new file mode 100644 index 0000000000..b218bf476b --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteKMSKey.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteKMSKey

+

Deletes a KMS key (only if not in use)

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe UUID of the KMS key to deletetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteKubernetesCluster.html b/static/api/apidocs-4.23/apis/deleteKubernetesCluster.html new file mode 100644 index 0000000000..c0075727bb --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteKubernetesCluster.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteKubernetesCluster

+

Deletes a Kubernetes cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Kubernetes clustertrue
cleanupDestroy attached instances of the ExternalManaged Cluster. Default: falsefalse
expungeExpunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: falsefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteKubernetesSupportedVersion.html b/static/api/apidocs-4.23/apis/deleteKubernetesSupportedVersion.html new file mode 100644 index 0000000000..4b67f1ac98 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteKubernetesSupportedVersion.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteKubernetesSupportedVersion

+

Deletes a Kubernetes cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Kubernetes supported versiontrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteLBHealthCheckPolicy.html b/static/api/apidocs-4.23/apis/deleteLBHealthCheckPolicy.html new file mode 100644 index 0000000000..e7c210803e --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteLBHealthCheckPolicy.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteLBHealthCheckPolicy

+

Deletes a load balancer health check policy.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the load balancer health check policytrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteLBStickinessPolicy.html b/static/api/apidocs-4.23/apis/deleteLBStickinessPolicy.html new file mode 100644 index 0000000000..7495ec0df1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteLBStickinessPolicy.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteLBStickinessPolicy

+

Deletes a load balancer stickiness policy.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the LB stickiness policytrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteLdapConfiguration.html b/static/api/apidocs-4.23/apis/deleteLdapConfiguration.html new file mode 100644 index 0000000000..e3f54ec53a --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteLdapConfiguration.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteLdapConfiguration

+

Remove an Ldap Configuration

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
domainidLinked Domainfalse
hostnameHostnamefalse
idID of the LDAP configurationfalse
portPortfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the LDAP configuration
domainidLinked domain
hostnameName of the host running the LDAP server
portPort the LDAP server is running on
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteLoadBalancer.html b/static/api/apidocs-4.23/apis/deleteLoadBalancer.html new file mode 100644 index 0000000000..7a85ed124e --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteLoadBalancer.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteLoadBalancer

+

Deletes an internal load balancer

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Load Balancertrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteLoadBalancerRule.html b/static/api/apidocs-4.23/apis/deleteLoadBalancerRule.html new file mode 100644 index 0000000000..d36c481f04 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteLoadBalancerRule.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteLoadBalancerRule

+

Deletes a load balancer rule.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the load balancer ruletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteManagementNetworkIpRange.html b/static/api/apidocs-4.23/apis/deleteManagementNetworkIpRange.html new file mode 100644 index 0000000000..200dd69b02 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteManagementNetworkIpRange.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteManagementNetworkIpRange

+

Deletes a management network IP range. This action is only allowed when no IPs in this range are allocated.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
endipThe ending IP address.true
podidUUID of POD, where the IP range belongs to.true
startipThe starting IP address.true
vlanThe vlan id the ip range sits ontrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteNetrisProvider.html b/static/api/apidocs-4.23/apis/deleteNetrisProvider.html new file mode 100644 index 0000000000..08617a7a49 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteNetrisProvider.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteNetrisProvider

+

delete Netris Provider to CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idNetris Provider IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameNetris Provider name
netristagNetris Tag for vNets
netrisurlNetris Provider URL
sitenameNetris Provider site
tenantnameNetris Admin tenant name
uuidNetris provider uuid
zoneidZone ID to which the Netris Provider is associated with
zonenameZone name to which the Netris Provider is associated with
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteNetscalerControlCenter.html b/static/api/apidocs-4.23/apis/deleteNetscalerControlCenter.html new file mode 100644 index 0000000000..2ae64c9ce2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteNetscalerControlCenter.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteNetscalerControlCenter

+

Delete Netscaler Control Center

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idNetscaler Control Center IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteNetscalerLoadBalancer.html b/static/api/apidocs-4.23/apis/deleteNetscalerLoadBalancer.html new file mode 100644 index 0000000000..019392cec7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteNetscalerLoadBalancer.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteNetscalerLoadBalancer

+

delete a netscaler load balancer device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
lbdeviceidNetscaler load balancer device IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteNetwork.html b/static/api/apidocs-4.23/apis/deleteNetwork.html new file mode 100644 index 0000000000..6b3af77a96 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteNetwork.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteNetwork

+

Deletes a Network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the networktrue
forcedForce delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteNetworkACL.html b/static/api/apidocs-4.23/apis/deleteNetworkACL.html new file mode 100644 index 0000000000..fc5ad250dc --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteNetworkACL.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteNetworkACL

+

Deletes a Network ACL

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Network ACLtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteNetworkACLList.html b/static/api/apidocs-4.23/apis/deleteNetworkACLList.html new file mode 100644 index 0000000000..57433025d5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteNetworkACLList.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteNetworkACLList

+

Deletes a network ACL

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the network ACLtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteNetworkDevice.html b/static/api/apidocs-4.23/apis/deleteNetworkDevice.html new file mode 100644 index 0000000000..de46604803 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteNetworkDevice.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteNetworkDevice

+

Deletes network device.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idId of network device to deletetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteNetworkOffering.html b/static/api/apidocs-4.23/apis/deleteNetworkOffering.html new file mode 100644 index 0000000000..ea32f1201b --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteNetworkOffering.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteNetworkOffering

+

Deletes a network offering.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the network offeringtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteNetworkServiceProvider.html b/static/api/apidocs-4.23/apis/deleteNetworkServiceProvider.html new file mode 100644 index 0000000000..2e3f48ac82 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteNetworkServiceProvider.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteNetworkServiceProvider

+

Deletes a Network Service Provider.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the network service providertrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteNiciraNvpDevice.html b/static/api/apidocs-4.23/apis/deleteNiciraNvpDevice.html new file mode 100644 index 0000000000..050a003d78 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteNiciraNvpDevice.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteNiciraNvpDevice

+

delete a nicira nvp device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
nvpdeviceidNicira device IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteNsxController.html b/static/api/apidocs-4.23/apis/deleteNsxController.html new file mode 100644 index 0000000000..d62095ebb5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteNsxController.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteNsxController

+

delete NSX Controller to CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
nsxcontrolleridNSX Controller IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
edgeclusterThe name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX
hostnameNSX controller hostname or IP address
nameNSX controller name
nsxprovideruuidNSX controller ID
portNSX controller port
tier0gatewayThe tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks
transportzoneThe name of the transport zone. A transport zone controls to which hosts a logical switch can reach
zoneidZone ID to which the NSX controller is associated with
zonenameZone name to which the NSX controller is associated with
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteOauthProvider.html b/static/api/apidocs-4.23/apis/deleteOauthProvider.html new file mode 100644 index 0000000000..5b1304ea16 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteOauthProvider.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteOauthProvider

+

Deletes the registered OAuth provider

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idid of the OAuth provider to be deletedtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteObjectStoragePool.html b/static/api/apidocs-4.23/apis/deleteObjectStoragePool.html new file mode 100644 index 0000000000..3866a6dea9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteObjectStoragePool.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteObjectStoragePool

+

Deletes an Object Storage Pool

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe Object Storage ID.true
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteOpenDaylightController.html b/static/api/apidocs-4.23/apis/deleteOpenDaylightController.html new file mode 100644 index 0000000000..078bc1a5bd --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteOpenDaylightController.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteOpenDaylightController

+

Removes an OpenDyalight controler

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idOpenDaylight Controller IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idDevice ID of the controller
nameThe name assigned to the controller
physicalnetworkidThe physical Network to which this controller belongs to
urlThe URL of the controller API
usernameThe username to authenticate to the controller
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteOsCategory.html b/static/api/apidocs-4.23/apis/deleteOsCategory.html new file mode 100644 index 0000000000..46213bf45b --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteOsCategory.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteOsCategory

+

Deletes an OS category

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the OS categorytrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deletePaloAltoFirewall.html b/static/api/apidocs-4.23/apis/deletePaloAltoFirewall.html new file mode 100644 index 0000000000..9604416b5a --- /dev/null +++ b/static/api/apidocs-4.23/apis/deletePaloAltoFirewall.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deletePaloAltoFirewall

+

delete a Palo Alto firewall device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
fwdeviceidPalo Alto firewall device IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deletePhysicalNetwork.html b/static/api/apidocs-4.23/apis/deletePhysicalNetwork.html new file mode 100644 index 0000000000..e707c6eb6d --- /dev/null +++ b/static/api/apidocs-4.23/apis/deletePhysicalNetwork.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deletePhysicalNetwork

+

Deletes a Physical Network.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Physical networktrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deletePod.html b/static/api/apidocs-4.23/apis/deletePod.html new file mode 100644 index 0000000000..40b98df827 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deletePod.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deletePod

+

Deletes a Pod.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Podtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deletePortForwardingRule.html b/static/api/apidocs-4.23/apis/deletePortForwardingRule.html new file mode 100644 index 0000000000..027a7364ad --- /dev/null +++ b/static/api/apidocs-4.23/apis/deletePortForwardingRule.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deletePortForwardingRule

+

Deletes a port forwarding rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the port forwarding ruletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deletePortableIpRange.html b/static/api/apidocs-4.23/apis/deletePortableIpRange.html new file mode 100644 index 0000000000..7132c18740 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deletePortableIpRange.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deletePortableIpRange

+

Deletes a range of portable public IP's associated with a region

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idId of the portable ip rangetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deletePrivateGateway.html b/static/api/apidocs-4.23/apis/deletePrivateGateway.html new file mode 100644 index 0000000000..c59c29644b --- /dev/null +++ b/static/api/apidocs-4.23/apis/deletePrivateGateway.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deletePrivateGateway

+

Deletes a Private gateway

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the private gatewaytrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteProject.html b/static/api/apidocs-4.23/apis/deleteProject.html new file mode 100644 index 0000000000..7e5d9516bf --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteProject.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteProject

+

Deletes a project

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the project to be deletedtrue
cleanupTrue if all project resources have to be cleaned up, false otherwisefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteProjectInvitation.html b/static/api/apidocs-4.23/apis/deleteProjectInvitation.html new file mode 100644 index 0000000000..074748d94f --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteProjectInvitation.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteProjectInvitation

+

Deletes project invitation

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the invitationtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteProjectRole.html b/static/api/apidocs-4.23/apis/deleteProjectRole.html new file mode 100644 index 0000000000..f14afd9653 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteProjectRole.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteProjectRole

+

Delete Project roles in CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the project role to be deletedtrue
projectidID of the project from where the role is to be deletedtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteProjectRolePermission.html b/static/api/apidocs-4.23/apis/deleteProjectRolePermission.html new file mode 100644 index 0000000000..afa2613c13 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteProjectRolePermission.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteProjectRolePermission

+

Deletes a project role permission in the project

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the project role permission to be deletedtrue
projectidID of the project where the project role permission is to be deletedtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteRemoteAccessVpn.html b/static/api/apidocs-4.23/apis/deleteRemoteAccessVpn.html new file mode 100644 index 0000000000..778e9fbb31 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteRemoteAccessVpn.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteRemoteAccessVpn

+

Destroys a l2tp/ipsec remote access VPN

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
publicipidPublic IP address id of the VPN servertrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteResourceIcon.html b/static/api/apidocs-4.23/apis/deleteResourceIcon.html new file mode 100644 index 0000000000..febbbef995 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteResourceIcon.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteResourceIcon

+

Deletes the resource icon from the specified resource(s)

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
resourceidsList of resources to upload the icon/image fortrue
resourcetypeType of the resourcetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteResourceSchedule.html b/static/api/apidocs-4.23/apis/deleteResourceSchedule.html new file mode 100644 index 0000000000..db3593ae35 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteResourceSchedule.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteResourceSchedule

+

Delete Resource Schedule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
resourceidID of the resource for which schedules are to be deletedtrue
resourcetypeType of the resourcetrue
idID of the schedule to be deletedfalse
idscomma separated list of schedule ids to be deletedfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteRole.html b/static/api/apidocs-4.23/apis/deleteRole.html new file mode 100644 index 0000000000..f6217e850b --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteRole.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteRole

+

Deletes a role

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the roletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteRolePermission.html b/static/api/apidocs-4.23/apis/deleteRolePermission.html new file mode 100644 index 0000000000..1cedcfbf33 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteRolePermission.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteRolePermission

+

Deletes a role permission

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the role permissiontrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteRoutingFirewallRule.html b/static/api/apidocs-4.23/apis/deleteRoutingFirewallRule.html new file mode 100644 index 0000000000..3cc03f80bb --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteRoutingFirewallRule.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteRoutingFirewallRule

+

Deletes a routing firewall rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the Routing firewall ruletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteSSHKeyPair.html b/static/api/apidocs-4.23/apis/deleteSSHKeyPair.html new file mode 100644 index 0000000000..217f1ff9b4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteSSHKeyPair.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteSSHKeyPair

+

Deletes a keypair by name

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of the keypairtrue
accountThe Account associated with the keypair. Must be used with the domainId parameter.false
domainidThe domain ID associated with the keypairfalse
projectidThe project associated with keypairfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteSecondaryStagingStore.html b/static/api/apidocs-4.23/apis/deleteSecondaryStagingStore.html new file mode 100644 index 0000000000..216ba0ea0e --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteSecondaryStagingStore.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteSecondaryStagingStore

+

Deletes a secondary staging store .

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe staging store IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteSecurityGroup.html b/static/api/apidocs-4.23/apis/deleteSecurityGroup.html new file mode 100644 index 0000000000..b726574a17 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteSecurityGroup.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteSecurityGroup

+

Deletes security group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountThe account of the security group. Must be specified with domain IDfalse
domainidThe domain ID of account owning the security groupfalse
idThe ID of the security group. Mutually exclusive with name parameterfalse
nameThe ID of the security group. Mutually exclusive with id parameterfalse
projectidThe project of the security groupfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteServiceOffering.html b/static/api/apidocs-4.23/apis/deleteServiceOffering.html new file mode 100644 index 0000000000..5f9d4f801b --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteServiceOffering.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteServiceOffering

+

Deletes a service offering.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the service offeringtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteServicePackageOffering.html b/static/api/apidocs-4.23/apis/deleteServicePackageOffering.html new file mode 100644 index 0000000000..18ee3a34cd --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteServicePackageOffering.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteServicePackageOffering

+

Delete Service Package

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe service offering IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteSnapshot.html b/static/api/apidocs-4.23/apis/deleteSnapshot.html new file mode 100644 index 0000000000..53dd0a504c --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteSnapshot.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteSnapshot

+

Deletes a Snapshot of a disk volume.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Snapshottrue
zoneidThe ID of the zone for the snapshotfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteSnapshotPolicies.html b/static/api/apidocs-4.23/apis/deleteSnapshotPolicies.html new file mode 100644 index 0000000000..7f4270e81b --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteSnapshotPolicies.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteSnapshotPolicies

+

Deletes Snapshot policies for the account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Snapshot policyfalse
idsList of Snapshots policy IDs separated by commafalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteSslCert.html b/static/api/apidocs-4.23/apis/deleteSslCert.html new file mode 100644 index 0000000000..0053967fe6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteSslCert.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteSslCert

+

Delete a certificate to CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idId of SSL certificatetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteStaticRoute.html b/static/api/apidocs-4.23/apis/deleteStaticRoute.html new file mode 100644 index 0000000000..a65c9eb009 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteStaticRoute.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteStaticRoute

+

Deletes a static route

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the static routetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteStorageNetworkIpRange.html b/static/api/apidocs-4.23/apis/deleteStorageNetworkIpRange.html new file mode 100644 index 0000000000..9fb6e02407 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteStorageNetworkIpRange.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteStorageNetworkIpRange

+

Deletes a storage network IP Range.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe UUID of the storage network IP rangetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteStoragePool.html b/static/api/apidocs-4.23/apis/deleteStoragePool.html new file mode 100644 index 0000000000..6214adee07 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteStoragePool.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteStoragePool

+

Deletes a storage pool.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idStorage pool idtrue
forcedForce destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal)false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteStratosphereSsp.html b/static/api/apidocs-4.23/apis/deleteStratosphereSsp.html new file mode 100644 index 0000000000..4466d6ea9b --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteStratosphereSsp.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteStratosphereSsp

+

Removes stratosphere ssp server

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
hostidThe host ID of ssp servertrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteTags.html b/static/api/apidocs-4.23/apis/deleteTags.html new file mode 100644 index 0000000000..2e69c9b7bf --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteTags.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteTags

+

Deleting resource tag(s)

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
resourceidsDelete tags for resource id(s)true
resourcetypeDelete tag by resource typetrue
tagsDelete tags matching key/value pairsfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteTemplate.html b/static/api/apidocs-4.23/apis/deleteTemplate.html new file mode 100644 index 0000000000..ad07b17853 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteTemplate.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteTemplate

+

Deletes a Template from the system. All Instances using the deleted Template will not be affected.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Templatetrue
forcedForce delete a Template.false
issystemNecessary if the template's type is system.false
zoneidThe ID of zone of the Templatefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteTrafficMonitor.html b/static/api/apidocs-4.23/apis/deleteTrafficMonitor.html new file mode 100644 index 0000000000..f720db8307 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteTrafficMonitor.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteTrafficMonitor

+

Deletes an traffic monitor host.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idId of the Traffic Monitor Host.true
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteTrafficType.html b/static/api/apidocs-4.23/apis/deleteTrafficType.html new file mode 100644 index 0000000000..ef67f1519a --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteTrafficType.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteTrafficType

+

Deletes traffic type of a physical network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idTraffic type IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteTungstenFabricAddressGroup.html b/static/api/apidocs-4.23/apis/deleteTungstenFabricAddressGroup.html new file mode 100644 index 0000000000..cf0efb172e --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteTungstenFabricAddressGroup.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteTungstenFabricAddressGroup

+

Delete Tungsten-Fabric address group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
addressgroupuuidThe UUID of Tungsten-Fabric address grouptrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteTungstenFabricApplicationPolicySet.html b/static/api/apidocs-4.23/apis/deleteTungstenFabricApplicationPolicySet.html new file mode 100644 index 0000000000..1c51b1a1fd --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteTungstenFabricApplicationPolicySet.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteTungstenFabricApplicationPolicySet

+

Delete Tungsten-Fabric application policy set

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
applicationpolicysetuuidThe UUID of Tungsten-Fabric application policy settrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteTungstenFabricFirewallPolicy.html b/static/api/apidocs-4.23/apis/deleteTungstenFabricFirewallPolicy.html new file mode 100644 index 0000000000..85c447e7c0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteTungstenFabricFirewallPolicy.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteTungstenFabricFirewallPolicy

+

Delete Tungsten-Fabric firewall policy

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
firewallpolicyuuidThe uuid of Tungsten-Fabric firewall policytrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteTungstenFabricFirewallRule.html b/static/api/apidocs-4.23/apis/deleteTungstenFabricFirewallRule.html new file mode 100644 index 0000000000..9ba3dee008 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteTungstenFabricFirewallRule.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteTungstenFabricFirewallRule

+

Delete Tungsten-Fabric firewall rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
firewallruleuuidThe uuid of Tungsten-Fabric firewall ruletrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteTungstenFabricLogicalRouter.html b/static/api/apidocs-4.23/apis/deleteTungstenFabricLogicalRouter.html new file mode 100644 index 0000000000..840cddf03b --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteTungstenFabricLogicalRouter.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteTungstenFabricLogicalRouter

+

Delete Tungsten-Fabric logical router

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
logicalrouteruuidThe uuid of Tungsten-Fabric logical routertrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteTungstenFabricPolicy.html b/static/api/apidocs-4.23/apis/deleteTungstenFabricPolicy.html new file mode 100644 index 0000000000..2fb9719b69 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteTungstenFabricPolicy.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteTungstenFabricPolicy

+

Delete Tungsten-Fabric policy

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
policyuuidThe Uuid of Tungsten-Fabric tag typetrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteTungstenFabricServiceGroup.html b/static/api/apidocs-4.23/apis/deleteTungstenFabricServiceGroup.html new file mode 100644 index 0000000000..4f94d35e1f --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteTungstenFabricServiceGroup.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteTungstenFabricServiceGroup

+

Delete Tungsten-Fabric service group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
servicegroupuuidThe uuid of Tungsten-Fabric service grouptrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteTungstenFabricTag.html b/static/api/apidocs-4.23/apis/deleteTungstenFabricTag.html new file mode 100644 index 0000000000..79813e0349 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteTungstenFabricTag.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteTungstenFabricTag

+

Delete Tungsten-Fabric tag

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
taguuidThe uuid of Tungsten-Fabric tagtrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteTungstenFabricTagType.html b/static/api/apidocs-4.23/apis/deleteTungstenFabricTagType.html new file mode 100644 index 0000000000..22e2a439f9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteTungstenFabricTagType.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteTungstenFabricTagType

+

Delete Tungsten-Fabric tag type

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
tagtypeuuidThe ID of Tungsten-Fabric tag typetrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteUcsManager.html b/static/api/apidocs-4.23/apis/deleteUcsManager.html new file mode 100644 index 0000000000..a71bcc7703 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteUcsManager.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteUcsManager

+

Delete a Ucs manager

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
ucsmanageridUcs manager IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteUser.html b/static/api/apidocs-4.23/apis/deleteUser.html new file mode 100644 index 0000000000..80c90e85dd --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteUser.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteUser

+

Deletes a user for an account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the user to be deletedtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteUserData.html b/static/api/apidocs-4.23/apis/deleteUserData.html new file mode 100644 index 0000000000..ff6c2a0b0f --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteUserData.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteUserData

+

Deletes a userdata

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Userdatatrue
accountAn optional account for the userdata. Must be used with domainId.false
domainidAn optional domainId for the userdata. If the account parameter is used, domainId must also be used.false
projectidAn optional project for the userdatafalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteUserFromProject.html b/static/api/apidocs-4.23/apis/deleteUserFromProject.html new file mode 100644 index 0000000000..867994ea70 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteUserFromProject.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteUserFromProject

+

Deletes User from the project

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
projectidID of the project to remove the User fromtrue
useridId of the User to be removed from the projecttrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteUserKeys.html b/static/api/apidocs-4.23/apis/deleteUserKeys.html new file mode 100644 index 0000000000..74630fbdfa --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteUserKeys.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteUserKeys

+

Deletes a keypair from a user

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
keypairidID of the keypair to be deleted.true
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteVMSchedule.html b/static/api/apidocs-4.23/apis/deleteVMSchedule.html new file mode 100644 index 0000000000..92e18ff644 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteVMSchedule.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteVMSchedule

+

Delete Instance Schedule.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidID of Instancetrue
idID of Instance schedulefalse
idsIDs of Instance schedulefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteVMSnapshot.html b/static/api/apidocs-4.23/apis/deleteVMSnapshot.html new file mode 100644 index 0000000000..5ac2c29f6e --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteVMSnapshot.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteVMSnapshot

+

Deletes an Instance Snapshot.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
vmsnapshotidThe ID of the Instance Snapshottrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteVPC.html b/static/api/apidocs-4.23/apis/deleteVPC.html new file mode 100644 index 0000000000..4e6032531d --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteVPC.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteVPC

+

Deletes a VPC

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the VPCtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteVPCOffering.html b/static/api/apidocs-4.23/apis/deleteVPCOffering.html new file mode 100644 index 0000000000..1155ac793d --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteVPCOffering.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteVPCOffering

+

Deletes VPC offering

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the VPC offeringtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteVgpuProfile.html b/static/api/apidocs-4.23/apis/deleteVgpuProfile.html new file mode 100644 index 0000000000..164026a1a4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteVgpuProfile.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteVgpuProfile

+

Deletes a vGPU profile from the system

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the vGPU profiletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteVirtualMachineCheckpoint.html b/static/api/apidocs-4.23/apis/deleteVirtualMachineCheckpoint.html new file mode 100644 index 0000000000..56b134b037 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteVirtualMachineCheckpoint.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteVirtualMachineCheckpoint

+

Delete a VM checkpoint. This API is intended for testing only and is disabled by default.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
checkpointidCheckpoint IDtrue
virtualmachineidID of the VMtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteVlanIpRange.html b/static/api/apidocs-4.23/apis/deleteVlanIpRange.html new file mode 100644 index 0000000000..a18983048f --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteVlanIpRange.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteVlanIpRange

+

Deletes a VLAN IP range.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the VLAN IP rangetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteVnfTemplate.html b/static/api/apidocs-4.23/apis/deleteVnfTemplate.html new file mode 100644 index 0000000000..9a77ab8332 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteVnfTemplate.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteVnfTemplate

+

Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Templatetrue
forcedForce delete a Template.false
issystemNecessary if the template's type is system.false
zoneidThe ID of zone of the Templatefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteVolume.html b/static/api/apidocs-4.23/apis/deleteVolume.html new file mode 100644 index 0000000000..34650c9822 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteVolume.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteVolume

+

Deletes a detached disk volume.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the disk volumetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteVpnConnection.html b/static/api/apidocs-4.23/apis/deleteVpnConnection.html new file mode 100644 index 0000000000..07fe101bda --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteVpnConnection.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteVpnConnection

+

Delete site to site VPN connection

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of VPN connectiontrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteVpnCustomerGateway.html b/static/api/apidocs-4.23/apis/deleteVpnCustomerGateway.html new file mode 100644 index 0000000000..03a256c8f1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteVpnCustomerGateway.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteVpnCustomerGateway

+

Delete site to site VPN customer gateway

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of customer gatewaytrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteVpnGateway.html b/static/api/apidocs-4.23/apis/deleteVpnGateway.html new file mode 100644 index 0000000000..a9bebc3db6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteVpnGateway.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteVpnGateway

+

Delete site to site VPN gateway

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of customer gatewaytrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteWebhook.html b/static/api/apidocs-4.23/apis/deleteWebhook.html new file mode 100644 index 0000000000..5764866e71 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteWebhook.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteWebhook

+

Deletes a Webhook

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Webhooktrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteWebhookDelivery.html b/static/api/apidocs-4.23/apis/deleteWebhookDelivery.html new file mode 100644 index 0000000000..ce218b078d --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteWebhookDelivery.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteWebhookDelivery

+

Deletes Webhook delivery

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enddateThe 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
idThe ID of the Webhook deliveryfalse
managementserveridThe ID of the management serverfalse
startdateThe 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
webhookidThe ID of the Webhookfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteWebhookFilter.html b/static/api/apidocs-4.23/apis/deleteWebhookFilter.html new file mode 100644 index 0000000000..0b7d7b59b9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteWebhookFilter.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteWebhookFilter

+

Deletes Webhook filter

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Webhook filterfalse
webhookidThe ID of the Webhookfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deleteZone.html b/static/api/apidocs-4.23/apis/deleteZone.html new file mode 100644 index 0000000000..0cf0956c67 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deleteZone.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deleteZone

+

Deletes a Zone.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Zonetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deployNetscalerVpx.html b/static/api/apidocs-4.23/apis/deployNetscalerVpx.html new file mode 100644 index 0000000000..4a938c9bac --- /dev/null +++ b/static/api/apidocs-4.23/apis/deployNetscalerVpx.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deployNetscalerVpx

+

Creates new NS Vpx

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
serviceofferingidThe ID of the service offering for the Instancetrue
templateidThe ID of the template for the Instancetrue
zoneidAvailability zone for the Instancetrue
networkidThe network this ip address should be associated to.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
gslbproviderTrue if NetScaler device is provisioned to be a GSLB service provider
gslbproviderprivateipPrivate IP of the NetScaler representing GSLB site
gslbproviderpublicipPublic IP of the NetScaler representing GSLB site
ipaddressThe management IP address of the external load balancer
isexclusivegslbproviderTrue if NetScaler device is provisioned exclusively to be a GSLB service provider
lbdevicecapacityDevice capacity
lbdevicededicatedTrue if device is dedicated for an account
lbdeviceidDevice ID of the netscaler load balancer
lbdevicenameDevice name
lbdevicestateDevice state
physicalnetworkidThe physical Network to which this netscaler device belongs to
podidsUsed 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.
privateinterfaceThe private interface of the load balancer
providerName of the provider
publicinterfaceThe public interface of the load balancer
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deployVirtualMachine.html b/static/api/apidocs-4.23/apis/deployVirtualMachine.html new file mode 100644 index 0000000000..e05e841d82 --- /dev/null +++ b/static/api/apidocs-4.23/apis/deployVirtualMachine.html @@ -0,0 +1,873 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deployVirtualMachine

+

Creates and automatically starts an Instance based on a service offering, disk offering, and Template.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
serviceofferingidThe ID of the Service offering for the Instancetrue
zoneidavailability zone for the virtual machinetrue
accountan optional account for the virtual machine. Must be used with domainId.false
affinitygroupidscomma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameterfalse
affinitygroupnamescomma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameterfalse
blankinstanceWhether to create a blank instance without storage and networkfalse
bootintosetupBoot into hardware setup or not (ignored if startVm = false, only valid for vmware)false
bootmodeBoot 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
boottypeGuest 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
clusteridDestination Cluster ID to deploy the Instance to - parameter available for root admin onlyfalse
copyimagetagsif true the image tags (if any) will be copied to the VM, default value is falsefalse
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
datadiskofferinglistdatadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameterfalse
datadisksdetailsDisk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200&datadisksdetails[0].kmskeyid=<uuid>false
deploymentplannerDeployment planner to use for vm allocation. Available to ROOT admin onlyfalse
detailsused to specify the custom parameters. 'extraconfig' is not allowed to be passed in detailsfalse
dhcpoptionsnetworklistDHCP 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.comfalse
diskofferingidthe 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
displaynamean optional user generated name for the virtual machinefalse
displayvman optional field, whether to the display the vm to the end user or not.false
domainidan 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
dynamicscalingenabledtrue if virtual machine needs to be dynamically scalablefalse
externaldetailsDetails in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevaluefalse
extraconfigan optional URL encoded string that can be passed to the virtual machine upon successful deploymentfalse
groupan optional group for the virtual machinefalse
hostiddestination Host ID to deploy the VM to - parameter available for root admin onlyfalse
hypervisorthe 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 callfalse
iodriverpolicyControls specific policies on IOfalse
iothreadsenabledIOThreads 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
ip6addressthe ipv6 address for default vm's networkfalse
ipaddressthe ip address for default vm's networkfalse
iptonetworklistip 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=uuidfalse
keyboardan optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,es-latam,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,usfalse
keypairname of the ssh key pair used to login to the virtual machinefalse
keypairsnames of the ssh key pairs used to login to the virtual machinefalse
leasedurationNumber of days instance is leased for.false
leaseexpiryactionLease expiry action, valid values are STOP and DESTROYfalse
macaddressthe mac address for default vm's networkfalse
namehost name for the virtual machinefalse
networkidslist of network ids used by virtual machine. Can't be specified with ipToNetworkList parameterfalse
nicmultiqueuenumberThe number of queues for multiqueue NICs.false
nicnetworklistVMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuidfalse
nicpackedvirtqueuesenabledEnable packed virtqueues or not.false
overridediskofferingidthe 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 idfalse
passwordThe password of the virtual machine. If null, a random password will be generated for the VM.false
podidDestination Pod ID to deploy the Instance to - parameter available for root admin onlyfalse
projectidDeploy vm for the projectfalse
propertiesused to specify the vApp properties.false
rootdiskkmskeyidID of the KMS Key to use for root disk encryptionfalse
rootdisksizeOptional 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 providedfalse
securitygroupidscomma 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 parameterfalse
securitygroupnamescomma 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 parameterfalse
sizethe arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingIdfalse
snapshotidfalse
startvmtrue if start vm after creating; defaulted to true if not specifiedfalse
templateidThe ID of the Template for the Instancefalse
userdataan 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 valuefalse
userdatadetailsused to specify the parameters values for the variables in userdata.false
userdataidthe ID of the Userdatafalse
volumeidfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/deployVnfAppliance.html b/static/api/apidocs-4.23/apis/deployVnfAppliance.html new file mode 100644 index 0000000000..b780a49b7e --- /dev/null +++ b/static/api/apidocs-4.23/apis/deployVnfAppliance.html @@ -0,0 +1,870 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

deployVnfAppliance

+

Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
serviceofferingidThe ID of the Service offering for the Instancetrue
zoneidavailability zone for the virtual machinetrue
accountan optional account for the virtual machine. Must be used with domainId.false
affinitygroupidscomma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameterfalse
affinitygroupnamescomma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameterfalse
bootintosetupBoot into hardware setup or not (ignored if startVm = false, only valid for vmware)false
bootmodeBoot 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
boottypeGuest 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
copyimagetagsif true the image tags (if any) will be copied to the VM, default value is falsefalse
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
datadiskofferinglistdatadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameterfalse
datadisksdetailsDisk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200&datadisksdetails[0].kmskeyid=<uuid>false
deploymentplannerDeployment planner to use for vm allocation. Available to ROOT admin onlyfalse
detailsused to specify the custom parameters. 'extraconfig' is not allowed to be passed in detailsfalse
dhcpoptionsnetworklistDHCP 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.comfalse
diskofferingidthe 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
displaynamean optional user generated name for the virtual machinefalse
displayvman optional field, whether to the display the vm to the end user or not.false
domainidan 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
dynamicscalingenabledtrue if virtual machine needs to be dynamically scalablefalse
externaldetailsDetails in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevaluefalse
extraconfigan optional URL encoded string that can be passed to the virtual machine upon successful deploymentfalse
groupan optional group for the virtual machinefalse
hostiddestination Host ID to deploy the VM to - parameter available for root admin onlyfalse
hypervisorthe 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 callfalse
iodriverpolicyControls specific policies on IOfalse
iothreadsenabledIOThreads 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
ip6addressthe ipv6 address for default vm's networkfalse
ipaddressthe ip address for default vm's networkfalse
iptonetworklistip 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=uuidfalse
keyboardan optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,es-latam,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,usfalse
keypairname of the ssh key pair used to login to the virtual machinefalse
keypairsnames of the ssh key pairs used to login to the virtual machinefalse
leasedurationNumber of days instance is leased for.false
leaseexpiryactionLease expiry action, valid values are STOP and DESTROYfalse
macaddressthe mac address for default vm's networkfalse
namehost name for the virtual machinefalse
networkidslist of network ids used by virtual machine. Can't be specified with ipToNetworkList parameterfalse
nicmultiqueuenumberThe number of queues for multiqueue NICs.false
nicnetworklistVMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuidfalse
nicpackedvirtqueuesenabledEnable packed virtqueues or not.false
overridediskofferingidthe 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 idfalse
passwordThe password of the virtual machine. If null, a random password will be generated for the VM.false
projectidDeploy vm for the projectfalse
propertiesused to specify the vApp properties.false
rootdiskkmskeyidID of the KMS Key to use for root disk encryptionfalse
rootdisksizeOptional 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 providedfalse
securitygroupidscomma 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 parameterfalse
securitygroupnamescomma 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 parameterfalse
sizethe arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingIdfalse
snapshotidfalse
startvmtrue if start vm after creating; defaulted to true if not specifiedfalse
templateidThe ID of the Template for the Instancefalse
userdataan 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 valuefalse
userdatadetailsused to specify the parameters values for the variables in userdata.false
userdataidthe ID of the Userdatafalse
vnfcidrlistthe 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
vnfconfiguremanagementFalse by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. True otherwise. Network rules are configured if management network is an isolated network or shared network with security groups.false
volumeidfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/destroyRouter.html b/static/api/apidocs-4.23/apis/destroyRouter.html new file mode 100644 index 0000000000..c39046e585 --- /dev/null +++ b/static/api/apidocs-4.23/apis/destroyRouter.html @@ -0,0 +1,360 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

destroyRouter

+

Destroys a router.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the routertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the router
accountThe Account associated with the router
archCPU arch of the router
createdThe date and time the router was created
dns1The first DNS for the router
dns2The second DNS for the router
domainThe domain associated with the router
domainidThe domain ID associated with the router
domainpathpath of the Domain the router belongs to
gatewayThe gateway for the router
guestipaddressThe guest IP address for the router
guestmacaddressThe guest MAC address for the router
guestnetmaskThe guest netmask for the router
guestnetworkidThe ID of the corresponding guest Network
guestnetworknameThe name of the corresponding guest Network
healthchecksfailedTrue if any health checks had failed
hostcontrolstateThe control state of the host for the router
hostidThe host ID for the router
hostnameThe hostname for the router
hypervisorThe hypervisor on which the Template runs
ip6dns1The first IPv6 DNS for the router
ip6dns2The second IPv6 DNS for the router
isredundantrouterIf this router is an redundant virtual router
linklocalipThe Control IP address for the router
linklocalmacaddressThe link local MAC address for the router
linklocalnetmaskThe link local netmask for the router
linklocalnetworkidThe ID of the corresponding link local Network
nameThe name of the router
networkdomainThe Network domain for the router
podidThe Pod ID for the router
podnameThe Pod name for the router
projectThe project name of the address
projectidThe project id of the IP address
publicipThe public IP address for the router
publicmacaddressThe public MAC address for the router
publicnetmaskThe public netmask for the router
publicnetworkidThe ID of the corresponding public Network
redundantstateThe state of redundant virtual router
requiresupgradeTrue if the router Template requires upgrade
roleRole of the domain router
scriptsversionThe version of scripts
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
softwareversionThe version of the code / software in the router
stateThe state of the router
templateidThe Template ID for the router
templatenameThe Template name for the router
versionThe version of Template
vpcidVPC the router belongs to
vpcnameThe name of VPC the router belongs to
zoneidThe Zone ID for the router
zonenameThe Zone name for the router
healthcheckresults(*)Last executed health check result for the router
checknameThe name of the health check on the router
checktypeThe type of the health check - basic or advanced
detailsDetailed response generated on running health check
lastupdatedThe date this VPC was created
statusthe result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}
successThe result of the health check if available
nic(*)The list of NICs associated with the router
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/destroySharedFileSystem.html b/static/api/apidocs-4.23/apis/destroySharedFileSystem.html new file mode 100644 index 0000000000..912abad6cf --- /dev/null +++ b/static/api/apidocs-4.23/apis/destroySharedFileSystem.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

destroySharedFileSystem

+

Destroy a Shared FileSystem by id

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
expungeIf true is passed, the shared filesystem is expunged immediately. False by default.false
forcedIf true is passed, the shared filesystem can be destroyed without stopping it first.false
idthe ID of the shared filesystem to deletefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/destroySystemVm.html b/static/api/apidocs-4.23/apis/destroySystemVm.html new file mode 100644 index 0000000000..dd2aa7bf7b --- /dev/null +++ b/static/api/apidocs-4.23/apis/destroySystemVm.html @@ -0,0 +1,198 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

destroySystemVm

+

Destroys a System VM.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the System VMtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the System VM
activeviewersessionsThe number of active console sessions for the console proxy System VM
agentstateThe agent state of the System VM
archCPU arch of the system VM
createdThe date and time the System VM was created
disconnectedThe last disconnected date of host
dns1The first DNS for the System VM
dns2The second DNS for the System VM
gatewayThe gateway for the System VM
guestvlanGuest VLAN range
hostcontrolstateThe control state of the host for the System VM
hostidThe host ID for the System VM
hostnameThe hostname for the System VM
hypervisorThe hypervisor on which the Template runs
isdynamicallyscalableTrue if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
linklocalipThe Control IP address for the System VM
linklocalmacaddressThe link local MAC address for the System VM
linklocalnetmaskThe link local netmask for the System VM
nameThe name of the System VM
networkdomainThe Network domain for the System VM
podidThe Pod ID for the System VM
podnameThe Pod name for the System VM
privateipThe private IP address for the System VM
privatemacaddressThe private MAC address for the System VM
privatenetmaskThe private netmask for the System VM
publicipThe public IP address for the System VM
publicmacaddressThe public MAC address for the System VM
publicnetmaskThe public netmask for the System VM
publicvlanPublic VLAN range
serviceofferingidthe ID of the service offering of the system virtual machine.
serviceofferingnamethe name of the service offering of the system virtual machine.
stateThe state of the System VM
storageipthe ip address for the system VM on the storage network
systemvmtypeThe System VM type
templateidThe Template ID for the System VM
templatenameThe Template name for the System VM
versionThe systemvm agent version
zoneidThe Zone ID for the System VM
zonenameThe Zone name for the System VM
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/destroyVirtualMachine.html b/static/api/apidocs-4.23/apis/destroyVirtualMachine.html new file mode 100644 index 0000000000..09173e74ff --- /dev/null +++ b/static/api/apidocs-4.23/apis/destroyVirtualMachine.html @@ -0,0 +1,705 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

destroyVirtualMachine

+

Destroys an Instance. Once destroyed, only the administrator can recover it.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instancetrue
expungeIf true is passed, the Instance is expunged immediately. False by default.false
forcedForce destroy the Instancefalse
volumeidsComma separated list of UUIDs for volumes that will be deletedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/destroyVolume.html b/static/api/apidocs-4.23/apis/destroyVolume.html new file mode 100644 index 0000000000..24da9d617a --- /dev/null +++ b/static/api/apidocs-4.23/apis/destroyVolume.html @@ -0,0 +1,306 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

destroyVolume

+

Destroys a Volume.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the volumetrue
expungeIf true is passed, the volume is expunged immediately. False by default.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the disk volume
accountThe Account associated with the disk volume
attachedThe date the volume was attached to an Instance
chaininfoThe chain info of the volume
clusteridCluster id of the volume
clusternameCluster name where the volume is allocated
createdThe date the disk volume was created
deleteprotectiontrue if volume has delete protection.
destroyedThe boolean state of whether the volume is destroyed or not
deviceidThe ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
diskBytesReadRateBytes read rate of the disk volume
diskBytesWriteRateBytes write rate of the disk volume
diskIopsReadRateIO requests read rate of the disk volume per the disk offering
diskIopsWriteRateIO requests write rate of the disk volume per the disk offering
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingdisplaytextThe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnameName of the disk offering
displayvolumeAn optional field whether to the display the volume to the end User or not.
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathpath of the Domain the disk volume belongs to
encryptformatthe format of the disk encryption if applicable
externaluuidVolume UUID that is given by virtualisation provider (only for VMware)
hypervisorHypervisor the volume belongs to
isextractableTrue if the volume is extractable, false otherwise
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isonameThe name of the ISO attached to the Instance
kmskeyKMS key name of the volume
kmskeyidKMS key id of the volume
kmskeyversionVersion number of the KMS key used for disk encryption if applicable
maxiopsMax IOPS of the disk volume
miniopsMin IOPS of the disk volume
nameName of the disk volume
pathThe path of the volume
physicalsizeThe bytes actually consumed on disk
podidPod id of the volume
podnamePod name of the volume
projectThe project name of the VPN
projectidThe project id of the VPN
provisioningtypeProvisioning type used to create volumes.
quiescevmNeed quiesce Instance or not when taking Snapshot
serviceofferingdisplaytextThe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnameName of the service offering for root disk
sizeSize of the disk volume
snapshotidID of the Snapshot from which this volume was created
stateThe state of the disk volume
statusThe status of the volume
storageName of the primary storage hosting the disk volume
storageidID of the primary storage hosting the disk volume; returned to admin User only
storagetypeShared or local storage
supportsstoragesnapshotTrue if storage Snapshot is supported for the volume, false otherwise
templatedisplaytextAn alternate display text of the Template for the Instance
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
typeType of the disk volume (ROOT or DATADISK)
utilizationThe disk utilization
virtualmachineidID of the Instance
virtualsizeThe bytes allocated
vmdisplaynameDisplay name of the Instance
vmnameName of the Instance
vmstateState of the Instance
vmtypeType of the Instance
volumecheckresultdetails for the volume check result, they may vary for different hypervisors
volumerepairresultdetails for the volume repair result, they may vary for different hypervisors
zoneidID of the availability zone
zonenameName of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/detachIso.html b/static/api/apidocs-4.23/apis/detachIso.html new file mode 100644 index 0000000000..78d9347a87 --- /dev/null +++ b/static/api/apidocs-4.23/apis/detachIso.html @@ -0,0 +1,702 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

detachIso

+

Detaches any ISO file (if any) currently attached to an Instance.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidThe ID of the Instancetrue
forcedIf true, ejects the ISO before detaching on VMware. Default: falsefalse
idThe ID of the ISO to detach. Required when the Instance has more than one ISO attached.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/detachVolume.html b/static/api/apidocs-4.23/apis/detachVolume.html new file mode 100644 index 0000000000..ac69977971 --- /dev/null +++ b/static/api/apidocs-4.23/apis/detachVolume.html @@ -0,0 +1,309 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

detachVolume

+

Detaches a disk volume from an Instance.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
deviceidThe device ID on the Instance where volume is detached fromfalse
id The ID of the disk volumefalse
virtualmachineidThe ID of the Instance where the volume is detached fromfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the disk volume
accountThe Account associated with the disk volume
attachedThe date the volume was attached to an Instance
chaininfoThe chain info of the volume
clusteridCluster id of the volume
clusternameCluster name where the volume is allocated
createdThe date the disk volume was created
deleteprotectiontrue if volume has delete protection.
destroyedThe boolean state of whether the volume is destroyed or not
deviceidThe ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
diskBytesReadRateBytes read rate of the disk volume
diskBytesWriteRateBytes write rate of the disk volume
diskIopsReadRateIO requests read rate of the disk volume per the disk offering
diskIopsWriteRateIO requests write rate of the disk volume per the disk offering
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingdisplaytextThe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnameName of the disk offering
displayvolumeAn optional field whether to the display the volume to the end User or not.
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathpath of the Domain the disk volume belongs to
encryptformatthe format of the disk encryption if applicable
externaluuidVolume UUID that is given by virtualisation provider (only for VMware)
hypervisorHypervisor the volume belongs to
isextractableTrue if the volume is extractable, false otherwise
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isonameThe name of the ISO attached to the Instance
kmskeyKMS key name of the volume
kmskeyidKMS key id of the volume
kmskeyversionVersion number of the KMS key used for disk encryption if applicable
maxiopsMax IOPS of the disk volume
miniopsMin IOPS of the disk volume
nameName of the disk volume
pathThe path of the volume
physicalsizeThe bytes actually consumed on disk
podidPod id of the volume
podnamePod name of the volume
projectThe project name of the VPN
projectidThe project id of the VPN
provisioningtypeProvisioning type used to create volumes.
quiescevmNeed quiesce Instance or not when taking Snapshot
serviceofferingdisplaytextThe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnameName of the service offering for root disk
sizeSize of the disk volume
snapshotidID of the Snapshot from which this volume was created
stateThe state of the disk volume
statusThe status of the volume
storageName of the primary storage hosting the disk volume
storageidID of the primary storage hosting the disk volume; returned to admin User only
storagetypeShared or local storage
supportsstoragesnapshotTrue if storage Snapshot is supported for the volume, false otherwise
templatedisplaytextAn alternate display text of the Template for the Instance
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
typeType of the disk volume (ROOT or DATADISK)
utilizationThe disk utilization
virtualmachineidID of the Instance
virtualsizeThe bytes allocated
vmdisplaynameDisplay name of the Instance
vmnameName of the Instance
vmstateState of the Instance
vmtypeType of the Instance
volumecheckresultdetails for the volume check result, they may vary for different hypervisors
volumerepairresultdetails for the volume repair result, they may vary for different hypervisors
zoneidID of the availability zone
zonenameName of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/disableAccount.html b/static/api/apidocs-4.23/apis/disableAccount.html new file mode 100644 index 0000000000..24d5916e78 --- /dev/null +++ b/static/api/apidocs-4.23/apis/disableAccount.html @@ -0,0 +1,393 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

disableAccount

+

Disables an account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
lockIf true, only lock the Account; else disable the Accounttrue
accountDisables specified Account.false
domainidDisables specified Account in this domain.false
idAccount idfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Account
accountdetailsDetails for the account
accounttypeAccount type (admin, domain-admin, user)
apikeyaccesswhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
backupavailablethe total number of backups available to this account
backuplimitthe total number of backups which can be stored by this account
backupstorageavailablethe total backup storage space (in GiB) available to the account
backupstoragelimitthe total backup storage space (in GiB) the account can own
backupstoragetotalthe total backup storage space (in GiB) owned by the account
backuptotalthe total number of backups stored by this account
bucketavailablethe total number of buckets available to this account
bucketlimitthe total number of buckets which can be stored by this account
buckettotalthe total number of buckets stored by this account
cpuavailableThe total number of CPU cores available to be created for this account
cpulimitThe total number of CPU cores the account can own
cputotalThe total number of CPU cores owned by account
createdThe date when this account was created
defaultzoneidThe default zone of the Account
domainName of the Domain the Account belongs to
domainidID of the Domain the Account belongs to
domainpathPath of the Domain the Account belongs to
gpuavailablethe total number of gpus available to be created for this account
gpulimitthe total number of gpus the account can own
gputotalthe total number of gpus owned by account
groupsThe list of ACL groups that account belongs to
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this Account to acquire
iplimitThe total number of public IP addresses this Account can acquire
iptotalThe total number of public IP addresses allocated for this Account
iscleanuprequiredTrue if the account requires cleanup
isdefaultTrue if account is default, false otherwise
memoryavailableThe total memory (in MB) available to be created for this account
memorylimitThe total memory (in MB) the account can own
memorytotalThe total memory (in MB) owned by account
nameThe name of the Account
networkavailableThe total number of Networks available to be created for this Account
networkdomainThe Network domain
networklimitThe total number of Networks the Account can own
networktotalThe total number of Networks owned by Account
objectstorageavailablethe total object storage space (in GiB) available to the account
objectstoragelimitthe total object storage space (in GiB) the account can own
objectstoragetotalthe total object storage space (in GiB) owned by the account
primarystorageavailableThe total primary storage space (in GiB) available to be used for this account
primarystoragelimitThe total primary storage space (in GiB) the account can own
primarystoragetotalThe total primary storage space (in GiB) owned by account
projectavailableThe total number of projects available for administration by this Account
projectlimitThe total number of projects the Account can own
projecttotalThe total number of projects being administrated by this Account
receivedbytesThe total number of Network traffic bytes received
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role (Admin, ResourceAdmin, DomainAdmin, User)
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this account
secondarystoragelimitThe total secondary storage space (in GiB) the account can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by account
sentbytesThe total number of Network traffic bytes sent
snapshotavailableThe total number of Snapshots available for this Account
snapshotlimitThe total number of Snapshots which can be stored by this Account
snapshottotalThe total number of Snapshots stored by this Account
stateThe state of the account
taggedresourcesThe tagged resource limit and count for the account
templateavailableThe total number of Templates available to be created by this Account
templatelimitThe total number of Templates which can be created by this Account
templatetotalThe total number of Templates which have been created by this Account
vmavailableThe total number of Instances available for this Account to acquire
vmlimitThe total number of Instances that can be deployed by this Account
vmrunningThe total number of Instances running for this Account
vmstoppedThe total number of Instances stopped for this Account
vmtotalThe total number of Instances deployed by this Account
volumeavailableThe total volume available for this Account
volumelimitThe total volume which can be used by this Account
volumetotalThe total volume being used by this Account
vpcavailableThe total number of VPCs available to be created for this account
vpclimitThe total number of VPCs the Account can own
vpctotalThe total number of VPCs owned by account
user(*)The list of users associated with account
idThe user ID
accountThe Account name of the user
accountidThe Account ID of the user
accounttypeThe Account type of the user
apikeyThe API key of the user
apikeyaccessWhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
createdThe date and time the user Account was created
domainThe domain name of the user
domainidThe domain ID of the user
emailThe user email address
firstnameThe user firstname
iconBase64 string representation of the resource icon
is2faenabledTrue if user has two factor authentication enabled
is2famandatedTrue if user has two factor authentication is mandated
iscallerchilddomainThe boolean value representing if the updating target is in caller's child domain
isdefaultTrue if user is default, false otherwise
lastnameThe user lastname
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role
secretkeyThe secret key of the user
stateThe user state
timezoneThe timezone user was created in
usernameThe user name
usersourceThe source type of the user in lowercase, such as native, ldap, saml2
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/disableAutoScaleVmGroup.html b/static/api/apidocs-4.23/apis/disableAutoScaleVmGroup.html new file mode 100644 index 0000000000..d4c22ec41f --- /dev/null +++ b/static/api/apidocs-4.23/apis/disableAutoScaleVmGroup.html @@ -0,0 +1,159 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

disableAutoScaleVmGroup

+

Disables an AutoScale Instance Group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the autoscale grouptrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe autoscale Instance group ID
accountThe Account owning the Instance group
associatednetworkidThe id of the guest Network the LB rule belongs to
associatednetworknameThe name of the guest Network the LB rule belongs to
availablevirtualmachinecountThe number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group
createdThe date when this Instance group was created
domainThe domain name of the Instance group
domainidThe domain ID of the Instance group
domainpathpath of the domain to which the vm group belongs
fordisplayIs group for display to the regular User
intervalThe frequency at which the conditions have to be evaluated
lbproviderThe LB provider of the guest Network the LB rule belongs to
lbruleidThe Load balancer rule ID
maxmembersThe maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.
minmembersThe minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.
nameThe name of the autoscale Instance group
privateportThe private port
projectThe project name of the Instance group
projectidThe project id of the Instance group
publicipThe public IP address
publicipidThe public IP address ID
publicportThe public port
scaledownpoliciesList of scaledown autoscale policies
scaleuppoliciesList of scaleup autoscale policies
stateThe current state of the AutoScale Instance Group
vmprofileidThe autoscale profile that contains information about the Instances in the Instance group.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/disableCiscoNexusVSM.html b/static/api/apidocs-4.23/apis/disableCiscoNexusVSM.html new file mode 100644 index 0000000000..30ab271b50 --- /dev/null +++ b/static/api/apidocs-4.23/apis/disableCiscoNexusVSM.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

disableCiscoNexusVSM

+

Disable a Cisco Nexus VSM device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idId of the Cisco Nexus 1000v VSM device to be deletedtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
ipaddressThe management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module
vsmconfigmodeThe mode of the VSM (standalone/HA)
vsmconfigstateThe Config State (Primary/Standby) of the VSM
vsmctrlvlanidControl VLAN ID of the VSM
vsmdeviceidDevice ID of the Cisco N1KV VSM device
vsmdevicenameDevice name
vsmdevicestateDevice state
vsmdevicestateThe Device State (Enabled/Disabled) of the VSM
vsmdomainidThe VSM is a switch supervisor. This is the VSM's switch domain ID
vsmmgmtvlanidManagement VLAN ID of the VSM
vsmpktvlanidPacket VLAN ID of the VSM
vsmstoragevlanidStorage VLAN ID of the VSM
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/disableHAForCluster.html b/static/api/apidocs-4.23/apis/disableHAForCluster.html new file mode 100644 index 0000000000..a87fa805bb --- /dev/null +++ b/static/api/apidocs-4.23/apis/disableHAForCluster.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

disableHAForCluster

+

Disables HA cluster-wide

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
clusteridID of the clustertrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/disableHAForHost.html b/static/api/apidocs-4.23/apis/disableHAForHost.html new file mode 100644 index 0000000000..1fd8697115 --- /dev/null +++ b/static/api/apidocs-4.23/apis/disableHAForHost.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

disableHAForHost

+

Disables HA for a host

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
hostidID of the hosttrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
haenableIf host HA is enabled for the host
haproviderThe host HA provider
hastateThe HA state of the host
hostidThe ID of the host
statusOperation status
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/disableHAForZone.html b/static/api/apidocs-4.23/apis/disableHAForZone.html new file mode 100644 index 0000000000..3cacf8c056 --- /dev/null +++ b/static/api/apidocs-4.23/apis/disableHAForZone.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

disableHAForZone

+

Disables HA for a zone

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
zoneidID of the zonetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/disableOutOfBandManagementForCluster.html b/static/api/apidocs-4.23/apis/disableOutOfBandManagementForCluster.html new file mode 100644 index 0000000000..a34b6bdb88 --- /dev/null +++ b/static/api/apidocs-4.23/apis/disableOutOfBandManagementForCluster.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

disableOutOfBandManagementForCluster

+

Disables out-of-band management for a cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
clusteridThe ID of the clustertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
actionThe out-of-band management action (if issued)
addressThe out-of-band management interface address
descriptionThe operation result description
driverThe out-of-band management driver for the host
enabledTrue if out-of-band management is enabled for the host
hostidThe ID of the host
passwordThe out-of-band management interface password
portThe out-of-band management interface port
powerstateThe out-of-band management interface powerState of the host
statusThe operation result
usernameThe out-of-band management interface username
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/disableOutOfBandManagementForHost.html b/static/api/apidocs-4.23/apis/disableOutOfBandManagementForHost.html new file mode 100644 index 0000000000..d3710e5cc3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/disableOutOfBandManagementForHost.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

disableOutOfBandManagementForHost

+

Disables out-of-band management for a host

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
hostidThe ID of the hosttrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
actionThe out-of-band management action (if issued)
addressThe out-of-band management interface address
descriptionThe operation result description
driverThe out-of-band management driver for the host
enabledTrue if out-of-band management is enabled for the host
hostidThe ID of the host
passwordThe out-of-band management interface password
portThe out-of-band management interface port
powerstateThe out-of-band management interface powerState of the host
statusThe operation result
usernameThe out-of-band management interface username
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/disableOutOfBandManagementForZone.html b/static/api/apidocs-4.23/apis/disableOutOfBandManagementForZone.html new file mode 100644 index 0000000000..7323ec07c4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/disableOutOfBandManagementForZone.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

disableOutOfBandManagementForZone

+

Disables out-of-band management for a zone

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
zoneidThe ID of the zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
actionThe out-of-band management action (if issued)
addressThe out-of-band management interface address
descriptionThe operation result description
driverThe out-of-band management driver for the host
enabledTrue if out-of-band management is enabled for the host
hostidThe ID of the host
passwordThe out-of-band management interface password
portThe out-of-band management interface port
powerstateThe out-of-band management interface powerState of the host
statusThe operation result
usernameThe out-of-band management interface username
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/disableRole.html b/static/api/apidocs-4.23/apis/disableRole.html new file mode 100644 index 0000000000..86d96eb6db --- /dev/null +++ b/static/api/apidocs-4.23/apis/disableRole.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

disableRole

+

Disables a role

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the roletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/disableStaticNat.html b/static/api/apidocs-4.23/apis/disableStaticNat.html new file mode 100644 index 0000000000..23e212fcc8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/disableStaticNat.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

disableStaticNat

+

Disables static rule for given IP address

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
ipaddressidThe public IP address ID for which static NAT feature is being disabledtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/disableUser.html b/static/api/apidocs-4.23/apis/disableUser.html new file mode 100644 index 0000000000..ccb50f3d52 --- /dev/null +++ b/static/api/apidocs-4.23/apis/disableUser.html @@ -0,0 +1,156 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

disableUser

+

Disables a user account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idDisables user by user ID.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe user ID
accountThe Account name of the user
accountidThe Account ID of the user
accounttypeThe Account type of the user
apikeyThe API key of the user
apikeyaccessWhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
createdThe date and time the user Account was created
domainThe domain name of the user
domainidThe domain ID of the user
emailThe user email address
firstnameThe user firstname
iconBase64 string representation of the resource icon
is2faenabledTrue if user has two factor authentication enabled
is2famandatedTrue if user has two factor authentication is mandated
iscallerchilddomainThe boolean value representing if the updating target is in caller's child domain
isdefaultTrue if user is default, false otherwise
lastnameThe user lastname
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role
secretkeyThe secret key of the user
stateThe user state
timezoneThe timezone user was created in
usernameThe user name
usersourceThe source type of the user in lowercase, such as native, ldap, saml2
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/disassociateDnsZoneFromNetwork.html b/static/api/apidocs-4.23/apis/disassociateDnsZoneFromNetwork.html new file mode 100644 index 0000000000..8f8430c179 --- /dev/null +++ b/static/api/apidocs-4.23/apis/disassociateDnsZoneFromNetwork.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

disassociateDnsZoneFromNetwork

+

Removes the association between a DNS Zone and a Network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
networkidThe ID of the Networktrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/disassociateIpAddress.html b/static/api/apidocs-4.23/apis/disassociateIpAddress.html new file mode 100644 index 0000000000..dc313edeb4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/disassociateIpAddress.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

disassociateIpAddress

+

Disassociates an IP address from the Account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameterfalse
ipaddressIP Address to be disassociated. Mutually exclusive with the id parameterfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/discoverGpuDevices.html b/static/api/apidocs-4.23/apis/discoverGpuDevices.html new file mode 100644 index 0000000000..596ee985c9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/discoverGpuDevices.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

discoverGpuDevices

+

Discovers available GPU devices on a host

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the hosttrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the GPU device
busaddressbus address of the GPU device or MDEV UUID for vGPU devices
gpucardidthe GPU card ID associated with this GPU device
gpucardnamethe GPU card name associated with this GPU device
gpudevicetypebus address of the GPU device
hostidthe host ID where the GPU device is attached
hostnamethe host name where the GPU device is attached
managedstatethe managed state of the GPU device (Enabled/Disabled)
numanodethe NUMA node where the GPU device is located
parentgpudeviceidthe ID of the parent GPU device, if this is a vGPU
statethe vGPU profile name assigned to this GPU device
vgpuprofileidthe vGPU profile ID assigned to this GPU device
vgpuprofilenamethe vGPU profile name assigned to this GPU device
virtualmachineidthe vGPU profile ID assigned to this GPU device
virtualmachinenamethe vGPU profile name assigned to this GPU device
vmstatethe state of the virtual machine to which this GPU device is allocated
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/downloadImageStoreObject.html b/static/api/apidocs-4.23/apis/downloadImageStoreObject.html new file mode 100644 index 0000000000..0cf7e648d8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/downloadImageStoreObject.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

downloadImageStoreObject

+

Download object at a specified path on an image store.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idid of the image storetrue
pathpath to download on image storefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of extracted object
accountidThe Account ID to which the extracted object belongs
createdThe time and date the object was created
extractIdThe upload ID of extracted object
extractModeThe mode of extraction - upload or download
nameThe name of the extracted object
stateThe state of the extracted object
statusThe status of the extraction
storagetypeType of the storage
uploadpercentageThe percentage of the entity uploaded to the specified location
urlIf mode = upload then URL of the uploaded entity. if mode = download the URL from which the entity can be downloaded
zoneidZone ID the object was extracted from
zonenameZone name the object was extracted from
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/downloadValidationScreenshot.html b/static/api/apidocs-4.23/apis/downloadValidationScreenshot.html new file mode 100644 index 0000000000..3bc9dbf848 --- /dev/null +++ b/static/api/apidocs-4.23/apis/downloadValidationScreenshot.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

downloadValidationScreenshot

+

Download validation screenshot of given backup.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
backupidID of the backup.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of extracted object
accountidThe Account ID to which the extracted object belongs
createdThe time and date the object was created
extractIdThe upload ID of extracted object
extractModeThe mode of extraction - upload or download
nameThe name of the extracted object
stateThe state of the extracted object
statusThe status of the extraction
storagetypeType of the storage
uploadpercentageThe percentage of the entity uploaded to the specified location
urlIf mode = upload then URL of the uploaded entity. if mode = download the URL from which the entity can be downloaded
zoneidZone ID the object was extracted from
zonenameZone name the object was extracted from
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/enableAccount.html b/static/api/apidocs-4.23/apis/enableAccount.html new file mode 100644 index 0000000000..d81c720988 --- /dev/null +++ b/static/api/apidocs-4.23/apis/enableAccount.html @@ -0,0 +1,390 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

enableAccount

+

Enables an account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountEnables specified Account.false
domainidEnables specified Account in this domain.false
idAccount idfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Account
accountdetailsDetails for the account
accounttypeAccount type (admin, domain-admin, user)
apikeyaccesswhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
backupavailablethe total number of backups available to this account
backuplimitthe total number of backups which can be stored by this account
backupstorageavailablethe total backup storage space (in GiB) available to the account
backupstoragelimitthe total backup storage space (in GiB) the account can own
backupstoragetotalthe total backup storage space (in GiB) owned by the account
backuptotalthe total number of backups stored by this account
bucketavailablethe total number of buckets available to this account
bucketlimitthe total number of buckets which can be stored by this account
buckettotalthe total number of buckets stored by this account
cpuavailableThe total number of CPU cores available to be created for this account
cpulimitThe total number of CPU cores the account can own
cputotalThe total number of CPU cores owned by account
createdThe date when this account was created
defaultzoneidThe default zone of the Account
domainName of the Domain the Account belongs to
domainidID of the Domain the Account belongs to
domainpathPath of the Domain the Account belongs to
gpuavailablethe total number of gpus available to be created for this account
gpulimitthe total number of gpus the account can own
gputotalthe total number of gpus owned by account
groupsThe list of ACL groups that account belongs to
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this Account to acquire
iplimitThe total number of public IP addresses this Account can acquire
iptotalThe total number of public IP addresses allocated for this Account
iscleanuprequiredTrue if the account requires cleanup
isdefaultTrue if account is default, false otherwise
memoryavailableThe total memory (in MB) available to be created for this account
memorylimitThe total memory (in MB) the account can own
memorytotalThe total memory (in MB) owned by account
nameThe name of the Account
networkavailableThe total number of Networks available to be created for this Account
networkdomainThe Network domain
networklimitThe total number of Networks the Account can own
networktotalThe total number of Networks owned by Account
objectstorageavailablethe total object storage space (in GiB) available to the account
objectstoragelimitthe total object storage space (in GiB) the account can own
objectstoragetotalthe total object storage space (in GiB) owned by the account
primarystorageavailableThe total primary storage space (in GiB) available to be used for this account
primarystoragelimitThe total primary storage space (in GiB) the account can own
primarystoragetotalThe total primary storage space (in GiB) owned by account
projectavailableThe total number of projects available for administration by this Account
projectlimitThe total number of projects the Account can own
projecttotalThe total number of projects being administrated by this Account
receivedbytesThe total number of Network traffic bytes received
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role (Admin, ResourceAdmin, DomainAdmin, User)
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this account
secondarystoragelimitThe total secondary storage space (in GiB) the account can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by account
sentbytesThe total number of Network traffic bytes sent
snapshotavailableThe total number of Snapshots available for this Account
snapshotlimitThe total number of Snapshots which can be stored by this Account
snapshottotalThe total number of Snapshots stored by this Account
stateThe state of the account
taggedresourcesThe tagged resource limit and count for the account
templateavailableThe total number of Templates available to be created by this Account
templatelimitThe total number of Templates which can be created by this Account
templatetotalThe total number of Templates which have been created by this Account
vmavailableThe total number of Instances available for this Account to acquire
vmlimitThe total number of Instances that can be deployed by this Account
vmrunningThe total number of Instances running for this Account
vmstoppedThe total number of Instances stopped for this Account
vmtotalThe total number of Instances deployed by this Account
volumeavailableThe total volume available for this Account
volumelimitThe total volume which can be used by this Account
volumetotalThe total volume being used by this Account
vpcavailableThe total number of VPCs available to be created for this account
vpclimitThe total number of VPCs the Account can own
vpctotalThe total number of VPCs owned by account
user(*)The list of users associated with account
idThe user ID
accountThe Account name of the user
accountidThe Account ID of the user
accounttypeThe Account type of the user
apikeyThe API key of the user
apikeyaccessWhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
createdThe date and time the user Account was created
domainThe domain name of the user
domainidThe domain ID of the user
emailThe user email address
firstnameThe user firstname
iconBase64 string representation of the resource icon
is2faenabledTrue if user has two factor authentication enabled
is2famandatedTrue if user has two factor authentication is mandated
iscallerchilddomainThe boolean value representing if the updating target is in caller's child domain
isdefaultTrue if user is default, false otherwise
lastnameThe user lastname
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role
secretkeyThe secret key of the user
stateThe user state
timezoneThe timezone user was created in
usernameThe user name
usersourceThe source type of the user in lowercase, such as native, ldap, saml2
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/enableAutoScaleVmGroup.html b/static/api/apidocs-4.23/apis/enableAutoScaleVmGroup.html new file mode 100644 index 0000000000..a5ade234e4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/enableAutoScaleVmGroup.html @@ -0,0 +1,159 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

enableAutoScaleVmGroup

+

Enables an AutoScale Instance Group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the autoscale grouptrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe autoscale Instance group ID
accountThe Account owning the Instance group
associatednetworkidThe id of the guest Network the LB rule belongs to
associatednetworknameThe name of the guest Network the LB rule belongs to
availablevirtualmachinecountThe number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group
createdThe date when this Instance group was created
domainThe domain name of the Instance group
domainidThe domain ID of the Instance group
domainpathpath of the domain to which the vm group belongs
fordisplayIs group for display to the regular User
intervalThe frequency at which the conditions have to be evaluated
lbproviderThe LB provider of the guest Network the LB rule belongs to
lbruleidThe Load balancer rule ID
maxmembersThe maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.
minmembersThe minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.
nameThe name of the autoscale Instance group
privateportThe private port
projectThe project name of the Instance group
projectidThe project id of the Instance group
publicipThe public IP address
publicipidThe public IP address ID
publicportThe public port
scaledownpoliciesList of scaledown autoscale policies
scaleuppoliciesList of scaleup autoscale policies
stateThe current state of the AutoScale Instance Group
vmprofileidThe autoscale profile that contains information about the Instances in the Instance group.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/enableCiscoNexusVSM.html b/static/api/apidocs-4.23/apis/enableCiscoNexusVSM.html new file mode 100644 index 0000000000..ca7885c712 --- /dev/null +++ b/static/api/apidocs-4.23/apis/enableCiscoNexusVSM.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

enableCiscoNexusVSM

+

Enable a Cisco Nexus VSM device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idId of the Cisco Nexus 1000v VSM device to be enabledtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
ipaddressThe management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module
vsmconfigmodeThe mode of the VSM (standalone/HA)
vsmconfigstateThe Config State (Primary/Standby) of the VSM
vsmctrlvlanidControl VLAN ID of the VSM
vsmdeviceidDevice ID of the Cisco N1KV VSM device
vsmdevicenameDevice name
vsmdevicestateDevice state
vsmdevicestateThe Device State (Enabled/Disabled) of the VSM
vsmdomainidThe VSM is a switch supervisor. This is the VSM's switch domain ID
vsmmgmtvlanidManagement VLAN ID of the VSM
vsmpktvlanidPacket VLAN ID of the VSM
vsmstoragevlanidStorage VLAN ID of the VSM
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/enableHAForCluster.html b/static/api/apidocs-4.23/apis/enableHAForCluster.html new file mode 100644 index 0000000000..f530c65d49 --- /dev/null +++ b/static/api/apidocs-4.23/apis/enableHAForCluster.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

enableHAForCluster

+

Enables HA cluster-wide

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
clusteridID of the clustertrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/enableHAForHost.html b/static/api/apidocs-4.23/apis/enableHAForHost.html new file mode 100644 index 0000000000..e37b6e5a1b --- /dev/null +++ b/static/api/apidocs-4.23/apis/enableHAForHost.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

enableHAForHost

+

Enables HA for a host

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
hostidID of the hosttrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
haenableIf host HA is enabled for the host
haproviderThe host HA provider
hastateThe HA state of the host
hostidThe ID of the host
statusOperation status
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/enableHAForZone.html b/static/api/apidocs-4.23/apis/enableHAForZone.html new file mode 100644 index 0000000000..bd87d9b7d3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/enableHAForZone.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

enableHAForZone

+

Enables HA for a zone

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
zoneidID of the zonetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/enableOutOfBandManagementForCluster.html b/static/api/apidocs-4.23/apis/enableOutOfBandManagementForCluster.html new file mode 100644 index 0000000000..aa028a0f06 --- /dev/null +++ b/static/api/apidocs-4.23/apis/enableOutOfBandManagementForCluster.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

enableOutOfBandManagementForCluster

+

Enables out-of-band management for a cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
clusteridThe ID of the clustertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
actionThe out-of-band management action (if issued)
addressThe out-of-band management interface address
descriptionThe operation result description
driverThe out-of-band management driver for the host
enabledTrue if out-of-band management is enabled for the host
hostidThe ID of the host
passwordThe out-of-band management interface password
portThe out-of-band management interface port
powerstateThe out-of-band management interface powerState of the host
statusThe operation result
usernameThe out-of-band management interface username
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/enableOutOfBandManagementForHost.html b/static/api/apidocs-4.23/apis/enableOutOfBandManagementForHost.html new file mode 100644 index 0000000000..5a7f99418a --- /dev/null +++ b/static/api/apidocs-4.23/apis/enableOutOfBandManagementForHost.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

enableOutOfBandManagementForHost

+

Enables out-of-band management for a host

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
hostidThe ID of the hosttrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
actionThe out-of-band management action (if issued)
addressThe out-of-band management interface address
descriptionThe operation result description
driverThe out-of-band management driver for the host
enabledTrue if out-of-band management is enabled for the host
hostidThe ID of the host
passwordThe out-of-band management interface password
portThe out-of-band management interface port
powerstateThe out-of-band management interface powerState of the host
statusThe operation result
usernameThe out-of-band management interface username
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/enableOutOfBandManagementForZone.html b/static/api/apidocs-4.23/apis/enableOutOfBandManagementForZone.html new file mode 100644 index 0000000000..bb2ed1ce0d --- /dev/null +++ b/static/api/apidocs-4.23/apis/enableOutOfBandManagementForZone.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

enableOutOfBandManagementForZone

+

Enables out-of-band management for a zone

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
zoneidThe ID of the zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
actionThe out-of-band management action (if issued)
addressThe out-of-band management interface address
descriptionThe operation result description
driverThe out-of-band management driver for the host
enabledTrue if out-of-band management is enabled for the host
hostidThe ID of the host
passwordThe out-of-band management interface password
portThe out-of-band management interface port
powerstateThe out-of-band management interface powerState of the host
statusThe operation result
usernameThe out-of-band management interface username
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/enableRole.html b/static/api/apidocs-4.23/apis/enableRole.html new file mode 100644 index 0000000000..a8a65c86e9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/enableRole.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

enableRole

+

Enables a role

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the roletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/enableStaticNat.html b/static/api/apidocs-4.23/apis/enableStaticNat.html new file mode 100644 index 0000000000..4bbed5d041 --- /dev/null +++ b/static/api/apidocs-4.23/apis/enableStaticNat.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

enableStaticNat

+

Enables static NAT for given IP address

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
ipaddressidThe public IP address ID for which static NAT feature is being enabledtrue
virtualmachineidThe ID of the Instance for enabling static NAT featuretrue
networkidThe Network of the Instance the static NAT will be enabled for. Required when public IP address is not associated with any guest Network yet (VPC case)false
vmguestipVM guest NIC secondary IP address for the port forwarding rulefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/enableStorageMaintenance.html b/static/api/apidocs-4.23/apis/enableStorageMaintenance.html new file mode 100644 index 0000000000..a90caacfc7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/enableStorageMaintenance.html @@ -0,0 +1,186 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

enableStorageMaintenance

+

Puts storage pool into maintenance state

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idPrimary storage IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the storage pool
allocatediopsTotal min IOPS currently in use by volumes
capacitybytesbytes CloudStack can provision from this storage pool
capacityiopsIOPS CloudStack can provision from this storage pool
clusteridThe ID of the cluster for the storage pool
clusternameThe name of the cluster for the storage pool
createdThe date and time the storage pool was created
detailsthe storage pool details
disksizeallocatedThe pool's currently allocated disk size
disksizetotalThe total disk size of the storage pool
disksizeusedThe pool's currently used disk size
hypervisorThe hypervisor type of the storage pool
ipaddressThe IP address of the storage pool
istagaruleWhether the informed tag is a JS interpretable rule or not.
managedwhether this pool is managed or not
nameThe name of the storage pool
nfsmountoptsthe nfs mount options for the storage pool
overprovisionfactorThe overprovisionfactor for the storage pool
pathThe storage pool path
podidThe Pod ID of the storage pool
podnameThe Pod name of the storage pool
providerStorage provider for this pool
scopeThe scope of the storage pool
stateThe state of the storage pool
storageaccessgroupsthe storage access groups for the storage pool
storagecapabilitiesThe storage pool capabilities
storagecustomstatsthe storage pool custom stats
suitableformigrationTrue if this pool is suitable to migrate a volume, false otherwise
tagsThe tags for the storage pool
typeThe storage pool type
usediopstotal IOPS currently in use
zoneidThe Zone ID of the storage pool
zonenameThe Zone name of the storage pool
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/enableUser.html b/static/api/apidocs-4.23/apis/enableUser.html new file mode 100644 index 0000000000..28e8cd5ec7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/enableUser.html @@ -0,0 +1,156 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

enableUser

+

Enables a user account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idEnables user by user ID.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe user ID
accountThe Account name of the user
accountidThe Account ID of the user
accounttypeThe Account type of the user
apikeyThe API key of the user
apikeyaccessWhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
createdThe date and time the user Account was created
domainThe domain name of the user
domainidThe domain ID of the user
emailThe user email address
firstnameThe user firstname
iconBase64 string representation of the resource icon
is2faenabledTrue if user has two factor authentication enabled
is2famandatedTrue if user has two factor authentication is mandated
iscallerchilddomainThe boolean value representing if the updating target is in caller's child domain
isdefaultTrue if user is default, false otherwise
lastnameThe user lastname
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role
secretkeyThe secret key of the user
stateThe user state
timezoneThe timezone user was created in
usernameThe user name
usersourceThe source type of the user in lowercase, such as native, ldap, saml2
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/executeClusterDrsPlan.html b/static/api/apidocs-4.23/apis/executeClusterDrsPlan.html new file mode 100644 index 0000000000..6f7a636844 --- /dev/null +++ b/static/api/apidocs-4.23/apis/executeClusterDrsPlan.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

executeClusterDrsPlan

+

Execute DRS for a cluster. If there is another plan in progress for the same cluster, this command will fail.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idID of clustertrue
migratetoVirtual 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idunique ID of the drs plan for cluster
clusteridId of the cluster
eventidStart event Id of the DRS Plan
migrationsList of migrations
statusStatus of DRS Plan
typeType of DRS Plan (Automated or Manual))
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/executeWebhookDelivery.html b/static/api/apidocs-4.23/apis/executeWebhookDelivery.html new file mode 100644 index 0000000000..ab8fbd5c9c --- /dev/null +++ b/static/api/apidocs-4.23/apis/executeWebhookDelivery.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

executeWebhookDelivery

+

Executes a Webhook delivery

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Webhook delivery for redeliveryfalse
payloadPayload of the Webhook deliveryfalse
payloadurlPayload URL of the Webhook deliveryfalse
secretkeySecret key of the Webhook deliveryfalse
sslverificationIf set to true then SSL verification will be done for the Webhook delivery otherwise notfalse
webhookidThe ID of the Webhookfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Webhook delivery
enddateThe end time of the Webhook delivery
eventidThe ID of the event
eventtypeThe type of the event
headersThe headers of the webhook delivery
managementserveridThe ID of the management server which executed delivery
managementservernameThe name of the management server which executed delivery
payloadThe payload of the webhook delivery
responseThe response of the webhook delivery
startdateThe start time of the Webhook delivery
successWhether Webhook delivery succeeded or not
webhookidThe ID of the Webhook
webhooknameThe name of the Webhook
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/expungeSharedFileSystem.html b/static/api/apidocs-4.23/apis/expungeSharedFileSystem.html new file mode 100644 index 0000000000..19799d6ea6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/expungeSharedFileSystem.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

expungeSharedFileSystem

+

Expunge a Shared FileSystem by id

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the shared filesystem to expungefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/expungeVirtualMachine.html b/static/api/apidocs-4.23/apis/expungeVirtualMachine.html new file mode 100644 index 0000000000..3d5a2ed23e --- /dev/null +++ b/static/api/apidocs-4.23/apis/expungeVirtualMachine.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

expungeVirtualMachine

+

Expunge an Instance. Once expunged, it cannot be recovered.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instancetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/extractIso.html b/static/api/apidocs-4.23/apis/extractIso.html new file mode 100644 index 0000000000..297aad42e7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/extractIso.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

extractIso

+

Extracts an ISO

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the ISO filetrue
modeThe mode of extraction - HTTP_DOWNLOAD or FTP_UPLOADtrue
urlThe URL to which the ISO would be extractedfalse
zoneidThe ID of the zone where the ISO is originally locatedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of extracted object
accountidThe Account ID to which the extracted object belongs
createdThe time and date the object was created
extractIdThe upload ID of extracted object
extractModeThe mode of extraction - upload or download
nameThe name of the extracted object
stateThe state of the extracted object
statusThe status of the extraction
storagetypeType of the storage
uploadpercentageThe percentage of the entity uploaded to the specified location
urlIf mode = upload then URL of the uploaded entity. if mode = download the URL from which the entity can be downloaded
zoneidZone ID the object was extracted from
zonenameZone name the object was extracted from
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/extractSnapshot.html b/static/api/apidocs-4.23/apis/extractSnapshot.html new file mode 100644 index 0000000000..0c177c516e --- /dev/null +++ b/static/api/apidocs-4.23/apis/extractSnapshot.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

extractSnapshot

+

Returns a download URL for extracting a snapshot. It must be in the Backed Up state.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the snapshottrue
zoneidthe ID of the zone where the snapshot is locatedtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of extracted object
accountidThe Account ID to which the extracted object belongs
createdThe time and date the object was created
extractIdThe upload ID of extracted object
extractModeThe mode of extraction - upload or download
nameThe name of the extracted object
stateThe state of the extracted object
statusThe status of the extraction
storagetypeType of the storage
uploadpercentageThe percentage of the entity uploaded to the specified location
urlIf mode = upload then URL of the uploaded entity. if mode = download the URL from which the entity can be downloaded
zoneidZone ID the object was extracted from
zonenameZone name the object was extracted from
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/extractTemplate.html b/static/api/apidocs-4.23/apis/extractTemplate.html new file mode 100644 index 0000000000..64014b0895 --- /dev/null +++ b/static/api/apidocs-4.23/apis/extractTemplate.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

extractTemplate

+

Extracts a Template

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Templatetrue
modeThe mode of extraction - HTTP_DOWNLOAD or FTP_UPLOADtrue
urlThe url to which the ISO would be extractedfalse
zoneidThe ID of the zone where the ISO is originally locatedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of extracted object
accountidThe Account ID to which the extracted object belongs
createdThe time and date the object was created
extractIdThe upload ID of extracted object
extractModeThe mode of extraction - upload or download
nameThe name of the extracted object
stateThe state of the extracted object
statusThe status of the extraction
storagetypeType of the storage
uploadpercentageThe percentage of the entity uploaded to the specified location
urlIf mode = upload then URL of the uploaded entity. if mode = download the URL from which the entity can be downloaded
zoneidZone ID the object was extracted from
zonenameZone name the object was extracted from
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/extractVolume.html b/static/api/apidocs-4.23/apis/extractVolume.html new file mode 100644 index 0000000000..05ea96cd81 --- /dev/null +++ b/static/api/apidocs-4.23/apis/extractVolume.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

extractVolume

+

Extracts volume

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the volumetrue
modeThe mode of extraction - HTTP_DOWNLOAD or FTP_UPLOADtrue
zoneidThe ID of the zone where the volume is locatedtrue
urlThe URL to which the volume would be extractedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of extracted object
accountidThe Account ID to which the extracted object belongs
createdThe time and date the object was created
extractIdThe upload ID of extracted object
extractModeThe mode of extraction - upload or download
nameThe name of the extracted object
stateThe state of the extracted object
statusThe status of the extraction
storagetypeType of the storage
uploadpercentageThe percentage of the entity uploaded to the specified location
urlIf mode = upload then URL of the uploaded entity. if mode = download the URL from which the entity can be downloaded
zoneidZone ID the object was extracted from
zonenameZone name the object was extracted from
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/finalizeBackup.html b/static/api/apidocs-4.23/apis/finalizeBackup.html new file mode 100644 index 0000000000..181d06fc8a --- /dev/null +++ b/static/api/apidocs-4.23/apis/finalizeBackup.html @@ -0,0 +1,174 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

finalizeBackup

+

Finalize a VM backup session. This API is intended for testing only and is disabled by default.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the backuptrue
virtualmachineidID of the VMtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the Instance backup
accountAccount name
accountidAccount id
backupofferingidBackup offering id
backupofferingnameBackup offering name
compressionstatusBackup compression status.
createdBackup date
descriptiondescription for the backup
domainDomain name
domainidDomain ID
externalidExternal backup id
fromcheckpointidPrevious active checkpoint ID for incremental backups
hostidHost ID where the backup is running
intervaltypeInterval type of the backup
isbackupvmexpungedIndicates whether the VM from which the backup was taken is expunged or not
namename of the backup
sizeBackup size in bytes
statusBackup status
tocheckpointidNext checkpoint ID for incremental backups
typeBackup type
uncompressedsizeBackup uncompressed size in bytes. Only defined if backup is compressed.
validationstatusBackup validation status.
virtualmachineidID of the Instance
virtualmachinenameName of the Instance
virtualsizeBackup protected (virtual) size in bytes
vmbackupofferingremovedThe backup offering corresponding to this backup was removed from the VM
vmdetailsLists the vm specific details for the backup
volumesBacked up volumes
zoneZone name
zoneidZone ID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/finalizeImageTransfer.html b/static/api/apidocs-4.23/apis/finalizeImageTransfer.html new file mode 100644 index 0000000000..ccd692f39d --- /dev/null +++ b/static/api/apidocs-4.23/apis/finalizeImageTransfer.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

finalizeImageTransfer

+

Finalize an image transfer. This API is intended for testing only and is disabled by default.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the image transfertrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/findHostsForMigration.html b/static/api/apidocs-4.23/apis/findHostsForMigration.html new file mode 100644 index 0000000000..d385d573e9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/findHostsForMigration.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

findHostsForMigration

+

Find hosts suitable for migrating an Instance.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidFind hosts to which this Instance can be migrated and flag the hosts with enough CPU/RAM to host the Instancetrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
requiresStorageMotionTrue if migrating an Instance to this host requires storage motion, false otherwise
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/findStoragePoolsForMigration.html b/static/api/apidocs-4.23/apis/findStoragePoolsForMigration.html new file mode 100644 index 0000000000..a919a1c7b9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/findStoragePoolsForMigration.html @@ -0,0 +1,195 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

findStoragePoolsForMigration

+

Lists storage pools available for migration of a volume.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the volumetrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the storage pool
allocatediopsTotal min IOPS currently in use by volumes
capacitybytesbytes CloudStack can provision from this storage pool
capacityiopsIOPS CloudStack can provision from this storage pool
clusteridThe ID of the cluster for the storage pool
clusternameThe name of the cluster for the storage pool
createdThe date and time the storage pool was created
detailsthe storage pool details
disksizeallocatedThe pool's currently allocated disk size
disksizetotalThe total disk size of the storage pool
disksizeusedThe pool's currently used disk size
hypervisorThe hypervisor type of the storage pool
ipaddressThe IP address of the storage pool
istagaruleWhether the informed tag is a JS interpretable rule or not.
managedwhether this pool is managed or not
nameThe name of the storage pool
nfsmountoptsthe nfs mount options for the storage pool
overprovisionfactorThe overprovisionfactor for the storage pool
pathThe storage pool path
podidThe Pod ID of the storage pool
podnameThe Pod name of the storage pool
providerStorage provider for this pool
scopeThe scope of the storage pool
stateThe state of the storage pool
storageaccessgroupsthe storage access groups for the storage pool
storagecapabilitiesThe storage pool capabilities
storagecustomstatsthe storage pool custom stats
suitableformigrationTrue if this pool is suitable to migrate a volume, false otherwise
tagsThe tags for the storage pool
typeThe storage pool type
usediopstotal IOPS currently in use
zoneidThe Zone ID of the storage pool
zonenameThe Zone name of the storage pool
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/finishBackupChain.html b/static/api/apidocs-4.23/apis/finishBackupChain.html new file mode 100644 index 0000000000..5bc6362cc9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/finishBackupChain.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

finishBackupChain

+

Finish the backup chain of VM. Currently only has effect on VMs with KBOSS backup offerings.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidID of the VM to finish the chain.true
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/forgotPassword.html b/static/api/apidocs-4.23/apis/forgotPassword.html new file mode 100644 index 0000000000..7e174ad903 --- /dev/null +++ b/static/api/apidocs-4.23/apis/forgotPassword.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

forgotPassword

+

Sends an email to the user with a token to reset the password using resetPassword command.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
usernameUsernametrue
domainPath 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
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/generateAlert.html b/static/api/apidocs-4.23/apis/generateAlert.html new file mode 100644 index 0000000000..991cea4b6f --- /dev/null +++ b/static/api/apidocs-4.23/apis/generateAlert.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

generateAlert

+

Generates an alert

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
descriptionAlert descriptiontrue
nameName of the alerttrue
typeType of the alerttrue
podidPod id for which alert is generatedfalse
zoneidZone id for which alert is generatedfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/generateClusterDrsPlan.html b/static/api/apidocs-4.23/apis/generateClusterDrsPlan.html new file mode 100644 index 0000000000..51eb93fc53 --- /dev/null +++ b/static/api/apidocs-4.23/apis/generateClusterDrsPlan.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

generateClusterDrsPlan

+

Generate DRS plan for a cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the Clustertrue
migrationsMaximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations settingfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idunique ID of the drs plan for cluster
clusteridId of the cluster
eventidStart event Id of the DRS Plan
migrationsList of migrations
statusStatus of DRS Plan
typeType of DRS Plan (Automated or Manual))
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/generateUsageRecords.html b/static/api/apidocs-4.23/apis/generateUsageRecords.html new file mode 100644 index 0000000000..071735a1f4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/generateUsageRecords.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

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

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
domainidList events for the specified domain.false
enddateEnd date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.false
startdateStart date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getApiLimit.html b/static/api/apidocs-4.23/apis/getApiLimit.html new file mode 100644 index 0000000000..80d727c4ca --- /dev/null +++ b/static/api/apidocs-4.23/apis/getApiLimit.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getApiLimit

+

Get API limit count for the caller

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account name of the api remaining count
accountidThe Account UUID of the api remaining count
apiAllowedCurrently allowed number of APIs
apiIssuedNumber of API already issued
expireAfterSeconds left to reset counters
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getCloudIdentifier.html b/static/api/apidocs-4.23/apis/getCloudIdentifier.html new file mode 100644 index 0000000000..c69599ba0c --- /dev/null +++ b/static/api/apidocs-4.23/apis/getCloudIdentifier.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getCloudIdentifier

+

Retrieves a cloud identifier.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
useridThe user ID for the cloud identifiertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
cloudidentifierThe cloud identifier
signatureThe signed response for the cloud identifier
useridThe User ID for the cloud identifier
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getDiagnosticsData.html b/static/api/apidocs-4.23/apis/getDiagnosticsData.html new file mode 100644 index 0000000000..8870020ce4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/getDiagnosticsData.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getDiagnosticsData

+

Get diagnostics and files from System VMs

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
targetidThe ID of the System VM to retrieve diagnostics data files fromtrue
filesA comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided.false
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
urlStorage URL to download retrieve diagnostics data files
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getHypervisorGuestOsNames.html b/static/api/apidocs-4.23/apis/getHypervisorGuestOsNames.html new file mode 100644 index 0000000000..c95442482a --- /dev/null +++ b/static/api/apidocs-4.23/apis/getHypervisorGuestOsNames.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getHypervisorGuestOsNames

+

Gets the guest OS names in the hypervisor

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hypervisorHypervisor type. One of : VMware, XenServertrue
hypervisorversionHypervisor version to get the guest OS names (at least one hypervisor host with the version specified must be available)true
keywordKeyword for guest OS namefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
guestoscountThe guest OS count of the hypervisor
hypervisorThe hypervisor
hypervisorversionVersion of the hypervisor for guest os names
guestoslist(*)The guest OS list of the hypervisor
osdisplaynameStandard display name for the Guest OS
osnameforhypervisorHypervisor specific name for the Guest OS
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getKubernetesClusterConfig.html b/static/api/apidocs-4.23/apis/getKubernetesClusterConfig.html new file mode 100644 index 0000000000..e205ca2cdd --- /dev/null +++ b/static/api/apidocs-4.23/apis/getKubernetesClusterConfig.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getKubernetesClusterConfig

+

Get Kubernetes cluster config

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Kubernetes clusterfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
idThe ID of the container cluster
configdataThe config data of the cluster
nameName of the container cluster
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getLoadBalancerSslCertificate.html b/static/api/apidocs-4.23/apis/getLoadBalancerSslCertificate.html new file mode 100644 index 0000000000..b99827b9b5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/getLoadBalancerSslCertificate.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getLoadBalancerSslCertificate

+

Get load balancer certificate

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of Lbtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
chainchain
crtcrt
keyKey
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getPathForVolume.html b/static/api/apidocs-4.23/apis/getPathForVolume.html new file mode 100644 index 0000000000..88320af1d0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/getPathForVolume.html @@ -0,0 +1,84 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getPathForVolume

+

Get the path associated with the provided volume UUID

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
volumeidCloudStack Volume UUIDtrue
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
pathThe path field for the volume
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getRouterHealthCheckResults.html b/static/api/apidocs-4.23/apis/getRouterHealthCheckResults.html new file mode 100644 index 0000000000..7c53d6bc6f --- /dev/null +++ b/static/api/apidocs-4.23/apis/getRouterHealthCheckResults.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getRouterHealthCheckResults

+

Starts a router.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
routeridThe ID of the routertrue
performfreshchecksIf true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetchedfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
healthchecksThe ID of the router
routeridThe ID of the router
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getSPMetadata.html b/static/api/apidocs-4.23/apis/getSPMetadata.html new file mode 100644 index 0000000000..966f3cb61f --- /dev/null +++ b/static/api/apidocs-4.23/apis/getSPMetadata.html @@ -0,0 +1,81 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getSPMetadata

+

Returns SAML2 CloudStack Service Provider MetaData

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
metadataThe Metadata XML
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getSolidFireAccountId.html b/static/api/apidocs-4.23/apis/getSolidFireAccountId.html new file mode 100644 index 0000000000..8b6b248e8b --- /dev/null +++ b/static/api/apidocs-4.23/apis/getSolidFireAccountId.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getSolidFireAccountId

+

Get SolidFire Account ID

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
accountidCloudStack Account UUIDtrue
storageidStorage Pool UUIDtrue
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
solidFireAccountIdSolidFire Account ID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getSolidFireVolumeAccessGroupIds.html b/static/api/apidocs-4.23/apis/getSolidFireVolumeAccessGroupIds.html new file mode 100644 index 0000000000..2702ca83bb --- /dev/null +++ b/static/api/apidocs-4.23/apis/getSolidFireVolumeAccessGroupIds.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getSolidFireVolumeAccessGroupIds

+

Get the SF Volume Access Group IDs

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
clusteridCluster UUIDtrue
storageidStorage Pool UUIDtrue
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
solidFireVolumeAccessGroupIdsSolidFire Volume Access Group Ids
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getSolidFireVolumeSize.html b/static/api/apidocs-4.23/apis/getSolidFireVolumeSize.html new file mode 100644 index 0000000000..33f66c77f9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/getSolidFireVolumeSize.html @@ -0,0 +1,84 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getSolidFireVolumeSize

+

Get the SF volume size including Hypervisor Snapshot Reserve

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
volumeidVolume UUIDtrue
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
solidFireVolumeSizeSolidFire Volume Size Including Hypervisor Snapshot Reserve
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getUploadParamsForIso.html b/static/api/apidocs-4.23/apis/getUploadParamsForIso.html new file mode 100644 index 0000000000..8dcaf23053 --- /dev/null +++ b/static/api/apidocs-4.23/apis/getUploadParamsForIso.html @@ -0,0 +1,137 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getUploadParamsForIso

+

Upload an existing ISO into the CloudStack cloud.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
formatThe format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.true
nameThe name of the Volume/Template/ISOtrue
zoneidThe ID of the zone the Volume/Template/ISO is to be hosted ontrue
accountAn optional accountName. Must be used with domainId.false
bootableTrue if this ISO is bootable. If not passed explicitly its assumed to be truefalse
checksumThe 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
displaytextThe display text of the ISO. This is usually used for display purposes.false
domainidAn optional domainId. If the Account parameter is used, domainId must also be used.false
isextractableTrue if the ISO or its derivatives are extractable; default is falsefalse
isfeaturedTrue if you want this ISO to be featuredfalse
ispublicTrue if you want to register the ISO to be publicly available to all Users, false otherwise.false
ostypeidThe ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passedfalse
projectidUpload Volume/Template/ISO for the projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template/volume ID
expiresThe timestamp after which the signature expires
metadataEncrypted data to be sent in the POST request.
postURLPOST url to upload the file to
signatureSignature to be sent in the POST request.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getUploadParamsForKubernetesSupportedVersion.html b/static/api/apidocs-4.23/apis/getUploadParamsForKubernetesSupportedVersion.html new file mode 100644 index 0000000000..a8efce4c8b --- /dev/null +++ b/static/api/apidocs-4.23/apis/getUploadParamsForKubernetesSupportedVersion.html @@ -0,0 +1,172 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getUploadParamsForKubernetesSupportedVersion

+

Upload a supported Kubernetes version

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
formatThe format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.true
mincpunumberthe minimum number of CPUs to be set with the Kubernetes versiontrue
minmemorythe minimum RAM size in MB to be set with the Kubernetes versiontrue
nameThe name of the Volume/Template/ISOtrue
semanticversionthe semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH formattrue
zoneidThe ID of the zone the Volume/Template/ISO is to be hosted ontrue
accountAn optional accountName. Must be used with domainId.false
checksumthe 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
checksumThe 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
domainidAn optional domainId. If the Account parameter is used, domainId must also be used.false
projectidUpload Volume/Template/ISO for the projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Kubernetes supported version
archthe arch of the binaries ISO for Kubernetes supported version
createdThe date when this Kubernetes supported version was created
directdownloadKVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage
isoidThe ID of the binaries ISO for Kubernetes supported version
isonameThe name of the binaries ISO for Kubernetes supported version
isostateThe state of the binaries ISO for Kubernetes supported version
isourlthe URL of the binaries ISO for Kubernetes supported version
mincpunumberThe minimum number of CPUs needed for the Kubernetes supported version
minmemoryThe minimum RAM size in MB needed for the Kubernetes supported version
nameName of the Kubernetes supported version
semanticversionKubernetes semantic version
stateThe enabled or disabled state of the Kubernetes supported version
supportsautoscalingWhether Kubernetes supported version supports Autoscaling
supportshaWhether Kubernetes supported version supports HA, multi-control nodes
zoneidThe ID of the zone in which Kubernetes supported version is available
zonenameThe name of the zone in which Kubernetes supported version is available
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getUploadParamsForTemplate.html b/static/api/apidocs-4.23/apis/getUploadParamsForTemplate.html new file mode 100644 index 0000000000..6bca1f6b30 --- /dev/null +++ b/static/api/apidocs-4.23/apis/getUploadParamsForTemplate.html @@ -0,0 +1,173 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getUploadParamsForTemplate

+

Upload an existing Template into the CloudStack cloud.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
formatThe format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.true
hypervisorThe target hypervisor for the Templatetrue
nameThe name of the Volume/Template/ISOtrue
zoneidThe ID of the zone the Volume/Template/ISO is to be hosted ontrue
accountAn optional accountName. Must be used with domainId.false
archthe CPU arch of the template. Valid options are: x86_64, aarch64, s390xfalse
bits32 or 64 bits support. 64 by defaultfalse
checksumThe 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
deployasis(VMware only) true if Instance deployments should preserve all the configurations defined for this Templatefalse
detailsTemplate details in key/value pairs.false
displaytextThe display text of the Template. This is usually used for display purposes.false
domainidAn optional domainId. If the Account parameter is used, domainId must also be used.false
forcksif true, the templates would be available for deploying CKS clustersfalse
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memoryfalse
isextractableTrue if the Template or its derivatives are extractable; default is falsefalse
isfeaturedTrue if this Template is a featured Template, false otherwisefalse
ispublicTrue if the Template is available to all accounts; default is truefalse
isroutingTrue if the Template type is routing i.e., if Template is used to deploy routerfalse
ostypeidThe 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
passwordenabledTrue if the Template supports the password reset feature; default is falsefalse
projectidUpload Volume/Template/ISO for the projectfalse
requireshvmTrue if this Template requires HVMfalse
sshkeyenabledTrue if the Template supports the SSHkey upload feature; default is falsefalse
templatetagThe tag for this Template.false
templatetypethe type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template/volume ID
expiresThe timestamp after which the signature expires
metadataEncrypted data to be sent in the POST request.
postURLPOST url to upload the file to
signatureSignature to be sent in the POST request.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getUploadParamsForVolume.html b/static/api/apidocs-4.23/apis/getUploadParamsForVolume.html new file mode 100644 index 0000000000..0c2e81f611 --- /dev/null +++ b/static/api/apidocs-4.23/apis/getUploadParamsForVolume.html @@ -0,0 +1,125 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getUploadParamsForVolume

+

Upload a data disk to the cloudstack cloud.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
formatThe format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.true
nameThe name of the Volume/Template/ISOtrue
zoneidThe ID of the zone the Volume/Template/ISO is to be hosted ontrue
accountAn optional accountName. Must be used with domainId.false
checksumThe 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
diskofferingidThe ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.false
domainidAn optional domainId. If the Account parameter is used, domainId must also be used.false
imagestoreuuidImage store uuidfalse
projectidUpload Volume/Template/ISO for the projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template/volume ID
expiresThe timestamp after which the signature expires
metadataEncrypted data to be sent in the POST request.
postURLPOST url to upload the file to
signatureSignature to be sent in the POST request.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getUser.html b/static/api/apidocs-4.23/apis/getUser.html new file mode 100644 index 0000000000..39e8b8109e --- /dev/null +++ b/static/api/apidocs-4.23/apis/getUser.html @@ -0,0 +1,156 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getUser

+

Find user account by API key

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
userapikeyAPI key of the usertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe user ID
accountThe Account name of the user
accountidThe Account ID of the user
accounttypeThe Account type of the user
apikeyThe API key of the user
apikeyaccessWhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
createdThe date and time the user Account was created
domainThe domain name of the user
domainidThe domain ID of the user
emailThe user email address
firstnameThe user firstname
iconBase64 string representation of the resource icon
is2faenabledTrue if user has two factor authentication enabled
is2famandatedTrue if user has two factor authentication is mandated
iscallerchilddomainThe boolean value representing if the updating target is in caller's child domain
isdefaultTrue if user is default, false otherwise
lastnameThe user lastname
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role
secretkeyThe secret key of the user
stateThe user state
timezoneThe timezone user was created in
usernameThe user name
usersourceThe source type of the user in lowercase, such as native, ldap, saml2
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getUserKeys.html b/static/api/apidocs-4.23/apis/getUserKeys.html new file mode 100644 index 0000000000..cf14eb55df --- /dev/null +++ b/static/api/apidocs-4.23/apis/getUserKeys.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getUserKeys

+

Queries the last registered secret and API keys of a user.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the user whose keys are requiredtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
apikeyThe API key of the registered user
apikeyaccessWhether API key access is allowed or not
secretkeyThe secret key of the registered user
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getVMPassword.html b/static/api/apidocs-4.23/apis/getVMPassword.html new file mode 100644 index 0000000000..23606aec4d --- /dev/null +++ b/static/api/apidocs-4.23/apis/getVMPassword.html @@ -0,0 +1,84 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getVMPassword

+

Returns an encrypted password for the Instance

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instancetrue
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
encryptedpasswordThe base64 encoded encrypted password of the Instance
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getVirtualMachineUserData.html b/static/api/apidocs-4.23/apis/getVirtualMachineUserData.html new file mode 100644 index 0000000000..02d72ac35c --- /dev/null +++ b/static/api/apidocs-4.23/apis/getVirtualMachineUserData.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getVirtualMachineUserData

+

Returns user data associated with the Instance

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidThe ID of the Instancetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
userdataBase64 encoded Instance User Data
virtualmachineidThe ID of the Instance
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getVolumeSnapshotDetails.html b/static/api/apidocs-4.23/apis/getVolumeSnapshotDetails.html new file mode 100644 index 0000000000..40f4699cf0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/getVolumeSnapshotDetails.html @@ -0,0 +1,84 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getVolumeSnapshotDetails

+

Get Volume Snapshot Details

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
snapshotidCloudStack Snapshot UUIDtrue
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
volumeiScsiNameVolume iSCSI Name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/getVolumeiScsiName.html b/static/api/apidocs-4.23/apis/getVolumeiScsiName.html new file mode 100644 index 0000000000..672fa1e8a9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/getVolumeiScsiName.html @@ -0,0 +1,84 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

getVolumeiScsiName

+

Get Volume's iSCSI Name

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
volumeidCloudStack Volume UUIDtrue
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
volumeiScsiNameVolume iSCSI Name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/importBackupOffering.html b/static/api/apidocs-4.23/apis/importBackupOffering.html new file mode 100644 index 0000000000..db5541ae02 --- /dev/null +++ b/static/api/apidocs-4.23/apis/importBackupOffering.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

importBackupOffering

+

Imports a backup offering using a backup provider

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
allowuserdrivenbackupsWhether users are allowed to create adhoc backups and backup schedulestrue
descriptionThe description of the backup offeringtrue
externalidThe backup offering ID (from backup provider side)true
nameThe name of the backup offeringtrue
zoneidThe zone IDtrue
domainidthe ID of the containing domain(s), null for public offeringsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the backup offering
allowuserdrivenbackupsWhether the offering allows User driven ad-hoc/scheduled backups
backupofferingdetailsDetails for the backup offering
createdThe date this backup offering was created
crosszoneinstancecreationthe backups with this offering can be used to create Instances on all Zones
descriptionDescription for the backup offering
domainthe domain name(s) this backup offering belongs to.
domainidthe domain ID(s) this backup offering belongs to.
externalidExternal ID on the provider side
nameName for the backup offering
providerprovider name
zoneidZone ID
zonenameZone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/importLdapUsers.html b/static/api/apidocs-4.23/apis/importLdapUsers.html new file mode 100644 index 0000000000..c13b600b71 --- /dev/null +++ b/static/api/apidocs-4.23/apis/importLdapUsers.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

importLdapUsers

+

Import LDAP users

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountCreates the user under the specified account. If no account is specified, the username will be used as the account name.false
accountdetailsDetails for account used to store specific parametersfalse
accounttypeType of the account. Specify 0 for user, 1 for root admin, and 2 for domain adminfalse
domainidSpecifies 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 domainfalse
groupSpecifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.false
keywordList by keywordfalse
pagefalse
pagesizefalse
roleidCreates the account under the specified role.false
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
conflictingusersourceThe authentication source for this user as known to the system or empty if the user is not yet in cloudstack.
domainThe user's domain
emailThe user's email
firstnameThe user's firstname
lastnameThe user's lastname
principalThe user's principle
usernameThe user's username
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/importNetworkACL.html b/static/api/apidocs-4.23/apis/importNetworkACL.html new file mode 100644 index 0000000000..f0e7ff31f1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/importNetworkACL.html @@ -0,0 +1,165 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

importNetworkACL

+

Imports Network ACL rules.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
aclidThe ID of the Network ACL to which the rules will be importedtrue
rulesRules param list, id and protocol are must. Invalid rules will be discarded. Example: rules[0].id=101&rules[0].protocol=tcp&rules[0].traffictype=ingress&rules[0].state=active&rules[0].cidrlist=192.168.1.0/24&rules[0].tags=web&rules[0].aclid=acl-001&rules[0].aclname=web-acl&rules[0].number=1&rules[0].action=allow&rules[0].fordisplay=true&rules[0].description=allow%20web%20traffic&rules[1].id=102&rules[1].protocol=udp&rules[1].traffictype=egress&rules[1].state=enabled&rules[1].cidrlist=10.0.0.0/8&rules[1].tags=db&rules[1].aclid=acl-002&rules[1].aclname=db-acl&rules[1].number=2&rules[1].action=deny&rules[1].fordisplay=false&rules[1].description=deny%20database%20traffictrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the ACL Item
aclidThe ID of the ACL this item belongs to
aclnameThe name of the ACL this item belongs to
actionAction of ACL Item. Allow/Deny
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
endportThe ending port of ACL's port range
fordisplayIs rule for display to the regular user
icmpcodeError code for this icmp message
icmptypeType of the icmp message being sent
numberNumber of the ACL Item
protocolThe protocol of the ACL
reasonAn explanation on why this ACL rule is being applied
startportThe starting port of ACL's port range
stateThe state of the rule
traffictypeThe traffic type for the ACL
tags(*)The list of resource tags associated with the Network ACLs
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/importRole.html b/static/api/apidocs-4.23/apis/importRole.html new file mode 100644 index 0000000000..ab9655ba54 --- /dev/null +++ b/static/api/apidocs-4.23/apis/importRole.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

importRole

+

Imports a role based on provided map of rule permissions

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameCreates a role with this unique nametrue
rulesRules 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=listingtrue
descriptionThe description of the rolefalse
forcedForce create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false.false
ispublicIndicates 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
typeThe type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, Userfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
isdefaultTrue if role is default, false otherwise
statethe state of the role
typeThe type of the role
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/importUnmanagedInstance.html b/static/api/apidocs-4.23/apis/importUnmanagedInstance.html new file mode 100644 index 0000000000..36cbf900fb --- /dev/null +++ b/static/api/apidocs-4.23/apis/importUnmanagedInstance.html @@ -0,0 +1,738 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

importUnmanagedInstance

+

Import unmanaged Instance from a given cluster.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
clusteridThe cluster IDtrue
nameThe name of the Instance as it is known to the hypervisortrue
serviceofferingidThe service offering for the Instancetrue
accountAn optional account for the Instance. Must be used with domainId.false
datadiskofferinglistDatadisk Template to disk-offering mapping using keys disk and diskOfferingfalse
detailsUsed to specify the custom parameters.false
displaynameThe display name of the Instancefalse
domainidImport Instance to the domain specifiedfalse
forcedInstance 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 generatedfalse
hostnameThe host name of the Instancefalse
migrateallowedInstance and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/poolfalse
nicipaddresslistVM NIC to ip address mapping using keys NIC, ip4Addressfalse
nicnetworklistVM NIC to network id mapping using keys NIC and networkfalse
projectidImport Instance for the projectfalse
templateidThe ID of the Template for the Instancefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/importVm.html b/static/api/apidocs-4.23/apis/importVm.html new file mode 100644 index 0000000000..b94d4c65c9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/importVm.html @@ -0,0 +1,810 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

importVm

+

Import virtual machine from a unmanaged host into CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
clusteridThe cluster IDtrue
hypervisorhypervisor type of the hosttrue
importsourceSource location for Importtrue
nameThe name of the Instance as it is known to the hypervisortrue
serviceofferingidThe service offering for the Instancetrue
zoneidthe zone IDtrue
accountAn optional account for the Instance. Must be used with domainId.false
clustername(only for importing VMs from VMware to KVM) Name of VMware cluster.false
convertinstancehostid(only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v conversion from VMware to KVM.false
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
datacentername(only for importing VMs from VMware to KVM) Name of VMware datacenter.false
datadiskofferinglistDatadisk Template to disk-offering mapping using keys disk and diskOfferingfalse
detailsUsed to specify the custom parameters.false
diskpathpath of the disk imagefalse
displaynameThe display name of the Instancefalse
domainidImport Instance to the domain specifiedfalse
existingvcenterid(only for importing VMs from VMware to KVM) UUID of a linked existing vCenterfalse
extraparams(only for importing VMs from VMware to KVM) optional - extra parameters to be passed on the virt-v2v command, if allowed by the administratorfalse
forceconverttopool(only for importing VMs from VMware to KVM) optional - if true, forces virt-v2v conversions to write directly on the provided storage pool (avoid using temporary conversion pool).false
forcedInstance 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 generatedfalse
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
hostthe host name or IP addressfalse
hostidHost where local disk is locatedfalse
hostip(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.false
hostnameThe host name of the Instancefalse
importinstancehostid(only for importing VMs from VMware to KVM) optional - the host to import the converted instance from VMware to KVM.false
migrateallowedInstance and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/poolfalse
networkidthe network IDfalse
nicipaddresslistVM NIC to ip address mapping using keys NIC, ip4Addressfalse
nicnetworklistVM NIC to network id mapping using keys NIC and networkfalse
osid(only for importing VMs from VMware to KVM) optional - the ID of the guest OS for the imported VM.false
passwordthe password for the hostfalse
projectidImport Instance for the projectfalse
storageidShared storage pool where disk is locatedfalse
templateidThe ID of the Template for the Instancefalse
temppathTemp Path on external host for disk image copyfalse
usernamethe username for the hostfalse
usevddk(only for importing VMs from VMware to KVM) optional - if true, uses VDDK on the KVM conversion host for converting the VM. This parameter is mutually exclusive with forcemstoimportvmfiles.false
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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/importVolume.html b/static/api/apidocs-4.23/apis/importVolume.html new file mode 100644 index 0000000000..e0d6296960 --- /dev/null +++ b/static/api/apidocs-4.23/apis/importVolume.html @@ -0,0 +1,321 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

importVolume

+

Import an unmanaged volume from a storage pool on a host into CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
paththe path of the volumetrue
storageidthe ID of the storage pooltrue
accountan optional account for the volume. Must be used with domainId.false
diskofferingidthe ID of the disk offering linked to the volumefalse
domainidimport volume to the domain specifiedfalse
namethe name of the volume. If not set, it will be set to the path of the volume.false
projectidimport volume for the projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the disk volume
accountThe Account associated with the disk volume
attachedThe date the volume was attached to an Instance
chaininfoThe chain info of the volume
clusteridCluster id of the volume
clusternameCluster name where the volume is allocated
createdThe date the disk volume was created
deleteprotectiontrue if volume has delete protection.
destroyedThe boolean state of whether the volume is destroyed or not
deviceidThe ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
diskBytesReadRateBytes read rate of the disk volume
diskBytesWriteRateBytes write rate of the disk volume
diskIopsReadRateIO requests read rate of the disk volume per the disk offering
diskIopsWriteRateIO requests write rate of the disk volume per the disk offering
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingdisplaytextThe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnameName of the disk offering
displayvolumeAn optional field whether to the display the volume to the end User or not.
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathpath of the Domain the disk volume belongs to
encryptformatthe format of the disk encryption if applicable
externaluuidVolume UUID that is given by virtualisation provider (only for VMware)
hypervisorHypervisor the volume belongs to
isextractableTrue if the volume is extractable, false otherwise
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isonameThe name of the ISO attached to the Instance
kmskeyKMS key name of the volume
kmskeyidKMS key id of the volume
kmskeyversionVersion number of the KMS key used for disk encryption if applicable
maxiopsMax IOPS of the disk volume
miniopsMin IOPS of the disk volume
nameName of the disk volume
pathThe path of the volume
physicalsizeThe bytes actually consumed on disk
podidPod id of the volume
podnamePod name of the volume
projectThe project name of the VPN
projectidThe project id of the VPN
provisioningtypeProvisioning type used to create volumes.
quiescevmNeed quiesce Instance or not when taking Snapshot
serviceofferingdisplaytextThe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnameName of the service offering for root disk
sizeSize of the disk volume
snapshotidID of the Snapshot from which this volume was created
stateThe state of the disk volume
statusThe status of the volume
storageName of the primary storage hosting the disk volume
storageidID of the primary storage hosting the disk volume; returned to admin User only
storagetypeShared or local storage
supportsstoragesnapshotTrue if storage Snapshot is supported for the volume, false otherwise
templatedisplaytextAn alternate display text of the Template for the Instance
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
typeType of the disk volume (ROOT or DATADISK)
utilizationThe disk utilization
virtualmachineidID of the Instance
virtualsizeThe bytes allocated
vmdisplaynameDisplay name of the Instance
vmnameName of the Instance
vmstateState of the Instance
vmtypeType of the Instance
volumecheckresultdetails for the volume check result, they may vary for different hypervisors
volumerepairresultdetails for the volume repair result, they may vary for different hypervisors
zoneidID of the availability zone
zonenameName of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/importVsphereStoragePolicies.html b/static/api/apidocs-4.23/apis/importVsphereStoragePolicies.html new file mode 100644 index 0000000000..f7f58b32de --- /dev/null +++ b/static/api/apidocs-4.23/apis/importVsphereStoragePolicies.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

importVsphereStoragePolicies

+

Import vSphere storage policies

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
zoneidID of the zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Storage Policy
descriptionThe description of the Storage Policy
nameThe name of the Storage Policy
policyidThe identifier of the Storage Policy in vSphere DataCenter
zoneidThe ID of the Zone
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/isAccountAllowedToCreateOfferingsWithTags.html b/static/api/apidocs-4.23/apis/isAccountAllowedToCreateOfferingsWithTags.html new file mode 100644 index 0000000000..0e0240d3bc --- /dev/null +++ b/static/api/apidocs-4.23/apis/isAccountAllowedToCreateOfferingsWithTags.html @@ -0,0 +1,84 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

isAccountAllowedToCreateOfferingsWithTags

+

Return true if the specified account is allowed to create offerings with tags.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idAccount UUIDtrue
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
isallowedIs domain admin allowed to create offerings with tags
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/issueCertificate.html b/static/api/apidocs-4.23/apis/issueCertificate.html new file mode 100644 index 0000000000..4cd6585fab --- /dev/null +++ b/static/api/apidocs-4.23/apis/issueCertificate.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

issueCertificate

+

Issues a client certificate using configured or provided CA plugin

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
csrThe certificate signing request (in pem format), if CSR is not provided then configured/provided options are consideredfalse
domainComma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CNfalse
durationCertificate validity duration in number of days, when not provided the default configured value will be usedfalse
ipaddressComma separated list of IP addresses, the certificate should be issued forfalse
providerName of the CA service provider, otherwise the default configured provider plugin will be usedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
cacertificatesThe CA certificate(s)
certificateThe client certificate
privatekeyPrivate key for the certificate
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/issueOutOfBandManagementPowerAction.html b/static/api/apidocs-4.23/apis/issueOutOfBandManagementPowerAction.html new file mode 100644 index 0000000000..d045325cbd --- /dev/null +++ b/static/api/apidocs-4.23/apis/issueOutOfBandManagementPowerAction.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

issueOutOfBandManagementPowerAction

+

Initiates the specified power action to the host's out-of-band management interface

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
actionOut-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUStrue
hostidThe ID of the hosttrue
timeoutOptional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout settingfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
actionThe out-of-band management action (if issued)
addressThe out-of-band management interface address
descriptionThe operation result description
driverThe out-of-band management driver for the host
enabledTrue if out-of-band management is enabled for the host
hostidThe ID of the host
passwordThe out-of-band management interface password
portThe out-of-band management interface port
powerstateThe out-of-band management interface powerState of the host
statusThe operation result
usernameThe out-of-band management interface username
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/ldapConfig.html b/static/api/apidocs-4.23/apis/ldapConfig.html new file mode 100644 index 0000000000..6a104a3f40 --- /dev/null +++ b/static/api/apidocs-4.23/apis/ldapConfig.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

ldapConfig

+

(Deprecated, use addLdapConfiguration) Configure the LDAP context for this site.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
binddnSpecify the distinguished name of a user with the search permission on the directory.false
bindpassEnter the password.false
hostnameHostname or ip address of the ldap server eg: my.ldap.comfalse
listallIf true return current LDAP configurationfalse
portSpecify the LDAP port if required, default is 389.false
queryfilterYou specify a query filter here, which narrows down the users, who can be part of this domain.false
searchbaseThe search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.false
sslCheck Use SSL if the external LDAP server is configured for LDAP over SSL.false
truststoreEnter the path to trust certificates store.false
truststorepassEnter the password for trust store.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
binddnSpecify the distinguished name of a user with the search permission on the directory
bindpassDN password
hostnameHostname or ip address of the ldap server eg: my.ldap.com
portSpecify the LDAP port if required, default is 389
queryfilterYou specify a query filter here, which narrows down the users, who can be part of this domain
searchbaseThe search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com
sslCheck Use SSL if the external LDAP server is configured for LDAP over SSL
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/ldapCreateAccount.html b/static/api/apidocs-4.23/apis/ldapCreateAccount.html new file mode 100644 index 0000000000..d15a1571a9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/ldapCreateAccount.html @@ -0,0 +1,411 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

ldapCreateAccount

+

Creates an account from an LDAP user

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
usernameUnique username.true
accountCreates the user under the specified account. If no account is specified, the username will be used as the account name.false
accountdetailsDetails for account used to store specific parametersfalse
accountidAccount UUID, required for adding account from external provisioning systemfalse
accounttypeType of the account. Specify 0 for user, 1 for root admin, and 2 for domain adminfalse
domainidCreates the user under the specified domain.false
networkdomainNetwork domain for the account's networksfalse
roleidCreates the account under the specified role.false
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.false
useridUser UUID, required for adding account from external provisioning systemfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Account
accountdetailsDetails for the account
accounttypeAccount type (admin, domain-admin, user)
apikeyaccesswhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
backupavailablethe total number of backups available to this account
backuplimitthe total number of backups which can be stored by this account
backupstorageavailablethe total backup storage space (in GiB) available to the account
backupstoragelimitthe total backup storage space (in GiB) the account can own
backupstoragetotalthe total backup storage space (in GiB) owned by the account
backuptotalthe total number of backups stored by this account
bucketavailablethe total number of buckets available to this account
bucketlimitthe total number of buckets which can be stored by this account
buckettotalthe total number of buckets stored by this account
cpuavailableThe total number of CPU cores available to be created for this account
cpulimitThe total number of CPU cores the account can own
cputotalThe total number of CPU cores owned by account
createdThe date when this account was created
defaultzoneidThe default zone of the Account
domainName of the Domain the Account belongs to
domainidID of the Domain the Account belongs to
domainpathPath of the Domain the Account belongs to
gpuavailablethe total number of gpus available to be created for this account
gpulimitthe total number of gpus the account can own
gputotalthe total number of gpus owned by account
groupsThe list of ACL groups that account belongs to
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this Account to acquire
iplimitThe total number of public IP addresses this Account can acquire
iptotalThe total number of public IP addresses allocated for this Account
iscleanuprequiredTrue if the account requires cleanup
isdefaultTrue if account is default, false otherwise
memoryavailableThe total memory (in MB) available to be created for this account
memorylimitThe total memory (in MB) the account can own
memorytotalThe total memory (in MB) owned by account
nameThe name of the Account
networkavailableThe total number of Networks available to be created for this Account
networkdomainThe Network domain
networklimitThe total number of Networks the Account can own
networktotalThe total number of Networks owned by Account
objectstorageavailablethe total object storage space (in GiB) available to the account
objectstoragelimitthe total object storage space (in GiB) the account can own
objectstoragetotalthe total object storage space (in GiB) owned by the account
primarystorageavailableThe total primary storage space (in GiB) available to be used for this account
primarystoragelimitThe total primary storage space (in GiB) the account can own
primarystoragetotalThe total primary storage space (in GiB) owned by account
projectavailableThe total number of projects available for administration by this Account
projectlimitThe total number of projects the Account can own
projecttotalThe total number of projects being administrated by this Account
receivedbytesThe total number of Network traffic bytes received
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role (Admin, ResourceAdmin, DomainAdmin, User)
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this account
secondarystoragelimitThe total secondary storage space (in GiB) the account can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by account
sentbytesThe total number of Network traffic bytes sent
snapshotavailableThe total number of Snapshots available for this Account
snapshotlimitThe total number of Snapshots which can be stored by this Account
snapshottotalThe total number of Snapshots stored by this Account
stateThe state of the account
taggedresourcesThe tagged resource limit and count for the account
templateavailableThe total number of Templates available to be created by this Account
templatelimitThe total number of Templates which can be created by this Account
templatetotalThe total number of Templates which have been created by this Account
vmavailableThe total number of Instances available for this Account to acquire
vmlimitThe total number of Instances that can be deployed by this Account
vmrunningThe total number of Instances running for this Account
vmstoppedThe total number of Instances stopped for this Account
vmtotalThe total number of Instances deployed by this Account
volumeavailableThe total volume available for this Account
volumelimitThe total volume which can be used by this Account
volumetotalThe total volume being used by this Account
vpcavailableThe total number of VPCs available to be created for this account
vpclimitThe total number of VPCs the Account can own
vpctotalThe total number of VPCs owned by account
user(*)The list of users associated with account
idThe user ID
accountThe Account name of the user
accountidThe Account ID of the user
accounttypeThe Account type of the user
apikeyThe API key of the user
apikeyaccessWhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
createdThe date and time the user Account was created
domainThe domain name of the user
domainidThe domain ID of the user
emailThe user email address
firstnameThe user firstname
iconBase64 string representation of the resource icon
is2faenabledTrue if user has two factor authentication enabled
is2famandatedTrue if user has two factor authentication is mandated
iscallerchilddomainThe boolean value representing if the updating target is in caller's child domain
isdefaultTrue if user is default, false otherwise
lastnameThe user lastname
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role
secretkeyThe secret key of the user
stateThe user state
timezoneThe timezone user was created in
usernameThe user name
usersourceThe source type of the user in lowercase, such as native, ldap, saml2
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/ldapRemove.html b/static/api/apidocs-4.23/apis/ldapRemove.html new file mode 100644 index 0000000000..19cb0c5261 --- /dev/null +++ b/static/api/apidocs-4.23/apis/ldapRemove.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

ldapRemove

+

(Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site.

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
binddnSpecify the distinguished name of a user with the search permission on the directory
bindpassDN password
hostnameHostname or ip address of the ldap server eg: my.ldap.com
portSpecify the LDAP port if required, default is 389
queryfilterYou specify a query filter here, which narrows down the users, who can be part of this domain
searchbaseThe search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com
sslCheck Use SSL if the external LDAP server is configured for LDAP over SSL
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/linkAccountToLdap.html b/static/api/apidocs-4.23/apis/linkAccountToLdap.html new file mode 100644 index 0000000000..34f399a38d --- /dev/null +++ b/static/api/apidocs-4.23/apis/linkAccountToLdap.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

linkAccountToLdap

+

Link a cloudstack account to a group or OU in ldap

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountName of the account, it will be created if it does not existtrue
domainidThe id of the domain that is to contain the linked account.true
ldapdomainName of the group or OU in LDAPtrue
accounttypeType of the account to auto import. Specify 0 for user and 2 for domain adminfalse
adminDomain admin username in LDAP false
roleidCreates the account under the specified role.false
typeType of the LDAP name. GROUP or OU, defaults to GROUPfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountidDomain Admin accountId that is created
accounttypeType of the Account to auto import
domainidID of the Domain which is linked to LDAP
ldapdomainName of the group or OU in LDAP which is linked to the domain
nameName of the group or OU in LDAP which is linked to the domain
typeType of the name in LDAP which is linked to the domain
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/linkDomainToLdap.html b/static/api/apidocs-4.23/apis/linkDomainToLdap.html new file mode 100644 index 0000000000..811443661f --- /dev/null +++ b/static/api/apidocs-4.23/apis/linkDomainToLdap.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

linkDomainToLdap

+

Link an existing Cloudstack domain to group or OU in ldap

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accounttypeType of the account to auto import. Specify 0 for user and 2 for domain admintrue
domainidThe id of the domain which has to be linked to LDAP.true
ldapdomainName of the GROUP or OU in LDAPtrue
typeType of the ldap name. GROUP or OUtrue
adminDomain admin username in LDAP false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountidDomain Admin accountId that is created
accounttypeType of the Account to auto import
domainidID of the Domain which is linked to LDAP
ldapdomainName of the group or OU in LDAP which is linked to the domain
nameName of the group or OU in LDAP which is linked to the domain
typeType of the name in LDAP which is linked to the domain
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/linkUserDataToTemplate.html b/static/api/apidocs-4.23/apis/linkUserDataToTemplate.html new file mode 100644 index 0000000000..89ce6d78ef --- /dev/null +++ b/static/api/apidocs-4.23/apis/linkUserDataToTemplate.html @@ -0,0 +1,261 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

linkUserDataToTemplate

+

Link or unlink a userdata to a Template.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
isoidThe ID of the ISO for the Instancefalse
templateidThe ID of the Template for the Instancefalse
userdataidThe ID of the userdata that has to be linked to Template/ISO. If not provided existing userdata will be unlinked from the Template/ISOfalse
userdatapolicyAn optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverridefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe Account name to which the Template belongs
accountidThe Account id to which the Template belongs
archCPU Arch of the template
bitsThe processor bit size
bootableTrue if the ISO is bootable, false otherwise
checksumChecksum of the Template
childtemplatesIf root disk Template, then IDs of the datas disk Templates this Template owns
createdThe date this Template was created
crossZonesTrue if the Template is managed across all Zones, false otherwise
deployasisVMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is Template
detailsAdditional key/value details tied with Template
directdownloadKVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextThe Template display text
domainThe name of the domain to which the Template belongs
domainidThe ID of the domain to which the Template belongs
domainpathPath of the Domain the template belongs to
downloaddetailsLists the download progress of a Template across all secondary storages
extensionidThe ID of extension linked to this template
extensionnameThe name of extension linked to this template
forcksIf true it indicates that the template can be used for CKS cluster deployments
formatThe format of the Template.
hostidThe ID of the secondary storage host for the Template
hostnameThe name of the secondary storage host for the Template
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
isextractableTrue if the Template is extractable, false otherwise
isfeaturedTrue if this Template is a featured Template, false otherwise
ispublicTrue if this Template is a public Template, false otherwise
isreadyTrue if the Template is ready to be deployed from, false otherwise.
nameThe Template name
ostypeidThe ID of the OS type for this Template.
ostypenameThe name of the OS type for this Template.
parenttemplateidIf Datadisk Template, then id of the root disk Template this Template belongs to
passwordenabledTrue if the reset password feature is enabled, false otherwise
physicalsizeThe physical size of the Template
projectThe project name of the Template
projectidThe project ID of the Template
removedThe date this Template was removed
requireshvmTrue if Template requires HVM enabled, false otherwise
sizeThe size of the Template
sourcetemplateidThe Template ID of the parent Template if present
sshkeyenabledTrue if Template is sshkey enabled, false otherwise
statusThe status of the Template
templatetagThe tag of this Template
templatetypeThe type of the Template
urlThe URL which the Template/ISO is registered from
userdataidThe id of userdata linked to this Template
userdatanameThe name of userdata linked to this Template
userdataparamsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
zoneidThe ID of the zone for this Template
zonenameThe name of the zone for this Template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listASNRanges.html b/static/api/apidocs-4.23/apis/listASNRanges.html new file mode 100644 index 0000000000..b68ca3d209 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listASNRanges.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listASNRanges

+

List Autonomous Systems Number Ranges

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
zoneidthe zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the AS Number Range
createdCreated date
endasnEnd AS Number
startasnStart AS Number
zoneidZone ID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listASNumbers.html b/static/api/apidocs-4.23/apis/listASNumbers.html new file mode 100644 index 0000000000..dd8cb7b75a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listASNumbers.html @@ -0,0 +1,162 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listASNumbers

+

List Autonomous Systems Numbers

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountaccount namefalse
asnrangeidthe AS Number range IDfalse
asnumberAS numberfalse
domainiddomain idfalse
isallocatedto indicate if the AS number is allocated to any networkfalse
keywordList by keywordfalse
networkidthe network idfalse
pagefalse
pagesizefalse
vpcidthe vpc idfalse
zoneidthe zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the AS Number
accountthe account name
accountidAccount ID
allocatedAllocated Date
allocationstateAllocation state
asnrangeAS Number Range
asnrangeidAS Number ID
asnumberAS Number
associatednetworkidNetwork ID
associatednetworknameNetwork Name
createdCreated Date
domainthe domain name
domainidDomain ID
vpcidVPC ID
vpcnameVPC Name
zoneidZone ID
zonenamethe zone name of the AS Number range
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listAccounts.html b/static/api/apidocs-4.23/apis/listAccounts.html new file mode 100644 index 0000000000..8893e3ebca --- /dev/null +++ b/static/api/apidocs-4.23/apis/listAccounts.html @@ -0,0 +1,426 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listAccounts

+

Lists Accounts and provides detailed Account information for listed Accounts

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accounttypeList Accounts by Account type. Valid Account types are 1 (admin), 2 (domain-admin), and 0 (user).false
apikeyaccessList accounts by the Api key access valuefalse
detailsComma separated list of account details requested, value can be a list of [ all, resource, min]false
domainidList only resources belonging to the domain specifiedfalse
idList Account by Account IDfalse
iscleanuprequiredList accounts by cleanuprequired attribute (values are true or false)false
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameList account by account namefalse
pagefalse
pagesizefalse
showiconFlag to display the resource icon for accountsfalse
stateList accounts by state. Valid states are enabled, disabled, and locked.false
tagTag for resource type to return usagefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Account
accountdetailsDetails for the account
accounttypeAccount type (admin, domain-admin, user)
apikeyaccesswhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
backupavailablethe total number of backups available to this account
backuplimitthe total number of backups which can be stored by this account
backupstorageavailablethe total backup storage space (in GiB) available to the account
backupstoragelimitthe total backup storage space (in GiB) the account can own
backupstoragetotalthe total backup storage space (in GiB) owned by the account
backuptotalthe total number of backups stored by this account
bucketavailablethe total number of buckets available to this account
bucketlimitthe total number of buckets which can be stored by this account
buckettotalthe total number of buckets stored by this account
cpuavailableThe total number of CPU cores available to be created for this account
cpulimitThe total number of CPU cores the account can own
cputotalThe total number of CPU cores owned by account
createdThe date when this account was created
defaultzoneidThe default zone of the Account
domainName of the Domain the Account belongs to
domainidID of the Domain the Account belongs to
domainpathPath of the Domain the Account belongs to
gpuavailablethe total number of gpus available to be created for this account
gpulimitthe total number of gpus the account can own
gputotalthe total number of gpus owned by account
groupsThe list of ACL groups that account belongs to
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this Account to acquire
iplimitThe total number of public IP addresses this Account can acquire
iptotalThe total number of public IP addresses allocated for this Account
iscleanuprequiredTrue if the account requires cleanup
isdefaultTrue if account is default, false otherwise
memoryavailableThe total memory (in MB) available to be created for this account
memorylimitThe total memory (in MB) the account can own
memorytotalThe total memory (in MB) owned by account
nameThe name of the Account
networkavailableThe total number of Networks available to be created for this Account
networkdomainThe Network domain
networklimitThe total number of Networks the Account can own
networktotalThe total number of Networks owned by Account
objectstorageavailablethe total object storage space (in GiB) available to the account
objectstoragelimitthe total object storage space (in GiB) the account can own
objectstoragetotalthe total object storage space (in GiB) owned by the account
primarystorageavailableThe total primary storage space (in GiB) available to be used for this account
primarystoragelimitThe total primary storage space (in GiB) the account can own
primarystoragetotalThe total primary storage space (in GiB) owned by account
projectavailableThe total number of projects available for administration by this Account
projectlimitThe total number of projects the Account can own
projecttotalThe total number of projects being administrated by this Account
receivedbytesThe total number of Network traffic bytes received
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role (Admin, ResourceAdmin, DomainAdmin, User)
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this account
secondarystoragelimitThe total secondary storage space (in GiB) the account can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by account
sentbytesThe total number of Network traffic bytes sent
snapshotavailableThe total number of Snapshots available for this Account
snapshotlimitThe total number of Snapshots which can be stored by this Account
snapshottotalThe total number of Snapshots stored by this Account
stateThe state of the account
taggedresourcesThe tagged resource limit and count for the account
templateavailableThe total number of Templates available to be created by this Account
templatelimitThe total number of Templates which can be created by this Account
templatetotalThe total number of Templates which have been created by this Account
vmavailableThe total number of Instances available for this Account to acquire
vmlimitThe total number of Instances that can be deployed by this Account
vmrunningThe total number of Instances running for this Account
vmstoppedThe total number of Instances stopped for this Account
vmtotalThe total number of Instances deployed by this Account
volumeavailableThe total volume available for this Account
volumelimitThe total volume which can be used by this Account
volumetotalThe total volume being used by this Account
vpcavailableThe total number of VPCs available to be created for this account
vpclimitThe total number of VPCs the Account can own
vpctotalThe total number of VPCs owned by account
user(*)The list of users associated with account
idThe user ID
accountThe Account name of the user
accountidThe Account ID of the user
accounttypeThe Account type of the user
apikeyThe API key of the user
apikeyaccessWhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
createdThe date and time the user Account was created
domainThe domain name of the user
domainidThe domain ID of the user
emailThe user email address
firstnameThe user firstname
iconBase64 string representation of the resource icon
is2faenabledTrue if user has two factor authentication enabled
is2famandatedTrue if user has two factor authentication is mandated
iscallerchilddomainThe boolean value representing if the updating target is in caller's child domain
isdefaultTrue if user is default, false otherwise
lastnameThe user lastname
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role
secretkeyThe secret key of the user
stateThe user state
timezoneThe timezone user was created in
usernameThe user name
usersourceThe source type of the user in lowercase, such as native, ldap, saml2
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listAffectedVmsForStorageScopeChange.html b/static/api/apidocs-4.23/apis/listAffectedVmsForStorageScopeChange.html new file mode 100644 index 0000000000..8517acc2d3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listAffectedVmsForStorageScopeChange.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

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.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
clusteridthe Id of the cluster the scope of the storage pool is being changed totrue
storageidthe Id of the storage pool on which change scope operation is being donetrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the VM
clusteridthe cluster ID for the VM
clusternamethe cluster name for the VM
hostidthe host ID for the VM
hostnamethe hostname for the VM
namethe name of the VM
typethe type of VM
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listAffinityGroupTypes.html b/static/api/apidocs-4.23/apis/listAffinityGroupTypes.html new file mode 100644 index 0000000000..1d65bc8c03 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listAffinityGroupTypes.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listAffinityGroupTypes

+

Lists affinity group types available

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
typeThe type of the affinity group
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listAffinityGroups.html b/static/api/apidocs-4.23/apis/listAffinityGroups.html new file mode 100644 index 0000000000..244512bd3a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listAffinityGroups.html @@ -0,0 +1,150 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listAffinityGroups

+

Lists affinity groups

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idList the affinity group by the ID providedfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameLists affinity groups by namefalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
typeLists affinity groups by typefalse
virtualmachineidLists affinity groups by Instance IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listAlertTypes.html b/static/api/apidocs-4.23/apis/listAlertTypes.html new file mode 100644 index 0000000000..069463bae1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listAlertTypes.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listAlertTypes

+

Lists all alerts types

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the alert
descriptionDescription of the alert
nameThe name of the alert
sentThe date and time the alert was sent
typeOne 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
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listAlerts.html b/static/api/apidocs-4.23/apis/listAlerts.html new file mode 100644 index 0000000000..074ef38a75 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listAlerts.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listAlerts

+

Lists all alerts.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the alertfalse
keywordList by keywordfalse
nameList by alert namefalse
pagefalse
pagesizefalse
typeList by alert typefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the alert
descriptionDescription of the alert
nameThe name of the alert
sentThe date and time the alert was sent
typeOne 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
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listAndSwitchSamlAccount.html b/static/api/apidocs-4.23/apis/listAndSwitchSamlAccount.html new file mode 100644 index 0000000000..29a44fd230 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listAndSwitchSamlAccount.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listAndSwitchSamlAccount

+

Lists and switches to other SAML accounts owned by the SAML user

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
domainidDomain uuidfalse
useridUser uuidfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listAnnotations.html b/static/api/apidocs-4.23/apis/listAnnotations.html new file mode 100644 index 0000000000..8194f03faa --- /dev/null +++ b/static/api/apidocs-4.23/apis/listAnnotations.html @@ -0,0 +1,132 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listAnnotations

+

Lists annotations.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
annotationfilterPossible values are "self" and "all". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can accessfalse
entityidThe ID of the entity for which to show annotationsfalse
entitytypeThe entity typefalse
idThe ID of the annotationfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
useridOptional: The ID of the user of the annotationfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe UUID of the annotation
adminsonlyTrue if the annotation is available for admins only
annotationThe contents of the annotation
createdThe creation timestamp for this annotation
entityidThe UUID of the entity to which this annotation pertains
entitynameThe name of the entity to which this annotation pertains
entitytypeThe type of the annotated entity
removedThe removal timestamp for this annotation
useridThe UUID of the User that entered the annotation
usernameThe username of the User that entered the annotation
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listApis.html b/static/api/apidocs-4.23/apis/listApis.html new file mode 100644 index 0000000000..37e41cc046 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listApis.html @@ -0,0 +1,141 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listApis

+

Lists all available APIs on the server, provided by the API Discovery plugin

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
nameAPI namefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
descriptionDescription of the API
httprequesttypePreferred HTTP request type for the API
isasyncTrue if API is asynchronous
nameThe name of the API command
relatedComma separated related apis
sinceVersion of CloudStack the API was introduced in
typeResponse field type
params(*)The list params the api accepts
descriptionDescription of the API parameter
lengthLength of the parameter
nameThe name of the API parameter
relatedComma separated related APIs to get the parameter
requiredTrue if this parameter is required for the API request
sinceVersion of CloudStack the API was introduced in
typeParameter type
response(*)API response fields
descriptionDescription of the API response field
nameThe name of the API response field
responseAPI response fields
typeResponse field type
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listAsyncJobs.html b/static/api/apidocs-4.23/apis/listAsyncJobs.html new file mode 100644 index 0000000000..9b4369c371 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listAsyncJobs.html @@ -0,0 +1,162 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listAsyncJobs

+

Lists all pending asynchronous jobs for the Account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
managementserveridThe id of the management serverfalse
pagefalse
pagesizefalse
resourceidthe ID of the resource associated with the jobfalse
resourcetypethe type of the resource associated with the jobfalse
startdateThe start date of the async job (use format "yyyy-MM-dd'T'HH:mm:ss'+'SSSS")false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account that executed the async command
accountidThe Account ID that executed the async command
cmdThe async command executed
completedThe completed date of the job
createdThe created date of the job
domainidThe domain ID that executed the async command
domainpathThe domain that executed the async command
jobinstanceidThe unique ID of the Instance/entity object related to the job
jobinstancetypeThe Instance/entity object related to the job
jobprocstatusThe progress information of the PENDING job
jobresultThe result reason
jobresultcodeThe result code for the job
jobresulttypeThe result type
managementserveridThe MSID of the management server on which the job is running
managementservernamethe management server name of the host
useridThe User that executed the async command
jobidthe ID of the async job
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listAutoScalePolicies.html b/static/api/apidocs-4.23/apis/listAutoScalePolicies.html new file mode 100644 index 0000000000..5c382e6d17 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listAutoScalePolicies.html @@ -0,0 +1,153 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listAutoScalePolicies

+

Lists autoscale policies.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
actionThe action to be executed if all the conditions evaluate to true for the specified duration.false
conditionidThe ID of the condition of the policyfalse
domainidList only resources belonging to the domain specifiedfalse
idThe ID of the autoscale policyfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameThe name of the autoscale policyfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
vmgroupidThe ID of the autoscale Instance groupfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe autoscale policy ID
accountThe Account owning the autoscale policy
actionThe action to be executed if all the conditions evaluate to true for the specified duration.
conditionsThe list of IDs of the conditions that are being evaluated on every interval
domainThe domain name of the autoscale policy
domainidThe domain ID of the autoscale policy
domainpathpath of the domain to which the autoscale policy belongs
durationThe duration for which the conditions have to be true before action is taken
nameName of the autoscale policy
projectThe project name of the autoscale policy
projectidThe project id autoscale policy
quiettimeThe cool down period for which the policy should not be evaluated after the action has been taken
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listAutoScaleVmGroups.html b/static/api/apidocs-4.23/apis/listAutoScaleVmGroups.html new file mode 100644 index 0000000000..e12c69ad29 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listAutoScaleVmGroups.html @@ -0,0 +1,201 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listAutoScaleVmGroups

+

Lists autoscale Instance groups.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idThe ID of the autoscale Instance groupfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
lbruleidThe ID of the loadbalancerfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameThe name of the autoscale vmgroupfalse
pagefalse
pagesizefalse
policyidThe ID of the policyfalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
vmprofileidThe ID of the profilefalse
zoneidThe availability zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe autoscale Instance group ID
accountThe Account owning the Instance group
associatednetworkidThe id of the guest Network the LB rule belongs to
associatednetworknameThe name of the guest Network the LB rule belongs to
availablevirtualmachinecountThe number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group
createdThe date when this Instance group was created
domainThe domain name of the Instance group
domainidThe domain ID of the Instance group
domainpathpath of the domain to which the vm group belongs
fordisplayIs group for display to the regular User
intervalThe frequency at which the conditions have to be evaluated
lbproviderThe LB provider of the guest Network the LB rule belongs to
lbruleidThe Load balancer rule ID
maxmembersThe maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.
minmembersThe minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.
nameThe name of the autoscale Instance group
privateportThe private port
projectThe project name of the Instance group
projectidThe project id of the Instance group
publicipThe public IP address
publicipidThe public IP address ID
publicportThe public port
scaledownpoliciesList of scaledown autoscale policies
scaleuppoliciesList of scaleup autoscale policies
stateThe current state of the AutoScale Instance Group
vmprofileidThe autoscale profile that contains information about the Instances in the Instance group.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listAutoScaleVmProfiles.html b/static/api/apidocs-4.23/apis/listAutoScaleVmProfiles.html new file mode 100644 index 0000000000..b18cdfcdc2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listAutoScaleVmProfiles.html @@ -0,0 +1,177 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listAutoScaleVmProfiles

+

Lists autoscale Instance profiles.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idThe ID of the autoscale Instance profilefalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
otherdeployparamsThe otherdeployparameters of the autoscale Instance profilefalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
serviceofferingidList profiles by service offering idfalse
templateidThe templateid of the autoscale Instance profilefalse
zoneidAvailability zone for the auto deployed Instancefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe autoscale Instance profile ID
accountThe Account owning the Instance group
autoscaleuseridThe ID of the User used to launch and destroy the Instances
domainThe domain name of the Instance profile
domainidThe domain ID of the Instance profile
domainpathpath of the domain to which the vm profile belongs
expungevmgraceperiodThe time allowed for existing connections to get closed before an Instance is destroyed
fordisplayIs profile for display to the regular User
otherdeployparamsParameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance
projectThe project name of the Instance profile
projectidThe project id Instance profile
serviceofferingidThe service offering to be used while deploying an Instance
templateidThe Template to be used while deploying an Instance
userdataBase64 encoded Instance user data
userdatadetailslist of variables and values for the variables declared in userdata
userdataidthe id of userdata used for the VM
userdatanamethe name of userdata used for the VM
userdatapolicythe userdata override policy with the userdata provided while deploying VM
zoneidThe availability zone to be used while deploying an Instance
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listBackupOfferings.html b/static/api/apidocs-4.23/apis/listBackupOfferings.html new file mode 100644 index 0000000000..9f2a1bf707 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listBackupOfferings.html @@ -0,0 +1,144 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listBackupOfferings

+

Lists backup offerings

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idThe backup offering IDfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
zoneidThe zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the backup offering
allowuserdrivenbackupsWhether the offering allows User driven ad-hoc/scheduled backups
backupofferingdetailsDetails for the backup offering
createdThe date this backup offering was created
crosszoneinstancecreationthe backups with this offering can be used to create Instances on all Zones
descriptionDescription for the backup offering
domainthe domain name(s) this backup offering belongs to.
domainidthe domain ID(s) this backup offering belongs to.
externalidExternal ID on the provider side
nameName for the backup offering
providerprovider name
zoneidZone ID
zonenameZone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listBackupProviderOfferings.html b/static/api/apidocs-4.23/apis/listBackupProviderOfferings.html new file mode 100644 index 0000000000..32733538c8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listBackupProviderOfferings.html @@ -0,0 +1,141 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listBackupProviderOfferings

+

Lists external backup offerings of the provider

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
zoneidThe zone IDtrue
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the backup offering
allowuserdrivenbackupsWhether the offering allows User driven ad-hoc/scheduled backups
backupofferingdetailsDetails for the backup offering
createdThe date this backup offering was created
crosszoneinstancecreationthe backups with this offering can be used to create Instances on all Zones
descriptionDescription for the backup offering
domainthe domain name(s) this backup offering belongs to.
domainidthe domain ID(s) this backup offering belongs to.
externalidExternal ID on the provider side
nameName for the backup offering
providerprovider name
zoneidZone ID
zonenameZone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listBackupProviders.html b/static/api/apidocs-4.23/apis/listBackupProviders.html new file mode 100644 index 0000000000..f92911c7d4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listBackupProviders.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listBackupProviders

+

Lists Backup and Recovery providers

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
nameList Backup and Recovery provider by namefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
descriptionThe description of the CA service provider
nameThe CA service provider name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listBackupRepositories.html b/static/api/apidocs-4.23/apis/listBackupRepositories.html new file mode 100644 index 0000000000..2b97afef6f --- /dev/null +++ b/static/api/apidocs-4.23/apis/listBackupRepositories.html @@ -0,0 +1,132 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listBackupRepositories

+

Lists all backup repositories

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the backup repositoryfalse
keywordList by keywordfalse
namename of the backup repositoryfalse
pagefalse
pagesizefalse
providerthe backup repository providerfalse
zoneidID of the zone where the backup repository is to be addedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the backup repository
addressthe address / url of the backup repository
capacitybytescapacity of the backup repository
createdthe date and time the backup repository was added
crosszoneinstancecreationthe backups in this repository can be used to create Instances on all Zones
mountoptsmount options
namethe name of the backup repository
providername of the provider
typebackup type
zoneidthe Zone ID of the backup repository
zonenamethe Zone name of the backup repository
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listBackupSchedule.html b/static/api/apidocs-4.23/apis/listBackupSchedule.html new file mode 100644 index 0000000000..6f3794651a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listBackupSchedule.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listBackupSchedule

+

List backup schedule of an Instance

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idthe ID of the backup schedulefalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
virtualmachineidID of the Instancefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the backup schedule.
intervaltypeThe interval type of the backup schedule
isolatedWhether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.
maxbackupsmaximum number of backups retained
quiescevmquiesce the instance before checkpointing the disks for backup
scheduleThe time the backup is scheduled to be taken.
timezoneThe time zone of the backup schedule
virtualmachineidID of the Instance
virtualmachinenameName of the Instance
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listBackupServiceJobs.html b/static/api/apidocs-4.23/apis/listBackupServiceJobs.html new file mode 100644 index 0000000000..fd1a948e02 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listBackupServiceJobs.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listBackupServiceJobs

+

List backup service jobs

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
backupidList jobs for the given backup.false
executingList executing jobs.false
hostidList jobs in the given host. When passing this parameter, only jobs that are currently executing will be returned.false
idList only job with given ID.false
keywordList by keywordfalse
pagefalse
pagesizefalse
scheduledList scheduled jobs.false
typeList jobs with the given type. Accepted values are StartCompression, FinalizeCompression and BackupValidation.false
zoneidList jobs in the given zone.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idCompression job ID.
attemptsNumber of attempts already made to complete this job.
backupidBackup ID.
hostidHost where the job is being executed.
removedCompression job scheduled removed date.
scheduleddateCompression job scheduled start date.
startdateCompression job start date.
typeCompression job type.
zoneidZone where the job is being executed.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listBackups.html b/static/api/apidocs-4.23/apis/listBackups.html new file mode 100644 index 0000000000..cce26702a7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listBackups.html @@ -0,0 +1,213 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listBackups

+

Lists Instance backups

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
backupofferingidlist backups by backup offeringfalse
domainidList only resources belonging to the domain specifiedfalse
idID of the backupfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
listvmdetailslist backups with VM detailsfalse
namelist backups by namefalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
statuslist backups by statusfalse
virtualmachineidID of the Instancefalse
zoneidList backups by zone idfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the Instance backup
accountAccount name
accountidAccount id
backupofferingidBackup offering id
backupofferingnameBackup offering name
compressionstatusBackup compression status.
createdBackup date
descriptiondescription for the backup
domainDomain name
domainidDomain ID
externalidExternal backup id
fromcheckpointidPrevious active checkpoint ID for incremental backups
hostidHost ID where the backup is running
intervaltypeInterval type of the backup
isbackupvmexpungedIndicates whether the VM from which the backup was taken is expunged or not
namename of the backup
sizeBackup size in bytes
statusBackup status
tocheckpointidNext checkpoint ID for incremental backups
typeBackup type
uncompressedsizeBackup uncompressed size in bytes. Only defined if backup is compressed.
validationstatusBackup validation status.
virtualmachineidID of the Instance
virtualmachinenameName of the Instance
virtualsizeBackup protected (virtual) size in bytes
vmbackupofferingremovedThe backup offering corresponding to this backup was removed from the VM
vmdetailsLists the vm specific details for the backup
volumesBacked up volumes
zoneZone name
zoneidZone ID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listBaremetalDhcp.html b/static/api/apidocs-4.23/apis/listBaremetalDhcp.html new file mode 100644 index 0000000000..3cdd70776a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listBaremetalDhcp.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listBaremetalDhcp

+

List baremetal dhcp servers

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
physicalnetworkidThe Physical Network IDtrue
dhcpservertypeType of DHCP devicefalse
idDHCP server device IDfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idDevice ID of
dhcpservertypeName of the provider
physicalnetworkidThe physical network to which this external dhcp device belongs to
providerName of the provider
urlURL
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listBaremetalPxeServers.html b/static/api/apidocs-4.23/apis/listBaremetalPxeServers.html new file mode 100644 index 0000000000..02e4b96605 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listBaremetalPxeServers.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listBaremetalPxeServers

+

List baremetal pxe server

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
physicalnetworkidThe Physical Network IDtrue
idPxe server device IDfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idDevice ID of
physicalnetworkidThe physical Network to which this external DHCP device belongs to
providerName of the provider
urlURL
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listBaremetalRct.html b/static/api/apidocs-4.23/apis/listBaremetalRct.html new file mode 100644 index 0000000000..d17d469838 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listBaremetalRct.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listBaremetalRct

+

List baremetal rack configuration

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
idID of RCT
urlURL
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listBgpPeers.html b/static/api/apidocs-4.23/apis/listBgpPeers.html new file mode 100644 index 0000000000..bd22c5e8bb --- /dev/null +++ b/static/api/apidocs-4.23/apis/listBgpPeers.html @@ -0,0 +1,150 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listBgpPeers

+

Lists Bgp Peers.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountthe account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.false
asnumberAS number of the Bgp Peer.false
domainidthe domain ID which the Bgp Peer is dedicated to.false
idUUID of the Bgp Peer.false
isdedicatedLists only dedicated or non-dedicated Bgp Peers. If not set, lists all dedicated and non-dedicated BGP peers the domain/account can access.false
keywordList by keywordfalse
pagefalse
pagesizefalse
projectidproject who which the Bgp Peer is dedicated tofalse
zoneidUUID of zone to which the Bgp Peer belongs to.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idid of the bgp peer
accountthe account of the bgp peer
asnumberAS number of bgp peer
createddate when this bgp peer was created.
detailsadditional key/value details of the bgp peer
domainthe domain name of the bgp peer
domainidthe domain ID of the bgp peer
ip6addressIPv6 address of bgp peer
ipaddressIPv4 address of bgp peer
passwordpassword of bgp peer
projectthe project name of the bgp peer
projectidthe project id of the bgp peer
zoneidid of zone to which the bgp peer belongs to.
zonenamename of zone to which the bgp peer belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listBigSwitchBcfDevices.html b/static/api/apidocs-4.23/apis/listBigSwitchBcfDevices.html new file mode 100644 index 0000000000..5aed92ac3d --- /dev/null +++ b/static/api/apidocs-4.23/apis/listBigSwitchBcfDevices.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listBigSwitchBcfDevices

+

Lists BigSwitch BCF Controller devices

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
bcfdeviceidBigswitch BCF controller device IDfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
physicalnetworkidThe Physical Network IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
bcfdeviceidDevice ID of the BigSwitch BCF Controller
bigswitchdevicenameDevice name
hostnameThe controller IP address
natNAT support
passwordThe controller password
physicalnetworkidThe physical Network to which this BigSwitch BCF segment belongs to
providerName of the provider
usernameThe controller username
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listBrocadeVcsDeviceNetworks.html b/static/api/apidocs-4.23/apis/listBrocadeVcsDeviceNetworks.html new file mode 100644 index 0000000000..c6cd7b9e12 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listBrocadeVcsDeviceNetworks.html @@ -0,0 +1,393 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listBrocadeVcsDeviceNetworks

+

Lists network that are using a brocade vcs switch

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
vcsdeviceidBrocade vcs switch IDtrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Network
accountThe owner of the Network
aclidACL ID associated with the VPC Network
aclnameACL name associated with the VPC Network
acltypeACL type - access type to the Network
asnumberAS NUMBER
asnumberidUUID of AS NUMBER
bgppeersThe BGP peers for the network
broadcastdomaintypeBroadcast domain type of the Network
broadcasturiBroadcast URI of the Network. This parameter is visible to ROOT admins only
canusefordeployList Networks available for Instance deployment
cidrCloudStack managed address space, all CloudStack managed Instances get IP address from CIDR
createdThe date this Network was created
detailsThe details of the Network
displaynetworkAn optional field, whether to the display the Network to the end user or not.
displaytextThe displaytext of the Network
dns1The first IPv4 DNS for the Network
dns2The second IPv4 DNS for the Network
dnssubdomainDNS subdomain associated to the network
dnszoneDNS zone associated to the network
domainThe domain name of the Network owner
domainidThe domain ID of the Network owner
domainpathPath of the Domain the network belongs to
egressdefaultpolicyTrue if guest Network default egress policy is allow; false if default egress policy is deny
externalidThe external ID of the Network
gatewayThe Network's gateway
iconBase64 string representation of the resource icon
internetprotocolThe internet protocol of Network offering
ip4routesThe routes for the network to ease adding route in upstream router
ip4routingThe IPv4 routing type of network
ip6cidrThe CIDR of IPv6 Network
ip6dns1The first IPv6 DNS for the network
ip6dns2The second IPv6 DNS for the network
ip6gatewayThe gateway of IPv6 Network
ip6routesThe routes for the Network to ease adding route in upstream router
ip6routingThe IPv6 routing type of network offering
isdefaultTrue if Network is default, false otherwise
ispersistentList Networks that are persistent
issystemTrue if Network is system, false otherwise
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.
nameThe name of the Network
netmaskThe Network's netmask
networkcidrThe Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE
networkdomainThe Network domain
networkofferingavailabilityAvailability of the Network offering the Network is created from
networkofferingconservemodeTrue if Network offering is IP conserve mode enabled
networkofferingdisplaytextDisplay text of the Network offering the Network is created from
networkofferingidNetwork offering ID the Network is created from
networkofferingnameName of the Network offering the Network is created from
physicalnetworkidThe physical Network id
privatemtuMTU configured on the network VR's private interfaces
projectThe project name of the address
projectidThe project ID of the IP address
publicmtuMTU configured on the Network VR's public facing interfaces
receivedbytesThe total number of Network traffic bytes received
redundantrouterIf the Network has redundant routers enabled
relatedRelated to what other Network configuration
reservediprangeThe Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes
restartrequiredTrue if Network requires restart
sentbytesThe total number of Network traffic bytes sent
specifyiprangesTrue if Network supports specifying IP ranges, false otherwise
specifyvlanTrue if network supports specifying vlan, false otherwise
stateState of the Network
strechedl2subnetTrue if Network can span multiple zones
subdomainaccessTrue if users from subdomains can access the domain level Network
supportsvmautoscalingIf Network offering supports Instance autoscaling feature
traffictypeThe traffic type of the Network
tungstenvirtualrouteruuidTungsten-Fabric virtual router the Network belongs to
typeThe type of the Network
vlanThe VLAN of the Network. This parameter is visible to ROOT admins only
vpcidVPC the Network belongs to
vpcnameName of the VPC to which this Network belongs
zoneidZone ID of the Network
zonenameThe name of the zone the Network belongs to
zonesnetworkspansIf a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans
service(*)The list of services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
tags(*)The list of resource tags associated with Network
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listBrocadeVcsDevices.html b/static/api/apidocs-4.23/apis/listBrocadeVcsDevices.html new file mode 100644 index 0000000000..b11218f8f5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listBrocadeVcsDevices.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listBrocadeVcsDevices

+

Lists Brocade VCS Switches

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
physicalnetworkidThe Physical Network IDfalse
vcsdeviceidBrocade VCS switch IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
brocadedevicenameDevice name
hostnameThe principal switch IP address
physicalnetworkidThe physical Network to which this Brocade VCS belongs to
providerName of the provider
vcsdeviceidDevice ID of the Brocade Vcs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listBuckets.html b/static/api/apidocs-4.23/apis/listBuckets.html new file mode 100644 index 0000000000..dbd482cf7a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listBuckets.html @@ -0,0 +1,183 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listBuckets

+

Lists all Buckets.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idthe ID of the bucketfalse
idsthe IDs of the Buckets, mutually exclusive with idfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
namethe name of the bucketfalse
objectstorageidthe ID of the object storage pool, available to ROOT admin onlyfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
tagsList resources by tags (key/value pairs)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the Bucket
accesskeyBucket Access Key
accountthe account associated with the Bucket
createdthe date the Bucket was created
domainthe domain associated with the bucket
domainidthe ID of the domain associated with the bucket
domainpathpath of the domain to which the bucket belongs
encryptionBucket Encryption
namename of the Bucket
objectlockingBucket Object Locking
objectstorageidid of the object storage hosting the Bucket; returned to admin user only
objectstoreName of the object storage hosting the Bucket; returned to admin user only
policyBucket Access Policy
projectthe project name of the bucket
projectidthe project id of the bucket
providerObject storage provider
quotaBucket Quota in GiB
sizeTotal size of objects in Bucket
stateState of the Bucket
urlBucket URL
usersecretkeyBucket Secret Key
versioningBucket Versioning
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listCAProviders.html b/static/api/apidocs-4.23/apis/listCAProviders.html new file mode 100644 index 0000000000..c8469efc21 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listCAProviders.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listCAProviders

+

Lists available certificate authority providers in CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
nameList CA service provider by namefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
descriptionThe description of the CA service provider
nameThe CA service provider name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listCaCertificate.html b/static/api/apidocs-4.23/apis/listCaCertificate.html new file mode 100644 index 0000000000..a4c42f0b7e --- /dev/null +++ b/static/api/apidocs-4.23/apis/listCaCertificate.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listCaCertificate

+

Lists the CA public certificate(s) as support by the configured/provided CA plugin

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
providerName of the CA service provider, otherwise the default configured provider plugin will be usedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
cacertificatesThe CA certificate(s)
certificateThe client certificate
privatekeyPrivate key for the certificate
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listCapabilities.html b/static/api/apidocs-4.23/apis/listCapabilities.html new file mode 100644 index 0000000000..dd1ee7dfa2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listCapabilities.html @@ -0,0 +1,183 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listCapabilities

+

Lists capabilities

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
domainidthe domain for listing capabilities.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
additionalconfigenabledtrue if additional configurations or extraconfig can be passed to Instances
allowusercreateprojectsTrue if regular User is allowed to create projects
allowuserexpungerecovervmTrue if the User can recover and expunge Instances, false otherwise
allowuserexpungerecovervolumeTrue if the User can recover and expunge volumes, false otherwise
allowuserforcestopvmtrue if users are allowed to force stop a vm, false otherwise
allowuserviewalldomainaccountsTrue if Users can see all Accounts within the same domain, false otherwise
allowuserviewdestroyedvmTrue if the User is allowed to view the destroyed Instances, false otherwise
apilimitintervalTime interval (in seconds) to reset api count
apilimitmaxMax allowed number of api requests within the specified interval
cloudstackversionVersion of the CloudStack
customdiskofferingmaxsizeMaximum size that can be specified when create disk from disk offering with custom size
customdiskofferingminsizeMinimum size that can be specified when create disk from disk offering with custom size
customhypervisordisplaynameDisplay name for custom hypervisor
defaultuipagesizeDefault page size in the UI for various views, value set in the configurations
dynamicrolesenabledTrue if dynamic role-based api checker is enabled, false otherwise
dynamicscalingenabledtrue if dynamically scaling for instances is enabled
extensionspathThe path of the extensions directory
instanceleaseenabledtrue if instance lease feature is enabled
instancesdisksstatsretentionenabledTrue if stats are retained for Instance disks otherwise false
instancesdisksstatsretentiontimeThe retention time for Instances disks stats
instancesstatsretentiontimeThe retention time for Instances stats
instancesstatsuseronlyTrue if stats are collected only for User Instances, false if System VM stats are also collected
kubernetesclusterexperimentalfeaturesenabledTrue if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise
kubernetesserviceenabledTrue if Kubernetes Service plugin is enabled, false otherwise
kvmsnapshotenabledTrue if Snapshot is supported for KVM host, false otherwise
projectinviterequiredIf invitation confirmation is required when add Account to project
regionsecondaryenabledTrue if region wide secondary is enabled, false otherwise
securitygroupsenabledTrue if security groups support is enabled, false otherwise
sharedfsvmmincpucountthe min CPU count for the service offering used by the shared filesystem instance
sharedfsvmminramsizethe min Ram size for the service offering used by the shared filesystem instance
snapshotshowchainsizeTrue to show the parent and chain size (sum of physical size of snapshot and all its parents) for incremental snapshots
supportELBTrue if region supports elastic Load balancer on basic zones
userpublictemplateenabledTrue if user and domain admins can set Templates to be shared, false otherwise
vpncustomergatewayparametersExcluded and obsolete VPN customer gateway cryptographic parameters
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listCapacity.html b/static/api/apidocs-4.23/apis/listCapacity.html new file mode 100644 index 0000000000..eda275a44c --- /dev/null +++ b/static/api/apidocs-4.23/apis/listCapacity.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listCapacity

+

Lists all the system wide capacities.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
clusteridLists capacity by the Cluster IDfalse
fetchlatestRecalculate capacities and fetch the latestfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
podidLists capacity by the Pod IDfalse
sortbySort the results. Available values: Usagefalse
tagTag for the resource typefalse
typeLists 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
zoneidLists capacity by the Zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
capacityallocatedThe capacity currently in allocated
capacitytotalThe total capacity available
capacityusedThe capacity currently in use
clusteridThe Cluster ID
clusternameThe Cluster name
nameThe capacity name
percentusedThe percentage of capacity currently in use
podidThe Pod ID
podnameThe Pod name
tagThe tag for the capacity type
typeThe capacity type
zoneidThe Zone ID
zonenameThe Zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listCiscoAsa1000vResources.html b/static/api/apidocs-4.23/apis/listCiscoAsa1000vResources.html new file mode 100644 index 0000000000..2e242880a5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listCiscoAsa1000vResources.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listCiscoAsa1000vResources

+

Lists Cisco ASA 1000v appliances

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hostnameHostname or ip address of the Cisco ASA 1000v appliance.false
keywordList by keywordfalse
pagefalse
pagesizefalse
physicalnetworkidThe Physical Network IDfalse
resourceidCisco ASA 1000v resource IDfalse
+
+
+

Response Tags

+ + + + +
Response NameDescription
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listCiscoNexusVSMs.html b/static/api/apidocs-4.23/apis/listCiscoNexusVSMs.html new file mode 100644 index 0000000000..73024c1877 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listCiscoNexusVSMs.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listCiscoNexusVSMs

+

Retrieves a Cisco Nexus 1000v Virtual Switch Manager device associated with a Cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
clusteridId of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.false
keywordList by keywordfalse
pagefalse
pagesizefalse
zoneidId of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
ipaddressThe management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module
vsmconfigmodeThe mode of the VSM (standalone/HA)
vsmconfigstateThe Config State (Primary/Standby) of the VSM
vsmctrlvlanidControl VLAN ID of the VSM
vsmdeviceidDevice ID of the Cisco N1KV VSM device
vsmdevicenameDevice name
vsmdevicestateDevice state
vsmdevicestateThe Device State (Enabled/Disabled) of the VSM
vsmdomainidThe VSM is a switch supervisor. This is the VSM's switch domain ID
vsmmgmtvlanidManagement VLAN ID of the VSM
vsmpktvlanidPacket VLAN ID of the VSM
vsmstoragevlanidStorage VLAN ID of the VSM
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listCiscoVnmcResources.html b/static/api/apidocs-4.23/apis/listCiscoVnmcResources.html new file mode 100644 index 0000000000..c98f8ec37b --- /dev/null +++ b/static/api/apidocs-4.23/apis/listCiscoVnmcResources.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listCiscoVnmcResources

+

Lists Cisco VNMC controllers

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
physicalnetworkidThe Physical Network IDfalse
resourceidCisco VNMC resource IDfalse
+
+
+

Response Tags

+ + + + +
Response NameDescription
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listClusterDrsPlan.html b/static/api/apidocs-4.23/apis/listClusterDrsPlan.html new file mode 100644 index 0000000000..88426c67aa --- /dev/null +++ b/static/api/apidocs-4.23/apis/listClusterDrsPlan.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listClusterDrsPlan

+

List DRS plans for a clusters

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
clusteridID of the clusterfalse
idID of the drs planfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idunique ID of the drs plan for cluster
clusteridId of the cluster
eventidStart event Id of the DRS Plan
migrationsList of migrations
statusStatus of DRS Plan
typeType of DRS Plan (Automated or Manual))
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listClusters.html b/static/api/apidocs-4.23/apis/listClusters.html new file mode 100644 index 0000000000..1c2f2a863b --- /dev/null +++ b/static/api/apidocs-4.23/apis/listClusters.html @@ -0,0 +1,222 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listClusters

+

Lists clusters.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
allocationstateLists clusters by allocation statefalse
archCPU arch of the clustersfalse
clustertypeLists clusters by cluster typefalse
hypervisorLists clusters by hypervisor typefalse
idLists clusters by the cluster IDfalse
keywordList by keywordfalse
managedstateWhether this cluster is managed by cloudstackfalse
nameLists clusters by the cluster namefalse
pagefalse
pagesizefalse
podidLists clusters by Pod IDfalse
showcapacitiesFlag to display the capacity of the clustersfalse
storageaccessgroupthe name of the storage access groupfalse
zoneidLists clusters by Zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe cluster ID
allocationstateThe allocation state of the cluster
archCPU Arch of the hosts in the cluster
clustertypeThe type of the cluster
cpuovercommitratioThe CPU overcommit ratio of the cluster
extensionidThe ID of extension for this cluster
extensionnameThe name of extension for this cluster
hypervisortypeThe hypervisor type of the cluster
managedstateWhether this cluster is managed by Cloudstack
memoryovercommitratioThe memory overcommit ratio of the cluster
nameThe cluster name
ovm3vipOvm3 VIP to use for pooling and/or clustering
podidThe Pod ID of the cluster
podnameThe Pod name of the cluster
podstorageaccessgroupscomma-separated list of storage access groups on the pod
resourcedetailsMeta data associated with the zone (key/value pairs)
storageaccessgroupscomma-separated list of storage access groups for the host
zoneidThe Zone ID of the cluster
zonenameThe Zone name of the cluster
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
capacity(*)The capacity of the Cluster
capacityallocatedThe capacity currently in allocated
capacitytotalThe total capacity available
capacityusedThe capacity currently in use
clusteridThe Cluster ID
clusternameThe Cluster name
nameThe capacity name
percentusedThe percentage of capacity currently in use
podidThe Pod ID
podnameThe Pod name
tagThe tag for the capacity type
typeThe capacity type
zoneidThe Zone ID
zonenameThe Zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listClustersMetrics.html b/static/api/apidocs-4.23/apis/listClustersMetrics.html new file mode 100644 index 0000000000..fc9a867a26 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listClustersMetrics.html @@ -0,0 +1,177 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listClustersMetrics

+

Lists clusters metrics

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
allocationstateLists clusters by allocation statefalse
archCPU arch of the clustersfalse
clustertypeLists clusters by cluster typefalse
hypervisorLists clusters by hypervisor typefalse
idLists clusters by the cluster IDfalse
keywordList by keywordfalse
managedstateWhether this cluster is managed by cloudstackfalse
nameLists clusters by the cluster namefalse
pagefalse
pagesizefalse
podidLists clusters by Pod IDfalse
showcapacitiesFlag to display the capacity of the clustersfalse
storageaccessgroupthe name of the storage access groupfalse
zoneidLists clusters by Zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
cpuallocatedThe total cpu allocated in Ghz
cpuallocateddisablethresholdCPU allocated disable threshold exceeded
cpuallocatedthresholdCPU allocated notification threshold exceeded
cpudisablethresholdCPU usage disable threshold exceeded
cpumaxdeviationThe maximum cpu deviation
cputhresholdCPU usage notification threshold exceeded
cputotalThe total cpu capacity in Ghz
cpuusedThe total cpu used in Ghz
drsimbalanceDRS imbalance for the cluster
hostsRunning / total hosts in the cluster
memoryallocatedThe total cpu allocated in GiB
memoryallocateddisablethresholdMemory allocated disable threshold exceeded
memoryallocatedthresholdMemory allocated notification threshold exceeded
memorydisablethresholdMemory usage disable threshold exceeded
memorymaxdeviationThe maximum memory deviation
memorythresholdMemory usage notification threshold exceeded
memorytotalThe total cpu capacity in GiB
memoryusedThe total cpu used in GiB
stateState of the cluster
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listCniConfiguration.html b/static/api/apidocs-4.23/apis/listCniConfiguration.html new file mode 100644 index 0000000000..03c0f0504f --- /dev/null +++ b/static/api/apidocs-4.23/apis/listCniConfiguration.html @@ -0,0 +1,141 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listCniConfiguration

+

List user data for CNI plugins

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idThe ID of the Userdatafalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameUserdata name to look forfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the User Data
accountThe owner of the User Data
accountidThe owner id of the User Data
domainThe domain name of the User Data owner
domainidThe domain id of the User Data owner
domainpathPath of the domain to which the User Data owner belongs
nameName of the User Data
paramsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in the User Data
projectThe project name of the User Data
projectidThe project id of the User Data
userdataBase64 encoded User Data content
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listConditions.html b/static/api/apidocs-4.23/apis/listConditions.html new file mode 100644 index 0000000000..87faa61c05 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listConditions.html @@ -0,0 +1,150 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listConditions

+

List Conditions for Instance auto scaling

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
counteridCounter-id of the condition.false
domainidList only resources belonging to the domain specifiedfalse
idID of the Condition.false
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
policyidThe ID of the policyfalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Condition
accountThe owner of the Condition.
counterDetails of the Counter.
counteridThe ID of the Counter.
counternameThe Name of the Counter.
domainThe domain name of the owner.
domainidThe domain ID of the Condition owner
domainpathpath of the domain to which the Condition owner belongs
projectThe project name of the Condition
projectidThe project ID of the Condition.
relationaloperatorRelational Operator to be used with threshold.
thresholdThreshold Value for the counter.
zoneidZone ID of counter
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listConfigurationGroups.html b/static/api/apidocs-4.23/apis/listConfigurationGroups.html new file mode 100644 index 0000000000..bb6e1ef3f7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listConfigurationGroups.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listConfigurationGroups

+

Lists all configuration groups (primarily used for UI).

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
groupLists configuration group by group namefalse
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
descriptionThe description of the configuration group
nameThe name of the configuration group
precedenceThe precedence of the configuration group
subgroup(*)The subgroups of the configuration group
nameThe name of the configuration subgroup
precedenceThe precedence of the configuration subgroup
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listConfigurations.html b/static/api/apidocs-4.23/apis/listConfigurations.html new file mode 100644 index 0000000000..c06dafca53 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listConfigurations.html @@ -0,0 +1,168 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listConfigurations

+

Lists all configurations.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountidThe ID of the Account to update the parameter value for corresponding accountfalse
categoryLists configurations by categoryfalse
clusteridThe ID of the Cluster to update the parameter value for corresponding clusterfalse
domainidThe ID of the Domain to update the parameter value for corresponding domainfalse
groupLists configuration by group name (primarily used for UI)false
imagestoreuuidThe ID of the Image Store to update the parameter value for corresponding image storefalse
keywordList by keywordfalse
managementserveridthe ID of the Management Server to update the parameter value for corresponding management serverfalse
nameLists configuration by namefalse
pagefalse
pagesizefalse
parentLists configuration by parent name (primarily used for UI)false
storageidThe ID of the Storage pool to update the parameter value for corresponding storage poolfalse
subgroupLists configuration by subgroup name (primarily used for UI)false
zoneidThe ID of the Zone to update the parameter value for corresponding zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe value of the configuration
categoryThe category of the configuration
componentThe component of the configuration
defaultvalueThe default value of the configuration
descriptionThe description of the configuration
displaytextThe display text of the configuration
groupThe group of the configuration
isdynamicTrue if the configuration is dynamic
nameThe name of the configuration
optionsThe possible options of the configuration value
parentThe name of the parent configuration
scopeScope (zone/cluster/pool/account) of the parameter that needs to be updated
subgroupThe subgroup of the configuration
typeThe type of the configuration value
valueThe value of the configuration
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listConsoleSessions.html b/static/api/apidocs-4.23/apis/listConsoleSessions.html new file mode 100644 index 0000000000..5d26a72af0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listConsoleSessions.html @@ -0,0 +1,177 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listConsoleSessions

+

Lists console sessions.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountidThe ID of the account that created the console endpoint.false
acquiredLists acquired console sessions, defaults to false. Acquired console sessions are the ones that have been accessed. The 'activeonly' parameter has precedence over the 'acquired' parameter, i.e., when the 'activeonly' parameter is 'true', the 'acquired' parameter value will be ignored.false
activeonlyLists only active console sessions, defaults to true. Active sessions are the ones that have been acquired and have not been removed.false
clientaddressIP address of the client that accessed the console session.false
consoleendpointcreatoraddressIP address of the creator of the console endpoint.false
domainidThe domain ID of the account that created the console endpoint.false
enddateLists console sessions generated up until this date. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "23:59:59"). If the recommended format is not used, the date will be considered in the server timezone.false
hostidLists console sessions from the specified host.false
idThe ID of the console session.false
isrecursiveLists console sessions recursively per domain. If an account ID is informed, only the account's console sessions will be listed. Defaults to false.false
keywordList by keywordfalse
pagefalse
pagesizefalse
startdateLists console sessions generated from this date onwards. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "00:00:00"). If the recommended format is not used, the date will be considered in the server timezone.false
useridThe ID of the user that created the console endpoint.false
virtualmachineidThe ID of the virtual machine.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the console session.
accountAccount that created the console endpoint.
accountidID of the account that created the console endpoint.
acquiredDate when the console session was acquired.
clientaddressIP address of the client that created the console session.
consoleendpointcreatoraddressIP address of the creator of the console endpoint.
createdDate when the console session's endpoint was created.
domainDomain of the account that created the console endpoint.
domainidDomain ID of the account that created the console endpoint.
domainpathDomain path of the account that created the console endpoint.
hostidID of the host.
hostnameName of the host.
removedDate when the console session was removed.
userUser that created the console endpoint.
useridID of the user that created the console endpoint.
virtualmachineidID of the virtual machine.
virtualmachinenameName of the virtual machine.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listCounters.html b/static/api/apidocs-4.23/apis/listCounters.html new file mode 100644 index 0000000000..45e231da8b --- /dev/null +++ b/static/api/apidocs-4.23/apis/listCounters.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listCounters

+

List the counters for Instance auto scaling

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the Counter.false
keywordList by keywordfalse
nameName of the counter.false
pagefalse
pagesizefalse
providerNetwork provider of the counter.false
sourceSource of the counter.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Counter
nameName of the counter.
providerProvider of the counter.
sourceSource of the counter.
valueValue in case of snmp or other specific counters.
zoneidZone ID of counter
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listCustomActions.html b/static/api/apidocs-4.23/apis/listCustomActions.html new file mode 100644 index 0000000000..75f72eadc7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listCustomActions.html @@ -0,0 +1,162 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listCustomActions

+

Lists the custom actions

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enabledList actions whether they are enabled or notfalse
extensioniduuid of the extensionfalse
iduuid of the custom actionfalse
keywordList by keywordfalse
nameName of the custom actionfalse
pagefalse
pagesizefalse
resourceidID of a resource for actionsfalse
resourcetypeType of the resource for actionsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the custom action
allowedroletypesList of role types allowed for the custom action
createdCreation timestamp of the custom action
descriptionDescription of the custom action
detailsDetails of the custom action
enabledWhether the custom action is enabled or not
errormessageMessage that will be used on failure during execution of the action
extensionidID of the extension that this custom action belongs to
extensionnameName of the extension that this custom action belongs to
nameName of the custom action
resourcetypeResource type for which the action is available
successmessageMessage that will be used on successful execution of the action
timeoutSpecifies the timeout in seconds to wait for the action to complete before failing
parameters(*)List of the parameters for the action
nameName of the parameter
requiredWhether the parameter is required or not
typeType of the parameter
validationformatValidation format for value of the parameter. Available for specific types
valueoptionsComma-separated list of options for value of the parameter
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listDbMetrics.html b/static/api/apidocs-4.23/apis/listDbMetrics.html new file mode 100644 index 0000000000..976e19d764 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listDbMetrics.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listDbMetrics

+

List the db hosts and statistics

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
collectiontimeThe time these statistics were collected
connectionsThe number of connections to the DB
dbloadaveragesThe last measured load averages on the DB
hostnameThe name of the active usage server
queriesThe number of queries performed on the DB
replicasThe state of the usage server
tlsversionsThe TLS versions currently in use (accepted) by the DB
uptimeThe uptime of the DB in seconds
versionThe version of the currently running DB
versioncommentThe version of the currently running DB
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listDedicatedClusters.html b/static/api/apidocs-4.23/apis/listDedicatedClusters.html new file mode 100644 index 0000000000..643aedcecb --- /dev/null +++ b/static/api/apidocs-4.23/apis/listDedicatedClusters.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listDedicatedClusters

+

Lists dedicated clusters.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountThe name of the account associated with the cluster. Must be used with domainId.false
affinitygroupidList dedicated clusters by affinity groupfalse
clusteridThe ID of the clusterfalse
domainidThe ID of the domain associated with the clusterfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the dedicated resource
accountidThe Account ID of the cluster
affinitygroupidThe Dedication Affinity Group ID of the cluster
clusteridThe ID of the cluster
clusternameThe name of the cluster
domainidThe domain ID of the cluster
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listDedicatedGuestVlanRanges.html b/static/api/apidocs-4.23/apis/listDedicatedGuestVlanRanges.html new file mode 100644 index 0000000000..7037eeaa81 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listDedicatedGuestVlanRanges.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listDedicatedGuestVlanRanges

+

Lists dedicated guest vlan ranges

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountThe account with which the guest VLAN range is associated. Must be used with the domainId parameter.false
domainidThe 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
guestvlanrangeThe dedicated guest vlan rangefalse
idList dedicated guest VLAN ranges by IDfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
physicalnetworkidPhysical network ID of the guest VLAN rangefalse
projectidProject who will own the guest VLAN rangefalse
zoneidZone of the guest VLAN rangefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the guest VLAN range
accountThe Account of the guest VLAN range
domainThe domain name of the guest VLAN range
domainidThe domain ID of the guest VLAN range
domainpathpath of the domain to which the guest VLAN range belongs
guestvlanrangeThe guest VLAN range
physicalnetworkidThe physical Network of the guest VLAN range
projectThe project name of the guest VLAN range
projectidThe project id of the guest VLAN range
zoneidThe zone of the guest VLAN range
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listDedicatedHosts.html b/static/api/apidocs-4.23/apis/listDedicatedHosts.html new file mode 100644 index 0000000000..becf93d725 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listDedicatedHosts.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listDedicatedHosts

+

Lists dedicated hosts.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountThe name of the account associated with the host. Must be used with domainId.false
affinitygroupidList dedicated hosts by affinity groupfalse
domainidThe ID of the domain associated with the hostfalse
hostidThe ID of the hostfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the dedicated resource
accountidThe Account ID of the host
affinitygroupidThe Dedication Affinity Group ID of the host
domainidThe domain ID of the host
hostidThe ID of the host
hostnameThe name of the host
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listDedicatedPods.html b/static/api/apidocs-4.23/apis/listDedicatedPods.html new file mode 100644 index 0000000000..d1f4f41381 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listDedicatedPods.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listDedicatedPods

+

Lists dedicated pods.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountThe name of the account associated with the pod. Must be used with domainId.false
affinitygroupidList dedicated pods by affinity groupfalse
domainidThe ID of the domain associated with the podfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
podidThe ID of the podfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the dedicated resource
accountidThe Account Id to which the Pod is dedicated
affinitygroupidThe Dedication Affinity Group ID of the pod
domainidThe domain ID to which the Pod is dedicated
podidThe ID of the Pod
podnameThe Name of the Pod
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listDedicatedZones.html b/static/api/apidocs-4.23/apis/listDedicatedZones.html new file mode 100644 index 0000000000..c2a645234a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listDedicatedZones.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listDedicatedZones

+

List dedicated zones.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountThe name of the account associated with the zone. Must be used with domainId.false
affinitygroupidList dedicated zones by affinity groupfalse
domainidThe ID of the domain associated with the zonefalse
keywordList by keywordfalse
pagefalse
pagesizefalse
zoneidThe ID of the Zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the dedicated resource
accountidThe Account ID to which the Zone is dedicated
affinitygroupidThe Dedication Affinity Group ID of the zone
domainidThe domain ID to which the Zone is dedicated
zoneidThe ID of the Zone
zonenameThe Name of the Zone
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listDeploymentPlanners.html b/static/api/apidocs-4.23/apis/listDeploymentPlanners.html new file mode 100644 index 0000000000..7ad7d61dd2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listDeploymentPlanners.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listDeploymentPlanners

+

Lists all DeploymentPlanners available.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
nameDeployment Planner name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listDetailOptions.html b/static/api/apidocs-4.23/apis/listDetailOptions.html new file mode 100644 index 0000000000..3a91b44dc8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listDetailOptions.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listDetailOptions

+

Lists all possible details and their options for a resource type such as an Instance or a Template

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
resourcetypeThe resource type such as UserVm, Template etc.true
resourceidThe UUID of the resource (optional)false
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
detailsMap of all possible details and their possible list of values
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listDiskOfferings.html b/static/api/apidocs-4.23/apis/listDiskOfferings.html new file mode 100644 index 0000000000..8f52b0a732 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listDiskOfferings.html @@ -0,0 +1,240 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listDiskOfferings

+

Lists all available disk offerings.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
encryptListed offerings support disk encryptionfalse
idID of the disk offeringfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameName of the disk offeringfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
stateFilter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.false
storageidThe ID of the storage pool, tags of the storage pool are used to filter the offeringsfalse
storagetypethe storage type of the service offering. Values are local and shared.false
virtualmachineidThe 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 responsefalse
volumeidThe ID of the volume, tags of the volume are used to filter the offeringsfalse
zoneidID of zone disk offering is associated withfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idUnique ID of the disk offering
cacheModeThe cache mode to use for this disk offering. none, writeback or writethrough
createdThe date this disk offering was created
detailsAdditional key/value details tied with this disk offering
diskBytesReadRateBytes read rate of the disk offering
diskBytesReadRateMaxBurst bytes read rate of the disk offering
diskBytesReadRateMaxLengthLength (in seconds) of the burst
diskBytesWriteRateBytes write rate of the disk offering
diskBytesWriteRateMaxBurst bytes write rate of the disk offering
diskBytesWriteRateMaxLengthLength (in seconds) of the burst
diskIopsReadRateI/O requests read rate of the disk offering
diskIopsReadRateMaxBurst io requests read rate of the disk offering
diskIopsReadRateMaxLengthLength (in second) of the burst
diskIopsWriteRateI/O requests write rate of the disk offering
diskIopsWriteRateMaxBurst io requests write rate of the disk offering
diskIopsWriteRateMaxLengthLength (in seconds) of the burst
disksizeThe size of the disk offering in GB
disksizestrictnessTo allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed
displayofferingWhether to display the offering to the end user or not.
displaytextAn alternate display text of the disk offering.
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
encryptWhether disks using this offering will be encrypted on primary storage
hypervisorsnapshotreserveHypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
iscustomizedTrue if disk offering uses custom size, false otherwise
iscustomizediopsTrue if disk offering uses custom IOPS, false otherwise
maxiopsThe max IOPS of the disk offering
miniopsThe min IOPS of the disk offering
nameThe name of the disk offering
provisioningtypeProvisioning type used to create volumes. Valid values are thin, sparse, fat.
statestate of the disk offering
storagetypeThe storage type for this disk offering
suitableforvirtualmachineReturns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false
tagsThe tags for the disk offering
vspherestoragepolicyThe vsphere storage policy tagged to the disk offering in case of VMware
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listDnsProviders.html b/static/api/apidocs-4.23/apis/listDnsProviders.html new file mode 100644 index 0000000000..faa2322ae3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listDnsProviders.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listDnsProviders

+

Lists available DNS plugin providers

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
nameThe name of the DNS provider (e.g. PowerDNS, Cloudflare)
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listDnsRecords.html b/static/api/apidocs-4.23/apis/listDnsRecords.html new file mode 100644 index 0000000000..f94ea820ae --- /dev/null +++ b/static/api/apidocs-4.23/apis/listDnsRecords.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listDnsRecords

+

Lists DNS records from the external provider

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
dnszoneidID of the DNS zone to list records fromtrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
contentsThe contents of the record (IP address or target)
nameThe record name (e.g., www.example.com.)
ttlTime to live (TTL) in seconds
typeThe record type (e.g., A, CNAME, TXT)
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listDnsServers.html b/static/api/apidocs-4.23/apis/listDnsServers.html new file mode 100644 index 0000000000..3c0a4d3aff --- /dev/null +++ b/static/api/apidocs-4.23/apis/listDnsServers.html @@ -0,0 +1,141 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listDnsServers

+

Lists DNS servers owned by the account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idthe ID of the DNS serverfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
providertypefilter by provider type (e.g. PowerDNS, Cloudflare)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the DNS server
accountthe account associated with the DNS server
domainthe name of the domain associated with the DNS server
domainidthe ID of the domain associated with the DNS server
ispublicIs the DNS server publicly available
nameName of the DNS server
nameserversName servers entries associated to DNS server
portThe port of the DNS server
providerThe provider type of the DNS server
publicdomainsuffixThe public domain suffix for the DNS server
stateThe state of the account
urlURL of the DNS server API
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listDnsZones.html b/static/api/apidocs-4.23/apis/listDnsZones.html new file mode 100644 index 0000000000..3278e56be3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listDnsZones.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listDnsZones

+

Lists DNS zones.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
dnsserveridList DNS zones belonging to a specific DNS serverfalse
idList DNS zone by IDfalse
keywordList by keywordfalse
nameList by zone namefalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the DNS zone
accountthe account associated with the DNS zone
descriptionDescription for the DNS zone
dnsserveraccountthe account name of the DNS server owner
dnsserveridID of the DNS server this zone belongs to
dnsservernamethe name of the DNS server hosting this zone
domainthe name of the domain associated with the DNS zone
domainidthe ID of the domain associated with the DNS server
nameName of the DNS zone
networkidID of the network this zone is associated with
networknameName of the network this zone is associated with
stateThe state of the zone (Active/Inactive)
typeThe type of the zone (Public/Private)
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listDomainChildren.html b/static/api/apidocs-4.23/apis/listDomainChildren.html new file mode 100644 index 0000000000..416e0b9a71 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listDomainChildren.html @@ -0,0 +1,294 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listDomainChildren

+

Lists all children domains belonging to a specified domain

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idList children domain by parent domain ID.false
isrecursiveTo return the entire tree, use the value "true". To return the first level children, use the value "false".false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is falsefalse
nameList children domains by namefalse
pagefalse
pagesizefalse
showiconFlag to display the resource icon for domainsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the domain
backupavailablethe total number of backups available to this domain
backuplimitthe total number of backups which can be stored by this domain
backupstorageavailablethe total backup storage space (in GiB) available to the domain
backupstoragelimitthe total backup storage space (in GiB) the domain can own
backupstoragetotalthe total backup storage space (in GiB) owned by the domain
backuptotalthe total number of backups stored by this domain
bucketavailablethe total number of buckets available to this domain
bucketlimitthe total number of buckets which can be stored by this domain
buckettotalthe total number of buckets stored by this domain
cpuavailableThe total number of CPU cores available to be created for this domain
cpulimitThe total number of CPU cores the domain can own
cputotalThe total number of CPU cores owned by domain
createdThe date when this domain was created
domaindetailsDetails for the domain
gpuavailablethe total number of gpus available to be created for this domain
gpulimitthe total number of gpus the domain can own
gputotalthe total number of gpus owned by domain
haschildWhether the domain has one or more sub-domains
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this domain to acquire
iplimitThe total number of public IP addresses this domain can acquire
iptotalThe total number of public IP addresses allocated for this domain
levelThe level of the domain
memoryavailableThe total memory (in MB) available to be created for this domain
memorylimitThe total memory (in MB) the domain can own
memorytotalThe total memory (in MB) owned by domain
nameThe name of the domain
networkavailableThe total number of Networks available to be created for this domain
networkdomainThe Network domain
networklimitThe total number of Networks the domain can own
networktotalThe total number of Networks owned by domain
objectstorageavailablethe total object storage space (in GiB) available to the domain
objectstoragelimitthe total object storage space (in GiB) the domain can own
objectstoragetotalthe total object storage space (in GiB) owned by the domain
parentdomainidThe domain ID of the parent domain
parentdomainnameThe domain name of the parent domain
pathThe path of the domain
primarystorageavailableThe total primary storage space (in GiB) available to be used for this domain
primarystoragelimitThe total primary storage space (in GiB) the domain can own
primarystoragetotalThe total primary storage space (in GiB) owned by domain
projectavailableThe total number of projects available for administration by this domain
projectlimitThe total number of projects the domain can own
projecttotalThe total number of projects being administrated by this domain
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this domain
secondarystoragelimitThe total secondary storage space (in GiB) the domain can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by domain
snapshotavailableThe total number of Snapshots available for this domain
snapshotlimitThe total number of Snapshots which can be stored by this domain
snapshottotalThe total number of Snapshots stored by this domain
stateThe state of the domain
taggedresourcesThe tagged resource limit and count for the domain
templateavailableThe total number of Templates available to be created by this domain
templatelimitThe total number of Templates which can be created by this domain
templatetotalThe total number of Templates which have been created by this domain
vmavailableThe total number of Instances available for this domain to acquire
vmlimitThe total number of Instances that can be deployed by this domain
vmtotalThe total number of Instances deployed by this domain
volumeavailableThe total volume available for this domain
volumelimitThe total volume which can be used by this domain
volumetotalThe total volume being used by this domain
vpcavailableThe total number of VPCs available to be created for this domain
vpclimitThe total number of VPCs the domain can own
vpctotalThe total number of VPCs owned by domain
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listDomains.html b/static/api/apidocs-4.23/apis/listDomains.html new file mode 100644 index 0000000000..7782249bd2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listDomains.html @@ -0,0 +1,318 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listDomains

+

Lists domains and provides detailed information for listed domains

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
detailsComma separated list of domain details requested, value can be a list of [ all, resource, min]false
domainidList only resources belonging to the domain specifiedfalse
idList domain by domain ID.false
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
levelList domains by domain level.false
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is falsefalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameList domain by domain name.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
showiconFlag to display the resource icon for domainsfalse
tagTag for resource type to return usagefalse
tagsList resources by tags (key/value pairs)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the domain
backupavailablethe total number of backups available to this domain
backuplimitthe total number of backups which can be stored by this domain
backupstorageavailablethe total backup storage space (in GiB) available to the domain
backupstoragelimitthe total backup storage space (in GiB) the domain can own
backupstoragetotalthe total backup storage space (in GiB) owned by the domain
backuptotalthe total number of backups stored by this domain
bucketavailablethe total number of buckets available to this domain
bucketlimitthe total number of buckets which can be stored by this domain
buckettotalthe total number of buckets stored by this domain
cpuavailableThe total number of CPU cores available to be created for this domain
cpulimitThe total number of CPU cores the domain can own
cputotalThe total number of CPU cores owned by domain
createdThe date when this domain was created
domaindetailsDetails for the domain
gpuavailablethe total number of gpus available to be created for this domain
gpulimitthe total number of gpus the domain can own
gputotalthe total number of gpus owned by domain
haschildWhether the domain has one or more sub-domains
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this domain to acquire
iplimitThe total number of public IP addresses this domain can acquire
iptotalThe total number of public IP addresses allocated for this domain
levelThe level of the domain
memoryavailableThe total memory (in MB) available to be created for this domain
memorylimitThe total memory (in MB) the domain can own
memorytotalThe total memory (in MB) owned by domain
nameThe name of the domain
networkavailableThe total number of Networks available to be created for this domain
networkdomainThe Network domain
networklimitThe total number of Networks the domain can own
networktotalThe total number of Networks owned by domain
objectstorageavailablethe total object storage space (in GiB) available to the domain
objectstoragelimitthe total object storage space (in GiB) the domain can own
objectstoragetotalthe total object storage space (in GiB) owned by the domain
parentdomainidThe domain ID of the parent domain
parentdomainnameThe domain name of the parent domain
pathThe path of the domain
primarystorageavailableThe total primary storage space (in GiB) available to be used for this domain
primarystoragelimitThe total primary storage space (in GiB) the domain can own
primarystoragetotalThe total primary storage space (in GiB) owned by domain
projectavailableThe total number of projects available for administration by this domain
projectlimitThe total number of projects the domain can own
projecttotalThe total number of projects being administrated by this domain
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this domain
secondarystoragelimitThe total secondary storage space (in GiB) the domain can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by domain
snapshotavailableThe total number of Snapshots available for this domain
snapshotlimitThe total number of Snapshots which can be stored by this domain
snapshottotalThe total number of Snapshots stored by this domain
stateThe state of the domain
taggedresourcesThe tagged resource limit and count for the domain
templateavailableThe total number of Templates available to be created by this domain
templatelimitThe total number of Templates which can be created by this domain
templatetotalThe total number of Templates which have been created by this domain
vmavailableThe total number of Instances available for this domain to acquire
vmlimitThe total number of Instances that can be deployed by this domain
vmtotalThe total number of Instances deployed by this domain
volumeavailableThe total volume available for this domain
volumelimitThe total volume which can be used by this domain
volumetotalThe total volume being used by this domain
vpcavailableThe total number of VPCs available to be created for this domain
vpclimitThe total number of VPCs the domain can own
vpctotalThe total number of VPCs owned by domain
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listEgressFirewallRules.html b/static/api/apidocs-4.23/apis/listEgressFirewallRules.html new file mode 100644 index 0000000000..028db5185b --- /dev/null +++ b/static/api/apidocs-4.23/apis/listEgressFirewallRules.html @@ -0,0 +1,198 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listEgressFirewallRules

+

Lists all egress firewall rules for network ID.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idLists rule with the specified ID.false
ipaddressidThe ID of IP address of the firewall servicesfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
networkidThe network ID for the egress firewall servicesfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
tagsList resources by tags (key/value pairs)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the firewall rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
destcidrlistThe CIDR list to forward traffic to. Multiple entries are separated by a single comma character (,).
endportThe ending port of firewall rule's port range
fordisplayIs rule for display to the regular user
icmpcodeError code for this ICMP message
icmptypeType of the ICMP message being sent
ipaddressThe public IP address for the firewall rule
ipaddressidThe public IP address ID for the firewall rule
networkidThe Network ID of the firewall rule
protocolThe protocol of the firewall rule
startportThe starting port of firewall rule's port range
stateThe state of the rule
traffictypeThe traffic type for the firewall rule
vpcidThe VPC ID of the firewall rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listElastistorInterface.html b/static/api/apidocs-4.23/apis/listElastistorInterface.html new file mode 100644 index 0000000000..9fa9ad2820 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listElastistorInterface.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listElastistorInterface

+

Lists the network Interfaces of elastistor

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
controlleridController IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the volume
compressionCompression
deduplicationDeduplication
graceallowedgraceallowed
nameThe name of the volume
syncSynchronization
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listElastistorPool.html b/static/api/apidocs-4.23/apis/listElastistorPool.html new file mode 100644 index 0000000000..149f0dce87 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listElastistorPool.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listElastistorPool

+

Lists the pools of elastistor

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Poolfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the storage pool
controlleridController of the pool
gatewayDefault gateway of the pool
maxiopsAvailable IOPS of the pool
nameThe name of the storage pool
sizeThe current available space of the pool
stateThe state of the storage pool
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listElastistorVolume.html b/static/api/apidocs-4.23/apis/listElastistorVolume.html new file mode 100644 index 0000000000..20c4fa7359 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listElastistorVolume.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listElastistorVolume

+

Lists the volumes of elastistor

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the accounttrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the volume
compressionCompression
deduplicationDeduplication
graceallowedgraceallowed
nameThe name of the volume
syncSynchronization
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listEventTypes.html b/static/api/apidocs-4.23/apis/listEventTypes.html new file mode 100644 index 0000000000..e4956b18ff --- /dev/null +++ b/static/api/apidocs-4.23/apis/listEventTypes.html @@ -0,0 +1,81 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listEventTypes

+

List Event Types

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
nameEvent Type
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listEvents.html b/static/api/apidocs-4.23/apis/listEvents.html new file mode 100644 index 0000000000..4d822c1386 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listEvents.html @@ -0,0 +1,192 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listEvents

+

A command to list events.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
archivedTrue to list archived events otherwise falsefalse
domainidList only resources belonging to the domain specifiedfalse
durationThe duration of the eventfalse
enddateThe 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
entrytimeThe time the event was enteredfalse
idThe ID of the eventfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
levelThe event level (INFO, WARN, ERROR)false
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
resourceidThe ID of the resource associated with the eventfalse
resourcetypeThe type of the resource associated with the eventfalse
startdateThe 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
startidThe parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent eventfalse
stateThe state of the eventsfalse
typeThe event type (see event types)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the event
accountThe Account name for the Account that owns the object being acted on in the event (e.g. the owner of the Instance, IP address, or security group)
archivedWhether the event has been archived or not
createdThe date the event was created
descriptionA brief description of the event
domainThe name of the Account's domain
domainidThe ID of the Account's domain
domainpathpath of the Domain the account's domain belongs to
levelThe event level (INFO, WARN, ERROR)
parentidWhether the event is parented
projectThe project name of the address
projectidThe project ID of the IP address
resourceidThe ID of the resource
resourcenameThe name of the resource
resourcetypeThe type of the resource
stateThe state of the event
typeThe type of the event (see event types)
usernameThe 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 Instance)
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listExtensions.html b/static/api/apidocs-4.23/apis/listExtensions.html new file mode 100644 index 0000000000..425a3c425d --- /dev/null +++ b/static/api/apidocs-4.23/apis/listExtensions.html @@ -0,0 +1,153 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listExtensions

+

Lists extensions

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
detailscomma separated list of extension details requested, value can be a list of [all, resources, external, min]. When no parameters are passed, all the details are returned.false
iduuid of the extensionfalse
keywordList by keywordfalse
nameName of the extensionfalse
pagefalse
pagesizefalse
typeType of the extension (e.g. Orchestrator, NetworkOrchestrator)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the extension
createdCreation timestamp of the extension
descriptionDescription of the extension
detailsThe details of the extension
isuserdefinedTrue if the extension is added by admin
nameName of the extension
pathThe path of the entry point fo the extension
pathreadyTrue if the extension path is in ready state across management servers
removedRemoval timestamp of the extension, if applicable
reservedresourcedetailsResource detail names as comma separated string that should be reserved and not visible to end users
stateThe state of the extension
typeType of the extension
resources(*)List of resources to which extension is registered to
idID of the resource associated with the extension
createdCreation timestamp of the mapping
detailsthe details of the resource map
nameName of the resource associated with this mapping
typeType of the resource
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listFirewallRules.html b/static/api/apidocs-4.23/apis/listFirewallRules.html new file mode 100644 index 0000000000..fd0b2c0927 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listFirewallRules.html @@ -0,0 +1,198 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listFirewallRules

+

Lists all firewall rules for an IP address.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idLists rule with the specified ID.false
ipaddressidThe ID of IP address of the firewall servicesfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
networkidList firewall rules for certain networkfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
tagsList resources by tags (key/value pairs)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the firewall rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
destcidrlistThe CIDR list to forward traffic to. Multiple entries are separated by a single comma character (,).
endportThe ending port of firewall rule's port range
fordisplayIs rule for display to the regular user
icmpcodeError code for this ICMP message
icmptypeType of the ICMP message being sent
ipaddressThe public IP address for the firewall rule
ipaddressidThe public IP address ID for the firewall rule
networkidThe Network ID of the firewall rule
protocolThe protocol of the firewall rule
startportThe starting port of firewall rule's port range
stateThe state of the rule
traffictypeThe traffic type for the firewall rule
vpcidThe VPC ID of the firewall rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listGlobalLoadBalancerRules.html b/static/api/apidocs-4.23/apis/listGlobalLoadBalancerRules.html new file mode 100644 index 0000000000..4b366d176a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listGlobalLoadBalancerRules.html @@ -0,0 +1,255 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listGlobalLoadBalancerRules

+

Lists load balancer rules.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idThe ID of the global load balancer rulefalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
regionidRegion IDfalse
tagsList resources by tags (key/value pairs)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idGlobal Load balancer rule ID
accountThe Account of the Load balancer rule
descriptionThe description of the global Load balancer rule
domainThe domain of the Load balancer rule
domainidThe domain ID of the Load balancer rule
domainpathpath of the domain to which the load balancer rule belongs
gslbdomainnameDNS domain name given for the global Load balancer
gslblbmethodLoad balancing method used for the global Load balancer
gslbservicetypeGSLB service type
gslbstickysessionmethodnameSession persistence method used for the global Load balancer
nameName of the global Load balancer rule
projectThe project name of the Load balancer
projectidThe project ID of the Load balancer
regionidRegion ID in which global Load balancer is created
loadbalancerrule(*)List of Load balancer rules that are part of GSLB rule
idThe Load balancer rule ID
accountThe Account of the Load balancer rule
algorithmThe Load balancer algorithm (source, roundrobin, leastconn)
cidrlistThe CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).
descriptionThe description of the Load balancer
domainThe domain of the Load balancer rule
domainidThe domain ID of the Load balancer rule
domainpathpath of the domain to which the load balancer rule belongs
fordisplayIs rule for display to the regular user
nameThe name of the Load balancer
networkidThe ID of the guest Network the LB rule belongs to
privateportThe private port
projectThe project name of the Load balancer
projectidThe project ID of the Load balancer
protocolThe protocol of the Load Balancer rule
publicipThe public IP address
publicipidThe public IP address ID
publicportThe public port
stateThe state of the rule
zoneidThe ID of the zone the rule belongs to
zonenameThe name of the zone the Load balancer rule belongs to
tags(*)The list of resource tags associated with Load balancer
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listGpuCards.html b/static/api/apidocs-4.23/apis/listGpuCards.html new file mode 100644 index 0000000000..827bc4b657 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listGpuCards.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listGpuCards

+

Lists all available GPU cards

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
activeonlyIf true, only GPU cards which have a device will be listed. If false, all GPU cards will be listed.false
deviceiddevice ID of the GPU cardfalse
devicenamedevice name of the GPU cardfalse
idID of the GPU cardfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
vendoridvendor ID of the GPU cardfalse
vendornamevendor name of the GPU cardfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the GPU card
deviceidthe device ID of the GPU card
devicenamethe device name of the GPU card
namethe display name of the GPU card
vendoridthe vendor ID of the GPU card
vendornamethe vendor name of the GPU card
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listGpuDevices.html b/static/api/apidocs-4.23/apis/listGpuDevices.html new file mode 100644 index 0000000000..fe74c5e1d3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listGpuDevices.html @@ -0,0 +1,150 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listGpuDevices

+

Lists all available GPU devices

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
gpucardidthe GPU card ID associated with the GPU devicefalse
hostidthe host ID where the GPU device is attachedfalse
idID of the GPU devicefalse
keywordList by keywordfalse
pagefalse
pagesizefalse
vgpuprofileidthe vGPU profile ID assigned to the GPU devicefalse
virtualmachineidthe virtual machine ID to which the GPU device is allocatedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the GPU device
busaddressbus address of the GPU device or MDEV UUID for vGPU devices
gpucardidthe GPU card ID associated with this GPU device
gpucardnamethe GPU card name associated with this GPU device
gpudevicetypebus address of the GPU device
hostidthe host ID where the GPU device is attached
hostnamethe host name where the GPU device is attached
managedstatethe managed state of the GPU device (Enabled/Disabled)
numanodethe NUMA node where the GPU device is located
parentgpudeviceidthe ID of the parent GPU device, if this is a vGPU
statethe vGPU profile name assigned to this GPU device
vgpuprofileidthe vGPU profile ID assigned to this GPU device
vgpuprofilenamethe vGPU profile name assigned to this GPU device
virtualmachineidthe vGPU profile ID assigned to this GPU device
virtualmachinenamethe vGPU profile name assigned to this GPU device
vmstatethe state of the virtual machine to which this GPU device is allocated
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listGuestNetworkIpv6Prefixes.html b/static/api/apidocs-4.23/apis/listGuestNetworkIpv6Prefixes.html new file mode 100644 index 0000000000..07d94bddf4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listGuestNetworkIpv6Prefixes.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listGuestNetworkIpv6Prefixes

+

Lists guest network IPv6 prefixes

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idUUID of the IPv6 prefix.false
keywordList by keywordfalse
pagefalse
pagesizefalse
zoneidUUID of zone to which the IPv6 prefix belongs to.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the guest IPv6 prefix
availablesubnetsCount of the available IPv6 subnets for the prefix.
createdDate when this IPv6 prefix was created.
prefixGuest IPv6 prefix
totalsubnetsCount of the total IPv6 subnets for the prefix.
usedsubnetsCount of the used IPv6 subnets for the prefix.
zoneidID of zone to which the IPv6 prefix belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listGuestOsMapping.html b/static/api/apidocs-4.23/apis/listGuestOsMapping.html new file mode 100644 index 0000000000..daa55b7953 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listGuestOsMapping.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listGuestOsMapping

+

Lists all available OS mappings for given hypervisor

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hypervisorList Guest OS mapping by hypervisorfalse
hypervisorversionList Guest OS mapping by hypervisor version. Must be used with hypervisor parameterfalse
idList mapping by its UUIDfalse
keywordList by keywordfalse
osdisplaynameList Guest OS mapping by OS display namefalse
osnameforhypervisorList Guest OS mapping by OS mapping name with hypervisorfalse
ostypeidList mapping by Guest OS Type UUIDfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Guest OS mapping
hypervisorThe hypervisor
hypervisorversionVersion of the hypervisor for mapping
isuserdefinedIs the mapping user defined
osdisplaynameStandard display name for the Guest OS
osnameforhypervisorHypervisor specific name for the Guest OS
ostypeidThe ID of the Guest OS type
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listGuestVlans.html b/static/api/apidocs-4.23/apis/listGuestVlans.html new file mode 100644 index 0000000000..7a57a6d3e2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listGuestVlans.html @@ -0,0 +1,150 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listGuestVlans

+

Lists all guest vlans

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
allocatedonlyLimits search results to allocated guest VLAN. False by default.false
idList guest VLAN by IDfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
physicalnetworkidList guest VLAN by physical networkfalse
vnetList guest VLAN by vnetfalse
zoneidList guest VLAN by zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe guest VLAN ID
accountThe Account of the guest VLAN range
allocationstateThe allocation state of the guest VLAN
domainThe domain name of the guest VLAN range
domainidThe domain ID of the guest VLAN range
domainpathpath of the domain to which the guest VLAN range belongs
isdedicatedTrue if the guest VLAN is dedicated to the Account
networkThe list of Networks who use this guest VLAN
physicalnetworkidThe physical Network ID of the guest VLAN range
physicalnetworknameThe physical Network name of the guest VLAN range
projectThe project name of the guest VLAN range
projectidThe project ID of the guest VLAN range
takenDate the guest VLAN was taken
vlanThe guest VLAN
zoneidThe zone ID of the guest VLAN range
zonenameThe zone name of the guest VLAN range
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listGuiThemes.html b/static/api/apidocs-4.23/apis/listGuiThemes.html new file mode 100644 index 0000000000..ce4953a566 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listGuiThemes.html @@ -0,0 +1,153 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listGuiThemes

+

Lists GUI themes.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountidThe ID of the account to be filtered.false
commonnameThe internet Common Name (CN) to be filtered.false
domainidThe ID of the domain to be filtered.false
idThe theme ID.false
keywordList by keywordfalse
listallWhether to list all themes.false
listonlydefaultthemeWhether to only list the default theme.false
nameThe name of the theme.false
pagefalse
pagesizefalse
showpublicWhether to list public themes.false
showremovedWhether to list removed themes.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the custom GUI theme.
accountidsA set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.
commonnamesA set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com
createdWhen the GUI theme was created.
cssThe CSS to be retrieved and imported into the GUI when matching the theme access configurations.
descriptionDescription of the GUI theme.
domainidsA set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.
ispublicDefines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.
jsonconfigurationThe JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.
loginbasedomainThe ACS domain to be used as base for the login when accessing the GUI through the common name defined in the theme. If a common name is not defined, this parameter is ignored on the GUI.
nameName of the GUI theme.
recursivedomainsWhether to consider the subdomains of the informed domain IDs.
removedWhen the GUI theme was removed.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listHSMProfiles.html b/static/api/apidocs-4.23/apis/listHSMProfiles.html new file mode 100644 index 0000000000..449a582be7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listHSMProfiles.html @@ -0,0 +1,171 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listHSMProfiles

+

Lists HSM profiles

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
enabledlist only enabled profilesfalse
idthe HSM profile IDfalse
ispublicwhen true, non-admin users see only system (global) profilesfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
protocolthe protocol of the HSM profilefalse
zoneidthe zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the HSM profile
accountthe account name of the HSM profile owner
accountidthe account ID of the HSM profile owner
createdthe date the HSM profile was created
detailsHSM configuration details (sensitive values are encrypted)
domainthe domain name of the HSM profile owner
domainidthe domain ID of the HSM profile owner
domainpaththe domain path of the HSM profile owner
enabledwhether the HSM profile is enabled
ispublicwhether this is a system HSM profile available to all users globally
namethe name of the HSM profile
projectthe project name of the HSM profile owner
projectidthe project ID of the HSM profile owner
protocolthe protocol of the HSM profile
statethe state of the HSM profile
vendorthe vendor name of the HSM profile
zoneidthe zone ID where the HSM profile is available
zonenamethe zone name where the HSM profile is available
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listHostHAProviders.html b/static/api/apidocs-4.23/apis/listHostHAProviders.html new file mode 100644 index 0000000000..1191deebdd --- /dev/null +++ b/static/api/apidocs-4.23/apis/listHostHAProviders.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listHostHAProviders

+

Lists HA providers

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
hypervisorHypervisor type of the resourcetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
haenableIf host HA is enabled for the host
haproviderThe host HA provider
hastateThe HA state of the host
hostidThe ID of the host
statusOperation status
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listHostHAResources.html b/static/api/apidocs-4.23/apis/listHostHAResources.html new file mode 100644 index 0000000000..70c74ad3f7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listHostHAResources.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listHostHAResources

+

Lists host HA resources

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
hostidList by host IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
haenableIf host HA is enabled for the host
haproviderThe host HA provider
hastateThe HA state of the host
hostidThe ID of the host
statusOperation status
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listHostTags.html b/static/api/apidocs-4.23/apis/listHostTags.html new file mode 100644 index 0000000000..c8267015f1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listHostTags.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listHostTags

+

Lists host tags

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the host tag
hostidThe host ID of the host tag
isimplicittrue if the host tag is implicit
nameThe name of the host tag
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listHosts.html b/static/api/apidocs-4.23/apis/listHosts.html new file mode 100644 index 0000000000..7cf0af5f4a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listHosts.html @@ -0,0 +1,405 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listHosts

+

Lists hosts.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
archCPU Arch of the hostfalse
clusteridLists hosts existing in particular clusterfalse
detailsComma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]false
hahostIf true, list only hosts dedicated to HAfalse
hypervisorHypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulatorfalse
idThe ID of the hostfalse
keywordList by keywordfalse
managementserveridthe id of the management serverfalse
nameThe name of the hostfalse
outofbandmanagementenabledList hosts for which out-of-band management is enabledfalse
outofbandmanagementpowerstateList hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]false
pagefalse
pagesizefalse
podidThe Pod ID for the hostfalse
resourcestateList 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
stateThe state of the hostfalse
storageaccessgroupthe name of the storage access groupfalse
typeThe host typefalse
versionthe host versionfalse
virtualmachineidLists hosts in the same cluster as this Instance and flag hosts with enough CPU/RAm to host this Instancefalse
zoneidThe Zone ID for the hostfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the host
annotationThe last annotation set on this host by an admin
archCPU Arch of the host
capabilitiesCapabilities of the host
clusteridThe cluster ID of the host
clusternameThe cluster name of the host
clusterstorageaccessgroupscomma-separated list of storage access groups on the cluster
clustertypeThe cluster type of the cluster that host belongs to
cpuallocatedThe amount of the host's CPU currently allocated
cpuallocatedpercentageThe amount of the host's CPU currently allocated in percentage
cpuallocatedvalueThe amount of the host's CPU currently allocated in MHz
cpuallocatedwithoverprovisioningThe amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor
cpuloadaverageThe average CPU load on the host
cpunumberThe CPU number of the host
cpusocketsThe number of CPU sockets on the host
cpuspeedThe CPU speed of the host
cpuusedThe amount of the host's CPU currently used
cpuwithoverprovisioningThe amount of the host's CPU after applying the cpu.overprovisioning.factor
createdThe date and time the host was created
detailsHost details in key/value pairs.
disconnectedTrue if the host is disconnected. False otherwise.
disksizeallocatedThe host's currently allocated disk size
disksizetotalThe total disk size of the host
encryptionsupportedTrue if the host supports encryption
eventsEvents available for the host
explicithosttagscomma-separated list of explicit host tags for the host
extensionidThe ID of extension for this cluster
extensionnameThe name of extension for this cluster
gputotalTotal GPUs on the Host
gpuusedUsed GPUs on the Host
guestosrulethe guest OS rule
hahostTrue if the host is Ha host (dedicated to Instances started by HA process; false otherwise
hasenoughcapacityTrue if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise
hosthaThe host HA information information
hosttagsComma-separated list of tags for the host
hypervisorThe host hypervisor
hypervisorversionThe hypervisor version
implicithosttagscomma-separated list of implicit host tags for the host
instanceconversionsupportedtrue if the host supports instance conversion (using virt-v2v)
ipaddressThe IP address of the host
islocalstorageactiveTrue if local storage is active, false otherwise
istagaruleWhether the informed tag is a JS interpretable rule or not.
lastannotatedThe last time this host was annotated
lastpingedThe date and time the host was last pinged
managementserveridThe management server ID of the host
managementservernamethe management server name of the host
memoryallocatedThe amount of the host's memory currently allocated
memoryallocatedbytesThe amount of the host's memory currently allocated in bytes
memoryallocatedpercentageThe amount of the host's memory currently allocated in percentage
memorytotalThe memory total of the host, this parameter is deprecated use memorywithoverprovisioning
memoryusedThe amount of the host's memory currently used
memorywithoverprovisioningThe amount of the host's memory after applying the mem.overprovisioning.factor
msid(only for details=core) the msid of the host's management server
nameThe name of the host
networkkbsreadThe incoming Network traffic on the host
networkkbswriteThe outgoing Network traffic on the host
oscategoryidThe OS category ID of the host
oscategorynameThe OS category name of the host
outofbandmanagementThe host out-of-band management information
podidThe Pod ID of the host
podnameThe Pod name of the host
podstorageaccessgroupscomma-separated list of storage access groups on the pod
removedThe date and time the host was removed
resourcestateThe resource state of the host
stateThe state of the host
storageaccessgroupscomma-separated list of storage access groups for the host
suitableformigrationTrue if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise
typeThe host type
ueficapabilityTrue if the host has capability to support UEFI boot
usernameThe admin that annotated this host
versionThe host version
virtualmachineidthe virtual machine id for host type ConsoleProxy and SecondaryStorageVM
zoneidThe Zone ID of the host
zonenameThe Zone name of the host
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
gpugroup(*)GPU cards present in the host
gpugroupnameGPU cards present in the host
vgpu(*)The list of enabled vGPUs
maxcapacityMaximum vGPU can be created with this vGPU type on the given GPU group
maxheadsMaximum displays per user
maxresolutionxMaximum X resolution per display
maxresolutionyMaximum Y resolution per display
maxvgpuperpgpuMaximum no. of vGPU per GPU card (pgpu)
remainingcapacityRemaining capacity in terms of no. of more Instances that can be deployed with this vGPU type
vgputypeModel Name of vGPU
videoramVideo RAM for this vGPU type
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listHostsMetrics.html b/static/api/apidocs-4.23/apis/listHostsMetrics.html new file mode 100644 index 0000000000..42737816cd --- /dev/null +++ b/static/api/apidocs-4.23/apis/listHostsMetrics.html @@ -0,0 +1,198 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listHostsMetrics

+

Lists hosts metrics

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
archCPU Arch of the hostfalse
clusteridLists hosts existing in particular clusterfalse
detailsComma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]false
hahostIf true, list only hosts dedicated to HAfalse
hypervisorHypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulatorfalse
idThe ID of the hostfalse
keywordList by keywordfalse
managementserveridthe id of the management serverfalse
nameThe name of the hostfalse
outofbandmanagementenabledList hosts for which out-of-band management is enabledfalse
outofbandmanagementpowerstateList hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]false
pagefalse
pagesizefalse
podidThe Pod ID for the hostfalse
resourcestateList 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
stateThe state of the hostfalse
storageaccessgroupthe name of the storage access groupfalse
typeThe host typefalse
versionthe host versionfalse
virtualmachineidLists hosts in the same cluster as this Instance and flag hosts with enough CPU/RAm to host this Instancefalse
zoneidThe Zone ID for the hostfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
cpuallocateddisablethresholdCPU allocated disable threshold exceeded
cpuallocatedghzThe total cpu allocated in Ghz
cpuallocatedthresholdCPU allocated notification threshold exceeded
cpudisablethresholdCPU usage disable threshold exceeded
cputhresholdCPU usage notification threshold exceeded
cputotalghzThe total cpu capacity in Ghz
cpuusedghzThe total cpu used in Ghz
instancesInstances on the host
memoryallocateddisablethresholdMemory allocated disable threshold exceeded
memoryallocatedgbThe total memory allocated in GiB
memoryallocatedthresholdMemory allocated notification threshold exceeded
memorydisablethresholdMemory usage disable threshold exceeded
memorythresholdMemory usage notification threshold exceeded
memorytotalgbThe total memory capacity in GiB
memoryusedgbThe total memory used in GiB
networkreadNetwork read in GiB
networkwriteNetwork write in GiB
powerstateOut-of-band management power state
systeminstancessystem vm instances on the host
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listHypervisorCapabilities.html b/static/api/apidocs-4.23/apis/listHypervisorCapabilities.html new file mode 100644 index 0000000000..30c2497fa8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listHypervisorCapabilities.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listHypervisorCapabilities

+

Lists all hypervisor capabilities.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hypervisorThe hypervisor for which to restrict the searchfalse
idID of the hypervisor capabilityfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe hypervisor capability ID
hypervisorThe hypervisor type
hypervisorversionThe hypervisor version
maxdatavolumeslimitThe maximum number of Data Volumes that can be attached for this hypervisor
maxguestslimitThe maximum number of guest Instances recommended for this hypervisor
maxhostsperclusterThe maximum number of Hosts per cluster for this hypervisor
securitygroupenabledTrue if security group is supported
storagemotionenabledTrue if storage motion is supported
vmsnapshotenabledTrue if Instance Snapshots are enabled for this hypervisor
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listHypervisors.html b/static/api/apidocs-4.23/apis/listHypervisors.html new file mode 100644 index 0000000000..09e9818f5e --- /dev/null +++ b/static/api/apidocs-4.23/apis/listHypervisors.html @@ -0,0 +1,84 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listHypervisors

+

List hypervisors

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
zoneidThe zone id for listing hypervisors.false
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
nameHypervisor name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listIdps.html b/static/api/apidocs-4.23/apis/listIdps.html new file mode 100644 index 0000000000..b3d50601a9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listIdps.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listIdps

+

Returns list of discovered SAML Identity Providers

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
idThe IdP Entity ID
orgNameThe IdP Organization Name
orgUrlThe IdP Organization URL
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listImageStoreObjects.html b/static/api/apidocs-4.23/apis/listImageStoreObjects.html new file mode 100644 index 0000000000..478446507e --- /dev/null +++ b/static/api/apidocs-4.23/apis/listImageStoreObjects.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listImageStoreObjects

+

Lists objects at specified path on an image store.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idid of the image storetrue
keywordList by keywordfalse
pagefalse
pagesizefalse
pathpath to list on image storefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
formatFormat of template associated with the data store object.
isdirectoryIs it a directory.
lastupdatedLast modified date of the file/directory.
nameName of the data store object.
sizeSize is in Bytes.
snapshotidSnapshot ID associated with the data store object.
snapshotnameSnapshot Name associated with the data store object.
templateidTemplate ID associated with the data store object.
templatenameTemplate Name associated with the data store object.
volumeidVolume ID associated with the data store object.
volumenameVolume Name associated with the data store object.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listImageStores.html b/static/api/apidocs-4.23/apis/listImageStores.html new file mode 100644 index 0000000000..1be8c08008 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listImageStores.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listImageStores

+

Lists image stores.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the storage poolfalse
keywordList by keywordfalse
nameThe name of the image storefalse
pagefalse
pagesizefalse
protocolThe image store protocolfalse
providerThe image store providerfalse
readonlyRead-only status of the image storefalse
zoneidThe Zone ID for the image storefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the image store
disksizetotalThe total disk size of the host
disksizeusedThe host's currently used disk size
nameThe name of the image store
protocolThe protocol of the image store
providernameThe provider name of the image store
readonlyDefines if store is read-only
scopeThe scope of the image store
urlThe URL of the image store
zoneidThe Zone ID of the image store
zonenameThe Zone name of the image store
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listImageTransfers.html b/static/api/apidocs-4.23/apis/listImageTransfers.html new file mode 100644 index 0000000000..8a6703bcec --- /dev/null +++ b/static/api/apidocs-4.23/apis/listImageTransfers.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listImageTransfers

+

List image transfers for a backup. This API is intended for testing only and is disabled by default.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
backupidID of the backupfalse
idID of the Image Transferfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the image transfer
backupidthe backup ID
createdthe date created
devicenamethe device name (vda, vdb, etc)
directionthe image transfer direction: upload / download
phasethe transfer phase
transferurlthe transfer URL
vmidthe VM ID
volumeidthe disk/volume ID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listImportVmTasks.html b/static/api/apidocs-4.23/apis/listImportVmTasks.html new file mode 100644 index 0000000000..b00c2eb027 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listImportVmTasks.html @@ -0,0 +1,159 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listImportVmTasks

+

List running import virtual machine tasks from a unmanaged hosts into CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
zoneidthe zone IDtrue
accountidthe ID of the Accountfalse
convertinstancehostidConversion host of the importing taskfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
tasksfilterFilter tasks by state, valid options are: All, Running, Completed, Failedfalse
vcenterThe name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of importing task
accountthe account name
accountidthe ID of account
convertinstancehostidthe ID of the host on which the instance is being converted
convertinstancehostnamethe name of the host on which the instance is being converted
createdthe create date of the importing task
datacenternamethe datacenter name of the importing VM task
descriptionthe current step description on the importing VM task
displaynamethe display name of the importing VM
durationthe total task duration
lastupdatedthe last updated date of the importing task
sourcevmnamethe source VM name
statethe state of the importing VM task
stepthe current step on the importing VM task
stepdurationthe duration of the current step
vcenterthe vcenter name of the importing VM task
virtualmachineidthe ID of the imported VM (after task is completed)
zoneidthe Zone ID
zonenamethe Zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listInfrastructure.html b/static/api/apidocs-4.23/apis/listInfrastructure.html new file mode 100644 index 0000000000..93b6b61876 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listInfrastructure.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listInfrastructure

+

Lists infrastructure

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
alertsNumber of Alerts
backuprepositoriesNumber of backup repositories
clustersNumber of clusters
cpusocketsNumber of cpu sockets
hostsNumber of hypervisor hosts
ilbvmsNumber of internal LBs
imagestoresNumber of images stores
managementserversNumber of management servers
objectstoresNumber of object stores
podsNumber of pods
routersNumber of routers
storagepoolsNumber of storage pools
systemvmsNumber of systemvms
zonesNumber of zones
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listInstanceGroups.html b/static/api/apidocs-4.23/apis/listInstanceGroups.html new file mode 100644 index 0000000000..a968f2d677 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listInstanceGroups.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listInstanceGroups

+

Lists Instance groups

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idList Instance groups by IDfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameList Instance groups by namefalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance group
accountThe Account owning the Instance group
createdTime and date the Instance group was created
domainThe domain name of the Instance group
domainidThe domain ID of the Instance group
domainpathpath of the Domain the instance group belongs to
nameThe name of the Instance group
projectThe project name of the Instance group
projectidThe project ID of the Instance group
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listInternalLoadBalancerElements.html b/static/api/apidocs-4.23/apis/listInternalLoadBalancerElements.html new file mode 100644 index 0000000000..6000cff8e5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listInternalLoadBalancerElements.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listInternalLoadBalancerElements

+

Lists all available Internal Load Balancer elements.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enabledList internal load balancer elements by enabled statefalse
idList internal load balancer elements by IDfalse
keywordList by keywordfalse
nspidList internal load balancer elements by network service provider IDfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
idThe ID of the internal Load balancer element
enabledEnabled/Disabled the element
nspidThe physical Network service provider ID of the element
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listInternalLoadBalancerVMs.html b/static/api/apidocs-4.23/apis/listInternalLoadBalancerVMs.html new file mode 100644 index 0000000000..fb5191510b --- /dev/null +++ b/static/api/apidocs-4.23/apis/listInternalLoadBalancerVMs.html @@ -0,0 +1,411 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listInternalLoadBalancerVMs

+

List internal LB Instances.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fetchhealthcheckresultsIf true is passed for this parameter, also fetch last executed health check results for the Instance. Default is falsefalse
forvpcIf true is passed for this parameter, list only VPC Internal LB Instancesfalse
hostidThe host ID of the Internal LB Instancefalse
idThe ID of the Internal LB Instancefalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameThe name of the Internal LB Instancefalse
networkidList by Network IDfalse
pagefalse
pagesizefalse
podidThe Pod ID of the Internal LB Instancefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
stateThe state of the Internal LB Instancefalse
vpcidList Internal LB Instances by VPCfalse
zoneidThe Zone ID of the Internal LB Instancefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the router
accountThe Account associated with the router
archCPU arch of the router
createdThe date and time the router was created
dns1The first DNS for the router
dns2The second DNS for the router
domainThe domain associated with the router
domainidThe domain ID associated with the router
domainpathpath of the Domain the router belongs to
gatewayThe gateway for the router
guestipaddressThe guest IP address for the router
guestmacaddressThe guest MAC address for the router
guestnetmaskThe guest netmask for the router
guestnetworkidThe ID of the corresponding guest Network
guestnetworknameThe name of the corresponding guest Network
healthchecksfailedTrue if any health checks had failed
hostcontrolstateThe control state of the host for the router
hostidThe host ID for the router
hostnameThe hostname for the router
hypervisorThe hypervisor on which the Template runs
ip6dns1The first IPv6 DNS for the router
ip6dns2The second IPv6 DNS for the router
isredundantrouterIf this router is an redundant virtual router
linklocalipThe Control IP address for the router
linklocalmacaddressThe link local MAC address for the router
linklocalnetmaskThe link local netmask for the router
linklocalnetworkidThe ID of the corresponding link local Network
nameThe name of the router
networkdomainThe Network domain for the router
podidThe Pod ID for the router
podnameThe Pod name for the router
projectThe project name of the address
projectidThe project id of the IP address
publicipThe public IP address for the router
publicmacaddressThe public MAC address for the router
publicnetmaskThe public netmask for the router
publicnetworkidThe ID of the corresponding public Network
redundantstateThe state of redundant virtual router
requiresupgradeTrue if the router Template requires upgrade
roleRole of the domain router
scriptsversionThe version of scripts
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
softwareversionThe version of the code / software in the router
stateThe state of the router
templateidThe Template ID for the router
templatenameThe Template name for the router
versionThe version of Template
vpcidVPC the router belongs to
vpcnameThe name of VPC the router belongs to
zoneidThe Zone ID for the router
zonenameThe Zone name for the router
healthcheckresults(*)Last executed health check result for the router
checknameThe name of the health check on the router
checktypeThe type of the health check - basic or advanced
detailsDetailed response generated on running health check
lastupdatedThe date this VPC was created
statusthe result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}
successThe result of the health check if available
nic(*)The list of NICs associated with the router
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listIpForwardingRules.html b/static/api/apidocs-4.23/apis/listIpForwardingRules.html new file mode 100644 index 0000000000..c487450e1d --- /dev/null +++ b/static/api/apidocs-4.23/apis/listIpForwardingRules.html @@ -0,0 +1,198 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listIpForwardingRules

+

List the IP forwarding rules

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idLists rule with the specified ID.false
ipaddressidList the rule belonging to this public IP addressfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
virtualmachineidLists all rules applied to the specified Instance.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the port forwarding rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
fordisplayIs firewall for display to the regular user
ipaddressThe public IP address for the port forwarding rule
ipaddressidThe public IP address id for the port forwarding rule
networkidThe ID of the guest Network the port forwarding rule belongs to
networknameThe Name of the guest Network the port forwarding rule belongs to
privateendportThe ending port of port forwarding rule's private port range
privateportThe starting port of port forwarding rule's private port range
protocolThe protocol of the port forwarding rule
publicendportThe ending port of port forwarding rule's private port range
publicportThe starting port of port forwarding rule's public port range
stateThe state of the rule
virtualmachinedisplaynameThe Instance display name for the port forwarding rule
virtualmachineidThe Instance ID for the port forwarding rule
virtualmachinenameThe Instance name for the port forwarding rule
vmguestipThe Instance IP address for the port forwarding rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listIpv4SubnetsForGuestNetwork.html b/static/api/apidocs-4.23/apis/listIpv4SubnetsForGuestNetwork.html new file mode 100644 index 0000000000..182a18a10a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listIpv4SubnetsForGuestNetwork.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listIpv4SubnetsForGuestNetwork

+

Lists IPv4 subnets for guest networks.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idUUID of the IPv4 subnet for guest network.false
keywordList by keywordfalse
networkidUUID of network to which the IPv4 subnet is associated to.false
pagefalse
pagesizefalse
parentidUUID of zone Ipv4 subnet which the IPv4 subnet belongs to.false
subnetThe CIDR of the Ipv4 subnet.false
vpcidUUID of VPC to which the IPv4 subnet is associated to.false
zoneidUUID of zone to which the IPv4 subnet belongs to.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idid of the IPv4 subnet for guest network
allocateddate when this IPv4 subnet was allocated.
createddate when this IPv4 subnet was created.
networkidid of network which the IPv4 subnet is associated with.
networknamename of network which the IPv4 subnet is associated with.
parentidid of the data center IPv4 subnet
parentsubnetsubnet of the data center IPv4 subnet
removeddate when this IPv4 subnet was removed.
statestate of subnet of the IPv4 network
subnetsubnet of the IPv4 network
vpcidId of the VPC which the IPv4 subnet is associated with.
vpcnameName of the VPC which the IPv4 subnet is associated with.
zoneidid of zone to which the IPv4 subnet belongs to.
zonenameid of zone to which the IPv4 subnet belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listIpv4SubnetsForZone.html b/static/api/apidocs-4.23/apis/listIpv4SubnetsForZone.html new file mode 100644 index 0000000000..c395052990 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listIpv4SubnetsForZone.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listIpv4SubnetsForZone

+

Lists IPv4 subnets for zone.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountthe account which the IPv4 subnet is dedicated to. Must be used with the domainId parameter.false
domainidthe domain ID which the IPv4 subnet is dedicated to.false
idUUID of the IPv4 subnet.false
keywordList by keywordfalse
pagefalse
pagesizefalse
projectidproject who which the IPv4 subnet is dedicated tofalse
subnetCIDR of the IPv4 subnet.false
zoneidUUID of zone to which the IPv4 subnet belongs to.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idid of the guest IPv4 subnet
accountthe account of the IPv4 subnet
createddate when this IPv4 subnet was created.
domainthe domain name of the IPv4 subnet
domainidthe domain ID of the IPv4 subnet
projectthe project name of the IPv4 subnet
projectidthe project id of the IPv4 subnet
subnetguest IPv4 subnet
zoneidid of zone to which the IPv4 subnet belongs to.
zonenamename of zone to which the IPv4 subnet belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listIpv6FirewallRules.html b/static/api/apidocs-4.23/apis/listIpv6FirewallRules.html new file mode 100644 index 0000000000..41bae31d5c --- /dev/null +++ b/static/api/apidocs-4.23/apis/listIpv6FirewallRules.html @@ -0,0 +1,204 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listIpv6FirewallRules

+

Lists all IPv6 firewall rules

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idLists IPv6 firewall rule with the specified IDfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
networkidList IPV6 firewall rules by Network IDfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
tagsList resources by tags (key/value pairs)false
traffictypeList IPV6 firewall rules by traffic type - ingress or egressfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the port forwarding rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
fordisplayIs firewall for display to the regular user
ipaddressThe public IP address for the port forwarding rule
ipaddressidThe public IP address id for the port forwarding rule
networkidThe ID of the guest Network the port forwarding rule belongs to
networknameThe Name of the guest Network the port forwarding rule belongs to
privateendportThe ending port of port forwarding rule's private port range
privateportThe starting port of port forwarding rule's private port range
protocolThe protocol of the port forwarding rule
publicendportThe ending port of port forwarding rule's private port range
publicportThe starting port of port forwarding rule's public port range
stateThe state of the rule
virtualmachinedisplaynameThe Instance display name for the port forwarding rule
virtualmachineidThe Instance ID for the port forwarding rule
virtualmachinenameThe Instance name for the port forwarding rule
vmguestipThe Instance IP address for the port forwarding rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listIsoPermissions.html b/static/api/apidocs-4.23/apis/listIsoPermissions.html new file mode 100644 index 0000000000..29b31ed9e1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listIsoPermissions.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listIsoPermissions

+

List ISO visibility and all accounts that have permissions to view this ISO.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe Template IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe list of Accounts the Template is available for
domainidThe ID of the domain to which the Template belongs
ispublicTrue if this Template is a public Template, false otherwise
projectidsThe list of projects the Template is available for
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listIsos.html b/static/api/apidocs-4.23/apis/listIsos.html new file mode 100644 index 0000000000..49ec708b0e --- /dev/null +++ b/static/api/apidocs-4.23/apis/listIsos.html @@ -0,0 +1,321 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listIsos

+

Lists all available ISO files.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
archthe CPU arch of the ISO. Valid options are: x86_64, aarch64, s390xfalse
bootableTrue if the ISO is bootable, false otherwisefalse
domainidList only resources belonging to the domain specifiedfalse
hypervisorThe hypervisor for which to restrict the searchfalse
idList ISO by IDfalse
imagestoreidID of the image or image cache storefalse
isofilterPossible 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 Instance. * 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 an Instance. * community : Templates that have been marked as public but not featured. * all : all Templates (only usable by admins).false
ispublicTrue if the ISO is publicly available to all Users, false otherwise.false
isreadyIf True, list ISOs that are ready to be deployed.false
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameList all ISOs by namefalse
oscategoryidthe ID of the OS category for the ISOfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
showiconFlag to display the resource image for the ISOsfalse
showremovedShow removed ISOs as wellfalse
showuniqueIf set to true, list only unique ISOs across zonesfalse
storageidID of the storage poolfalse
tagsList resources by tags (key/value pairs)false
zoneidThe ID of the zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe Account name to which the Template belongs
accountidThe Account id to which the Template belongs
archCPU Arch of the template
bitsThe processor bit size
bootableTrue if the ISO is bootable, false otherwise
checksumChecksum of the Template
childtemplatesIf root disk Template, then IDs of the datas disk Templates this Template owns
createdThe date this Template was created
crossZonesTrue if the Template is managed across all Zones, false otherwise
deployasisVMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is Template
detailsAdditional key/value details tied with Template
directdownloadKVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextThe Template display text
domainThe name of the domain to which the Template belongs
domainidThe ID of the domain to which the Template belongs
domainpathPath of the Domain the template belongs to
downloaddetailsLists the download progress of a Template across all secondary storages
extensionidThe ID of extension linked to this template
extensionnameThe name of extension linked to this template
forcksIf true it indicates that the template can be used for CKS cluster deployments
formatThe format of the Template.
hostidThe ID of the secondary storage host for the Template
hostnameThe name of the secondary storage host for the Template
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
isextractableTrue if the Template is extractable, false otherwise
isfeaturedTrue if this Template is a featured Template, false otherwise
ispublicTrue if this Template is a public Template, false otherwise
isreadyTrue if the Template is ready to be deployed from, false otherwise.
nameThe Template name
ostypeidThe ID of the OS type for this Template.
ostypenameThe name of the OS type for this Template.
parenttemplateidIf Datadisk Template, then id of the root disk Template this Template belongs to
passwordenabledTrue if the reset password feature is enabled, false otherwise
physicalsizeThe physical size of the Template
projectThe project name of the Template
projectidThe project ID of the Template
removedThe date this Template was removed
requireshvmTrue if Template requires HVM enabled, false otherwise
sizeThe size of the Template
sourcetemplateidThe Template ID of the parent Template if present
sshkeyenabledTrue if Template is sshkey enabled, false otherwise
statusThe status of the Template
templatetagThe tag of this Template
templatetypeThe type of the Template
urlThe URL which the Template/ISO is registered from
userdataidThe id of userdata linked to this Template
userdatanameThe name of userdata linked to this Template
userdataparamsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
zoneidThe ID of the zone for this Template
zonenameThe name of the zone for this Template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listKMSKeys.html b/static/api/apidocs-4.23/apis/listKMSKeys.html new file mode 100644 index 0000000000..049e73e3e0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listKMSKeys.html @@ -0,0 +1,174 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listKMSKeys

+

Lists KMS keys available to the caller

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
enabledFilter by enabled statusfalse
hsmprofileidFilter by HSM profile IDfalse
idList KMS key by UUIDfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
zoneidFilter by zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe UUID of the key
accountthe account owning the key
accountidthe account ID owning the key
algorithmthe encryption algorithm
createdthe creation timestamp
descriptionthe description of the key
domainthe domain name of the key
domainidthe domain ID of the key
domainpaththe domain path of the key
enabledwhether the key is enabled
hsmprofilethe zone name where the key is valid
hsmprofileidthe zone ID where the key is valid
keklabelthe provider-specific KEK label (admin only)
keybitsthe key size in bits
namethe name of the key
projectthe project name of the key
projectidthe project ID of the key
versionthe key size in bits
zoneidthe zone ID where the key is valid
zonenamethe zone name where the key is valid
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listKubernetesClusters.html b/static/api/apidocs-4.23/apis/listKubernetesClusters.html new file mode 100644 index 0000000000..7c1e279147 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listKubernetesClusters.html @@ -0,0 +1,273 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listKubernetesClusters

+

Lists Kubernetes clusters

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
clustertypeType of the cluster: CloudManaged, ExternalManagedfalse
domainidList only resources belonging to the domain specifiedfalse
idThe ID of the Kubernetes clusterfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameName of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
stateState of the Kubernetes clusterfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Kubernetes cluster
accountThe Account associated with the Kubernetes cluster
associatednetworknameThe name of the network of the Kubernetes cluster
autoscalingenabledWhether autoscaling is enabled for the cluster
clustertypeThe type of the cluster
cniconfignameName of CNI Configuration associated with the cluster
cniconfigurationidID of CNI Configuration associated with the cluster
consoleendpointURL end point for the Kubernetes cluster dashboard UI
controlaffinitygroupidsThe IDs of affinity groups associated with control nodes
controlaffinitygroupnamesThe names of affinity groups associated with control nodes
controlnodesThe control nodes count for the Kubernetes cluster
controlofferingidthe ID of the service offering of the control nodes on the Kubernetes cluster
controlofferingnamethe name of the service offering of the control nodes on the Kubernetes cluster
cpunumberThe cpu cores of the Kubernetes cluster
createdThe date when this Kubernetes cluster was created
csienabledIndicates if the CloudStack CSI driver has been setup in the cluster
descriptionThe description of the Kubernetes cluster
domainThe name of the domain in which the Kubernetes cluster exists
domainidThe ID of the domain in which the Kubernetes cluster exists
domainpathPath of the domain to which the Kubernetes cluster belongs
endpointURL end point for the Kubernetes cluster
etcdaffinitygroupidsThe IDs of affinity groups associated with etcd nodes
etcdaffinitygroupnamesThe names of affinity groups associated with etcd nodes
etcdipsPublic IP Addresses of the etcd nodes
etcdnodesthe number of the etcd nodes on the Kubernetes cluster
etcdofferingidthe ID of the service offering of the etcd nodes on the Kubernetes cluster
etcdofferingnamethe name of the service offering of the etcd nodes on the Kubernetes cluster
ipaddressPublic IP Address of the cluster
ipaddressidPublic IP Address ID of the cluster
keypairKeypair details
kubernetesversionidThe ID of the Kubernetes version for the Kubernetes cluster
kubernetesversionnameThe name of the Kubernetes version for the Kubernetes cluster
masternodesThe master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.
maxsizeMaximum size of the cluster
memoryThe memory the Kubernetes cluster
minsizeMinimum size of the cluster
nameThe name of the Kubernetes cluster
networkidThe ID of the network of the Kubernetes cluster
projectThe project name of the Kubernetes cluster
projectidThe project id of the Kubernetes cluster
serviceofferingidThe ID of the service offering of the Kubernetes cluster
serviceofferingnameThe name of the service offering of the Kubernetes cluster
sizeThe size (worker nodes count) of the Kubernetes cluster
stateThe state of the Kubernetes cluster
templateidThe ID of the Template of the Kubernetes cluster
templatenamethe name of the template of the Kubernetes cluster
virtualmachinesThe list of virtualmachines associated with this Kubernetes cluster
workeraffinitygroupidsThe IDs of affinity groups associated with worker nodes
workeraffinitygroupnamesThe names of affinity groups associated with worker nodes
workerofferingidthe ID of the service offering of the worker nodes on the Kubernetes cluster
workerofferingnamethe name of the service offering of the worker nodes on the Kubernetes cluster
zoneidThe name of the zone of the Kubernetes cluster
zonenameThe name of the zone of the Kubernetes cluster
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listKubernetesSupportedVersions.html b/static/api/apidocs-4.23/apis/listKubernetesSupportedVersions.html new file mode 100644 index 0000000000..6687bec859 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listKubernetesSupportedVersions.html @@ -0,0 +1,153 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listKubernetesSupportedVersions

+

Lists supported Kubernetes version

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
archthe CPU arch of the binaries ISO. Valid options are: x86_64, aarch64, s390xfalse
idThe ID of the Kubernetes supported versionfalse
keywordList by keywordfalse
minimumkubernetesversionidThe ID of the minimum Kubernetes supported versionfalse
minimumsemanticversionThe minimum semantic version for the Kubernetes supported version to be listedfalse
pagefalse
pagesizefalse
zoneidThe ID of the zone in which Kubernetes supported version will be availablefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Kubernetes supported version
archthe arch of the binaries ISO for Kubernetes supported version
createdThe date when this Kubernetes supported version was created
directdownloadKVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage
isoidThe ID of the binaries ISO for Kubernetes supported version
isonameThe name of the binaries ISO for Kubernetes supported version
isostateThe state of the binaries ISO for Kubernetes supported version
isourlthe URL of the binaries ISO for Kubernetes supported version
mincpunumberThe minimum number of CPUs needed for the Kubernetes supported version
minmemoryThe minimum RAM size in MB needed for the Kubernetes supported version
nameName of the Kubernetes supported version
semanticversionKubernetes semantic version
stateThe enabled or disabled state of the Kubernetes supported version
supportsautoscalingWhether Kubernetes supported version supports Autoscaling
supportshaWhether Kubernetes supported version supports HA, multi-control nodes
zoneidThe ID of the zone in which Kubernetes supported version is available
zonenameThe name of the zone in which Kubernetes supported version is available
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listLBHealthCheckPolicies.html b/static/api/apidocs-4.23/apis/listLBHealthCheckPolicies.html new file mode 100644 index 0000000000..3828db57cc --- /dev/null +++ b/static/api/apidocs-4.23/apis/listLBHealthCheckPolicies.html @@ -0,0 +1,141 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listLBHealthCheckPolicies

+

Lists load balancer health check policies.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idThe ID of the health check policyfalse
keywordList by keywordfalse
lbruleidThe ID of the load balancer rulefalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account of the HealthCheck policy
domainThe domain of the HealthCheck policy
domainidThe domain ID of the HealthCheck policy
lbruleidThe LB rule ID
zoneidThe ID of the zone the HealthCheck policy belongs to
healthcheckpolicy(*)The list of healthcheckpolicies
idThe LB HealthCheck policy ID
descriptionThe description of the healthcheck policy
fordisplayIs policy for display to the regular user
healthcheckintervalAmount of time between health checks
healthcheckthressholdNumber of consecutive health check success before declaring an Instance healthy
pingpathThe pingpath of the healthcheck policy
responsetimeTime to wait when receiving a response from the health check
stateThe state of the policy
unhealthcheckthressholdNumber of consecutive health check failures before declaring an Instance unhealthy.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listLBStickinessPolicies.html b/static/api/apidocs-4.23/apis/listLBStickinessPolicies.html new file mode 100644 index 0000000000..a3dfd0ef13 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listLBStickinessPolicies.html @@ -0,0 +1,144 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listLBStickinessPolicies

+

Lists load balancer stickiness policies.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idThe ID of the load balancer stickiness policyfalse
keywordList by keywordfalse
lbruleidThe ID of the load balancer rulefalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account of the Stickiness policy
descriptionThe description of the Stickiness policy
domainThe domain of the Stickiness policy
domainidThe domain ID of the Stickiness policy
lbruleidThe LB rule ID
nameThe name of the Stickiness policy
stateThe state of the policy
zoneidThe ID of the zone the Stickiness policy belongs to
stickinesspolicy(*)The list of stickinesspolicies
idThe LB Stickiness policy ID
descriptionThe description of the Stickiness policy
fordisplayIs policy for display to the regular user
methodnameThe method name of the Stickiness policy
nameThe name of the Stickiness policy
paramsThe params of the policy
stateThe state of the policy
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listLdapConfigurations.html b/static/api/apidocs-4.23/apis/listLdapConfigurations.html new file mode 100644 index 0000000000..aa1cdc06b3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listLdapConfigurations.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listLdapConfigurations

+

Lists all LDAP configurations

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
domainidLinked Domainfalse
hostnameHostnamefalse
idlist ldap configuration by ID; when passed, all other parameters are ignoredfalse
keywordList by keywordfalse
listallIf set to true, and no `domainid` specified, list all LDAP configurations irrespective of the linked domainfalse
pagefalse
pagesizefalse
portPortfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the LDAP configuration
domainidLinked domain
hostnameName of the host running the LDAP server
portPort the LDAP server is running on
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listLdapUsers.html b/static/api/apidocs-4.23/apis/listLdapUsers.html new file mode 100644 index 0000000000..ed08963a4a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listLdapUsers.html @@ -0,0 +1,122 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listLdapUsers

+

Lists LDAP Users according to the specifications from the user request.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
domainidLinked Domainfalse
keywordList by keywordfalse
listtypeDetermines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameterfalse
pagefalse
pagesizefalse
userfilterDetermines 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 userSourcefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
conflictingusersourceThe authentication source for this user as known to the system or empty if the user is not yet in cloudstack.
domainThe user's domain
emailThe user's email
firstnameThe user's firstname
lastnameThe user's lastname
principalThe user's principle
usernameThe user's username
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listLoadBalancerRuleInstances.html b/static/api/apidocs-4.23/apis/listLoadBalancerRuleInstances.html new file mode 100644 index 0000000000..911864413f --- /dev/null +++ b/static/api/apidocs-4.23/apis/listLoadBalancerRuleInstances.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listLoadBalancerRuleInstances

+

List all Instances that are assigned to a load balancer rule.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the load balancer ruletrue
appliedTrue if listing all Instances currently applied to the load balancer rule; default is truefalse
keywordList by keywordfalse
lbvmipsTrue if load balancer rule Instance IP information to be included; default is falsefalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
lbvmipaddressesIP addresses of the Instance set of LB rule
loadbalancerruleinstanceThe user Instance set for LB rule
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listLoadBalancerRules.html b/static/api/apidocs-4.23/apis/listLoadBalancerRules.html new file mode 100644 index 0000000000..95352585c8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listLoadBalancerRules.html @@ -0,0 +1,225 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listLoadBalancerRules

+

Lists load balancer rules.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idThe ID of the load balancer rulefalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameThe name of the load balancer rulefalse
networkidList by Network ID the rule belongs tofalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
publicipidThe public IP address ID of the load balancer rulefalse
tagsList resources by tags (key/value pairs)false
virtualmachineidThe ID of the Instance of the load balancer rulefalse
zoneidThe availability zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Load balancer rule ID
accountThe Account of the Load balancer rule
algorithmThe Load balancer algorithm (source, roundrobin, leastconn)
cidrlistThe CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).
descriptionThe description of the Load balancer
domainThe domain of the Load balancer rule
domainidThe domain ID of the Load balancer rule
domainpathpath of the domain to which the load balancer rule belongs
fordisplayIs rule for display to the regular user
nameThe name of the Load balancer
networkidThe ID of the guest Network the LB rule belongs to
privateportThe private port
projectThe project name of the Load balancer
projectidThe project ID of the Load balancer
protocolThe protocol of the Load Balancer rule
publicipThe public IP address
publicipidThe public IP address ID
publicportThe public port
stateThe state of the rule
zoneidThe ID of the zone the rule belongs to
zonenameThe name of the zone the Load balancer rule belongs to
tags(*)The list of resource tags associated with Load balancer
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listLoadBalancers.html b/static/api/apidocs-4.23/apis/listLoadBalancers.html new file mode 100644 index 0000000000..98be8345e1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listLoadBalancers.html @@ -0,0 +1,231 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listLoadBalancers

+

Lists internal load balancers

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idThe ID of the load balancerfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameThe name of the load balancerfalse
networkidThe network ID of the load balancerfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
schemeThe scheme of the load balancer. Supported value is internal in the current releasefalse
sourceipaddressThe source IP address of the load balancerfalse
sourceipaddressnetworkidThe network ID of the source IP addressfalse
tagsList resources by tags (key/value pairs)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Load Balancer ID
accountThe Account of the Load Balancer
algorithmThe Load balancer algorithm (source, roundrobin, leastconn)
descriptionThe description of the Load Balancer
domainThe domain of the Load Balancer
domainidThe domain ID of the Load Balancer
domainpathpath of the domain to which the Load Balancer belongs
fordisplayIs rule for display to the regular User
nameThe name of the Load Balancer
networkidLoad Balancer Network id
projectThe project name of the Load Balancer
projectidThe project id of the Load Balancer
sourceipaddressLoad Balancer source IP
sourceipaddressnetworkidLoad Balancer source IP Network id
loadbalancerinstance(*)The list of Instances associated with the Load Balancer
idThe Instance ID
ipaddressThe IP address of the Instance
nameThe name of the Instance
stateThe state of the Instance
loadbalancerrule(*)The list of rules associated with the Load Balancer
instanceportInstance port of the Load balancer rule
sourceportSource port of the Load balancer rule
stateThe state of the Load balancer rule
tags(*)The list of resource tags associated with the Load Balancer
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listManagementServers.html b/static/api/apidocs-4.23/apis/listManagementServers.html new file mode 100644 index 0000000000..642300dc2d --- /dev/null +++ b/static/api/apidocs-4.23/apis/listManagementServers.html @@ -0,0 +1,153 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listManagementServers

+

Lists management servers.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the management serverfalse
keywordList by keywordfalse
nameThe name of the management serverfalse
pagefalse
pagesizefalse
peersWhether to return the management server peers or not. By default, the management server peers will not be returned.false
versionthe version of the management serverfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the management server
agentsthe agents this Management Server is responsible for
agentscountthe number of host agents this Management Server is responsible for
ipaddressthe IP Address for this Management Server
javadistributionThe java distribution name running the management server process
javaversionThe version of the java distribution running the management server process
kernelversionThe running OS kernel version for this Management Server
lastagentsthe last agents this Management Server is responsible for, before shutdown or preparing for maintenance
lastboottimeThe last time the host on which this Management Server runs was booted
lastserverstartThe last time this Management Server was started
lastserverstopThe last time this Management Server was stopped
nameThe name of the management server
osdistributionThe name of the OS distribution running on the management server
peersthe Management Server Peers
pendingjobscountthe number of pending jobs in this Management Server
serviceipThe IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.
stateThe state of the management server
versionThe version of the management server
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listManagementServersMetrics.html b/static/api/apidocs-4.23/apis/listManagementServersMetrics.html new file mode 100644 index 0000000000..4a84a1acaa --- /dev/null +++ b/static/api/apidocs-4.23/apis/listManagementServersMetrics.html @@ -0,0 +1,171 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listManagementServersMetrics

+

Lists Management Server metrics

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the management serverfalse
keywordList by keywordfalse
nameThe name of the management serverfalse
pagefalse
pagesizefalse
peersWhether to return the management server peers or not. By default, the management server peers will not be returned.false
systemInclude system level statsfalse
versionthe version of the management serverfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
agentcountThe number of agents this Management Server is responsible for
availableprocessorsThe number of processors available to the JVM
collectiontimeThe time these statistics were collected
cpuloadThe current cpu load
dbislocalThe system is running against a local database
heapmemorytotalThe amount of memory allocated to this Management Server
heapmemoryusedThe amount of memory used by this Management Server
loginfoThe log files and their usage on disk
sessionsThe number of client sessions active on this Management Server
systemcycleusageThe system load for user, and system processes and the system idle cycles
systemloadaveragesThe load averages for 1 5 and 15 minutes
systemmemoryfreeFree system memory
systemmemorytotalTotal system memory
systemmemoryusedAmount of memory used
systemmemoryvirtualsizeVirtual size of the fully loaded process
systemtotalcpucyclesThe total system cpu capacity
threadsblockedcountThe number of blocked threads
threadsdaemoncountThe number of daemon threads
threadsrunnablecountThe number of runnable threads
threadsteminatedcountThe number of terminated threads
threadstotalcountThe number of threads
threadswaitingcountThe number of waiting threads
usageislocalThe system has a usage server running locally
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNetrisProviders.html b/static/api/apidocs-4.23/apis/listNetrisProviders.html new file mode 100644 index 0000000000..f0f6f2b0d0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNetrisProviders.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNetrisProviders

+

list all Netris providers added to CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
zoneidID of the zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameNetris Provider name
netristagNetris Tag for vNets
netrisurlNetris Provider URL
sitenameNetris Provider site
tenantnameNetris Admin tenant name
uuidNetris provider uuid
zoneidZone ID to which the Netris Provider is associated with
zonenameZone name to which the Netris Provider is associated with
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNetscalerControlCenter.html b/static/api/apidocs-4.23/apis/listNetscalerControlCenter.html new file mode 100644 index 0000000000..0e6c4d846a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNetscalerControlCenter.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNetscalerControlCenter

+

List control center

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID
ipaddressncc_ip
numretriesNumber of retries
usernameUsername
uuidUUID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNetscalerLoadBalancerNetworks.html b/static/api/apidocs-4.23/apis/listNetscalerLoadBalancerNetworks.html new file mode 100644 index 0000000000..7c1cf5a1da --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNetscalerLoadBalancerNetworks.html @@ -0,0 +1,393 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNetscalerLoadBalancerNetworks

+

Lists network that are using a netscaler load balancer device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
lbdeviceidNetscaler load balancer device IDtrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Network
accountThe owner of the Network
aclidACL ID associated with the VPC Network
aclnameACL name associated with the VPC Network
acltypeACL type - access type to the Network
asnumberAS NUMBER
asnumberidUUID of AS NUMBER
bgppeersThe BGP peers for the network
broadcastdomaintypeBroadcast domain type of the Network
broadcasturiBroadcast URI of the Network. This parameter is visible to ROOT admins only
canusefordeployList Networks available for Instance deployment
cidrCloudStack managed address space, all CloudStack managed Instances get IP address from CIDR
createdThe date this Network was created
detailsThe details of the Network
displaynetworkAn optional field, whether to the display the Network to the end user or not.
displaytextThe displaytext of the Network
dns1The first IPv4 DNS for the Network
dns2The second IPv4 DNS for the Network
dnssubdomainDNS subdomain associated to the network
dnszoneDNS zone associated to the network
domainThe domain name of the Network owner
domainidThe domain ID of the Network owner
domainpathPath of the Domain the network belongs to
egressdefaultpolicyTrue if guest Network default egress policy is allow; false if default egress policy is deny
externalidThe external ID of the Network
gatewayThe Network's gateway
iconBase64 string representation of the resource icon
internetprotocolThe internet protocol of Network offering
ip4routesThe routes for the network to ease adding route in upstream router
ip4routingThe IPv4 routing type of network
ip6cidrThe CIDR of IPv6 Network
ip6dns1The first IPv6 DNS for the network
ip6dns2The second IPv6 DNS for the network
ip6gatewayThe gateway of IPv6 Network
ip6routesThe routes for the Network to ease adding route in upstream router
ip6routingThe IPv6 routing type of network offering
isdefaultTrue if Network is default, false otherwise
ispersistentList Networks that are persistent
issystemTrue if Network is system, false otherwise
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.
nameThe name of the Network
netmaskThe Network's netmask
networkcidrThe Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE
networkdomainThe Network domain
networkofferingavailabilityAvailability of the Network offering the Network is created from
networkofferingconservemodeTrue if Network offering is IP conserve mode enabled
networkofferingdisplaytextDisplay text of the Network offering the Network is created from
networkofferingidNetwork offering ID the Network is created from
networkofferingnameName of the Network offering the Network is created from
physicalnetworkidThe physical Network id
privatemtuMTU configured on the network VR's private interfaces
projectThe project name of the address
projectidThe project ID of the IP address
publicmtuMTU configured on the Network VR's public facing interfaces
receivedbytesThe total number of Network traffic bytes received
redundantrouterIf the Network has redundant routers enabled
relatedRelated to what other Network configuration
reservediprangeThe Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes
restartrequiredTrue if Network requires restart
sentbytesThe total number of Network traffic bytes sent
specifyiprangesTrue if Network supports specifying IP ranges, false otherwise
specifyvlanTrue if network supports specifying vlan, false otherwise
stateState of the Network
strechedl2subnetTrue if Network can span multiple zones
subdomainaccessTrue if users from subdomains can access the domain level Network
supportsvmautoscalingIf Network offering supports Instance autoscaling feature
traffictypeThe traffic type of the Network
tungstenvirtualrouteruuidTungsten-Fabric virtual router the Network belongs to
typeThe type of the Network
vlanThe VLAN of the Network. This parameter is visible to ROOT admins only
vpcidVPC the Network belongs to
vpcnameName of the VPC to which this Network belongs
zoneidZone ID of the Network
zonenameThe name of the zone the Network belongs to
zonesnetworkspansIf a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans
service(*)The list of services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
tags(*)The list of resource tags associated with Network
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNetscalerLoadBalancers.html b/static/api/apidocs-4.23/apis/listNetscalerLoadBalancers.html new file mode 100644 index 0000000000..0a385b5be1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNetscalerLoadBalancers.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNetscalerLoadBalancers

+

Lists netscaler load balancer devices

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
lbdeviceidNetscaler load balancer device IDfalse
pagefalse
pagesizefalse
physicalnetworkidThe Physical Network IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
gslbproviderTrue if NetScaler device is provisioned to be a GSLB service provider
gslbproviderprivateipPrivate IP of the NetScaler representing GSLB site
gslbproviderpublicipPublic IP of the NetScaler representing GSLB site
ipaddressThe management IP address of the external load balancer
isexclusivegslbproviderTrue if NetScaler device is provisioned exclusively to be a GSLB service provider
lbdevicecapacityDevice capacity
lbdevicededicatedTrue if device is dedicated for an account
lbdeviceidDevice ID of the netscaler load balancer
lbdevicenameDevice name
lbdevicestateDevice state
physicalnetworkidThe physical Network to which this netscaler device belongs to
podidsUsed 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.
privateinterfaceThe private interface of the load balancer
providerName of the provider
publicinterfaceThe public interface of the load balancer
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNetworkACLLists.html b/static/api/apidocs-4.23/apis/listNetworkACLLists.html new file mode 100644 index 0000000000..ecfed72ed4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNetworkACLLists.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNetworkACLLists

+

Lists all network ACLs

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idLists network ACL with the specified ID.false
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameList network ACLs by specified namefalse
networkidList network ACLs by network IDfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
vpcidList network ACLs by VPC IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the ACL
descriptionDescription of the ACL
fordisplayIs ACL for display to the regular user
nameThe Name of the ACL
vpcidId of the VPC this ACL is associated with
vpcnameName of the VPC this ACL is associated with
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNetworkACLs.html b/static/api/apidocs-4.23/apis/listNetworkACLs.html new file mode 100644 index 0000000000..8cc0415e75 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNetworkACLs.html @@ -0,0 +1,207 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNetworkACLs

+

Lists all network ACL items

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
aclidList network ACL items by ACL IDfalse
actionList network ACL items by actionfalse
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idLists network ACL Item with the specified IDfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
networkidList network ACL items by network IDfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
protocolList network ACL items by protocolfalse
tagsList resources by tags (key/value pairs)false
traffictypeList network ACL items by traffic type - ingress or egressfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the ACL Item
aclidThe ID of the ACL this item belongs to
aclnameThe name of the ACL this item belongs to
actionAction of ACL Item. Allow/Deny
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
endportThe ending port of ACL's port range
fordisplayIs rule for display to the regular user
icmpcodeError code for this icmp message
icmptypeType of the icmp message being sent
numberNumber of the ACL Item
protocolThe protocol of the ACL
reasonAn explanation on why this ACL rule is being applied
startportThe starting port of ACL's port range
stateThe state of the rule
traffictypeThe traffic type for the ACL
tags(*)The list of resource tags associated with the Network ACLs
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNetworkDevice.html b/static/api/apidocs-4.23/apis/listNetworkDevice.html new file mode 100644 index 0000000000..04a2b9560a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNetworkDevice.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNetworkDevice

+

List network devices

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
networkdeviceparameterlistParameters for network devicefalse
networkdevicetypeNetwork device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewallfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
idThe ID of the Network device
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNetworkIsolationMethods.html b/static/api/apidocs-4.23/apis/listNetworkIsolationMethods.html new file mode 100644 index 0000000000..9adfcad34f --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNetworkIsolationMethods.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNetworkIsolationMethods

+

Lists supported methods of network isolation

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
nameNetwork isolation method name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNetworkOfferings.html b/static/api/apidocs-4.23/apis/listNetworkOfferings.html new file mode 100644 index 0000000000..1aad709f45 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNetworkOfferings.html @@ -0,0 +1,285 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNetworkOfferings

+

Lists all available network offerings.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
availabilityThe availability of network offering. Default value is requiredfalse
displaytextList network offerings by display textfalse
domainidList network offerings available for network creation in specific domainfalse
forvpcThe network offering can be used only for network creation inside the VPCfalse
guestiptypeList network offerings by guest type: shared or isolatedfalse
idList network offerings by IDfalse
isdefaultTrue if need to list only default network offerings. Default value is falsefalse
istaggedTrue if offering has tags specifiedfalse
keywordList by keywordfalse
nameList network offerings by namefalse
networkidThe ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.false
pagefalse
pagesizefalse
routingmodethe routing mode for the network offering. Supported types are: Static or Dynamic.false
sourcenatsupportedTrue if need to list only netwok offerings where source NAT is supported, false otherwisefalse
specifyiprangesTrue if need to list only network offerings which support specifying ip rangesfalse
specifyvlanThe tags for the network offering.false
stateList network offerings by statefalse
supportedservicesList network offerings supporting certain servicesfalse
tagsList network offerings by tagsfalse
traffictypeList by traffic typefalse
zoneidList network offerings available for network creation in specific zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Network offering
availabilityAvailability of the Network offering
conservemodeTrue if Network offering is IP conserve mode enabled
createdThe date this Network offering was created
detailsAdditional key/value details tied with network offering
displaytextAn alternate display text of the Network offering.
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
egressdefaultpolicyTrue if guest network default egress policy is allow; false if default egress policy is deny
fornsxtrue if network offering can be used by NSX networks only
fortungstenTrue if Network offering can be used by Tungsten-Fabric Networks only
forvpcTrue if Network offering can be used by VPC Networks only
guestiptypeGuest type of the Network offering, can be Shared or Isolated
internetprotocolThe internet protocol of the network offering
isdefaultTrue if Network offering is default, false otherwise
ispersistentTrue if Network offering supports persistent networks, false otherwise
maxconnectionsMaximum number of concurrent connections to be handled by LB
nameThe name of the Network offering
networkmodeMode in which the network will operate. The valid values are NATTED and ROUTED
networkrateData transfer rate in megabits per second allowed.
routingmodethe routing mode for the network offering, supported types are Static or Dynamic.
serviceofferingidThe ID of the service offering used by virtual router provider
specifyasnumbertrue if network offering supports choosing AS numbers
specifyiprangesTrue if Network offering supports specifying IP ranges, false otherwise
specifyvlanTrue if Network offering supports VLANs, false otherwise
stateState of the Network offering. Can be Disabled/Enabled/Inactive
supportsinternallbtrue if network offering supports public access for guest networks
supportspublicaccessTrue if network offering supports public access for guest networks
supportsstrechedl2subnetTrue if network offering supports network that span multiple zones
tagsThe tags for the Network offering
traffictypeThe traffic type for the Network offering, supported types are Public, Management, Control, Guest, VLAN or Storage.
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
service(*)The list of supported services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNetworkPermissions.html b/static/api/apidocs-4.23/apis/listNetworkPermissions.html new file mode 100644 index 0000000000..7f86407610 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNetworkPermissions.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNetworkPermissions

+

List Network visibility and all Accounts that have permissions to view this Network.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
networkidLists Network permission by Network IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account the Network is available for
accountidThe ID of Account the Network is available for
domainThe name of the domain to which the Network belongs
domainidThe ID of the domain to which the Network belongs
networkidThe Network ID
projectThe project the Network is available for
projectidThe ID of project the Network is available for
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNetworkProtocols.html b/static/api/apidocs-4.23/apis/listNetworkProtocols.html new file mode 100644 index 0000000000..520499ef8c --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNetworkProtocols.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNetworkProtocols

+

Lists details of network protocols

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
optionThe option of network protocols. Supported values are: protocolnumber, icmptype.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
descriptionthe description of the protocol parameter
detailsthe details of the protocol parameter
indexthe index (ID, Value, Code, Type, Option, etc) of the protocol parameter
namethe name of the protocol parameter
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNetworkServiceProviders.html b/static/api/apidocs-4.23/apis/listNetworkServiceProviders.html new file mode 100644 index 0000000000..1aa04030da --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNetworkServiceProviders.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNetworkServiceProviders

+

Lists network serviceproviders for a given physical network.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
nameList providers by namefalse
pagefalse
pagesizefalse
physicalnetworkidThe Physical Network IDfalse
stateList providers by statefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNetworks.html b/static/api/apidocs-4.23/apis/listNetworks.html new file mode 100644 index 0000000000..4c707a0b60 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNetworks.html @@ -0,0 +1,471 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNetworks

+

Lists all available networks.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
acltypeList Networks by ACL (access control list) type. Supported values are Account and domainfalse
associatednetworkidList networks by associated networks. Only available if create a Shared network.false
canusefordeployList networks available for Instance deploymentfalse
displaynetworkList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
domainidList only resources belonging to the domain specifiedfalse
forvpcThe network belongs to VPCfalse
idList Networks by IDfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
issystemTrue if Network is system, false otherwisefalse
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
namelist networks by namefalse
networkfilterPossible 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
networkofferingidList networks by network offering IDfalse
pagefalse
pagesizefalse
physicalnetworkidList Networks by physical Network IDfalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
restartrequiredList networks by restartRequiredfalse
retrieveonlyresourcecountMakes the API's response contains only the resource countfalse
showiconFlag to display the resource icon for networksfalse
specifyiprangesTrue if need to list only networks which support specifying IP rangesfalse
supportedservicesList Networks supporting certain servicesfalse
tagsList resources by tags (key/value pairs)false
traffictypeType of the trafficfalse
typeThe type of the Network. Supported values are: isolated, l2, shared and allfalse
vlanThe ID or VID of the networkfalse
vpcidList networks by VPCfalse
zoneidThe zone ID of the Networkfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Network
accountThe owner of the Network
aclidACL ID associated with the VPC Network
aclnameACL name associated with the VPC Network
acltypeACL type - access type to the Network
asnumberAS NUMBER
asnumberidUUID of AS NUMBER
bgppeersThe BGP peers for the network
broadcastdomaintypeBroadcast domain type of the Network
broadcasturiBroadcast URI of the Network. This parameter is visible to ROOT admins only
canusefordeployList Networks available for Instance deployment
cidrCloudStack managed address space, all CloudStack managed Instances get IP address from CIDR
createdThe date this Network was created
detailsThe details of the Network
displaynetworkAn optional field, whether to the display the Network to the end user or not.
displaytextThe displaytext of the Network
dns1The first IPv4 DNS for the Network
dns2The second IPv4 DNS for the Network
dnssubdomainDNS subdomain associated to the network
dnszoneDNS zone associated to the network
domainThe domain name of the Network owner
domainidThe domain ID of the Network owner
domainpathPath of the Domain the network belongs to
egressdefaultpolicyTrue if guest Network default egress policy is allow; false if default egress policy is deny
externalidThe external ID of the Network
gatewayThe Network's gateway
iconBase64 string representation of the resource icon
internetprotocolThe internet protocol of Network offering
ip4routesThe routes for the network to ease adding route in upstream router
ip4routingThe IPv4 routing type of network
ip6cidrThe CIDR of IPv6 Network
ip6dns1The first IPv6 DNS for the network
ip6dns2The second IPv6 DNS for the network
ip6gatewayThe gateway of IPv6 Network
ip6routesThe routes for the Network to ease adding route in upstream router
ip6routingThe IPv6 routing type of network offering
isdefaultTrue if Network is default, false otherwise
ispersistentList Networks that are persistent
issystemTrue if Network is system, false otherwise
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.
nameThe name of the Network
netmaskThe Network's netmask
networkcidrThe Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE
networkdomainThe Network domain
networkofferingavailabilityAvailability of the Network offering the Network is created from
networkofferingconservemodeTrue if Network offering is IP conserve mode enabled
networkofferingdisplaytextDisplay text of the Network offering the Network is created from
networkofferingidNetwork offering ID the Network is created from
networkofferingnameName of the Network offering the Network is created from
physicalnetworkidThe physical Network id
privatemtuMTU configured on the network VR's private interfaces
projectThe project name of the address
projectidThe project ID of the IP address
publicmtuMTU configured on the Network VR's public facing interfaces
receivedbytesThe total number of Network traffic bytes received
redundantrouterIf the Network has redundant routers enabled
relatedRelated to what other Network configuration
reservediprangeThe Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes
restartrequiredTrue if Network requires restart
sentbytesThe total number of Network traffic bytes sent
specifyiprangesTrue if Network supports specifying IP ranges, false otherwise
specifyvlanTrue if network supports specifying vlan, false otherwise
stateState of the Network
strechedl2subnetTrue if Network can span multiple zones
subdomainaccessTrue if users from subdomains can access the domain level Network
supportsvmautoscalingIf Network offering supports Instance autoscaling feature
traffictypeThe traffic type of the Network
tungstenvirtualrouteruuidTungsten-Fabric virtual router the Network belongs to
typeThe type of the Network
vlanThe VLAN of the Network. This parameter is visible to ROOT admins only
vpcidVPC the Network belongs to
vpcnameName of the VPC to which this Network belongs
zoneidZone ID of the Network
zonenameThe name of the zone the Network belongs to
zonesnetworkspansIf a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans
service(*)The list of services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
tags(*)The list of resource tags associated with Network
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNiciraNvpDeviceNetworks.html b/static/api/apidocs-4.23/apis/listNiciraNvpDeviceNetworks.html new file mode 100644 index 0000000000..8bee695aa4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNiciraNvpDeviceNetworks.html @@ -0,0 +1,393 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNiciraNvpDeviceNetworks

+

Lists network that are using a nicira nvp device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nvpdeviceidnicira nvp device IDtrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Network
accountThe owner of the Network
aclidACL ID associated with the VPC Network
aclnameACL name associated with the VPC Network
acltypeACL type - access type to the Network
asnumberAS NUMBER
asnumberidUUID of AS NUMBER
bgppeersThe BGP peers for the network
broadcastdomaintypeBroadcast domain type of the Network
broadcasturiBroadcast URI of the Network. This parameter is visible to ROOT admins only
canusefordeployList Networks available for Instance deployment
cidrCloudStack managed address space, all CloudStack managed Instances get IP address from CIDR
createdThe date this Network was created
detailsThe details of the Network
displaynetworkAn optional field, whether to the display the Network to the end user or not.
displaytextThe displaytext of the Network
dns1The first IPv4 DNS for the Network
dns2The second IPv4 DNS for the Network
dnssubdomainDNS subdomain associated to the network
dnszoneDNS zone associated to the network
domainThe domain name of the Network owner
domainidThe domain ID of the Network owner
domainpathPath of the Domain the network belongs to
egressdefaultpolicyTrue if guest Network default egress policy is allow; false if default egress policy is deny
externalidThe external ID of the Network
gatewayThe Network's gateway
iconBase64 string representation of the resource icon
internetprotocolThe internet protocol of Network offering
ip4routesThe routes for the network to ease adding route in upstream router
ip4routingThe IPv4 routing type of network
ip6cidrThe CIDR of IPv6 Network
ip6dns1The first IPv6 DNS for the network
ip6dns2The second IPv6 DNS for the network
ip6gatewayThe gateway of IPv6 Network
ip6routesThe routes for the Network to ease adding route in upstream router
ip6routingThe IPv6 routing type of network offering
isdefaultTrue if Network is default, false otherwise
ispersistentList Networks that are persistent
issystemTrue if Network is system, false otherwise
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.
nameThe name of the Network
netmaskThe Network's netmask
networkcidrThe Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE
networkdomainThe Network domain
networkofferingavailabilityAvailability of the Network offering the Network is created from
networkofferingconservemodeTrue if Network offering is IP conserve mode enabled
networkofferingdisplaytextDisplay text of the Network offering the Network is created from
networkofferingidNetwork offering ID the Network is created from
networkofferingnameName of the Network offering the Network is created from
physicalnetworkidThe physical Network id
privatemtuMTU configured on the network VR's private interfaces
projectThe project name of the address
projectidThe project ID of the IP address
publicmtuMTU configured on the Network VR's public facing interfaces
receivedbytesThe total number of Network traffic bytes received
redundantrouterIf the Network has redundant routers enabled
relatedRelated to what other Network configuration
reservediprangeThe Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes
restartrequiredTrue if Network requires restart
sentbytesThe total number of Network traffic bytes sent
specifyiprangesTrue if Network supports specifying IP ranges, false otherwise
specifyvlanTrue if network supports specifying vlan, false otherwise
stateState of the Network
strechedl2subnetTrue if Network can span multiple zones
subdomainaccessTrue if users from subdomains can access the domain level Network
supportsvmautoscalingIf Network offering supports Instance autoscaling feature
traffictypeThe traffic type of the Network
tungstenvirtualrouteruuidTungsten-Fabric virtual router the Network belongs to
typeThe type of the Network
vlanThe VLAN of the Network. This parameter is visible to ROOT admins only
vpcidVPC the Network belongs to
vpcnameName of the VPC to which this Network belongs
zoneidZone ID of the Network
zonenameThe name of the zone the Network belongs to
zonesnetworkspansIf a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans
service(*)The list of services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
tags(*)The list of resource tags associated with Network
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNiciraNvpDevices.html b/static/api/apidocs-4.23/apis/listNiciraNvpDevices.html new file mode 100644 index 0000000000..b3ddedc1a9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNiciraNvpDevices.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNiciraNvpDevices

+

Lists Nicira NVP devices

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
nvpdeviceidnicira nvp device IDfalse
pagefalse
pagesizefalse
physicalnetworkidThe Physical Network IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
hostnameThe controller IP address
l2gatewayserviceuuidThis L2 gateway service UUID
l3gatewayserviceuuidThis L3 gateway service UUID
niciradevicenameDevice name
nvpdeviceidDevice ID of the Nicire Nvp
physicalnetworkidThe physical Network to which this Nirica Nvp belongs to
providerName of the provider
transportzoneuuidThe transport zone UUID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNics.html b/static/api/apidocs-4.23/apis/listNics.html new file mode 100644 index 0000000000..02f9cb50e9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNics.html @@ -0,0 +1,198 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNics

+

List the Instance NICs IP to NIC

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidThe ID of the Instancetrue
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
keywordList by keywordfalse
networkidList NIC of the specific Instance's Networkfalse
nicidThe ID of the NIC to list IPsfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listNsxControllers.html b/static/api/apidocs-4.23/apis/listNsxControllers.html new file mode 100644 index 0000000000..4a77685c76 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listNsxControllers.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listNsxControllers

+

list all NSX controllers added to CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
zoneidNSX controller added to the specific zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
edgeclusterThe name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX
hostnameNSX controller hostname or IP address
nameNSX controller name
nsxprovideruuidNSX controller ID
portNSX controller port
tier0gatewayThe tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks
transportzoneThe name of the transport zone. A transport zone controls to which hosts a logical switch can reach
zoneidZone ID to which the NSX controller is associated with
zonenameZone name to which the NSX controller is associated with
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listOauthProvider.html b/static/api/apidocs-4.23/apis/listOauthProvider.html new file mode 100644 index 0000000000..630bbce121 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listOauthProvider.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listOauthProvider

+

List OAuth providers registered

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
domainDomain path for domain-specific OAuth provider lookup. Ignored when Domain ID is passed.false
domainidDomain ID to list OAuth providers for a specific domain. Use -1 for global providers only.false
idthe ID of the OAuth providerfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
providerName of the providerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the provider
authorizeurlAuthorize URL registered in the OAuth provider
clientidClient ID registered in the OAuth provider
descriptionDescription of the provider registered
domainname of the domain the provider belongs to (empty for global)
domainidUUID of the domain the provider belongs to (empty for global)
domainpathpath of the domain the provider belongs to (empty for global)
enabledWhether the OAuth provider is enabled or not
nameName of the provider
providerName of the provider
redirecturiRedirect URI registered in the OAuth provider
secretkeySecret key registered in the OAuth provider
tokenurlToken URL registered in the OAuth provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listObjectStoragePools.html b/static/api/apidocs-4.23/apis/listObjectStoragePools.html new file mode 100644 index 0000000000..3dac938751 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listObjectStoragePools.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listObjectStoragePools

+

Lists object storage pools.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the storage poolfalse
keywordList by keywordfalse
namethe name of the object storefalse
pagefalse
pagesizefalse
providerthe object store providerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the object store
namethe name of the object store
providernamethe provider name of the object store
storageallocatedthe allocated size of the object store
storagetotalthe total size of the object store
storageusedthe object store currently used size
urlthe url of the object store
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listOpenDaylightControllers.html b/static/api/apidocs-4.23/apis/listOpenDaylightControllers.html new file mode 100644 index 0000000000..c278818639 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listOpenDaylightControllers.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listOpenDaylightControllers

+

Lists OpenDyalight controllers

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of a OpenDaylight Controllerfalse
physicalnetworkidThe Physical Network IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idDevice ID of the controller
nameThe name assigned to the controller
physicalnetworkidThe physical Network to which this controller belongs to
urlThe URL of the controller API
usernameThe username to authenticate to the controller
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listOsCategories.html b/static/api/apidocs-4.23/apis/listOsCategories.html new file mode 100644 index 0000000000..4ad928c71e --- /dev/null +++ b/static/api/apidocs-4.23/apis/listOsCategories.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listOsCategories

+

Lists all supported OS categories for this cloud.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
archList OS categories types available for given CPU architecturefalse
idList OS category by IDfalse
isfeaturedList available OS categories by featured or notfalse
isisoList OS categories for which an ISO is availablefalse
isvnfList OS categories for which a VNF template is availablefalse
keywordList by keywordfalse
nameList OS category by namefalse
pagefalse
pagesizefalse
showiconflag to display the resource image for the OS categoryfalse
zoneidList available OS categories types for the zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the OS category
createdDate when the OS category was created.
iconBase64 string representation of the resource icon
isfeaturedWhether the OS category is featured
nameThe name of the OS category
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listOsTypes.html b/static/api/apidocs-4.23/apis/listOsTypes.html new file mode 100644 index 0000000000..a147395309 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listOsTypes.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listOsTypes

+

Lists all supported OS types for this cloud.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
descriptionList OS by descriptionfalse
fordisplaylist resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idList by OS type IDfalse
idsComma separated list of OS typesfalse
keywordList by keywordfalse
oscategoryidList by OS Category IDfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the OS type
descriptionThe name/description of the OS type
fordisplayIs the guest OS visible for the users
isuserdefinedIs the guest OS user defined
nameThe name of the OS type
oscategoryidThe ID of the OS category
oscategorynameThe name of the OS category
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listOvsElements.html b/static/api/apidocs-4.23/apis/listOvsElements.html new file mode 100644 index 0000000000..f7278778a8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listOvsElements.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listOvsElements

+

Lists all available ovs elements.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enabledList network offerings by enabled statefalse
idList ovs elements by idfalse
keywordList by keywordfalse
nspidList ovs elements by network service provider idfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the ovs
accountThe Account associated with the provider
domainThe domain associated with the provider
domainidThe domain ID associated with the provider
domainpathPath of the domain to which the provider belongs
enabledEnabled/Disabled the service provider
nspidThe physical Network service provider id of the provider
projectThe project name of the address
projectidThe project ID of the IP address
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listPaloAltoFirewallNetworks.html b/static/api/apidocs-4.23/apis/listPaloAltoFirewallNetworks.html new file mode 100644 index 0000000000..64a07dc46a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listPaloAltoFirewallNetworks.html @@ -0,0 +1,393 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listPaloAltoFirewallNetworks

+

Lists Network that are using Palo Alto firewall device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
lbdeviceidPalo alto balancer device IDtrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Network
accountThe owner of the Network
aclidACL ID associated with the VPC Network
aclnameACL name associated with the VPC Network
acltypeACL type - access type to the Network
asnumberAS NUMBER
asnumberidUUID of AS NUMBER
bgppeersThe BGP peers for the network
broadcastdomaintypeBroadcast domain type of the Network
broadcasturiBroadcast URI of the Network. This parameter is visible to ROOT admins only
canusefordeployList Networks available for Instance deployment
cidrCloudStack managed address space, all CloudStack managed Instances get IP address from CIDR
createdThe date this Network was created
detailsThe details of the Network
displaynetworkAn optional field, whether to the display the Network to the end user or not.
displaytextThe displaytext of the Network
dns1The first IPv4 DNS for the Network
dns2The second IPv4 DNS for the Network
dnssubdomainDNS subdomain associated to the network
dnszoneDNS zone associated to the network
domainThe domain name of the Network owner
domainidThe domain ID of the Network owner
domainpathPath of the Domain the network belongs to
egressdefaultpolicyTrue if guest Network default egress policy is allow; false if default egress policy is deny
externalidThe external ID of the Network
gatewayThe Network's gateway
iconBase64 string representation of the resource icon
internetprotocolThe internet protocol of Network offering
ip4routesThe routes for the network to ease adding route in upstream router
ip4routingThe IPv4 routing type of network
ip6cidrThe CIDR of IPv6 Network
ip6dns1The first IPv6 DNS for the network
ip6dns2The second IPv6 DNS for the network
ip6gatewayThe gateway of IPv6 Network
ip6routesThe routes for the Network to ease adding route in upstream router
ip6routingThe IPv6 routing type of network offering
isdefaultTrue if Network is default, false otherwise
ispersistentList Networks that are persistent
issystemTrue if Network is system, false otherwise
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.
nameThe name of the Network
netmaskThe Network's netmask
networkcidrThe Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE
networkdomainThe Network domain
networkofferingavailabilityAvailability of the Network offering the Network is created from
networkofferingconservemodeTrue if Network offering is IP conserve mode enabled
networkofferingdisplaytextDisplay text of the Network offering the Network is created from
networkofferingidNetwork offering ID the Network is created from
networkofferingnameName of the Network offering the Network is created from
physicalnetworkidThe physical Network id
privatemtuMTU configured on the network VR's private interfaces
projectThe project name of the address
projectidThe project ID of the IP address
publicmtuMTU configured on the Network VR's public facing interfaces
receivedbytesThe total number of Network traffic bytes received
redundantrouterIf the Network has redundant routers enabled
relatedRelated to what other Network configuration
reservediprangeThe Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes
restartrequiredTrue if Network requires restart
sentbytesThe total number of Network traffic bytes sent
specifyiprangesTrue if Network supports specifying IP ranges, false otherwise
specifyvlanTrue if network supports specifying vlan, false otherwise
stateState of the Network
strechedl2subnetTrue if Network can span multiple zones
subdomainaccessTrue if users from subdomains can access the domain level Network
supportsvmautoscalingIf Network offering supports Instance autoscaling feature
traffictypeThe traffic type of the Network
tungstenvirtualrouteruuidTungsten-Fabric virtual router the Network belongs to
typeThe type of the Network
vlanThe VLAN of the Network. This parameter is visible to ROOT admins only
vpcidVPC the Network belongs to
vpcnameName of the VPC to which this Network belongs
zoneidZone ID of the Network
zonenameThe name of the zone the Network belongs to
zonesnetworkspansIf a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans
service(*)The list of services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
tags(*)The list of resource tags associated with Network
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listPaloAltoFirewalls.html b/static/api/apidocs-4.23/apis/listPaloAltoFirewalls.html new file mode 100644 index 0000000000..ad3b7ce1ce --- /dev/null +++ b/static/api/apidocs-4.23/apis/listPaloAltoFirewalls.html @@ -0,0 +1,141 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listPaloAltoFirewalls

+

Lists Palo Alto firewall devices in a physical Network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
fwdeviceidPalo Alto firewall device IDfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
physicalnetworkidThe Physical Network IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
fwdevicecapacityDevice capacity
fwdeviceidDevice ID of the Palo Alto firewall
fwdevicenameDevice name
fwdevicestateDevice state
ipaddressThe management IP address of the external firewall
numretriesThe number of times to retry requests to the external firewall
physicalnetworkidThe physical Network to which this Palo Alto firewall belongs to
privateinterfaceThe private interface of the external firewall
privatezoneThe private security zone of the external firewall
providerName of the provider
publicinterfaceThe public interface of the external firewall
publiczoneThe public security zone of the external firewall
timeoutThe timeout (in seconds) for requests to the external firewall
usageinterfaceThe usage interface of the external firewall
usernameThe username that's used to log in to the external firewall
zoneidThe zone ID of the external firewall
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listPhysicalNetworks.html b/static/api/apidocs-4.23/apis/listPhysicalNetworks.html new file mode 100644 index 0000000000..d3cd89b938 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listPhysicalNetworks.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listPhysicalNetworks

+

Lists physical networks

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idList physical network by idfalse
keywordList by keywordfalse
nameSearch by namefalse
pagefalse
pagesizefalse
zoneidThe Zone ID for the physical networkfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe UUID of the physical Network
broadcastdomainrangeBroadcast domain range of the physical Network
domainidThe domain ID of the physical Network owner
isolationmethodsIsolation methods
nameName of the physical Network
networkspeedThe speed of the physical Network
stateState of the physical Network
tagsComma separated tag
vlanThe VLAN of the physical Network
zoneidZone ID of the physical Network
zonenameZone name of the physical Network
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listPods.html b/static/api/apidocs-4.23/apis/listPods.html new file mode 100644 index 0000000000..1be509cb7d --- /dev/null +++ b/static/api/apidocs-4.23/apis/listPods.html @@ -0,0 +1,207 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listPods

+

Lists all Pods.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
allocationstateList pods by allocation statefalse
idList Pods by IDfalse
keywordList by keywordfalse
nameList Pods by namefalse
pagefalse
pagesizefalse
showcapacitiesFlag to display the capacity of the podsfalse
storageaccessgroupthe name of the storage access groupfalse
zoneidList Pods by Zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Pod
allocationstateThe allocation state of the Pod
endipThe ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.
forsystemvmsIndicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.
gatewayThe gateway of the Pod
nameThe name of the Pod
netmaskThe netmask of the Pod
startipThe starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.
storageaccessgroupscomma-separated list of storage access groups for the pod
vlanidIndicates VLAN ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.
zoneidThe Zone ID of the Pod
zonenameThe Zone name of the Pod
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
capacity(*)The capacity of the Pod
capacityallocatedThe capacity currently in allocated
capacitytotalThe total capacity available
capacityusedThe capacity currently in use
clusteridThe Cluster ID
clusternameThe Cluster name
nameThe capacity name
percentusedThe percentage of capacity currently in use
podidThe Pod ID
podnameThe Pod name
tagThe tag for the capacity type
typeThe capacity type
zoneidThe Zone ID
zonenameThe Zone name
ipranges(*)The IP ranges for the Pod
cidrThe CIDR for the range
endipThe ending IP for the range
forsystemvmsIndicates if range is dedicated for CPVM and SSVM
gatewayThe gateway for the range
startipThe starting IP for the range
vlanidIndicates VLAN ID for the range
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listPortForwardingRules.html b/static/api/apidocs-4.23/apis/listPortForwardingRules.html new file mode 100644 index 0000000000..788280e4c0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listPortForwardingRules.html @@ -0,0 +1,204 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listPortForwardingRules

+

Lists all port forwarding rules for an IP address.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idLists rule with the specified ID.false
ipaddressidThe ID of IP address of the port forwarding servicesfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
networkidList port forwarding rules for certain networkfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
tagsList resources by tags (key/value pairs)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the port forwarding rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
fordisplayIs firewall for display to the regular user
ipaddressThe public IP address for the port forwarding rule
ipaddressidThe public IP address id for the port forwarding rule
networkidThe ID of the guest Network the port forwarding rule belongs to
networknameThe Name of the guest Network the port forwarding rule belongs to
privateendportThe ending port of port forwarding rule's private port range
privateportThe starting port of port forwarding rule's private port range
protocolThe protocol of the port forwarding rule
publicendportThe ending port of port forwarding rule's private port range
publicportThe starting port of port forwarding rule's public port range
stateThe state of the rule
virtualmachinedisplaynameThe Instance display name for the port forwarding rule
virtualmachineidThe Instance ID for the port forwarding rule
virtualmachinenameThe Instance name for the port forwarding rule
vmguestipThe Instance IP address for the port forwarding rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listPortableIpRanges.html b/static/api/apidocs-4.23/apis/listPortableIpRanges.html new file mode 100644 index 0000000000..e50a84dfb9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listPortableIpRanges.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listPortableIpRanges

+

List portable IP ranges

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idId of the portable ip rangefalse
keywordList by keywordfalse
pagefalse
pagesizefalse
regionidId of a Regionfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idPortable IP range ID
endipThe end IP of the portable IP range
gatewayThe gateway of the VLAN IP range
netmaskThe netmask of the VLAN IP range
regionidRegion ID in which portable IP range is provisioned
startipThe start IP of the portable IP range
vlanThe ID or VID of the VLAN.
portableipaddress(*)List of portable IP and association with zone/network/vpc details that are part of GSLB rule
accountidThe Account ID the portable IP address is associated with
allocatedDate the portal IP address was acquired
domainidThe domain ID the portable IP address is associated with
ipaddressPublic IP address
networkidThe ID of the Network where IP belongs to
physicalnetworkidThe physical Network this belongs to
regionidRegion ID in which global Load balancer is created
stateState of the IP address. Can be: Allocating, Allocated, Releasing and Free
vpcidVPC the IP belongs to
zoneidThe ID of the zone the public IP address belongs to
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listPrivateGateways.html b/static/api/apidocs-4.23/apis/listPrivateGateways.html new file mode 100644 index 0000000000..d1ca785b9a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listPrivateGateways.html @@ -0,0 +1,177 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listPrivateGateways

+

List private gateways

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idList private gateway by IDfalse
ipaddressList gateways by IP addressfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
stateList gateways by statefalse
vlanList gateways by VLANfalse
vpcidList gateways by VPCfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the private gateway
accountThe Account associated with the private gateway
aclidACL ID set for private gateway
aclnameACL name set for private gateway
domainThe domain associated with the private gateway
domainidThe ID of the domain associated with the private gateway
domainpathPath of the domain to which the private gateway belongs
gatewayThe gateway
ipaddressThe private gateway's IP address
netmaskThe private gateway's netmask
physicalnetworkidThe physical Network id
projectThe project name of the private gateway
projectidThe project ID of the private gateway
sourcenatsupportedSource Nat enable status
stateState of the gateway, can be Creating, Ready, Deleting
vlanThe Network implementation uri for the private gateway
vpcidVPC ID the private gateway belongs to
vpcnameVPC name the private gateway belongs to
zoneidZone ID of the private gateway
zonenameThe name of the zone the private gateway belongs to
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listProjectAccounts.html b/static/api/apidocs-4.23/apis/listProjectAccounts.html new file mode 100644 index 0000000000..f7c3cedf47 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listProjectAccounts.html @@ -0,0 +1,321 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listProjectAccounts

+

Lists project's Accounts

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
projectidID of the projecttrue
accountList Accounts of the project by Account namefalse
keywordList by keywordfalse
pagefalse
pagesizefalse
projectroleidList Accounts of the project by project role idfalse
roleList Accounts of the project by rolefalse
useridList invitation by User IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the project
backupavailablethe total number of backups available to this project
backuplimitthe total number of backups which can be stored by this project
backupstorageavailablethe total backup storage space (in GiB) available to the project
backupstoragelimitthe total backup storage space (in GiB) the project can own
backupstoragetotalthe total backup storage space (in GiB) owned by the project
backuptotalthe total number of backups stored by this project
bucketavailablethe total number of buckets available to this project
bucketlimitthe total number of buckets which can be stored by this project
buckettotalthe total number of buckets stored by this project
cpuavailableThe total number of CPU cores available to be created for this project
cpulimitThe total number of CPU cores the project can own
cputotalThe total number of CPU cores owned by project
createdThe date this project was created
displaytextThe displaytext of the project
domainThe domain name where the project belongs to
domainidThe domain ID the project belongs to
gpuavailablethe total number of gpus available to be created for this project
gpulimitthe total number of gpus the project can own
gputotalthe total number of gpus owned by project
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this project to acquire
iplimitThe total number of public IP addresses this project can acquire
iptotalThe total number of public IP addresses allocated for this project
memoryavailableThe total memory (in MB) available to be created for this project
memorylimitThe total memory (in MB) the project can own
memorytotalThe total memory (in MB) owned by project
nameThe name of the project
networkavailableThe total number of Networks available to be created for this project
networklimitThe total number of Networks the project can own
networktotalThe total number of Networks owned by project
objectstorageavailablethe total object storage space (in GiB) available to the project
objectstoragelimitthe total object storage space (in GiB) the project can own
objectstoragetotalthe total object storage space (in GiB) owned by the project
ownerThe Account name of the project's owners
primarystorageavailableThe total primary storage space (in GiB) available to be used for this project
primarystoragelimitThe total primary storage space (in GiB) the project can own
primarystoragetotalThe total primary storage space (in GiB) owned by project
projectaccountnameThe project Account name of the project
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this project
secondarystoragelimitThe total secondary storage space (in GiB) the project can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by project
snapshotavailableThe total number of Snapshots available for this project
snapshotlimitThe total number of Snapshots which can be stored by this project
snapshottotalThe total number of Snapshots stored by this project
stateThe state of the project
taggedresourcesThe tagged resource limit and count for the project
templateavailableThe total number of Templates available to be created by this project
templatelimitThe total number of Templates which can be created by this project
templatetotalThe total number of Templates which have been created by this project
vmavailableThe total number of Instances available for this project to acquire
vmlimitThe total number of Instances that can be deployed by this project
vmrunningThe total number of Instances running for this project
vmstoppedThe total number of Instances stopped for this project
vmtotalThe total number of Instances deployed by this project
volumeavailableThe total volume available for this project
volumelimitThe total volume which can be used by this project
volumetotalThe total volume being used by this project
vpcavailableThe total number of VPCs available to be created for this project
vpclimitThe total number of VPCs the project can own
vpctotalThe total number of VPCs owned by project
tags(*)The list of resource tags associated with Instance
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listProjectInvitations.html b/static/api/apidocs-4.23/apis/listProjectInvitations.html new file mode 100644 index 0000000000..d3418a3f48 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listProjectInvitations.html @@ -0,0 +1,144 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listProjectInvitations

+

Lists project invitations and provides detailed information for listed invitations

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
activeonlyIf true, list only active invitations - having Pending state and ones that are not timed out yetfalse
domainidList only resources belonging to the domain specifiedfalse
idList invitations by IDfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList by project IDfalse
stateList invitations by statefalse
useridList invitation by user IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the invitation
accountThe Account name of the project's owner
domainThe domain name where the project belongs to
domainidThe domain ID the project belongs to
domainpathPath of the Domain the project belongs to
emailThe email the invitation was sent to
projectThe name of the project
projectidThe ID of the project
stateThe invitation state
useridThe User ID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listProjectRolePermissions.html b/static/api/apidocs-4.23/apis/listProjectRolePermissions.html new file mode 100644 index 0000000000..f7531173ac --- /dev/null +++ b/static/api/apidocs-4.23/apis/listProjectRolePermissions.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listProjectRolePermissions

+

Lists a project's project role permissions

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
projectidID of the projecttrue
projectroleidID of the project rolefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the project role permission
projectidThe ID of the project
projectroleidThe ID of the project role to which the role permission belongs
projectrolenameThe name of the project role to which the role permission belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listProjectRoles.html b/static/api/apidocs-4.23/apis/listProjectRoles.html new file mode 100644 index 0000000000..cfa382d2a6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listProjectRoles.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listProjectRoles

+

Lists Project roles in CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
projectidList project role by project ID.true
keywordList by keywordfalse
nameList project role by project role name.false
pagefalse
pagesizefalse
projectroleidList project role by project role ID.false
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
projectidThe ID of the project
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listProjects.html b/static/api/apidocs-4.23/apis/listProjects.html new file mode 100644 index 0000000000..7f15c3159b --- /dev/null +++ b/static/api/apidocs-4.23/apis/listProjects.html @@ -0,0 +1,342 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listProjects

+

Lists projects and provides detailed information for listed projects

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
detailsComma separated list of project details requested, value can be a list of [ all, resource, min]false
displaytextList projects by display textfalse
domainidList only resources belonging to the domain specifiedfalse
idList projects by project IDfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameList projects by namefalse
pagefalse
pagesizefalse
showiconFlag to display the resource icon for projectsfalse
stateList projects by statefalse
tagsList projects by tags (key/value pairs)false
usernameList projects by usernamefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the project
backupavailablethe total number of backups available to this project
backuplimitthe total number of backups which can be stored by this project
backupstorageavailablethe total backup storage space (in GiB) available to the project
backupstoragelimitthe total backup storage space (in GiB) the project can own
backupstoragetotalthe total backup storage space (in GiB) owned by the project
backuptotalthe total number of backups stored by this project
bucketavailablethe total number of buckets available to this project
bucketlimitthe total number of buckets which can be stored by this project
buckettotalthe total number of buckets stored by this project
cpuavailableThe total number of CPU cores available to be created for this project
cpulimitThe total number of CPU cores the project can own
cputotalThe total number of CPU cores owned by project
createdThe date this project was created
displaytextThe displaytext of the project
domainThe domain name where the project belongs to
domainidThe domain ID the project belongs to
gpuavailablethe total number of gpus available to be created for this project
gpulimitthe total number of gpus the project can own
gputotalthe total number of gpus owned by project
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this project to acquire
iplimitThe total number of public IP addresses this project can acquire
iptotalThe total number of public IP addresses allocated for this project
memoryavailableThe total memory (in MB) available to be created for this project
memorylimitThe total memory (in MB) the project can own
memorytotalThe total memory (in MB) owned by project
nameThe name of the project
networkavailableThe total number of Networks available to be created for this project
networklimitThe total number of Networks the project can own
networktotalThe total number of Networks owned by project
objectstorageavailablethe total object storage space (in GiB) available to the project
objectstoragelimitthe total object storage space (in GiB) the project can own
objectstoragetotalthe total object storage space (in GiB) owned by the project
ownerThe Account name of the project's owners
primarystorageavailableThe total primary storage space (in GiB) available to be used for this project
primarystoragelimitThe total primary storage space (in GiB) the project can own
primarystoragetotalThe total primary storage space (in GiB) owned by project
projectaccountnameThe project Account name of the project
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this project
secondarystoragelimitThe total secondary storage space (in GiB) the project can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by project
snapshotavailableThe total number of Snapshots available for this project
snapshotlimitThe total number of Snapshots which can be stored by this project
snapshottotalThe total number of Snapshots stored by this project
stateThe state of the project
taggedresourcesThe tagged resource limit and count for the project
templateavailableThe total number of Templates available to be created by this project
templatelimitThe total number of Templates which can be created by this project
templatetotalThe total number of Templates which have been created by this project
vmavailableThe total number of Instances available for this project to acquire
vmlimitThe total number of Instances that can be deployed by this project
vmrunningThe total number of Instances running for this project
vmstoppedThe total number of Instances stopped for this project
vmtotalThe total number of Instances deployed by this project
volumeavailableThe total volume available for this project
volumelimitThe total volume which can be used by this project
volumetotalThe total volume being used by this project
vpcavailableThe total number of VPCs available to be created for this project
vpclimitThe total number of VPCs the project can own
vpctotalThe total number of VPCs owned by project
tags(*)The list of resource tags associated with Instance
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listPublicIpAddresses.html b/static/api/apidocs-4.23/apis/listPublicIpAddresses.html new file mode 100644 index 0000000000..fa38d34a7e --- /dev/null +++ b/static/api/apidocs-4.23/apis/listPublicIpAddresses.html @@ -0,0 +1,309 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listPublicIpAddresses

+

Lists all public IP addresses

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
allocatedonlyLimits search results to allocated public IP addressesfalse
associatednetworkidLists all public IP addresses associated to the Network specifiedfalse
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
forloadbalancingList only IPs used for load balancingfalse
forprovidertrue if range is dedicated for external network providerfalse
forsystemvmstrue if range is dedicated for system VMsfalse
forvirtualnetworkThe virtual Network for the IP addressfalse
idLists IP address by IDfalse
ipaddressLists the specified IP addressfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
issourcenatList only source NAT IP addressesfalse
isstaticnatList only static NAT IP addressesfalse
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
networkidLists all public IP addresses by source Network IDfalse
pagefalse
pagesizefalse
physicalnetworkidLists all public IP addresses by physical Network IDfalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
retrieveonlyresourcecountMakes the API's response contains only the resource countfalse
stateLists all public IP addresses by state. A comma-separated list of states can be passed.false
tagsList resources by tags (key/value pairs)false
vlanidLists all public IP addresses by VLAN IDfalse
vpcidList IPs belonging to the VPCfalse
zoneidLists all public IP addresses by zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idPublic IP address ID
accountThe Account the public IP address is associated with
allocatedDate the public IP address was acquired
associatednetworkidThe ID of the Network associated with the IP address
associatednetworknameThe name of the Network associated with the IP address
domainThe domain the public IP address is associated with
domainidThe domain ID the public IP address is associated with
domainpathpath of the domain to which the public IP address belongs
fordisplayIs public IP for display to the regular user
forprovidertrue if range is dedicated for external network providers
forsystemvmstrue if range is dedicated for System VMs
forvirtualnetworkThe virtual Network for the IP address
hasrulesWhether the IP address has Firewall/PortForwarding/LoadBalancing rules defined
ipaddressPublic IP address
isportableIs public IP portable across the zones
issourcenatTrue if the IP address is a source NAT address, false otherwise
isstaticnatTrue if this IP is for static NAT, false otherwise
issystemTrue if this IP is system IP (was allocated as a part of deployVm or createLbRule)
networkidThe ID of the Network where IP belongs to
networknameThe name of the Network where IP belongs to
physicalnetworkidThe physical Network this belongs to
projectThe project name of the address
projectidThe project id of the IP address
purposePurpose of the IP address. In Acton this value is not null for IPs with isSystem=true, and can have either StaticNat or LB value
stateState of the IP address. Can be: Allocating, Allocated, Releasing, Reserved and Free
virtualmachinedisplaynameInstance display name the IP address is assigned to (not null only for static NAT IP)
virtualmachineidInstance id the IP address is assigned to
virtualmachinenameInstance name the IP address is assigned to
virtualmachinetypeInstance type the IP address is assigned to
vlanidThe ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only
vlannameThe VLAN associated with the IP address
vmipaddressInstance (DNAT) IP address (not null only for static NAT IP)
vpcidVPC ID the IP belongs to
vpcnameVPC name the IP belongs to
zoneidThe ID of the zone the public IP address belongs to
zonenameThe name of the zone the public IP address belongs to
tags(*)The list of resource tags associated with IP address
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listQuarantinedIps.html b/static/api/apidocs-4.23/apis/listQuarantinedIps.html new file mode 100644 index 0000000000..ec515f6dfe --- /dev/null +++ b/static/api/apidocs-4.23/apis/listQuarantinedIps.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listQuarantinedIps

+

List public IP addresses in quarantine.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
showinactiveShow IPs that are no longer in quarantine.false
showremovedShow IPs removed from quarantine.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the quarantine process.
createdWhen the quarantine was created.
enddateEnd date for the quarantine.
ipaddressThe public IP address in quarantine.
previousowneridAccount ID of the previous public IP address owner.
previousownernameAccount name of the previous public IP address owner.
removalreasonThe reason for removing the IP from quarantine prematurely.
removedWhen the quarantine was removed.
removeraccountidID of the account that removed the IP from quarantine.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listRegions.html b/static/api/apidocs-4.23/apis/listRegions.html new file mode 100644 index 0000000000..7e93ecf568 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listRegions.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listRegions

+

Lists Regions

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idList Region by region ID.false
keywordList by keywordfalse
nameList Region by region name.false
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the region
endpointThe end point of the region
gslbserviceenabledTrue if GSLB service is enabled in the region, false otherwise
nameThe name of the region
portableipserviceenabledTrue if security groups support is enabled, false otherwise
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listRegisteredServicePackages.html b/static/api/apidocs-4.23/apis/listRegisteredServicePackages.html new file mode 100644 index 0000000000..2891511bea --- /dev/null +++ b/static/api/apidocs-4.23/apis/listRegisteredServicePackages.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listRegisteredServicePackages

+

Lists registered service packages

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
idService Package UUID
descriptionDescription of Service Package
nameService Package Name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listRemoteAccessVpns.html b/static/api/apidocs-4.23/apis/listRemoteAccessVpns.html new file mode 100644 index 0000000000..65fdd7f377 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listRemoteAccessVpns.html @@ -0,0 +1,153 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listRemoteAccessVpns

+

Lists remote access VPNs

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idLists remote access VPN rule with the specified IDfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
networkidList remote access VPNs for certain Networkfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
publicipidPublic ip address id of the VPN serverfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the remote access VPN
accountThe Account of the remote access VPN
domainThe domain name of the Account of the remote access VPN
domainidThe domain ID of the Account of the remote access VPN
domainpathPath of the domain to which the remote access VPN belongs
fordisplayIs VPN for display to the regular user
iprangeThe range of IPs to allocate to the clients
presharedkeyThe IPSec preshared key
projectThe project name of the VPN
projectidThe project ID of the VPN
publicipThe public IP address of the VPN server
publicipidThe public IP address of the VPN server
stateThe state of the rule
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listResourceDetails.html b/static/api/apidocs-4.23/apis/listResourceDetails.html new file mode 100644 index 0000000000..a5869a1067 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listResourceDetails.html @@ -0,0 +1,150 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listResourceDetails

+

List resource detail(s)

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
resourcetypeList by resource typetrue
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fordisplayIf set to true, only details marked with display=true, are returned. False by defaultfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keyList by keyfalse
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
resourceidList by resource IDfalse
valueList by key, value. Needs to be passed only along with keyfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listResourceIcon.html b/static/api/apidocs-4.23/apis/listResourceIcon.html new file mode 100644 index 0000000000..1b3637e67c --- /dev/null +++ b/static/api/apidocs-4.23/apis/listResourceIcon.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listResourceIcon

+

Lists the resource icon for the specified resource(s)

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
resourceidsList of resources to upload the icon/image fortrue
resourcetypeType of the resourcetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
base64imageBase64 representation of resource icon
resourceidID of the resource
resourcetypeResource type
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listResourceLimits.html b/static/api/apidocs-4.23/apis/listResourceLimits.html new file mode 100644 index 0000000000..deb3da1539 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listResourceLimits.html @@ -0,0 +1,144 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listResourceLimits

+

Lists resource limits.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idLists resource limits by ID.false
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
resourcetypeType 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
resourcetypenameType 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
tagTag for the resource typefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account of the resource limit
domainThe domain name of the resource limit
domainidThe domain ID of the resource limit
domainpathPath of the domain to which the resource limit belongs
maxThe maximum number of the resource. A -1 means the resource currently has no limit.
projectThe project name of the resource limit
projectidThe project ID of the resource limit
resourcetypeResource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.
resourcetypenameResource type name. Values include user_vm, public_ip, volume, Snapshot, Template, project, Network, VPC, CPU, memory, primary_storage, secondary_storage.
tagThe tag for the resource limit
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listResourceSchedule.html b/static/api/apidocs-4.23/apis/listResourceSchedule.html new file mode 100644 index 0000000000..b5e53e2339 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listResourceSchedule.html @@ -0,0 +1,141 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listResourceSchedule

+

List Resource Schedules

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
resourceidID of the resource for which schedules are to be listed.true
resourcetypeType of the resource.true
actionAction to take on the resource.false
enabledFilter by enabled status.false
idID of the schedulefalse
idscomma separated list of schedule idsfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of resource schedule
actionAction
createdDate when the schedule was created
descriptionDescription of resource schedule
detailsSchedule details
enabledResource schedule is enabled
enddateDate after which the schedule becomes inactive
resourceidID of the resource
resourcetypeType of the resource
scheduleCron formatted resource schedule
startdateDate from which the schedule is active
timezoneTimezone of the schedule
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listRolePermissions.html b/static/api/apidocs-4.23/apis/listRolePermissions.html new file mode 100644 index 0000000000..89f31a7ce7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listRolePermissions.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listRolePermissions

+

Lists role permissions

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
roleidID of the rolefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
idThe ID of the role permission
roleidThe ID of the role to which the role permission belongs
rolenameThe name of the role to which the role permission belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listRoles.html b/static/api/apidocs-4.23/apis/listRoles.html new file mode 100644 index 0000000000..45238788c6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listRoles.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listRoles

+

Lists dynamic roles in CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idList role by role ID.false
keywordList by keywordfalse
nameList role by role name.false
pagefalse
pagesizefalse
stateList role by role type status, valid options are: enabled, disabledfalse
typeList role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.false
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
isdefaultTrue if role is default, false otherwise
statethe state of the role
typeThe type of the role
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listRouters.html b/static/api/apidocs-4.23/apis/listRouters.html new file mode 100644 index 0000000000..24b75d08a9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listRouters.html @@ -0,0 +1,423 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listRouters

+

List routers.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
archCPU arch of the routerfalse
clusteridThe cluster ID of the routerfalse
domainidList only resources belonging to the domain specifiedfalse
fetchhealthcheckresultsIf true is passed for this parameter, also fetch last executed health check results for the router. Default is falsefalse
forvpcIf true is passed for this parameter, list only VPC routersfalse
healthchecksfailedIf this parameter is passed, list only routers by health check resultsfalse
hostidThe host ID of the routerfalse
idThe ID of the disk routerfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameThe name of the routerfalse
networkidList by network idfalse
pagefalse
pagesizefalse
podidThe Pod ID of the routerfalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
stateThe state of the routerfalse
versionList virtual router elements by versionfalse
vpcidList networks by VPCfalse
zoneidThe Zone ID of the routerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the router
accountThe Account associated with the router
archCPU arch of the router
createdThe date and time the router was created
dns1The first DNS for the router
dns2The second DNS for the router
domainThe domain associated with the router
domainidThe domain ID associated with the router
domainpathpath of the Domain the router belongs to
gatewayThe gateway for the router
guestipaddressThe guest IP address for the router
guestmacaddressThe guest MAC address for the router
guestnetmaskThe guest netmask for the router
guestnetworkidThe ID of the corresponding guest Network
guestnetworknameThe name of the corresponding guest Network
healthchecksfailedTrue if any health checks had failed
hostcontrolstateThe control state of the host for the router
hostidThe host ID for the router
hostnameThe hostname for the router
hypervisorThe hypervisor on which the Template runs
ip6dns1The first IPv6 DNS for the router
ip6dns2The second IPv6 DNS for the router
isredundantrouterIf this router is an redundant virtual router
linklocalipThe Control IP address for the router
linklocalmacaddressThe link local MAC address for the router
linklocalnetmaskThe link local netmask for the router
linklocalnetworkidThe ID of the corresponding link local Network
nameThe name of the router
networkdomainThe Network domain for the router
podidThe Pod ID for the router
podnameThe Pod name for the router
projectThe project name of the address
projectidThe project id of the IP address
publicipThe public IP address for the router
publicmacaddressThe public MAC address for the router
publicnetmaskThe public netmask for the router
publicnetworkidThe ID of the corresponding public Network
redundantstateThe state of redundant virtual router
requiresupgradeTrue if the router Template requires upgrade
roleRole of the domain router
scriptsversionThe version of scripts
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
softwareversionThe version of the code / software in the router
stateThe state of the router
templateidThe Template ID for the router
templatenameThe Template name for the router
versionThe version of Template
vpcidVPC the router belongs to
vpcnameThe name of VPC the router belongs to
zoneidThe Zone ID for the router
zonenameThe Zone name for the router
healthcheckresults(*)Last executed health check result for the router
checknameThe name of the health check on the router
checktypeThe type of the health check - basic or advanced
detailsDetailed response generated on running health check
lastupdatedThe date this VPC was created
statusthe result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}
successThe result of the health check if available
nic(*)The list of NICs associated with the router
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listRoutingFirewallRules.html b/static/api/apidocs-4.23/apis/listRoutingFirewallRules.html new file mode 100644 index 0000000000..1700c7a9cc --- /dev/null +++ b/static/api/apidocs-4.23/apis/listRoutingFirewallRules.html @@ -0,0 +1,204 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listRoutingFirewallRules

+

Lists all Routing firewall rules

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fordisplaylist resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idLists Routing firewall rule with the specified IDfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
networkidlist Routing firewall rules by network IDfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
tagsList resources by tags (key/value pairs)false
traffictypelist Routing firewall rules by traffic type - ingress or egressfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the port forwarding rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
fordisplayIs firewall for display to the regular user
ipaddressThe public IP address for the port forwarding rule
ipaddressidThe public IP address id for the port forwarding rule
networkidThe ID of the guest Network the port forwarding rule belongs to
networknameThe Name of the guest Network the port forwarding rule belongs to
privateendportThe ending port of port forwarding rule's private port range
privateportThe starting port of port forwarding rule's private port range
protocolThe protocol of the port forwarding rule
publicendportThe ending port of port forwarding rule's private port range
publicportThe starting port of port forwarding rule's public port range
stateThe state of the rule
virtualmachinedisplaynameThe Instance display name for the port forwarding rule
virtualmachineidThe Instance ID for the port forwarding rule
virtualmachinenameThe Instance name for the port forwarding rule
vmguestipThe Instance IP address for the port forwarding rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listSSHKeyPairs.html b/static/api/apidocs-4.23/apis/listSSHKeyPairs.html new file mode 100644 index 0000000000..b478ceadb4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listSSHKeyPairs.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listSSHKeyPairs

+

List registered keypairs

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fingerprintA public key fingerprint to look forfalse
idThe ID of the SSH keypairfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameA key pair name to look forfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the SSH keypair
accountThe owner of the keypair
domainThe domain name of the keypair owner
domainidThe domain id of the keypair owner
fingerprintFingerprint of the public key
nameName of the keypair
projectThe project name of the keypair owner
projectidThe project id of the keypair owner
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listSamlAuthorization.html b/static/api/apidocs-4.23/apis/listSamlAuthorization.html new file mode 100644 index 0000000000..fd82353c21 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listSamlAuthorization.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listSamlAuthorization

+

Lists authorized users who can used SAML SSO

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
useridUser uuidfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
idpidThe authorized Identity Provider ID
statusThe SAML authorization status
useridThe user ID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listSecondaryStagingStores.html b/static/api/apidocs-4.23/apis/listSecondaryStagingStores.html new file mode 100644 index 0000000000..edf8f0c524 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listSecondaryStagingStores.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listSecondaryStagingStores

+

Lists secondary staging stores.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the staging storefalse
keywordList by keywordfalse
nameThe name of the staging storefalse
pagefalse
pagesizefalse
protocolThe staging store protocolfalse
providerThe staging store providerfalse
zoneidThe Zone ID for the staging storefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the image store
disksizetotalThe total disk size of the host
disksizeusedThe host's currently used disk size
nameThe name of the image store
protocolThe protocol of the image store
providernameThe provider name of the image store
readonlyDefines if store is read-only
scopeThe scope of the image store
urlThe URL of the image store
zoneidThe Zone ID of the image store
zonenameThe Zone name of the image store
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listSecondaryStorageSelectors.html b/static/api/apidocs-4.23/apis/listSecondaryStorageSelectors.html new file mode 100644 index 0000000000..940533bd4a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listSecondaryStorageSelectors.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listSecondaryStorageSelectors

+

Lists the secondary storage selectors and their rules.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
zoneidThe zone ID to be used in the search filter.true
keywordList by keywordfalse
pagefalse
pagesizefalse
showremovedShow removed heuristics.false
typeWhether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, BACKUP, TEMPLATE and VOLUME.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the heuristic.
createdWhen the heuristic was created.
descriptionDescription of the heuristic.
heuristicruleThe heuristic rule, in JavaScript language, used to select a secondary storage to be directed.
nameName of the heuristic.
removedWhen the heuristic was removed.
typeThe resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, BACKUP, TEMPLATE and VOLUME.
zoneidThe zone which the heuristic is valid upon.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listSecurityGroups.html b/static/api/apidocs-4.23/apis/listSecurityGroups.html new file mode 100644 index 0000000000..fbad99352d --- /dev/null +++ b/static/api/apidocs-4.23/apis/listSecurityGroups.html @@ -0,0 +1,321 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listSecurityGroups

+

Lists security groups

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idList the security group by the id providedfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
securitygroupnameLists security groups by namefalse
tagsList resources by tags (key/value pairs)false
virtualmachineidLists security groups by Instance idfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listServiceOfferings.html b/static/api/apidocs-4.23/apis/listServiceOfferings.html new file mode 100644 index 0000000000..425b7962cb --- /dev/null +++ b/static/api/apidocs-4.23/apis/listServiceOfferings.html @@ -0,0 +1,339 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listServiceOfferings

+

Lists all available service offerings.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
cpunumberThe CPU number that listed offerings must supportfalse
cpuspeedThe CPU speed that listed offerings must supportfalse
domainidList only resources belonging to the domain specifiedfalse
encryptrootListed offerings support root disk encryptionfalse
gpuenabledFlag to indicate if the service offering supports GPU. If set to true, only service offerings that support GPU will be returned.false
idID of the service offeringfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
issystem Is this a System VM offeringfalse
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
memoryThe RAM memory that listed offering must supportfalse
nameName of the service offeringfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
stateFilter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.false
storagetypethe storage type of the service offering. Values are local and shared.false
systemvmtypeThe system Instance type. Possible types are "consoleproxy", "secondarystoragevm" or "domainrouter".false
templateidThe ID of the template that listed offerings must supportfalse
vgpuprofileidThe ID of the vGPU profile that listed offerings must supportfalse
virtualmachineidThe ID of the Instance. Pass this in if you want to see the available service offering that an Instance can be changed to.false
zoneidID of zone disk offering is associated withfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the service offering
cacheModeThe cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default
cpunumberThe number of CPU
cpuspeedThe clock rate CPU speed in Mhz
createdThe date this service offering was created
defaultuseIs this a default System VM offering
deploymentplannerDeployment strategy used to deploy Instance.
diskBytesReadRateBytes read rate of the service offering
diskBytesReadRateMaxBurst bytes read rate of the disk offering
diskBytesReadRateMaxLengthLength (in seconds) of the burst
diskBytesWriteRateBytes write rate of the service offering
diskBytesWriteRateMaxBurst bytes write rate of the disk offering
diskBytesWriteRateMaxLengthLength (in seconds) of the burst
diskIopsReadRateI/O requests read rate of the service offering
diskIopsReadRateMaxBurst io requests read rate of the disk offering
diskIopsReadRateMaxLengthLength (in second) of the burst
diskIopsWriteRateI/O requests write rate of the service offering
diskIopsWriteRateMaxBurst I/O requests write rate of the disk offering
diskIopsWriteRateMaxLengthLength (in seconds) of the burst
diskofferingdisplaytextThe display text of the disk offering
diskofferingidThe ID of the disk offering to which service offering is linked
diskofferingnameName of the disk offering
diskofferingstrictnessTrue/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 Instance is deployed and change disk offering is not allowed for the ROOT disk after the Instance is deployed
displaytextAn alternate display text of the service offering.
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
dynamicscalingenabledTrue if Instance needs to be dynamically scalable of CPU or memory
encryptrootTrue if Instance root disk will be encrypted on storage
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs to attach
gpudisplaywhether GPU device is used for display or not
hosttagsThe host tag for the service offering
hypervisorsnapshotreserveHypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
iscustomizedIs true if the offering is customized
iscustomizediopsTrue if disk offering uses custom IOPS, false otherwise
issystemIs this a System VM offering
isvolatileTrue if the Instance needs to be volatile, i.e., on every reboot of Instance from API root disk is discarded and creates a new root disk
leasedurationInstance lease duration (in days) for service offering
leaseexpiryactionAction to be taken once lease is over
limitcpuuseRestrict the CPU usage to committed service offering
maxheadsthe maximum number of display heads
maxiopsThe max IOPS of the disk offering
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory in MB
miniopsThe min IOPS of the disk offering
nameThe name of the service offering
networkrateData transfer rate in megabits per second allowed.
offerhaThe HA support in the service offering
provisioningtypeProvisioning type used to create volumes. Valid values are thin, sparse, fat.
purgeresourcesWhether to cleanup VM and its associated resource upon expunge
rootdisksizeRoot disk size in GB
serviceofferingdetailsAdditional key/value details tied with this service offering
stateState of the service offering
storagetagsThe tags for the service offering
storagetypeThe storage type for this service offering
systemvmtypeIs this a the System VM type for System VM offering
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vspherestoragepolicyThe vsphere storage policy tagged to the service offering in case of VMware
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listSharedFileSystemProviders.html b/static/api/apidocs-4.23/apis/listSharedFileSystemProviders.html new file mode 100644 index 0000000000..3242835b84 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listSharedFileSystemProviders.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listSharedFileSystemProviders

+

Lists all available shared filesystem providers.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
namethe name of the shared filesystem provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listSharedFileSystems.html b/static/api/apidocs-4.23/apis/listSharedFileSystems.html new file mode 100644 index 0000000000..6b23664d58 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listSharedFileSystems.html @@ -0,0 +1,345 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listSharedFileSystems

+

List Shared FileSystems

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
diskofferingidthe disk offering of the shared filesystemfalse
domainidList only resources belonging to the domain specifiedfalse
idthe ID of the shared filesystemfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
namethe name of the shared filesystemfalse
networkidthe ID of the networkfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
retrieveonlyresourcecountMakes the API's response contains only the resource countfalse
serviceofferingidthe service offering of the shared filesystemfalse
tagsList resources by tags (key/value pairs)false
zoneidthe ID of the availability zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the shared filesystem
accountthe account associated with the shared filesystem
descriptiondescription of the shared filesystem
diskioreadthe read (IO) of disk on the shared filesystem
diskiowritethe write (IO) of disk on the shared filesystem
diskkbsreadthe shared filesystem's disk read in KiB
diskkbswritethe shared filesystem's disk write in KiB
diskofferingdisplaytextdisk offering display text for the shared filesystem
diskofferingiddisk offering ID for the shared filesystem
diskofferingnamedisk offering for the shared filesystem
domainthe domain associated with the shared filesystem
domainidthe ID of the domain associated with the shared filesystem
domainpathpath of the domain to which the shared filesystem
filesystemthe filesystem format
iscustomdiskofferingdisk offering for the shared filesystem has custom size
namename of the shared filesystem
networkidNetwork ID of the shared filesystem
networknameNetwork name of the shared filesystem
pathpath to mount the shared filesystem
physicalsizethe bytes actually consumed on disk
projectthe project name of the shared filesystem
projectidthe project ID of the shared filesystem
providerthe shared filesystem provider
provisioningtypeprovisioning type used in the shared filesystem
serviceofferingidservice offering ID for the shared filesystem
serviceofferingnameservice offering for the shared filesystem
sizesize of the shared filesystem
sizegbsize of the shared filesystem in GiB
statethe state of the shared filesystem
storagename of the storage pool hosting the data volume
storageidID of the storage pool hosting the data volume
utilizationthe disk utilization
virtualmachineidID of the storage fs vm
virtualsizethe bytes allocated
vmstateID of the storage fs vm
volumeidID of the storage fs data volume
volumenamename of the storage fs data volume
zoneidID of the availability zone
zonenameName of the availability zone
nic(*)the list of nics associated with the shared filesystem
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listSnapshotPolicies.html b/static/api/apidocs-4.23/apis/listSnapshotPolicies.html new file mode 100644 index 0000000000..769b067861 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listSnapshotPolicies.html @@ -0,0 +1,141 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listSnapshotPolicies

+

Lists Snapshot policies.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idThe ID of the Snapshot policyfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
volumeidThe ID of the disk volumefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Snapshot policy
fordisplayIs this policy for display to the regular user
intervaltypeThe interval type of the Snapshot policy
maxsnapsMaximum number of Snapshots retained
scheduleTime the Snapshot is scheduled to be taken.
storageThe list of pools in which snapshot backup is scheduled
timezoneThe time zone of the Snapshot policy
volumeidThe ID of the disk volume
volumenamethe name of the disk volume
zoneThe list of zones in which snapshot backup is scheduled
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listSnapshots.html b/static/api/apidocs-4.23/apis/listSnapshots.html new file mode 100644 index 0000000000..850127e1da --- /dev/null +++ b/static/api/apidocs-4.23/apis/listSnapshots.html @@ -0,0 +1,243 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listSnapshots

+

Lists all available snapshots for the account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idLists Snapshot by Snapshot IDfalse
idsThe IDs of the Snapshots, mutually exclusive with idfalse
imagestoreidID of the image or image cache storefalse
intervaltypeValid values are HOURLY, DAILY, WEEKLY, and MONTHLY.false
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
locationtypelist snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is emptyfalse
nameLists Snapshot by Snapshot namefalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
showuniqueIf set to false, list templates across zones and their storagesfalse
snapshottypeValid values are MANUAL or RECURRING.false
storageidID of the storage poolfalse
tagsList resources by tags (key/value pairs)false
volumeidThe ID of the disk volumefalse
zoneidList Snapshots by zone idfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the Snapshot
accountThe Account associated with the Snapshot
chainsizechain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true
createdThe date the Snapshot was created
datastoreidID of the datastore for the snapshot entry
datastorenamename of the datastore for the snapshot entry
datastorestatestate of the snapshot on the datastore
datastoretypetype of the datastore for the snapshot entry
domainThe domain name of the Snapshot's Account
domainidThe domain ID of the Snapshot's Account
domainpathpath of the Domain the snapshot's account belongs to
downloaddetailsdownload progress of a snapshot
intervaltypeValid types are hourly, daily, weekly, monthy, Template, and none.
locationtypeValid location types are primary and secondary.
nameName of the Snapshot
osdisplaynameDisplay name of the os on volume
ostypeidID of the os on volume
parentThe parent ID of the Snapshot
parentnameThe parent name of the Snapshot
physicalsizePhysical size of backed up Snapshot on image store
projectThe project name of the Snapshot
projectidThe project id of the Snapshot
revertableIndicates whether the underlying storage supports reverting the volume to this Snapshot
snapshottypeThe type of the Snapshot
stateThe 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
statusthe status of the template
virtualsizeVirtual size of backedup Snapshot on image store
volumeidID of the disk volume
volumenameName of the disk volume
volumestatestate of the disk volume
volumetypeType of the disk volume
zoneidID of the availability zone
zonenamename of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listSslCerts.html b/static/api/apidocs-4.23/apis/listSslCerts.html new file mode 100644 index 0000000000..c1ac05017a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listSslCerts.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listSslCerts

+

Lists SSL certificates

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountidAccount IDfalse
certidID of SSL certificatefalse
lbruleidLoad balancer rule IDfalse
projectidProject that owns the SSL certificatefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idSSL certificate ID
accountAccount for the certificate
certchainCertificate chain
certificateCertificate
domainThe domain name of the Network owner
domainidThe domain id of the Network owner
fingerprintCertificate fingerprint
loadbalancerrulelistList of loabalancers this certificate is bound to
nameName
projectThe project name of the certificate
projectidThe project id of the certificate
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listStaticRoutes.html b/static/api/apidocs-4.23/apis/listStaticRoutes.html new file mode 100644 index 0000000000..05d2bbb643 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listStaticRoutes.html @@ -0,0 +1,192 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listStaticRoutes

+

Lists all static routes

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
gatewayidList static routes by gateway IDfalse
idList static route by IDfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
stateList static routes by statefalse
tagsList resources by tags (key/value pairs)false
vpcidList static routes by VPC IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of static route
accountThe Account associated with the static route
cidrStatic route CIDR
domainThe domain associated with the static route
domainidThe ID of the domain associated with the static route
domainpaththe domain path associated with the static route
nexthopNext hop of the static route
projectThe project name of the static route
projectidThe project ID of the static route
stateThe state of the static route
vpcgatewayidVPC gateway the route is created for
vpcgatewayipIP of VPC gateway the route is created for
vpcidVPC the static route belongs to
tags(*)The list of resource tags associated with static route
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listStorageAccessGroups.html b/static/api/apidocs-4.23/apis/listStorageAccessGroups.html new file mode 100644 index 0000000000..2c97bb8ec5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listStorageAccessGroups.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listStorageAccessGroups

+

Lists storage access groups

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
nameName of the Storage access groupfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the storage access group
clustersList of Clusters in the Storage Access Group
hostsList of Hosts in the Storage Access Group
namethe name of the storage access group
podsList of Pods in the Storage Access Group
storagepoolsList of Storage Pools in the Storage Access Group
zonesList of Zones in the Storage Access Group
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listStorageNetworkIpRange.html b/static/api/apidocs-4.23/apis/listStorageNetworkIpRange.html new file mode 100644 index 0000000000..1b6b74a44e --- /dev/null +++ b/static/api/apidocs-4.23/apis/listStorageNetworkIpRange.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listStorageNetworkIpRange

+

List a storage network IP range.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idOptional parameter. Storage network IP range UUID, if specified, using it to search the range.false
keywordList by keywordfalse
pagefalse
pagesizefalse
podidOptional parameter. Pod UUID, if specified and range UUID is absent, using it to search the range.false
zoneidOptional parameter. Zone UUID, if specified and both pod UUID and range UUID are absent, using it to search the range.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe UUID of storage Network IP range.
endipThe end IP of the storage Network IP range
gatewayThe gateway of the storage Network IP range
netmaskThe netmask of the storage Network IP range
networkidThe Network UUID of storage Network IP range
podidThe Pod UUID for the storage Network IP range
startipThe start IP of the storage Network IP range
vlanThe ID or VID of the VLAN.
zoneidThe Zone UUID of the storage Network IP range
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listStoragePoolObjects.html b/static/api/apidocs-4.23/apis/listStoragePoolObjects.html new file mode 100644 index 0000000000..581db5658c --- /dev/null +++ b/static/api/apidocs-4.23/apis/listStoragePoolObjects.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listStoragePoolObjects

+

Lists objects at specified path on a storage pool.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idid of the storage pooltrue
keywordList by keywordfalse
pagefalse
pagesizefalse
pathpath to list on storage poolfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
formatFormat of template associated with the data store object.
isdirectoryIs it a directory.
lastupdatedLast modified date of the file/directory.
nameName of the data store object.
sizeSize is in Bytes.
snapshotidSnapshot ID associated with the data store object.
snapshotnameSnapshot Name associated with the data store object.
templateidTemplate ID associated with the data store object.
templatenameTemplate Name associated with the data store object.
volumeidVolume ID associated with the data store object.
volumenameVolume Name associated with the data store object.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listStoragePools.html b/static/api/apidocs-4.23/apis/listStoragePools.html new file mode 100644 index 0000000000..46cb059085 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listStoragePools.html @@ -0,0 +1,228 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listStoragePools

+

Lists storage pools.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
clusteridList storage pools belonging to the specific clusterfalse
hostidhost ID of the storage poolsfalse
idThe ID of the storage poolfalse
ipaddressThe IP address for the storage poolfalse
keywordList by keywordfalse
nameThe name of the storage poolfalse
pagefalse
pagesizefalse
pathThe storage pool pathfalse
podidThe Pod ID for the storage poolfalse
scopeThe scope of the storage poolfalse
statusThe status of the storage poolfalse
storageaccessgroupthe name of the storage access groupfalse
storagecustomstatsIf true, lists the custom stats of the storage poolfalse
zoneidThe Zone ID for the storage poolfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the storage pool
allocatediopsTotal min IOPS currently in use by volumes
capacitybytesbytes CloudStack can provision from this storage pool
capacityiopsIOPS CloudStack can provision from this storage pool
clusteridThe ID of the cluster for the storage pool
clusternameThe name of the cluster for the storage pool
createdThe date and time the storage pool was created
detailsthe storage pool details
disksizeallocatedThe pool's currently allocated disk size
disksizetotalThe total disk size of the storage pool
disksizeusedThe pool's currently used disk size
hypervisorThe hypervisor type of the storage pool
ipaddressThe IP address of the storage pool
istagaruleWhether the informed tag is a JS interpretable rule or not.
managedwhether this pool is managed or not
nameThe name of the storage pool
nfsmountoptsthe nfs mount options for the storage pool
overprovisionfactorThe overprovisionfactor for the storage pool
pathThe storage pool path
podidThe Pod ID of the storage pool
podnameThe Pod name of the storage pool
providerStorage provider for this pool
scopeThe scope of the storage pool
stateThe state of the storage pool
storageaccessgroupsthe storage access groups for the storage pool
storagecapabilitiesThe storage pool capabilities
storagecustomstatsthe storage pool custom stats
suitableformigrationTrue if this pool is suitable to migrate a volume, false otherwise
tagsThe tags for the storage pool
typeThe storage pool type
usediopstotal IOPS currently in use
zoneidThe Zone ID of the storage pool
zonenameThe Zone name of the storage pool
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listStoragePoolsMetrics.html b/static/api/apidocs-4.23/apis/listStoragePoolsMetrics.html new file mode 100644 index 0000000000..05e7d68375 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listStoragePoolsMetrics.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listStoragePoolsMetrics

+

Lists storage pool metrics

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
clusteridList storage pools belonging to the specific clusterfalse
hostidhost ID of the storage poolsfalse
idThe ID of the storage poolfalse
ipaddressThe IP address for the storage poolfalse
keywordList by keywordfalse
nameThe name of the storage poolfalse
pagefalse
pagesizefalse
pathThe storage pool pathfalse
podidThe Pod ID for the storage poolfalse
scopeThe scope of the storage poolfalse
statusThe status of the storage poolfalse
storageaccessgroupthe name of the storage access groupfalse
storagecustomstatsIf true, lists the custom stats of the storage poolfalse
zoneidThe Zone ID for the storage poolfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
disksizeallocatedgbDisk size allocated in GiB
disksizetotalgbDisk size in GiB
disksizeunallocatedgbDisk size unallocated in GiB
disksizeusedgbDisk size used in GiB
storageallocateddisablethresholdStorage allocated disable threshold exceeded
storageallocatedthresholdStorage allocated notification threshold exceeded
storageusagedisablethresholdStorage usage disable threshold exceeded
storageusagethresholdStorage usage notification threshold exceeded
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listStorageProviders.html b/static/api/apidocs-4.23/apis/listStorageProviders.html new file mode 100644 index 0000000000..54c3a718fb --- /dev/null +++ b/static/api/apidocs-4.23/apis/listStorageProviders.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listStorageProviders

+

Lists storage providers.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
typeThe type of storage provider: either primary or imagetrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
nameThe name of the storage provider
typeThe type of the storage provider: primary or image provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listStorageTags.html b/static/api/apidocs-4.23/apis/listStorageTags.html new file mode 100644 index 0000000000..52ed0afa3c --- /dev/null +++ b/static/api/apidocs-4.23/apis/listStorageTags.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listStorageTags

+

Lists storage tags

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
idThe ID of the storage tag
nameThe name of the storage tag
poolidThe pool ID of the storage tag
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listSupportedNetworkServices.html b/static/api/apidocs-4.23/apis/listSupportedNetworkServices.html new file mode 100644 index 0000000000..d36bf7be88 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listSupportedNetworkServices.html @@ -0,0 +1,132 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listSupportedNetworkServices

+

Lists all network services provided by CloudStack or for the given Provider.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
providerNetwork service provider namefalse
serviceNetwork service name to list providers and capabilities offalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listSwifts.html b/static/api/apidocs-4.23/apis/listSwifts.html new file mode 100644 index 0000000000..21d208ae1b --- /dev/null +++ b/static/api/apidocs-4.23/apis/listSwifts.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listSwifts

+

List Swift.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe id of the swiftfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the image store
disksizetotalThe total disk size of the host
disksizeusedThe host's currently used disk size
nameThe name of the image store
protocolThe protocol of the image store
providernameThe provider name of the image store
readonlyDefines if store is read-only
scopeThe scope of the image store
urlThe URL of the image store
zoneidThe Zone ID of the image store
zonenameThe Zone name of the image store
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listSystemVms.html b/static/api/apidocs-4.23/apis/listSystemVms.html new file mode 100644 index 0000000000..808b02be8d --- /dev/null +++ b/static/api/apidocs-4.23/apis/listSystemVms.html @@ -0,0 +1,231 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listSystemVms

+

List System VMs.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
archCPU arch of the system VMfalse
hostidThe host ID of the system VMfalse
idThe ID of the system VMfalse
keywordList by keywordfalse
nameThe name of the system VMfalse
pagefalse
pagesizefalse
podidThe Pod ID of the system VMfalse
stateThe state of the system VMfalse
storageidThe storage ID where Instance's volumes belong tofalse
systemvmtypeThe system VM type. Possible types are "consoleproxy" and "secondarystoragevm".false
zoneidThe Zone ID of the system VMfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the System VM
activeviewersessionsThe number of active console sessions for the console proxy System VM
agentstateThe agent state of the System VM
archCPU arch of the system VM
createdThe date and time the System VM was created
disconnectedThe last disconnected date of host
dns1The first DNS for the System VM
dns2The second DNS for the System VM
gatewayThe gateway for the System VM
guestvlanGuest VLAN range
hostcontrolstateThe control state of the host for the System VM
hostidThe host ID for the System VM
hostnameThe hostname for the System VM
hypervisorThe hypervisor on which the Template runs
isdynamicallyscalableTrue if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
linklocalipThe Control IP address for the System VM
linklocalmacaddressThe link local MAC address for the System VM
linklocalnetmaskThe link local netmask for the System VM
nameThe name of the System VM
networkdomainThe Network domain for the System VM
podidThe Pod ID for the System VM
podnameThe Pod name for the System VM
privateipThe private IP address for the System VM
privatemacaddressThe private MAC address for the System VM
privatenetmaskThe private netmask for the System VM
publicipThe public IP address for the System VM
publicmacaddressThe public MAC address for the System VM
publicnetmaskThe public netmask for the System VM
publicvlanPublic VLAN range
serviceofferingidthe ID of the service offering of the system virtual machine.
serviceofferingnamethe name of the service offering of the system virtual machine.
stateThe state of the System VM
storageipthe ip address for the system VM on the storage network
systemvmtypeThe System VM type
templateidThe Template ID for the System VM
templatenameThe Template name for the System VM
versionThe systemvm agent version
zoneidThe Zone ID for the System VM
zonenameThe Zone name for the System VM
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listSystemVmsUsageHistory.html b/static/api/apidocs-4.23/apis/listSystemVmsUsageHistory.html new file mode 100644 index 0000000000..c69cededb8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listSystemVmsUsageHistory.html @@ -0,0 +1,156 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listSystemVmsUsageHistory

+

Lists System VM stats

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enddateEnd date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")false
idThe ID of the system VM.false
idsThe IDs of the System VMs, mutually exclusive with ID.false
keywordList by keywordfalse
nameName of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).false
pagefalse
pagesizefalse
startdateStart date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
nameThe Name of the Instance
stats(*)The list of Instance stats
cpuusedThe amount (percentage) of the Instance's CPU currently used
diskiopstotalThe total disk IOPS since the last stats retrieval
diskioreadThe Instance's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration
diskiowriteThe Instance's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
memoryintfreekbsThe Instance's free memory in KB or -1 if it cannot be gathered
memorykbsThe memory used by the Instance in KB
memorytargetkbsThe target memory in Instance (KB)
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
networkreadThe amount of downloaded data by the Instance in MiB
networkwriteThe amount of uploaded data by the Instance in MiB
timestampThe time when the Instance stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTags.html b/static/api/apidocs-4.23/apis/listTags.html new file mode 100644 index 0000000000..45116839fe --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTags.html @@ -0,0 +1,150 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTags

+

List resource tag(s)

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
customerList by customer namefalse
domainidList only resources belonging to the domain specifiedfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keyList by keyfalse
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
resourceidList by resource IDfalse
resourcetypeList by resource typefalse
valueList by valuefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTemplateDirectDownloadCertificates.html b/static/api/apidocs-4.23/apis/listTemplateDirectDownloadCertificates.html new file mode 100644 index 0000000000..bff4a52c3a --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTemplateDirectDownloadCertificates.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTemplateDirectDownloadCertificates

+

List the uploaded certificates for direct download Templates

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idList direct download certificate by IDfalse
keywordList by keywordfalse
listhostsIf set to true: include the hosts where the certificate is uploaded tofalse
pagefalse
pagesizefalse
zoneidThe zone where certificates are uploadedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe direct download certificate ID
aliasThe direct download certificate alias
hostsmapThe hosts where the certificate is uploaded to
hypervisorThe hypervisor of the hosts where the certificate is uploaded
issuerThe direct download certificate issuer
serialnumThe direct download certificate serial num
subjectThe direct download certificate subject
validityThe direct download certificate issuer
versionThe direct download certificate version
zoneidThe zone ID where the certificate is uploaded
zonenameThe zone name where the certificate is uploaded
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTemplatePermissions.html b/static/api/apidocs-4.23/apis/listTemplatePermissions.html new file mode 100644 index 0000000000..befde9c909 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTemplatePermissions.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTemplatePermissions

+

List Template visibility and all accounts that have permissions to view this Template.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe Template IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe list of Accounts the Template is available for
domainidThe ID of the domain to which the Template belongs
ispublicTrue if this Template is a public Template, false otherwise
projectidsThe list of projects the Template is available for
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTemplates.html b/static/api/apidocs-4.23/apis/listTemplates.html new file mode 100644 index 0000000000..e10f6a30a9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTemplates.html @@ -0,0 +1,336 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTemplates

+

List all public, private, and privileged Templates.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
templatefilterPossible 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 Instance. * 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 an Instance. * community : Templates that have been marked as public but not featured. * all : all Templates (only usable by admins).true
accountList resources by Account. Must be used with the domainId parameter.false
archthe CPU arch of the template. Valid options are: x86_64, aarch64, s390xfalse
detailsComma separated list of Template details requested, value can be a list of [all, min]false
domainidList only resources belonging to the domain specifiedfalse
extensionidID of the extension for the templatefalse
forckslist templates that can be used to deploy CKS clustersfalse
hypervisorThe hypervisor for which to restrict the searchfalse
idThe Template IDfalse
idsThe IDs of the Templates, mutually exclusive with idfalse
imagestoreidID of the image or image cache storefalse
isreadylist templates that are ready to be deployedfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
isvnfflag to list VNF templates or not; true if need to list VNF templates, false otherwise.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameThe Template namefalse
oscategoryidthe ID of the OS category for the templatefalse
pagefalse
pagesizefalse
parenttemplateidList datadisk Templates by parent Template idfalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
showiconFlag to display the resource image for the Templatesfalse
showremovedShow removed Templates as wellfalse
showuniqueIf set to true, list only unique Templates across zonesfalse
storageidID of the storage poolfalse
tagsList resources by tags (key/value pairs)false
templatetypethe type of the templatefalse
zoneidList Templates by zoneIdfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe Account name to which the Template belongs
accountidThe Account id to which the Template belongs
archCPU Arch of the template
bitsThe processor bit size
bootableTrue if the ISO is bootable, false otherwise
checksumChecksum of the Template
childtemplatesIf root disk Template, then IDs of the datas disk Templates this Template owns
createdThe date this Template was created
crossZonesTrue if the Template is managed across all Zones, false otherwise
deployasisVMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is Template
detailsAdditional key/value details tied with Template
directdownloadKVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextThe Template display text
domainThe name of the domain to which the Template belongs
domainidThe ID of the domain to which the Template belongs
domainpathPath of the Domain the template belongs to
downloaddetailsLists the download progress of a Template across all secondary storages
extensionidThe ID of extension linked to this template
extensionnameThe name of extension linked to this template
forcksIf true it indicates that the template can be used for CKS cluster deployments
formatThe format of the Template.
hostidThe ID of the secondary storage host for the Template
hostnameThe name of the secondary storage host for the Template
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
isextractableTrue if the Template is extractable, false otherwise
isfeaturedTrue if this Template is a featured Template, false otherwise
ispublicTrue if this Template is a public Template, false otherwise
isreadyTrue if the Template is ready to be deployed from, false otherwise.
nameThe Template name
ostypeidThe ID of the OS type for this Template.
ostypenameThe name of the OS type for this Template.
parenttemplateidIf Datadisk Template, then id of the root disk Template this Template belongs to
passwordenabledTrue if the reset password feature is enabled, false otherwise
physicalsizeThe physical size of the Template
projectThe project name of the Template
projectidThe project ID of the Template
removedThe date this Template was removed
requireshvmTrue if Template requires HVM enabled, false otherwise
sizeThe size of the Template
sourcetemplateidThe Template ID of the parent Template if present
sshkeyenabledTrue if Template is sshkey enabled, false otherwise
statusThe status of the Template
templatetagThe tag of this Template
templatetypeThe type of the Template
urlThe URL which the Template/ISO is registered from
userdataidThe id of userdata linked to this Template
userdatanameThe name of userdata linked to this Template
userdataparamsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
zoneidThe ID of the zone for this Template
zonenameThe name of the zone for this Template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTrafficMonitors.html b/static/api/apidocs-4.23/apis/listTrafficMonitors.html new file mode 100644 index 0000000000..92651104d9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTrafficMonitors.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTrafficMonitors

+

List traffic monitor Hosts.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
zoneidZone IDtrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the external firewall
ipaddressThe management IP address of the external firewall
numretriesThe number of times to retry requests to the external firewall
timeoutThe timeout (in seconds) for requests to the external firewall
zoneidThe zone ID of the external firewall
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTrafficTypeImplementors.html b/static/api/apidocs-4.23/apis/listTrafficTypeImplementors.html new file mode 100644 index 0000000000..df86357242 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTrafficTypeImplementors.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTrafficTypeImplementors

+

Lists implementors of implementor of a network traffic type or implementors of all network traffic types

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
traffictypeOptional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementorfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
traffictypeNetwork traffic type
traffictypeimplementorImplementor of Network traffic type
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTrafficTypes.html b/static/api/apidocs-4.23/apis/listTrafficTypes.html new file mode 100644 index 0000000000..25e28a3eb2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTrafficTypes.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTrafficTypes

+

Lists traffic types of a given physical network.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
physicalnetworkidThe Physical Network IDtrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the Network provider
hypervnetworklabelThe Network name label of the physical device dedicated to this traffic on a HyperV host
isolationmethodsisolation methods for the physical network traffic
kvmnetworklabelThe Network name label of the physical device dedicated to this traffic on a KVM host
ovm3networklabelThe Network name of the physical device dedicated to this traffic on an OVM3 host
physicalnetworkidThe physical Network this belongs to
traffictypeThe trafficType to be added to the physical Network
vlanThe VLAN id to be used for Management traffic by VMware host
vmwarenetworklabelThe Network name label of the physical device dedicated to this traffic on a VMware host
xennetworklabelThe Network name label of the physical device dedicated to this traffic on a XenServer host
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTungstenFabricAddressGroup.html b/static/api/apidocs-4.23/apis/listTungstenFabricAddressGroup.html new file mode 100644 index 0000000000..4da8df39ee --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTungstenFabricAddressGroup.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTungstenFabricAddressGroup

+

List Tungsten-Fabric address group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
addressgroupuuidThe uuid of Tungsten-Fabric address groupfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
zoneidThe ID of zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
ipprefixTungsten-Fabric address group IP prefix
ipprefixlenTungsten-Fabric address group IP prefix length
nameTungsten-Fabric address group name
uuidTungsten-Fabric address group UUID
zoneidTungsten-Fabric provider zone ID
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTungstenFabricApplicationPolicySet.html b/static/api/apidocs-4.23/apis/listTungstenFabricApplicationPolicySet.html new file mode 100644 index 0000000000..92b5ab05ae --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTungstenFabricApplicationPolicySet.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTungstenFabricApplicationPolicySet

+

List Tungsten-Fabric application policy set

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
applicationpolicysetuuidThe uuid of Tungsten-Fabric application policy setfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
zoneidThe ID of zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
firewallpolicyList Tungsten-Fabric firewall policy
nameTungsten-Fabric policy name
tagList Tungsten-Fabric tag
uuidTungsten-Fabric application policy uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTungstenFabricFirewallPolicy.html b/static/api/apidocs-4.23/apis/listTungstenFabricFirewallPolicy.html new file mode 100644 index 0000000000..ba097e2fbb --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTungstenFabricFirewallPolicy.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTungstenFabricFirewallPolicy

+

List Tungsten-Fabric firewall policy

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
applicationpolicysetuuidThe UUID of Tungsten-Fabric application policy setfalse
firewallpolicyuuidThe UUID of Tungsten-Fabric firewall policyfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
zoneidThe ID of zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
firewallruleList Tungsten-Fabric firewall rule
nameTungsten-Fabric firewall policy name
uuidTungsten-Fabric firewall policy uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTungstenFabricFirewallRule.html b/static/api/apidocs-4.23/apis/listTungstenFabricFirewallRule.html new file mode 100644 index 0000000000..579052b330 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTungstenFabricFirewallRule.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTungstenFabricFirewallRule

+

List Tungsten-Fabric firewall rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
firewallpolicyuuidThe uuid of Tungsten-Fabric firewall policyfalse
firewallruleuuidThe uuid of Tungsten-Fabric firewall rulefalse
keywordList by keywordfalse
pagefalse
pagesizefalse
zoneidThe ID of zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
actionTungsten-Fabric firewall rule action
destaddressgroupTungsten-Fabric firewall rule destination address group
destnetworkTungsten-Fabric firewall rule destination network
desttagTungsten-Fabric firewall rule destination tag
directionTungsten-Fabric firewall rule direction
nameTungsten-Fabric firewall rule name
servicegroupTungsten-Fabric firewall rule service group
srcaddressgroupTungsten-Fabric firewall rule source address group
srcnetworkTungsten-Fabric firewall rule source network
srctagTungsten-Fabric firewall rule source tag
tagtypeTungsten-Fabric firewall rule tag type
uuidTungsten-Fabric firewall rule uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTungstenFabricLBHealthMonitor.html b/static/api/apidocs-4.23/apis/listTungstenFabricLBHealthMonitor.html new file mode 100644 index 0000000000..111f274c0b --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTungstenFabricLBHealthMonitor.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTungstenFabricLBHealthMonitor

+

List Tungsten-Fabric LB health monitor

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
lbruleidThe ID of lb ruletrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe health monitor ID
expectedcodeThe health monitor expected code
httpmethodThe health monitor HTTP method
intervalThe health monitor interval
lbruleidThe LB rule ID
retryThe health monitor retry
timeoutThe health monitor timeout
typeThe health monitor type
urlpathThe health monitor URL path
uuidThe health monitor UUID
zoneidTungsten-Fabric provider zone ID
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTungstenFabricLogicalRouter.html b/static/api/apidocs-4.23/apis/listTungstenFabricLogicalRouter.html new file mode 100644 index 0000000000..deb3f48b3d --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTungstenFabricLogicalRouter.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTungstenFabricLogicalRouter

+

List Tungsten-Fabric logical router

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
logicalrouteruuidThe uuid of Tungsten-Fabric logical routerfalse
networkuuidThe uuid of Tungsten-Fabric networkfalse
pagefalse
pagesizefalse
zoneidThe ID of zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric logical router name
networkList Tungsten-Fabric policy network name
uuidTungsten-Fabric logical router uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTungstenFabricNetwork.html b/static/api/apidocs-4.23/apis/listTungstenFabricNetwork.html new file mode 100644 index 0000000000..94a2fbddb4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTungstenFabricNetwork.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTungstenFabricNetwork

+

List Tungsten-Fabric network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
listallIf 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 falsefalse
networkuuidThe uuid of Tungsten-Fabric networkfalse
pagefalse
pagesizefalse
zoneidThe ID of zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric network name
uuidTungsten-Fabric network uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTungstenFabricNic.html b/static/api/apidocs-4.23/apis/listTungstenFabricNic.html new file mode 100644 index 0000000000..c0162c9db0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTungstenFabricNic.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTungstenFabricNic

+

List Tungsten-Fabric nic

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
nicuuidThe uuid of Tungsten-Fabric nicfalse
pagefalse
pagesizefalse
zoneidThe ID of zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric nic name
uuidTungsten-Fabric nic uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTungstenFabricPolicy.html b/static/api/apidocs-4.23/apis/listTungstenFabricPolicy.html new file mode 100644 index 0000000000..2b819b9375 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTungstenFabricPolicy.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTungstenFabricPolicy

+

List Tungsten-Fabric policy

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
ipaddressidThe ID of ip addressfalse
keywordList by keywordfalse
networkidThe ID of networkfalse
pagefalse
pagesizefalse
policyuuidThe uuid of Tungsten-Fabric policyfalse
zoneidThe ID of zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric policy name
networkList Tungsten-Fabric policy network name
uuidTungsten-Fabric tag type uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTungstenFabricPolicyRule.html b/static/api/apidocs-4.23/apis/listTungstenFabricPolicyRule.html new file mode 100644 index 0000000000..9b60797006 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTungstenFabricPolicyRule.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTungstenFabricPolicyRule

+

List Tungsten-Fabric policy

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
policyuuidThe uuid of Tungsten-Fabric policytrue
keywordList by keywordfalse
pagefalse
pagesizefalse
ruleuuidThe uuid of Tungsten-Fabric rulefalse
zoneidThe ID of zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
actionTungsten-Fabric policy action
destendportTungsten-Fabric policy destination end port
destipprefixTungsten-Fabric policy destination ip prefix
destipprefixlenTungsten-Fabric policy destination ip prefix length
destnetworkTungsten-Fabric policy destination network
deststartportTungsten-Fabric policy destination start port
directionTungsten-Fabric policy name
policyuuidTungsten-Fabric policy uuid
protocolTungsten-Fabric policy protocol
srcendportTungsten-Fabric policy source end port
srcipprefixTungsten-Fabric policy source ip prefix
srcipprefixlenTungsten-Fabric policy source ip prefix length
srcnetworkTungsten-Fabric policy source network
srcstartportTungsten-Fabric policy source start port
uuidTungsten-Fabric rule uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTungstenFabricProviders.html b/static/api/apidocs-4.23/apis/listTungstenFabricProviders.html new file mode 100644 index 0000000000..317f1b8681 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTungstenFabricProviders.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTungstenFabricProviders

+

Lists Tungsten-Fabric providers

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
zoneidfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric provider name
securitygroupsenabledTrue if security groups support is enabled, false otherwise
tungstengatewayTungsten-Fabric provider gateway
tungstenproviderhostnameTungsten-Fabric provider hostname
tungstenproviderintrospectportTungsten-Fabric provider introspect port
tungstenproviderportTungsten-Fabric provider port
tungstenprovideruuidTungsten-Fabric provider uuid
tungstenprovidervrouterportTungsten-Fabric provider vrouter port
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTungstenFabricServiceGroup.html b/static/api/apidocs-4.23/apis/listTungstenFabricServiceGroup.html new file mode 100644 index 0000000000..133cb330da --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTungstenFabricServiceGroup.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTungstenFabricServiceGroup

+

List Tungsten-Fabric service group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
servicegroupuuidThe uuid of Tungsten-Fabric service groupfalse
zoneidThe ID of zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
endportTungsten-Fabric service group end port
nameTungsten-Fabric service group name
protocolTungsten-Fabric service group protocol
startportTungsten-Fabric service group start port
uuidTungsten-Fabric service group uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTungstenFabricTag.html b/static/api/apidocs-4.23/apis/listTungstenFabricTag.html new file mode 100644 index 0000000000..1f22846314 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTungstenFabricTag.html @@ -0,0 +1,132 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTungstenFabricTag

+

Lists Tungsten-Fabric tags

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
applicationpolicysetuuidThe uuid of Tungsten-Fabric application policy setfalse
keywordList by keywordfalse
networkuuidThe uuid of Tungsten-Fabric Networkfalse
nicuuidThe uuid of Tungsten-Fabric NICfalse
pagefalse
pagesizefalse
policyuuidThe uuid of Tungsten-Fabric policyfalse
taguuidThe uuid of Tungsten-Fabric tagfalse
vmuuidThe uuid of Tungsten-Fabric Instancefalse
zoneidThe ID of zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric tag name
networkList Tungsten-Fabric network
nicList Tungsten-Fabric NIC
policyList Tungsten-Fabric policy
uuidTungsten-Fabric tag type uuid
vmList Tungsten-Fabric Instance
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTungstenFabricTagType.html b/static/api/apidocs-4.23/apis/listTungstenFabricTagType.html new file mode 100644 index 0000000000..63682a070e --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTungstenFabricTagType.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTungstenFabricTagType

+

Lists Tungsten-Fabric tags

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
tagtypeuuidThe uuid of Tungsten-Fabric tag typefalse
zoneidThe ID of zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric tag type name
uuidTungsten-Fabric tag type uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listTungstenFabricVm.html b/static/api/apidocs-4.23/apis/listTungstenFabricVm.html new file mode 100644 index 0000000000..a5ed981839 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listTungstenFabricVm.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listTungstenFabricVm

+

List Tungsten-Fabric vm

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
vmuuidThe uuid of Tungsten-Fabric vmfalse
zoneidThe ID of zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric vm name
uuidTungsten-Fabric nic uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listUcsBlades.html b/static/api/apidocs-4.23/apis/listUcsBlades.html new file mode 100644 index 0000000000..eb233986b7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listUcsBlades.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listUcsBlades

+

List ucs blades

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
ucsmanageridUcs manager IDtrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idUCS blade ID
bladednUCS blade dn
hostidCloudStack host ID this blade associates to
profilednAssociated UCS profile dn
ucsmanageridUCS manager ID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listUcsManagers.html b/static/api/apidocs-4.23/apis/listUcsManagers.html new file mode 100644 index 0000000000..9e4c6df19f --- /dev/null +++ b/static/api/apidocs-4.23/apis/listUcsManagers.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listUcsManagers

+

List ucs manager

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the ucs managerfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
zoneidThe zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the UCS manager
nameThe name of UCS manager
urlThe URL of UCS manager
zoneidThe zone ID of UCS manager
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listUcsProfiles.html b/static/api/apidocs-4.23/apis/listUcsProfiles.html new file mode 100644 index 0000000000..453b51c0a2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listUcsProfiles.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listUcsProfiles

+

List profile in ucs manager

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
ucsmanageridThe ID for the ucs managertrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
ucsdnUCS profile dn
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listUnmanagedInstances.html b/static/api/apidocs-4.23/apis/listUnmanagedInstances.html new file mode 100644 index 0000000000..a536f51cce --- /dev/null +++ b/static/api/apidocs-4.23/apis/listUnmanagedInstances.html @@ -0,0 +1,279 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listUnmanagedInstances

+

Lists unmanaged Instances for a given cluster.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
clusteridThe cluster IDtrue
keywordList by keywordfalse
nameThe hypervisor name of the Instancefalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
bootmodeindicates the boot mode
boottypeindicates the boot type
clusteridThe ID of the cluster to which Instance belongs
clusternamethe name of the cluster to which virtual machine belongs
cpucorepersocketThe CPU cores per socket for the Instance. VMware specific
cpunumberThe CPU cores of the Instance
cpuspeedThe CPU speed of the Instance
hostidThe ID of the host to which Instance belongs
hostnameThe name of the host to which Instance belongs
hypervisorThe hypervisor to which Instance belongs
hypervisorversionThe hypervisor version of the host to which Instance belongs
memoryThe memory of the Instance in MB
nameThe name of the Instance
osdisplaynameThe operating system of the Instance
osidThe operating system ID of the Instance
powerstateThe power state of the Instance
disk(*)The list of disks associated with the Instance
idThe ID of the disk
capacityThe capacity of the disk in bytes
controllerThe controller of the disk
controllerunitThe controller unit of the disk
datastorehostThe controller of the disk
datastorenameThe controller of the disk
datastorepathThe controller of the disk
datastoretypeThe controller of the disk
imagepathThe file path of the disk image
labelThe label of the disk
positionThe position of the disk
nic(*)The list of NICs associated with the Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listUsageRecords.html b/static/api/apidocs-4.23/apis/listUsageRecords.html new file mode 100644 index 0000000000..0711c6d3f3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listUsageRecords.html @@ -0,0 +1,222 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listUsageRecords

+

Lists usage records for accounts

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enddateEnd 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
startdateStart 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
accountList usage records for the specified user.false
accountidList usage records for the specified accountfalse
domainidList usage records for the specified domain.false
includetagsFlag to enable display of Tags for a resourcefalse
isrecursiveSpecify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.false
keywordList by keywordfalse
oldformatFlag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.false
pagefalse
pagesizefalse
projectidList usage records for specified projectfalse
typeList usage records for the specified usage typefalse
usageidList usage records for the specified usage UUID. Can be used only together with TYPE parameter.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe user Account name
accountidThe user Account ID
cpunumberNumber of CPU of resource
cpuspeedSpeed of each CPU of resource
descriptionDescription of the usage record
domainThe domain the resource is associated with
domainidThe domain ID
domainpathPath of the domain to which the usage reocrd belongs
enddateEnd date of the usage record
isdefaultTrue if the resource is default
issourcenatTrue if the IPAddress is source NAT
issystemTrue if the IPAddress is system IP - allocated during Instance deploy or LB rule create
memoryMemory allocated for the resource
nameResource or Instance name
networkidID of the Network
offeringidOffering ID
oscategoryidInstance guest os category ID
oscategorynameInstance os category name
osdisplaynameInstance os display name
ostypeidInstance os type ID
projectThe project name of the resource
projectidThe project ID of the resource
rawusageRaw usage in hours
sizeResource size
startdateStart date of the usage record
templateidTemplate ID
typeResource type
usageUsage in hours
usageidID of the resource
usagetypeUsage type ID
virtualmachineidInstance ID
virtualsizeVirtual size of resource
vpcidID of the VPC
zoneidThe zone ID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listUsageServerMetrics.html b/static/api/apidocs-4.23/apis/listUsageServerMetrics.html new file mode 100644 index 0000000000..324035e6be --- /dev/null +++ b/static/api/apidocs-4.23/apis/listUsageServerMetrics.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listUsageServerMetrics

+

Lists Usage Server metrics

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
collectiontimeThe time these statistics were collected
hostnameThe name of the active usage server
lastheartbeatThe last time this Usage Server checked for jobs
lastsuccessfuljobThe last time a usage job successfully completed
stateThe state of the usage server
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listUsageTypes.html b/static/api/apidocs-4.23/apis/listUsageTypes.html new file mode 100644 index 0000000000..2934dd5c23 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listUsageTypes.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listUsageTypes

+

List Usage Types

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
idUsage type ID
descriptionUsage type description
nameUsage type name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listUserData.html b/static/api/apidocs-4.23/apis/listUserData.html new file mode 100644 index 0000000000..db64273332 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listUserData.html @@ -0,0 +1,141 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listUserData

+

List registered userdatas

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idThe ID of the Userdatafalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameUserdata name to look forfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the User Data
accountThe owner of the User Data
accountidThe owner id of the User Data
domainThe domain name of the User Data owner
domainidThe domain id of the User Data owner
domainpathPath of the domain to which the User Data owner belongs
nameName of the User Data
paramsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in the User Data
projectThe project name of the User Data
projectidThe project id of the User Data
userdataBase64 encoded User Data content
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listUserKeyRules.html b/static/api/apidocs-4.23/apis/listUserKeyRules.html new file mode 100644 index 0000000000..0930205916 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listUserKeyRules.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listUserKeyRules

+

Lists the rules defined for a API key pair.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
keypairidID of the key pair.true
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
descriptionThe description of the role permission
permissionThe permission type of the api name or wildcard rule, allow/deny
ruleThe api name or wildcard rule
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listUserKeys.html b/static/api/apidocs-4.23/apis/listUserKeys.html new file mode 100644 index 0000000000..02ab903e7b --- /dev/null +++ b/static/api/apidocs-4.23/apis/listUserKeys.html @@ -0,0 +1,165 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listUserKeys

+

Lists the API key pairs (API and secret keys) of a user.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
apikeyfilterAPI key of the key pair.false
keypairidID of the key pair.false
keywordList by keywordfalse
listallLists all API key pairs of users that are accessible by the calling account. Only available for administrators. Defaults to false.false
pagefalse
pagesizefalse
showpermissionsWhether API Key rules should be returned. Defaults to false.false
useridID of the user that owns the keys.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the API key pair.
accountidAccount ID.
accountnameAccount name.
accounttypeAccount type.
apikeyThe API key of the registered user.
createdAPI key pair creation timestamp.
descriptionAPI key pair description.
domainName of the domain which the account belongs to.
domainidID of the domain which the account belongs to.
domainpathPath of the domain which the account belongs to.
enddateAPI key pair expiration date.
nameName of the API key pair
permissionsPermissions of the API key pair.
roleidID of the role.
rolenameName of the role.
roletypeType of the role (Admin, ResourceAdmin, DomainAdmin, User).
secretkeyThe secret key of the registered user.
startdateAPI key pair start date.
stateState of the API key pair.
useridID of the user that owns the keypair.
usernameUsername of the keypair's owner.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listUserTwoFactorAuthenticatorProviders.html b/static/api/apidocs-4.23/apis/listUserTwoFactorAuthenticatorProviders.html new file mode 100644 index 0000000000..0c6dd1872e --- /dev/null +++ b/static/api/apidocs-4.23/apis/listUserTwoFactorAuthenticatorProviders.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listUserTwoFactorAuthenticatorProviders

+

Lists user two factor authenticator providers

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
nameList user two factor authenticator provider by namefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
descriptionThe description of the user two factor authenticator provider
nameThe user two factor authenticator provider name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listUsers.html b/static/api/apidocs-4.23/apis/listUsers.html new file mode 100644 index 0000000000..2ca876558c --- /dev/null +++ b/static/api/apidocs-4.23/apis/listUsers.html @@ -0,0 +1,195 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listUsers

+

Lists user accounts

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
accounttypeList users by account type. Valid types include admin, domain-admin, read-only-admin, or user.false
apikeyaccessList users by the Api key access valuefalse
domainidList only resources belonging to the domain specifiedfalse
idList user by ID.false
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
showiconFlag to display the resource icon for usersfalse
stateList users by state of the user account.false
usernameList user by the usernamefalse
usersourceList users by their authentication source. Valid values are: native, ldap, saml2 and saml2disabled.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe user ID
accountThe Account name of the user
accountidThe Account ID of the user
accounttypeThe Account type of the user
apikeyThe API key of the user
apikeyaccessWhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
createdThe date and time the user Account was created
domainThe domain name of the user
domainidThe domain ID of the user
emailThe user email address
firstnameThe user firstname
iconBase64 string representation of the resource icon
is2faenabledTrue if user has two factor authentication enabled
is2famandatedTrue if user has two factor authentication is mandated
iscallerchilddomainThe boolean value representing if the updating target is in caller's child domain
isdefaultTrue if user is default, false otherwise
lastnameThe user lastname
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role
secretkeyThe secret key of the user
stateThe user state
timezoneThe timezone user was created in
usernameThe user name
usersourceThe source type of the user in lowercase, such as native, ldap, saml2
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVMSchedule.html b/static/api/apidocs-4.23/apis/listVMSchedule.html new file mode 100644 index 0000000000..d8f7bff5ea --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVMSchedule.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVMSchedule

+

List Instance Schedules.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidID of the Instance for which schedule is to be definedtrue
actionAction taken by schedulefalse
enabledFilter by enabled statusfalse
idID of Instance schedulefalse
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of Instance schedule
actionAction
createdDate when the schedule was created
descriptionDescription of Instance schedule
enabledVM schedule is enabled
enddateDate after which the schedule becomes inactive
scheduleCron formatted Instance schedule
startdateDate from which the schedule is active
timezoneTimezone of the schedule
virtualmachineidID of Instance
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVMSnapshot.html b/static/api/apidocs-4.23/apis/listVMSnapshot.html new file mode 100644 index 0000000000..27e3792684 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVMSnapshot.html @@ -0,0 +1,183 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVMSnapshot

+

List Instance Snapshot by conditions

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameLists Snapshot by Snapshot name or display namefalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
stateState of the Instance Snapshotfalse
tagsList resources by tags (key/value pairs)false
virtualmachineidThe ID of the Instancefalse
vmsnapshotidThe ID of the Instance Snapshotfalse
vmsnapshotidsThe IDs of the Instance Snapshots, mutually exclusive with vmsnapshotidfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance Snapshot
accountThe Account associated with the disk volume
createdThe create date of the Instance Snapshot
currentIndicates if this is current Snapshot
descriptionThe description of the Instance Snapshot
displaynameThe display name of the Instance Snapshot
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathPath of the domain to which the disk volume belongs
hypervisorThe type of hypervisor on which Snapshot is stored
nameThe name of the Instance Snapshot
parentThe parent ID of the Instance Snapshot
parentNameThe parent displayName of the Instance Snapshot
projectThe project name of the VPN
projectidThe project ID of the VPN
stateThe state of the Instance Snapshot
typeInstance Snapshot type
virtualmachineidThe Instance ID of the Instance Snapshot
virtualmachinenameThe Instance name of the Instance Snapshot
zoneidThe Zone ID of the Instance Snapshot
zonenameThe Zone name of the Instance Snapshot
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVPCOfferings.html b/static/api/apidocs-4.23/apis/listVPCOfferings.html new file mode 100644 index 0000000000..665a8585fc --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVPCOfferings.html @@ -0,0 +1,207 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVPCOfferings

+

Lists VPC offerings

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
displaytextList VPC offerings by display textfalse
domainidList VPC offerings available for VPC creation in specific domainfalse
idList VPC offerings by IDfalse
isdefaultTrue if need to list only default VPC offerings. Default value is falsefalse
keywordList by keywordfalse
nameList VPC offerings by namefalse
pagefalse
pagesizefalse
stateList VPC offerings by statefalse
supportedservicesList VPC offerings supporting certain servicesfalse
zoneidID of zone VPC offering is associated withfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the VPC offering
conservemodeTrue if the VPC offering is IP conserve mode enabled, allowing public IP services to be used across multiple VPC tiers.
createdThe date this VPC offering was created
displaytextAn alternate display text of the VPC offering.
distributedvpcrouterIndicates if the VPC offering supports distributed router for one-hop forwarding
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
fornsxTrue if VPC offering can be used by NSX networks only
internetprotocolThe internet protocol of the VPC offering
isdefaultTrue if VPC offering is default, false otherwise
nameThe name of the VPC offering
networkmodeMode in which the network will operate. The valid values are NATTED and ROUTED
routingmodeThe routing mode for the network offering, supported types are Static or Dynamic.
specifyasnumberTrue if network offering supports choosing AS numbers
stateState of the VPC offering. Can be Disabled/Enabled
supportsregionLevelvpcIndicated if the offering can support region level VPC
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
service(*)The list of supported services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVPCs.html b/static/api/apidocs-4.23/apis/listVPCs.html new file mode 100644 index 0000000000..6b5d195bfa --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVPCs.html @@ -0,0 +1,327 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVPCs

+

Lists VPCs

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
cidrList by CIDR of the VPC. All VPC Guest Network's CIDRs should be within this CIDRfalse
displaytextList by display text of The VPCfalse
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idList VPC by IDfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameList by name of the VPCfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
restartrequiredList VPCs by restartRequired optionfalse
showiconFlag to display the resource icon for VPCsfalse
stateList VPCs by statefalse
supportedservicesList VPC supporting certain servicesfalse
tagsList resources by tags (key/value pairs)false
vpcofferingidList by ID of the VPC offeringfalse
zoneidList by zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the VPC
accountThe owner of the VPC
asnumberAS NUMBER
asnumberidUUID of AS NUMBER
bgppeersThe BGP peers for the VPC
cidrThe CIDR the VPC
createdThe date this VPC was created
displaytextAn alternate display text of the VPC.
distributedvpcrouterDoes VPC use distributed router for one hop forwarding and host based Network ACL's
dns1The first IPv4 DNS for the VPC
dns2The second IPv4 DNS for the VPC
domainThe domain name of the owner
domainidThe domain ID of the VPC owner
domainpathThe domain path of the owner
fordisplayIs VPC for display to the regular user
iconBase64 string representation of the resource icon
ip4routesThe routes for the VPC to ease adding route in upstream router
ip4routingThe IPv4 routing mode of VPC
ip6dns1The first IPv6 DNS for the VPC
ip6dns2The second IPv6 DNS for the VPC
ip6routesThe routes for the Network to ease adding route in upstream router
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.
nameThe name of the VPC
networkThe list of Networks belonging to the VPC
networkdomainThe Network domain of the VPC
projectThe project name of the VPC
projectidThe project ID of the VPC
publicmtuMTU configured on the public interfaces of the VPC VR
redundantvpcrouterIf this VPC has redundant router
regionlevelvpcTrue if VPC is region level
restartrequiredTrue VPC requires restart
stateState of the VPC. Can be Inactive/Enabled
vpcofferingconservemodetrue if VPC offering is ip conserve mode enabled
vpcofferingidVPC offering ID the VPC is created from
vpcofferingnameVPC offering name the VPC is created from
zoneidZone ID of the VPC
zonenameThe name of the zone the VPC belongs to
service(*)The list of supported services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
tags(*)The list of resource tags associated with the project
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVgpuProfiles.html b/static/api/apidocs-4.23/apis/listVgpuProfiles.html new file mode 100644 index 0000000000..1f914106e9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVgpuProfiles.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVgpuProfiles

+

Lists all available vGPU profiles

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
activeonlyIf true, only vGPU profiles which have a device will be listed. If false, all vGPU profiles will be listed.false
gpucardidthe GPU card ID associated with this GPU devicefalse
idID of the vGPU profilefalse
keywordList by keywordfalse
namename of the vGPU profilefalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
descriptionthe description of the vGPU profile
gpucardidthe ID of the GPU card associated with this vGPU profile
gpucardnamethe name of the vGPU profile
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
maxvgpuperphysicalgputhe maximum number of vGPUs per physical GPU
videoramthe video RAM size in MB
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVirtualMachineCheckpoints.html b/static/api/apidocs-4.23/apis/listVirtualMachineCheckpoints.html new file mode 100644 index 0000000000..16bcd74fb7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVirtualMachineCheckpoints.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVirtualMachineCheckpoints

+

List checkpoints for a VM. This API is intended for testing only and is disabled by default.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidID of the VMtrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
idthe checkpoint ID
createdthe checkpoint creation time
isactivewhether this is the active checkpoint
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVirtualMachines.html b/static/api/apidocs-4.23/apis/listVirtualMachines.html new file mode 100644 index 0000000000..85dd5b4030 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVirtualMachines.html @@ -0,0 +1,828 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVirtualMachines

+

List the Instances owned by the account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
accumulateAccumulates the Instance 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
affinitygroupidList Instances by affinity groupfalse
archCPU arch of the VMfalse
autoscalevmgroupidThe ID of AutoScaling Instance Groupfalse
backupofferingidList by the backup offeringfalse
clusteridThe cluster IDfalse
detailsComma separated list of Instance 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
displayvmList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
domainidList only resources belonging to the domain specifiedfalse
extensionidThe ID of the Orchestrator extension for the VMfalse
forvirtualnetworkList by Network type; true if need to list Instances using Virtual Network, false otherwisefalse
gpuenabledFlag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.false
groupidThe group IDfalse
haenableList by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabledfalse
hostidThe host IDfalse
hypervisorThe target hypervisor for the Templatefalse
idThe ID of the Instancefalse
idsThe IDs of the Instances, mutually exclusive with idfalse
isoidList Instances by ISOfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
isvnfflag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.false
keypairList Instances by SSH keypair namefalse
keywordList by keywordfalse
leasedWhether to return only leased instancesfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameName of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)false
networkidList by Network IDfalse
pagefalse
pagesizefalse
podidThe pod IDfalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
retrieveonlyresourcecountMakes the API's response contains only the resource countfalse
securitygroupidThe security group IDfalse
serviceofferingidList by the service offeringfalse
showiconFlag to display the resource icon for Instancesfalse
stateState of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.false
storageidThe storage ID where Instance's volumes belong tofalse
tagsList resources by tags (key/value pairs)false
templateidList Instances by Templatefalse
userdataWhether to return the Instances' User data or not. By default, User data will not be returned.false
userdataidthe instances by userdatafalse
useridThe user ID that created the Instance and is under the Account that owns the Instancefalse
vpcidList Instances by VPCfalse
zoneidThe availability zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVirtualMachinesMetrics.html b/static/api/apidocs-4.23/apis/listVirtualMachinesMetrics.html new file mode 100644 index 0000000000..ed64b0bc4b --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVirtualMachinesMetrics.html @@ -0,0 +1,234 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVirtualMachinesMetrics

+

Lists VM metrics

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
accumulateAccumulates the Instance 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
affinitygroupidList Instances by affinity groupfalse
archCPU arch of the VMfalse
autoscalevmgroupidThe ID of AutoScaling Instance Groupfalse
backupofferingidList by the backup offeringfalse
clusteridThe cluster IDfalse
detailsComma separated list of Instance 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
displayvmList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
domainidList only resources belonging to the domain specifiedfalse
extensionidThe ID of the Orchestrator extension for the VMfalse
forvirtualnetworkList by Network type; true if need to list Instances using Virtual Network, false otherwisefalse
gpuenabledFlag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.false
groupidThe group IDfalse
haenableList by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabledfalse
hostidThe host IDfalse
hypervisorThe target hypervisor for the Templatefalse
idThe ID of the Instancefalse
idsThe IDs of the Instances, mutually exclusive with idfalse
isoidList Instances by ISOfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
isvnfflag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.false
keypairList Instances by SSH keypair namefalse
keywordList by keywordfalse
leasedWhether to return only leased instancesfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameName of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)false
networkidList by Network IDfalse
pagefalse
pagesizefalse
podidThe pod IDfalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
retrieveonlyresourcecountMakes the API's response contains only the resource countfalse
securitygroupidThe security group IDfalse
serviceofferingidList by the service offeringfalse
showiconFlag to display the resource icon for Instancesfalse
stateState of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.false
storageidThe storage ID where vm's volumes belong tofalse
tagsList resources by tags (key/value pairs)false
templateidList Instances by Templatefalse
userdataWhether to return the Instances' User data or not. By default, User data will not be returned.false
userdataidthe instances by userdatafalse
useridThe user ID that created the Instance and is under the Account that owns the Instancefalse
vpcidList Instances by VPCfalse
zoneidThe availability zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
cputotalThe total cpu capacity in Ghz
diskiopstotalThe total disk iops
diskreadDisk read in MiB
diskwriteDisk write in MiB
memorytotalThe total memory capacity in GiB
networkreadNetwork read in MiB
networkwriteNetwork write in MiB
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVirtualMachinesUsageHistory.html b/static/api/apidocs-4.23/apis/listVirtualMachinesUsageHistory.html new file mode 100644 index 0000000000..1109e9af51 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVirtualMachinesUsageHistory.html @@ -0,0 +1,156 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVirtualMachinesUsageHistory

+

Lists VM stats

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enddateEnd date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")false
idThe ID of the Instance.false
idsThe IDs of the Instances, mutually exclusive with id.false
keywordList by keywordfalse
nameName of the Instance (a substring match is made against the parameter value returning the data for all matching Instances).false
pagefalse
pagesizefalse
startdateStart date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
nameThe Name of the Instance
stats(*)The list of Instance stats
cpuusedThe amount (percentage) of the Instance's CPU currently used
diskiopstotalThe total disk IOPS since the last stats retrieval
diskioreadThe Instance's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration
diskiowriteThe Instance's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
memoryintfreekbsThe Instance's free memory in KB or -1 if it cannot be gathered
memorykbsThe memory used by the Instance in KB
memorytargetkbsThe target memory in Instance (KB)
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
networkreadThe amount of downloaded data by the Instance in MiB
networkwriteThe amount of uploaded data by the Instance in MiB
timestampThe time when the Instance stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVirtualRouterElements.html b/static/api/apidocs-4.23/apis/listVirtualRouterElements.html new file mode 100644 index 0000000000..8c90db4abc --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVirtualRouterElements.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVirtualRouterElements

+

Lists all available virtual router elements.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enabledList network offerings by enabled statefalse
idList virtual router elements by idfalse
keywordList by keywordfalse
nspidList virtual router elements by network service provider idfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the router
accountThe Account associated with the provider
domainThe domain associated with the provider
domainidThe domain ID associated with the provider
domainpathPath of the domain to which the provider belongs
enabledEnabled/Disabled the service provider
nspidThe physical Network service provider ID of the provider
projectThe project name of the address
projectidThe project ID of the IP address
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVlanIpRanges.html b/static/api/apidocs-4.23/apis/listVlanIpRanges.html new file mode 100644 index 0000000000..ed41aa13bb --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVlanIpRanges.html @@ -0,0 +1,195 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVlanIpRanges

+

Lists all VLAN IP ranges.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountThe account with which the VLAN IP range is associated. Must be used with the domainId parameter.false
domainidThe 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
forvirtualnetworkTrue if VLAN is of Virtual type, false if Directfalse
idThe ID of the VLAN IP rangefalse
keywordList by keywordfalse
networkidNetwork ID of the VLAN IP rangefalse
pagefalse
pagesizefalse
physicalnetworkidPhysical Network ID of the VLAN IP rangefalse
podidThe Pod ID of the VLAN IP rangefalse
projectidProject who will own the VLANfalse
vlanThe ID or VID of the VLAN. Default is an "untagged" VLAN.false
zoneidThe Zone ID of the VLAN IP rangefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the VLAN IP range
accountThe Account of the VLAN IP range
cidrThe CIDR of the VLAN IP range
descriptionThe description of the VLAN IP range
domainThe domain name of the VLAN IP range
domainidThe domain ID of the VLAN IP range
domainpathPath of the domain to which the VLAN IP range belongs
endipThe end IP of the VLAN IP range
endipv6The end IPv6 of the VLAN IP range
forsystemvmsIndicates whether VLAN IP range is dedicated to System VMs or not
forvirtualnetworkThe virtual Network for the VLAN IP range
gatewayThe gateway of the VLAN IP range
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
netmaskThe netmask of the VLAN IP range
networkidThe Network ID of VLAN range
physicalnetworkidThe physical Network this belongs to
podidThe Pod ID for the VLAN IP range
podnameThe Pod name for the VLAN IP range
projectThe project name of the VLAN range
projectidThe project ID of the VLAN range
providerindicates to which provider the IP range is dedicated to
startipThe start IP of the VLAN IP range
startipv6The start IPv6 of the VLAN IP range
vlanThe ID or VID of the VLAN.
zoneidThe Zone ID of the VLAN IP range
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVmsForImport.html b/static/api/apidocs-4.23/apis/listVmsForImport.html new file mode 100644 index 0000000000..a50a3063a7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVmsForImport.html @@ -0,0 +1,288 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVmsForImport

+

Lists virtual machines on a unmanaged host

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hostthe host name or IP addresstrue
hypervisorhypervisor type of the hosttrue
zoneidthe zone IDtrue
keywordList by keywordfalse
pagefalse
pagesizefalse
passwordthe password for the hostfalse
usernamethe username for the hostfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
bootmodeindicates the boot mode
boottypeindicates the boot type
clusteridThe ID of the cluster to which Instance belongs
clusternamethe name of the cluster to which virtual machine belongs
cpucorepersocketThe CPU cores per socket for the Instance. VMware specific
cpunumberThe CPU cores of the Instance
cpuspeedThe CPU speed of the Instance
hostidThe ID of the host to which Instance belongs
hostnameThe name of the host to which Instance belongs
hypervisorThe hypervisor to which Instance belongs
hypervisorversionThe hypervisor version of the host to which Instance belongs
memoryThe memory of the Instance in MB
nameThe name of the Instance
osdisplaynameThe operating system of the Instance
osidThe operating system ID of the Instance
powerstateThe power state of the Instance
disk(*)The list of disks associated with the Instance
idThe ID of the disk
capacityThe capacity of the disk in bytes
controllerThe controller of the disk
controllerunitThe controller unit of the disk
datastorehostThe controller of the disk
datastorenameThe controller of the disk
datastorepathThe controller of the disk
datastoretypeThe controller of the disk
imagepathThe file path of the disk image
labelThe label of the disk
positionThe position of the disk
nic(*)The list of NICs associated with the Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVmwareDcVms.html b/static/api/apidocs-4.23/apis/listVmwareDcVms.html new file mode 100644 index 0000000000..5d5c31ce95 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVmwareDcVms.html @@ -0,0 +1,294 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVmwareDcVms

+

Lists the VMs in a VMware Datacenter

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
datacenternameName of VMware datacenter.false
existingvcenteridUUID of a linked existing vCenterfalse
hostnameName of the host on vCenter. Must be set along with the instancename parameterfalse
instancenameName of the VM on vCenter. Must be set along with the hostname parameterfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
passwordThe password for specified username.false
usernameThe Username required to connect to resource.false
vcenterThe name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
bootmodeindicates the boot mode
boottypeindicates the boot type
clusteridThe ID of the cluster to which Instance belongs
clusternamethe name of the cluster to which virtual machine belongs
cpucorepersocketThe CPU cores per socket for the Instance. VMware specific
cpunumberThe CPU cores of the Instance
cpuspeedThe CPU speed of the Instance
hostidThe ID of the host to which Instance belongs
hostnameThe name of the host to which Instance belongs
hypervisorThe hypervisor to which Instance belongs
hypervisorversionThe hypervisor version of the host to which Instance belongs
memoryThe memory of the Instance in MB
nameThe name of the Instance
osdisplaynameThe operating system of the Instance
osidThe operating system ID of the Instance
powerstateThe power state of the Instance
disk(*)The list of disks associated with the Instance
idThe ID of the disk
capacityThe capacity of the disk in bytes
controllerThe controller of the disk
controllerunitThe controller unit of the disk
datastorehostThe controller of the disk
datastorenameThe controller of the disk
datastorepathThe controller of the disk
datastoretypeThe controller of the disk
imagepathThe file path of the disk image
labelThe label of the disk
positionThe position of the disk
nic(*)The list of NICs associated with the Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVmwareDcs.html b/static/api/apidocs-4.23/apis/listVmwareDcs.html new file mode 100644 index 0000000000..d698c65fba --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVmwareDcs.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVmwareDcs

+

Retrieves VMware DC(s) associated with a zone.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
zoneidId of the CloudStack zone.true
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idThe VMware Datacenter ID
nameThe VMware Datacenter name
vcenterThe VMware vCenter name/ip
zoneidThe Zone ID associated with this VMware Datacenter
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVnfAppliances.html b/static/api/apidocs-4.23/apis/listVnfAppliances.html new file mode 100644 index 0000000000..363047ce62 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVnfAppliances.html @@ -0,0 +1,816 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVnfAppliances

+

List VNF appliance owned by the account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
accumulateAccumulates the Instance 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
affinitygroupidList Instances by affinity groupfalse
archCPU arch of the VMfalse
autoscalevmgroupidThe ID of AutoScaling Instance Groupfalse
backupofferingidList by the backup offeringfalse
detailsComma separated list of Instance 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
displayvmList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
domainidList only resources belonging to the domain specifiedfalse
extensionidThe ID of the Orchestrator extension for the VMfalse
forvirtualnetworkList by Network type; true if need to list Instances using Virtual Network, false otherwisefalse
gpuenabledFlag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.false
groupidThe group IDfalse
haenableList by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabledfalse
hypervisorThe target hypervisor for the Templatefalse
idThe ID of the Instancefalse
idsThe IDs of the Instances, mutually exclusive with idfalse
isoidList Instances by ISOfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
isvnfflag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.false
keypairList Instances by SSH keypair namefalse
keywordList by keywordfalse
leasedWhether to return only leased instancesfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameName of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)false
networkidList by Network IDfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
retrieveonlyresourcecountMakes the API's response contains only the resource countfalse
securitygroupidThe security group IDfalse
serviceofferingidList by the service offeringfalse
showiconFlag to display the resource icon for Instancesfalse
stateState of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.false
tagsList resources by tags (key/value pairs)false
templateidList Instances by Templatefalse
userdataWhether to return the Instances' User data or not. By default, User data will not be returned.false
userdataidthe instances by userdatafalse
useridThe user ID that created the Instance and is under the Account that owns the Instancefalse
vpcidList Instances by VPCfalse
zoneidThe availability zone IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVnfTemplates.html b/static/api/apidocs-4.23/apis/listVnfTemplates.html new file mode 100644 index 0000000000..ff84e1bb0c --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVnfTemplates.html @@ -0,0 +1,330 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVnfTemplates

+

List all public, private, and privileged VNF templates.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
templatefilterPossible 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 Instance. * 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 an Instance. * community : Templates that have been marked as public but not featured. * all : all Templates (only usable by admins).true
accountList resources by Account. Must be used with the domainId parameter.false
archthe CPU arch of the template. Valid options are: x86_64, aarch64, s390xfalse
detailsComma separated list of Template details requested, value can be a list of [all, min]false
domainidList only resources belonging to the domain specifiedfalse
extensionidID of the extension for the templatefalse
forckslist templates that can be used to deploy CKS clustersfalse
hypervisorThe hypervisor for which to restrict the searchfalse
idThe Template IDfalse
idsThe IDs of the Templates, mutually exclusive with idfalse
isreadylist templates that are ready to be deployedfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
isvnfflag to list VNF templates or not; true if need to list VNF templates, false otherwise.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameThe Template namefalse
oscategoryidthe ID of the OS category for the templatefalse
pagefalse
pagesizefalse
parenttemplateidList datadisk Templates by parent Template idfalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
showiconFlag to display the resource image for the Templatesfalse
showremovedShow removed Templates as wellfalse
showuniqueIf set to true, list only unique Templates across zonesfalse
tagsList resources by tags (key/value pairs)false
templatetypethe type of the templatefalse
zoneidList Templates by zoneIdfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe Account name to which the Template belongs
accountidThe Account id to which the Template belongs
archCPU Arch of the template
bitsThe processor bit size
bootableTrue if the ISO is bootable, false otherwise
checksumChecksum of the Template
childtemplatesIf root disk Template, then IDs of the datas disk Templates this Template owns
createdThe date this Template was created
crossZonesTrue if the Template is managed across all Zones, false otherwise
deployasisVMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is Template
detailsAdditional key/value details tied with Template
directdownloadKVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextThe Template display text
domainThe name of the domain to which the Template belongs
domainidThe ID of the domain to which the Template belongs
domainpathPath of the Domain the template belongs to
downloaddetailsLists the download progress of a Template across all secondary storages
extensionidThe ID of extension linked to this template
extensionnameThe name of extension linked to this template
forcksIf true it indicates that the template can be used for CKS cluster deployments
formatThe format of the Template.
hostidThe ID of the secondary storage host for the Template
hostnameThe name of the secondary storage host for the Template
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
isextractableTrue if the Template is extractable, false otherwise
isfeaturedTrue if this Template is a featured Template, false otherwise
ispublicTrue if this Template is a public Template, false otherwise
isreadyTrue if the Template is ready to be deployed from, false otherwise.
nameThe Template name
ostypeidThe ID of the OS type for this Template.
ostypenameThe name of the OS type for this Template.
parenttemplateidIf Datadisk Template, then id of the root disk Template this Template belongs to
passwordenabledTrue if the reset password feature is enabled, false otherwise
physicalsizeThe physical size of the Template
projectThe project name of the Template
projectidThe project ID of the Template
removedThe date this Template was removed
requireshvmTrue if Template requires HVM enabled, false otherwise
sizeThe size of the Template
sourcetemplateidThe Template ID of the parent Template if present
sshkeyenabledTrue if Template is sshkey enabled, false otherwise
statusThe status of the Template
templatetagThe tag of this Template
templatetypeThe type of the Template
urlThe URL which the Template/ISO is registered from
userdataidThe id of userdata linked to this Template
userdatanameThe name of userdata linked to this Template
userdataparamsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
zoneidThe ID of the zone for this Template
zonenameThe name of the zone for this Template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVolumes.html b/static/api/apidocs-4.23/apis/listVolumes.html new file mode 100644 index 0000000000..b03b67e32e --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVolumes.html @@ -0,0 +1,381 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVolumes

+

Lists all volumes.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
clusteridThe cluster ID the disk volume belongs tofalse
diskofferingidList volumes by disk offeringfalse
displayvolumeList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
domainidList only resources belonging to the domain specifiedfalse
hostidList volumes on specified hostfalse
idThe ID of the disk volumefalse
idsThe IDs of the volumes, mutually exclusive with idfalse
isencryptedlist only volumes that are encryptedfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
kmskeyidList volumes by KMS Keyfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
listsystemvmsList system VMs; only ROOT admin is eligible to pass this parameterfalse
nameThe name of the disk volumefalse
pagefalse
pagesizefalse
podidThe pod ID the disk volume belongs tofalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
retrieveonlyresourcecountMakes the API's response contains only the resource countfalse
serviceofferingidList volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignoredfalse
stateState of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.false
storageidThe ID of the storage pool, available to ROOT admin onlyfalse
tagsList resources by tags (key/value pairs)false
typeThe type of disk volumefalse
virtualmachineidThe ID of the Instancefalse
zoneidThe ID of the availability zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the disk volume
accountThe Account associated with the disk volume
attachedThe date the volume was attached to an Instance
chaininfoThe chain info of the volume
clusteridCluster id of the volume
clusternameCluster name where the volume is allocated
createdThe date the disk volume was created
deleteprotectiontrue if volume has delete protection.
destroyedThe boolean state of whether the volume is destroyed or not
deviceidThe ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
diskBytesReadRateBytes read rate of the disk volume
diskBytesWriteRateBytes write rate of the disk volume
diskIopsReadRateIO requests read rate of the disk volume per the disk offering
diskIopsWriteRateIO requests write rate of the disk volume per the disk offering
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingdisplaytextThe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnameName of the disk offering
displayvolumeAn optional field whether to the display the volume to the end User or not.
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathpath of the Domain the disk volume belongs to
encryptformatthe format of the disk encryption if applicable
externaluuidVolume UUID that is given by virtualisation provider (only for VMware)
hypervisorHypervisor the volume belongs to
isextractableTrue if the volume is extractable, false otherwise
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isonameThe name of the ISO attached to the Instance
kmskeyKMS key name of the volume
kmskeyidKMS key id of the volume
kmskeyversionVersion number of the KMS key used for disk encryption if applicable
maxiopsMax IOPS of the disk volume
miniopsMin IOPS of the disk volume
nameName of the disk volume
pathThe path of the volume
physicalsizeThe bytes actually consumed on disk
podidPod id of the volume
podnamePod name of the volume
projectThe project name of the VPN
projectidThe project id of the VPN
provisioningtypeProvisioning type used to create volumes.
quiescevmNeed quiesce Instance or not when taking Snapshot
serviceofferingdisplaytextThe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnameName of the service offering for root disk
sizeSize of the disk volume
snapshotidID of the Snapshot from which this volume was created
stateThe state of the disk volume
statusThe status of the volume
storageName of the primary storage hosting the disk volume
storageidID of the primary storage hosting the disk volume; returned to admin User only
storagetypeShared or local storage
supportsstoragesnapshotTrue if storage Snapshot is supported for the volume, false otherwise
templatedisplaytextAn alternate display text of the Template for the Instance
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
typeType of the disk volume (ROOT or DATADISK)
utilizationThe disk utilization
virtualmachineidID of the Instance
virtualsizeThe bytes allocated
vmdisplaynameDisplay name of the Instance
vmnameName of the Instance
vmstateState of the Instance
vmtypeType of the Instance
volumecheckresultdetails for the volume check result, they may vary for different hypervisors
volumerepairresultdetails for the volume repair result, they may vary for different hypervisors
zoneidID of the availability zone
zonenameName of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVolumesForImport.html b/static/api/apidocs-4.23/apis/listVolumesForImport.html new file mode 100644 index 0000000000..56367934fd --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVolumesForImport.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVolumesForImport

+

Lists unmanaged volumes on a storage pool

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
storageidthe ID of the storage pooltrue
keywordList by keywordfalse
pagefalse
pagesizefalse
paththe path of the volume on the storage poolfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
chaininfothe chain info of the volume
detailsvolume details in key/value pairs.
encryptformatthe encrypt format of the volume
formatthe format of the volume
fullpaththe full path of the volume
namethe name of the volume
paththe path of the volume
sizethe size of the volume
storagename of the primary storage hosting the volume
storageidid of the primary storage hosting the volume
storagetypetype of the primary storage hosting the volume
virtualsizethe virtual size of the volume
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVolumesMetrics.html b/static/api/apidocs-4.23/apis/listVolumesMetrics.html new file mode 100644 index 0000000000..b219bc3ba8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVolumesMetrics.html @@ -0,0 +1,165 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVolumesMetrics

+

Lists volume metrics

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
clusteridThe cluster ID the disk volume belongs tofalse
diskofferingidList volumes by disk offeringfalse
displayvolumeList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
domainidList only resources belonging to the domain specifiedfalse
hostidList volumes on specified hostfalse
idThe ID of the disk volumefalse
idsThe IDs of the volumes, mutually exclusive with idfalse
isencryptedlist only volumes that are encryptedfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
kmskeyidList volumes by KMS Keyfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
listsystemvmsList system VMs; only ROOT admin is eligible to pass this parameterfalse
nameThe name of the disk volumefalse
pagefalse
pagesizefalse
podidThe pod ID the disk volume belongs tofalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
retrieveonlyresourcecountMakes the API's response contains only the resource countfalse
serviceofferingidList volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignoredfalse
stateState of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.false
storageidThe ID of the storage pool, available to ROOT admin onlyfalse
tagsList resources by tags (key/value pairs)false
typeThe type of disk volumefalse
virtualmachineidThe ID of the Instancefalse
zoneidThe ID of the availability zonefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
diskiopstotalThe total disk iops
sizegbDisk size in GiB
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVolumesUsageHistory.html b/static/api/apidocs-4.23/apis/listVolumesUsageHistory.html new file mode 100644 index 0000000000..4ea7b5fb7c --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVolumesUsageHistory.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVolumesUsageHistory

+

Lists volume stats

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enddateEnd date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")false
idThe ID of the volume.false
idsthe IDs of the Volumes, mutually exclusive with id.false
keywordList by keywordfalse
nameName of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).false
pagefalse
pagesizefalse
startdateStart date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")false
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
idThe ID of the volume
nameThe name of the volume
statsThe list of VM stats
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVpnConnections.html b/static/api/apidocs-4.23/apis/listVpnConnections.html new file mode 100644 index 0000000000..cc80c3b89b --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVpnConnections.html @@ -0,0 +1,189 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVpnConnections

+

Lists site to site VPN connection gateways

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idID of the VPN connectionfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
vpcidID of VPCfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe connection ID
accountThe owner
cidrlistGuest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).
createdThe date and time the host was created
domainThe domain name of the owner
domainidThe domain id of the owner
domainpaththe domain path of the owner
dpdIf DPD is enabled for customer gateway
esplifetimeLifetime of ESP SA of customer gateway
esppolicyESP policy of the customer gateway
forceencapIf Force NAT Encapsulation is enabled for customer gateway
fordisplayIs connection for display to the regular user
gatewayPublic IP address id of the customer gateway
ikelifetimeLifetime of IKE SA of customer gateway
ikepolicyIKE policy of the customer gateway
ikeversionWhich IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike
ipsecpskIPsec Preshared-Key of the customer gateway
passiveState of VPN connection
projectThe project name
projectidThe project id
publicipThe public IP address
removedThe date and time the host was removed
s2scustomergatewayidThe customer gateway ID
s2svpngatewayidThe VPN gateway ID
splitconnectionsSplit multiple remote Networks into multiple phase 2 SAs. Often used with Cisco some products.
stateState of VPN connection
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVpnCustomerGateways.html b/static/api/apidocs-4.23/apis/listVpnCustomerGateways.html new file mode 100644 index 0000000000..96b7110fe6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVpnCustomerGateways.html @@ -0,0 +1,174 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVpnCustomerGateways

+

Lists site to site VPN customer gateways

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idID of the customer gatewayfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe VPN gateway ID
accountThe owner
cidrlistGuest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).
domainThe domain name of the owner
domainidThe domain ID of the owner
domainpathThe domain path of the owner
dpdIf DPD is enabled for customer gateway
esplifetimeLifetime of ESP SA of customer gateway
esppolicyIPsec policy of customer gateway
excludedparametersContains the list of excluded/not allowed cryptographic parameters that the vpn customer gateway is using.
forceencapIf Force NAT Encapsulation is enabled for customer gateway
gatewayPublic IP address ID of the customer gateway
ikelifetimeLifetime of IKE SA of customer gateway
ikepolicyIKE policy of customer gateway
ikeversionWhich IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike
ipaddressGuest IP of the customer gateway
ipsecpskIPsec preshared-key of customer gateway
nameName of the customer gateway
obsoleteparametersContains the list of obsolete/insecure cryptographic parameters that the vpn customer gateway is using.
projectThe project name
projectidThe project ID
removedThe date and time the host was removed
splitconnectionsFor IKEv2, whether to split multiple right subnet CIDRs into multiple connection statements.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVpnGateways.html b/static/api/apidocs-4.23/apis/listVpnGateways.html new file mode 100644 index 0000000000..f07b97487b --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVpnGateways.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVpnGateways

+

Lists site 2 site VPN gateways

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
fordisplayList resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idID of the VPN gatewayfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
vpcidID of VPC false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe VPN gateway ID
accountThe owner
domainThe domain name of the owner
domainidThe domain id of the owner
domainpaththe domain path of the owner
fordisplayIs VPN gateway for display to the regular user
projectThe project name
projectidThe project id
publicipThe public IP address
removedThe date and time the host was removed
vpcidThe VPC id of this gateway
vpcnameThe VPC name of this gateway
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVpnUsers.html b/static/api/apidocs-4.23/apis/listVpnUsers.html new file mode 100644 index 0000000000..7dd7d1304c --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVpnUsers.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVpnUsers

+

Lists VPN Users

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idThe UUID of the VPN Userfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
usernameThe username of the VPN User.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe VPN user ID
accountThe Account of the remote access VPN
domainThe domain name of the Account of the remote access VPN
domainidThe domain ID of the Account of the remote access VPN
domainpathPath of the domain to which the remote access VPN belongs
projectThe project name of the VPN
projectidThe project ID of the VPN
stateThe state of the VPN User, can be 'Add', 'Revoke' or 'Active'.
usernameThe username of the VPN user
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVsphereStoragePolicies.html b/static/api/apidocs-4.23/apis/listVsphereStoragePolicies.html new file mode 100644 index 0000000000..e6ca04d923 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVsphereStoragePolicies.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVsphereStoragePolicies

+

List vSphere storage policies

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
zoneidID of the zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Storage Policy
descriptionThe description of the Storage Policy
nameThe name of the Storage Policy
policyidThe identifier of the Storage Policy in vSphere DataCenter
zoneidThe ID of the Zone
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listVsphereStoragePolicyCompatiblePools.html b/static/api/apidocs-4.23/apis/listVsphereStoragePolicyCompatiblePools.html new file mode 100644 index 0000000000..9ede037719 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listVsphereStoragePolicyCompatiblePools.html @@ -0,0 +1,198 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listVsphereStoragePolicyCompatiblePools

+

List storage pools compatible with a vSphere storage policy

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
policyidID of the storage policyfalse
zoneidID of the zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the storage pool
allocatediopsTotal min IOPS currently in use by volumes
capacitybytesbytes CloudStack can provision from this storage pool
capacityiopsIOPS CloudStack can provision from this storage pool
clusteridThe ID of the cluster for the storage pool
clusternameThe name of the cluster for the storage pool
createdThe date and time the storage pool was created
detailsthe storage pool details
disksizeallocatedThe pool's currently allocated disk size
disksizetotalThe total disk size of the storage pool
disksizeusedThe pool's currently used disk size
hypervisorThe hypervisor type of the storage pool
ipaddressThe IP address of the storage pool
istagaruleWhether the informed tag is a JS interpretable rule or not.
managedwhether this pool is managed or not
nameThe name of the storage pool
nfsmountoptsthe nfs mount options for the storage pool
overprovisionfactorThe overprovisionfactor for the storage pool
pathThe storage pool path
podidThe Pod ID of the storage pool
podnameThe Pod name of the storage pool
providerStorage provider for this pool
scopeThe scope of the storage pool
stateThe state of the storage pool
storageaccessgroupsthe storage access groups for the storage pool
storagecapabilitiesThe storage pool capabilities
storagecustomstatsthe storage pool custom stats
suitableformigrationTrue if this pool is suitable to migrate a volume, false otherwise
tagsThe tags for the storage pool
typeThe storage pool type
usediopstotal IOPS currently in use
zoneidThe Zone ID of the storage pool
zonenameThe Zone name of the storage pool
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listWebhookDeliveries.html b/static/api/apidocs-4.23/apis/listWebhookDeliveries.html new file mode 100644 index 0000000000..b76f287313 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listWebhookDeliveries.html @@ -0,0 +1,150 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listWebhookDeliveries

+

Lists Webhook deliveries

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enddateThe 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
eventtypeThe event type of the Webhook deliveryfalse
idThe ID of the Webhook deliveryfalse
keywordList by keywordfalse
managementserveridThe ID of the management serverfalse
pagefalse
pagesizefalse
startdateThe 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
webhookidThe ID of the Webhookfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Webhook
accountThe account associated with the Webhook
createdThe date when this Webhook was created
descriptionThe description of the Webhook
domainThe name of the domain in which the Webhook exists
domainidThe ID of the domain in which the Webhook exists
domainpathpath of the domain to which the Webhook belongs
nameThe name of the Webhook
payloadurlThe payload URL end point for the Webhook
projectthe project name of the Kubernetes cluster
projectidthe project id of the Kubernetes cluster
scopeThe scope of the Webhook
secretkeyThe secret key for the Webhook
sslverificationWhether SSL verification is enabled for the Webhook
stateThe state of the Webhook
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listWebhookFilters.html b/static/api/apidocs-4.23/apis/listWebhookFilters.html new file mode 100644 index 0000000000..1c0e7ab21f --- /dev/null +++ b/static/api/apidocs-4.23/apis/listWebhookFilters.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listWebhookFilters

+

Lists Webhook filters

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Webhook deliveryfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
webhookidThe ID of the Webhookfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Webhook filter
createdThe type of the Webhook filter
matchtypeThe type of the Webhook filter
modeThe type of the Webhook filter
typeThe type of the Webhook filter
valueThe type of the Webhook filter
webhookidThe ID of the Webhook
webhooknameThe name of the Webhook
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listWebhooks.html b/static/api/apidocs-4.23/apis/listWebhooks.html new file mode 100644 index 0000000000..f9405683f4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listWebhooks.html @@ -0,0 +1,159 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listWebhooks

+

Lists Webhooks

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
idThe ID of the Webhookfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameThe name of the Webhookfalse
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
scopeThe scope of the Webhookfalse
stateThe state of the Webhookfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Webhook
accountThe account associated with the Webhook
createdThe date when this Webhook was created
descriptionThe description of the Webhook
domainThe name of the domain in which the Webhook exists
domainidThe ID of the domain in which the Webhook exists
domainpathpath of the domain to which the Webhook belongs
nameThe name of the Webhook
payloadurlThe payload URL end point for the Webhook
projectthe project name of the Kubernetes cluster
projectidthe project id of the Kubernetes cluster
scopeThe scope of the Webhook
secretkeyThe secret key for the Webhook
sslverificationWhether SSL verification is enabled for the Webhook
stateThe state of the Webhook
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listZones.html b/static/api/apidocs-4.23/apis/listZones.html new file mode 100644 index 0000000000..f25eef500f --- /dev/null +++ b/static/api/apidocs-4.23/apis/listZones.html @@ -0,0 +1,297 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listZones

+

Lists zones

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
availableTrue if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one Instance. Default is false.false
domainidThe ID of the domain associated with the zonefalse
idThe ID of the zonefalse
idsthe IDs of the zones, mutually exclusive with idfalse
keywordList by keywordfalse
nameThe name of the zonefalse
networktypeThe Network type of the zone that the Instance belongs tofalse
pagefalse
pagesizefalse
showcapacitiesFlag to display the capacity of the zonesfalse
showiconFlag to display the resource image for the zonesfalse
storageaccessgroupthe name of the storage access groupfalse
tagsList zones by resource tags (key/value pairs)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idZone id
allocationstateThe allocation state of the cluster
allowuserspecifyvrmtuAllow end users to specify VR MTU
asnrangeAS Number Range
descriptionZone description
dhcpproviderThe DHCP Provider for the Zone
displaytextThe display text of the zone
dns1The first DNS for the Zone
dns2The second DNS for the Zone
domainNetwork domain name for the Networks in the zone
domainidThe UUID of the containing domain, null for public zones
domainnameThe name of the containing domain, null for public zones
gputotalTotal GPUs in the Zone
gpuusedUsed GPUs in the Zone
guestcidraddressThe guest CIDR address for the Zone
iconBase64 string representation of the resource icon
internaldns1The first internal DNS for the Zone
internaldns2The second internal DNS for the Zone
ip6dns1The first IPv6 DNS for the Zone
ip6dns2The second IPv6 DNS for the Zone
ismultiarchTrue, if zone contains clusters and hosts from different CPU architectures
isnsxenabledTrue, if zone is NSX enabled
localstorageenabledTrue if local storage offering enabled, false otherwise
nameZone name
networktypeThe Network type of the zone; can be Basic or Advanced
providerExternal network provider if any
resourcedetailsMeta data associated with the zone (key/value pairs)
routedmodeenabledTrue, if routed Network/VPC is enabled
routerprivateinterfacemaxmtuThe maximum value the MTU can have on the VR's private interfaces
routerpublicinterfacemaxmtuThe maximum value the MTU can have on the VR's public interfaces
securitygroupsenabledTrue if security groups support is enabled, false otherwise
storageaccessgroupscomma-separated list of storage access groups for the zone
typeThe type of the zone - core or edge
zonetokenZone Token
capacity(*)The capacity of the Zone
capacityallocatedThe capacity currently in allocated
capacitytotalThe total capacity available
capacityusedThe capacity currently in use
clusteridThe Cluster ID
clusternameThe Cluster name
nameThe capacity name
percentusedThe percentage of capacity currently in use
podidThe Pod ID
podnameThe Pod name
tagThe tag for the capacity type
typeThe capacity type
zoneidThe Zone ID
zonenameThe Zone name
tags(*)The list of resource tags associated with zone.
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/listZonesMetrics.html b/static/api/apidocs-4.23/apis/listZonesMetrics.html new file mode 100644 index 0000000000..2f0ad2f3f6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/listZonesMetrics.html @@ -0,0 +1,171 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

listZonesMetrics

+

Lists zone metrics

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
availableTrue if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one Instance. Default is false.false
domainidThe ID of the domain associated with the zonefalse
idThe ID of the zonefalse
idsthe IDs of the zones, mutually exclusive with idfalse
keywordList by keywordfalse
nameThe name of the zonefalse
networktypeThe Network type of the zone that the Instance belongs tofalse
pagefalse
pagesizefalse
showcapacitiesFlag to display the capacity of the zonesfalse
showiconFlag to display the resource image for the zonesfalse
storageaccessgroupthe name of the storage access groupfalse
tagsList zones by resource tags (key/value pairs)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
clustersHealthy / total clusters in the zone
cpuallocatedThe total cpu allocated in Ghz
cpuallocateddisablethresholdCPU allocated disable threshold exceeded
cpuallocatedthresholdCPU allocated notification threshold exceeded
cpudisablethresholdCPU usage disable threshold exceeded
cpumaxdeviationThe maximum cpu deviation
cputhresholdCPU usage notification threshold exceeded
cputotalThe total cpu capacity in Ghz
cpuusedThe total cpu used in Ghz
memoryallocatedThe total cpu allocated in GiB
memoryallocateddisablethresholdMemory allocated disable threshold exceeded
memoryallocatedthresholdMemory allocated notification threshold exceeded
memorydisablethresholdMemory usage disable threshold exceeded
memorymaxdeviationThe maximum memory deviation
memorythresholdMemory usage notification threshold exceeded
memorytotalThe total cpu capacity in GiB
memoryusedThe total cpu used in GiB
stateState of the cluster
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/lockAccount.html b/static/api/apidocs-4.23/apis/lockAccount.html new file mode 100644 index 0000000000..14c454bf01 --- /dev/null +++ b/static/api/apidocs-4.23/apis/lockAccount.html @@ -0,0 +1,387 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

lockAccount

+

This deprecated function used to lock an Account. Look for the API DisableAccount instead

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
accountLocks the specified account.true
domainidLocks the specified Account on this domain.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Account
accountdetailsDetails for the account
accounttypeAccount type (admin, domain-admin, user)
apikeyaccesswhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
backupavailablethe total number of backups available to this account
backuplimitthe total number of backups which can be stored by this account
backupstorageavailablethe total backup storage space (in GiB) available to the account
backupstoragelimitthe total backup storage space (in GiB) the account can own
backupstoragetotalthe total backup storage space (in GiB) owned by the account
backuptotalthe total number of backups stored by this account
bucketavailablethe total number of buckets available to this account
bucketlimitthe total number of buckets which can be stored by this account
buckettotalthe total number of buckets stored by this account
cpuavailableThe total number of CPU cores available to be created for this account
cpulimitThe total number of CPU cores the account can own
cputotalThe total number of CPU cores owned by account
createdThe date when this account was created
defaultzoneidThe default zone of the Account
domainName of the Domain the Account belongs to
domainidID of the Domain the Account belongs to
domainpathPath of the Domain the Account belongs to
gpuavailablethe total number of gpus available to be created for this account
gpulimitthe total number of gpus the account can own
gputotalthe total number of gpus owned by account
groupsThe list of ACL groups that account belongs to
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this Account to acquire
iplimitThe total number of public IP addresses this Account can acquire
iptotalThe total number of public IP addresses allocated for this Account
iscleanuprequiredTrue if the account requires cleanup
isdefaultTrue if account is default, false otherwise
memoryavailableThe total memory (in MB) available to be created for this account
memorylimitThe total memory (in MB) the account can own
memorytotalThe total memory (in MB) owned by account
nameThe name of the Account
networkavailableThe total number of Networks available to be created for this Account
networkdomainThe Network domain
networklimitThe total number of Networks the Account can own
networktotalThe total number of Networks owned by Account
objectstorageavailablethe total object storage space (in GiB) available to the account
objectstoragelimitthe total object storage space (in GiB) the account can own
objectstoragetotalthe total object storage space (in GiB) owned by the account
primarystorageavailableThe total primary storage space (in GiB) available to be used for this account
primarystoragelimitThe total primary storage space (in GiB) the account can own
primarystoragetotalThe total primary storage space (in GiB) owned by account
projectavailableThe total number of projects available for administration by this Account
projectlimitThe total number of projects the Account can own
projecttotalThe total number of projects being administrated by this Account
receivedbytesThe total number of Network traffic bytes received
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role (Admin, ResourceAdmin, DomainAdmin, User)
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this account
secondarystoragelimitThe total secondary storage space (in GiB) the account can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by account
sentbytesThe total number of Network traffic bytes sent
snapshotavailableThe total number of Snapshots available for this Account
snapshotlimitThe total number of Snapshots which can be stored by this Account
snapshottotalThe total number of Snapshots stored by this Account
stateThe state of the account
taggedresourcesThe tagged resource limit and count for the account
templateavailableThe total number of Templates available to be created by this Account
templatelimitThe total number of Templates which can be created by this Account
templatetotalThe total number of Templates which have been created by this Account
vmavailableThe total number of Instances available for this Account to acquire
vmlimitThe total number of Instances that can be deployed by this Account
vmrunningThe total number of Instances running for this Account
vmstoppedThe total number of Instances stopped for this Account
vmtotalThe total number of Instances deployed by this Account
volumeavailableThe total volume available for this Account
volumelimitThe total volume which can be used by this Account
volumetotalThe total volume being used by this Account
vpcavailableThe total number of VPCs available to be created for this account
vpclimitThe total number of VPCs the Account can own
vpctotalThe total number of VPCs owned by account
user(*)The list of users associated with account
idThe user ID
accountThe Account name of the user
accountidThe Account ID of the user
accounttypeThe Account type of the user
apikeyThe API key of the user
apikeyaccessWhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
createdThe date and time the user Account was created
domainThe domain name of the user
domainidThe domain ID of the user
emailThe user email address
firstnameThe user firstname
iconBase64 string representation of the resource icon
is2faenabledTrue if user has two factor authentication enabled
is2famandatedTrue if user has two factor authentication is mandated
iscallerchilddomainThe boolean value representing if the updating target is in caller's child domain
isdefaultTrue if user is default, false otherwise
lastnameThe user lastname
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role
secretkeyThe secret key of the user
stateThe user state
timezoneThe timezone user was created in
usernameThe user name
usersourceThe source type of the user in lowercase, such as native, ldap, saml2
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/lockUser.html b/static/api/apidocs-4.23/apis/lockUser.html new file mode 100644 index 0000000000..c6140c540b --- /dev/null +++ b/static/api/apidocs-4.23/apis/lockUser.html @@ -0,0 +1,156 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

lockUser

+

Locks a user account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idLocks user by user ID.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe user ID
accountThe Account name of the user
accountidThe Account ID of the user
accounttypeThe Account type of the user
apikeyThe API key of the user
apikeyaccessWhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
createdThe date and time the user Account was created
domainThe domain name of the user
domainidThe domain ID of the user
emailThe user email address
firstnameThe user firstname
iconBase64 string representation of the resource icon
is2faenabledTrue if user has two factor authentication enabled
is2famandatedTrue if user has two factor authentication is mandated
iscallerchilddomainThe boolean value representing if the updating target is in caller's child domain
isdefaultTrue if user is default, false otherwise
lastnameThe user lastname
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role
secretkeyThe secret key of the user
stateThe user state
timezoneThe timezone user was created in
usernameThe user name
usersourceThe source type of the user in lowercase, such as native, ldap, saml2
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/login.html b/static/api/apidocs-4.23/apis/login.html new file mode 100644 index 0000000000..283542af55 --- /dev/null +++ b/static/api/apidocs-4.23/apis/login.html @@ -0,0 +1,144 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

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.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
passwordHashed 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
usernameUsernametrue
domainPath 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
domainIdThe id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precedence.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account name the User belongs to
domainidDomain ID that the user belongs to
firstnameFirst name of the user
is2faenabledIs two factor authentication enabled
is2faverifiedIs two factor authentication verified
issuerfor2faTwo factor authentication issuer
lastnameLast name of the user
managementserveridManagement Server ID that the user logged to
passwordchangerequiredIndicates whether the User is required to change password on next login.
providerfor2faTwo factor authentication provider
registeredIs user registered
sessionkeySession key that can be passed in subsequent Query command calls
timeoutThe time period before the session has expired
timezoneUser time zone
timezoneoffsetUser time zoneoffset
typeThe Account type (admin, domain-admin, read-only-admin, user)
useridUser ID
usernameUsername
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/logout.html b/static/api/apidocs-4.23/apis/logout.html new file mode 100644 index 0000000000..e3235b7a26 --- /dev/null +++ b/static/api/apidocs-4.23/apis/logout.html @@ -0,0 +1,81 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

logout

+

Logs out the user

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
descriptionResponse description
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/manageGpuDevice.html b/static/api/apidocs-4.23/apis/manageGpuDevice.html new file mode 100644 index 0000000000..6d0ab5ab4f --- /dev/null +++ b/static/api/apidocs-4.23/apis/manageGpuDevice.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

manageGpuDevice

+

Manages a GPU device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idscomma separated list of IDs of the GPU devicetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/markDefaultZoneForAccount.html b/static/api/apidocs-4.23/apis/markDefaultZoneForAccount.html new file mode 100644 index 0000000000..7836f63008 --- /dev/null +++ b/static/api/apidocs-4.23/apis/markDefaultZoneForAccount.html @@ -0,0 +1,390 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

markDefaultZoneForAccount

+

Marks a default zone for this account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountName of the account that is to be marked.true
domainidMarks the account that belongs to the specified domain.true
zoneidThe Zone ID with which the account is to be marked.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Account
accountdetailsDetails for the account
accounttypeAccount type (admin, domain-admin, user)
apikeyaccesswhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
backupavailablethe total number of backups available to this account
backuplimitthe total number of backups which can be stored by this account
backupstorageavailablethe total backup storage space (in GiB) available to the account
backupstoragelimitthe total backup storage space (in GiB) the account can own
backupstoragetotalthe total backup storage space (in GiB) owned by the account
backuptotalthe total number of backups stored by this account
bucketavailablethe total number of buckets available to this account
bucketlimitthe total number of buckets which can be stored by this account
buckettotalthe total number of buckets stored by this account
cpuavailableThe total number of CPU cores available to be created for this account
cpulimitThe total number of CPU cores the account can own
cputotalThe total number of CPU cores owned by account
createdThe date when this account was created
defaultzoneidThe default zone of the Account
domainName of the Domain the Account belongs to
domainidID of the Domain the Account belongs to
domainpathPath of the Domain the Account belongs to
gpuavailablethe total number of gpus available to be created for this account
gpulimitthe total number of gpus the account can own
gputotalthe total number of gpus owned by account
groupsThe list of ACL groups that account belongs to
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this Account to acquire
iplimitThe total number of public IP addresses this Account can acquire
iptotalThe total number of public IP addresses allocated for this Account
iscleanuprequiredTrue if the account requires cleanup
isdefaultTrue if account is default, false otherwise
memoryavailableThe total memory (in MB) available to be created for this account
memorylimitThe total memory (in MB) the account can own
memorytotalThe total memory (in MB) owned by account
nameThe name of the Account
networkavailableThe total number of Networks available to be created for this Account
networkdomainThe Network domain
networklimitThe total number of Networks the Account can own
networktotalThe total number of Networks owned by Account
objectstorageavailablethe total object storage space (in GiB) available to the account
objectstoragelimitthe total object storage space (in GiB) the account can own
objectstoragetotalthe total object storage space (in GiB) owned by the account
primarystorageavailableThe total primary storage space (in GiB) available to be used for this account
primarystoragelimitThe total primary storage space (in GiB) the account can own
primarystoragetotalThe total primary storage space (in GiB) owned by account
projectavailableThe total number of projects available for administration by this Account
projectlimitThe total number of projects the Account can own
projecttotalThe total number of projects being administrated by this Account
receivedbytesThe total number of Network traffic bytes received
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role (Admin, ResourceAdmin, DomainAdmin, User)
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this account
secondarystoragelimitThe total secondary storage space (in GiB) the account can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by account
sentbytesThe total number of Network traffic bytes sent
snapshotavailableThe total number of Snapshots available for this Account
snapshotlimitThe total number of Snapshots which can be stored by this Account
snapshottotalThe total number of Snapshots stored by this Account
stateThe state of the account
taggedresourcesThe tagged resource limit and count for the account
templateavailableThe total number of Templates available to be created by this Account
templatelimitThe total number of Templates which can be created by this Account
templatetotalThe total number of Templates which have been created by this Account
vmavailableThe total number of Instances available for this Account to acquire
vmlimitThe total number of Instances that can be deployed by this Account
vmrunningThe total number of Instances running for this Account
vmstoppedThe total number of Instances stopped for this Account
vmtotalThe total number of Instances deployed by this Account
volumeavailableThe total volume available for this Account
volumelimitThe total volume which can be used by this Account
volumetotalThe total volume being used by this Account
vpcavailableThe total number of VPCs available to be created for this account
vpclimitThe total number of VPCs the Account can own
vpctotalThe total number of VPCs owned by account
user(*)The list of users associated with account
idThe user ID
accountThe Account name of the user
accountidThe Account ID of the user
accounttypeThe Account type of the user
apikeyThe API key of the user
apikeyaccessWhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
createdThe date and time the user Account was created
domainThe domain name of the user
domainidThe domain ID of the user
emailThe user email address
firstnameThe user firstname
iconBase64 string representation of the resource icon
is2faenabledTrue if user has two factor authentication enabled
is2famandatedTrue if user has two factor authentication is mandated
iscallerchilddomainThe boolean value representing if the updating target is in caller's child domain
isdefaultTrue if user is default, false otherwise
lastnameThe user lastname
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role
secretkeyThe secret key of the user
stateThe user state
timezoneThe timezone user was created in
usernameThe user name
usersourceThe source type of the user in lowercase, such as native, ldap, saml2
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/migrateNetwork.html b/static/api/apidocs-4.23/apis/migrateNetwork.html new file mode 100644 index 0000000000..316400afb2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/migrateNetwork.html @@ -0,0 +1,390 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

migrateNetwork

+

Moves a network to another physical network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
networkidThe ID of the networktrue
networkofferingidNetwork offering IDtrue
resumeTrue if previous network migration cmd failedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Network
accountThe owner of the Network
aclidACL ID associated with the VPC Network
aclnameACL name associated with the VPC Network
acltypeACL type - access type to the Network
asnumberAS NUMBER
asnumberidUUID of AS NUMBER
bgppeersThe BGP peers for the network
broadcastdomaintypeBroadcast domain type of the Network
broadcasturiBroadcast URI of the Network. This parameter is visible to ROOT admins only
canusefordeployList Networks available for Instance deployment
cidrCloudStack managed address space, all CloudStack managed Instances get IP address from CIDR
createdThe date this Network was created
detailsThe details of the Network
displaynetworkAn optional field, whether to the display the Network to the end user or not.
displaytextThe displaytext of the Network
dns1The first IPv4 DNS for the Network
dns2The second IPv4 DNS for the Network
dnssubdomainDNS subdomain associated to the network
dnszoneDNS zone associated to the network
domainThe domain name of the Network owner
domainidThe domain ID of the Network owner
domainpathPath of the Domain the network belongs to
egressdefaultpolicyTrue if guest Network default egress policy is allow; false if default egress policy is deny
externalidThe external ID of the Network
gatewayThe Network's gateway
iconBase64 string representation of the resource icon
internetprotocolThe internet protocol of Network offering
ip4routesThe routes for the network to ease adding route in upstream router
ip4routingThe IPv4 routing type of network
ip6cidrThe CIDR of IPv6 Network
ip6dns1The first IPv6 DNS for the network
ip6dns2The second IPv6 DNS for the network
ip6gatewayThe gateway of IPv6 Network
ip6routesThe routes for the Network to ease adding route in upstream router
ip6routingThe IPv6 routing type of network offering
isdefaultTrue if Network is default, false otherwise
ispersistentList Networks that are persistent
issystemTrue if Network is system, false otherwise
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.
nameThe name of the Network
netmaskThe Network's netmask
networkcidrThe Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE
networkdomainThe Network domain
networkofferingavailabilityAvailability of the Network offering the Network is created from
networkofferingconservemodeTrue if Network offering is IP conserve mode enabled
networkofferingdisplaytextDisplay text of the Network offering the Network is created from
networkofferingidNetwork offering ID the Network is created from
networkofferingnameName of the Network offering the Network is created from
physicalnetworkidThe physical Network id
privatemtuMTU configured on the network VR's private interfaces
projectThe project name of the address
projectidThe project ID of the IP address
publicmtuMTU configured on the Network VR's public facing interfaces
receivedbytesThe total number of Network traffic bytes received
redundantrouterIf the Network has redundant routers enabled
relatedRelated to what other Network configuration
reservediprangeThe Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes
restartrequiredTrue if Network requires restart
sentbytesThe total number of Network traffic bytes sent
specifyiprangesTrue if Network supports specifying IP ranges, false otherwise
specifyvlanTrue if network supports specifying vlan, false otherwise
stateState of the Network
strechedl2subnetTrue if Network can span multiple zones
subdomainaccessTrue if users from subdomains can access the domain level Network
supportsvmautoscalingIf Network offering supports Instance autoscaling feature
traffictypeThe traffic type of the Network
tungstenvirtualrouteruuidTungsten-Fabric virtual router the Network belongs to
typeThe type of the Network
vlanThe VLAN of the Network. This parameter is visible to ROOT admins only
vpcidVPC the Network belongs to
vpcnameName of the VPC to which this Network belongs
zoneidZone ID of the Network
zonenameThe name of the zone the Network belongs to
zonesnetworkspansIf a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans
service(*)The list of services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
tags(*)The list of resource tags associated with Network
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/migrateResourceToAnotherSecondaryStorage.html b/static/api/apidocs-4.23/apis/migrateResourceToAnotherSecondaryStorage.html new file mode 100644 index 0000000000..06b764d46c --- /dev/null +++ b/static/api/apidocs-4.23/apis/migrateResourceToAnotherSecondaryStorage.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

migrateResourceToAnotherSecondaryStorage

+

migrates resources from one secondary storage to destination image store

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
destpoolid of the destination secondary storage pool to which the resources are to be migratedtrue
srcpoolid of the image store from where the data is to be migratedtrue
snapshotsid(s) of the snapshots to be migratedfalse
templatesid(s) of the templates to be migratedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
messageResponse message from migration of secondary storage data objects
migrationtypeType of migration requested for
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/migrateSecondaryStorageData.html b/static/api/apidocs-4.23/apis/migrateSecondaryStorageData.html new file mode 100644 index 0000000000..687fd5bf3b --- /dev/null +++ b/static/api/apidocs-4.23/apis/migrateSecondaryStorageData.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

migrateSecondaryStorageData

+

Migrates data objects from one secondary storage to destination image store(s)

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
destpoolsID(s) of the destination secondary storage pool(s) to which the Templates are to be migratedtrue
srcpoolID of the image store from where the data is to be migratedtrue
migrationtypeBalance: 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: Completefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
messageResponse message from migration of secondary storage data objects
migrationtypeType of migration requested for
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/migrateSystemVm.html b/static/api/apidocs-4.23/apis/migrateSystemVm.html new file mode 100644 index 0000000000..db1091dbae --- /dev/null +++ b/static/api/apidocs-4.23/apis/migrateSystemVm.html @@ -0,0 +1,207 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

migrateSystemVm

+

Attempts Migration of a System VM to the host specified.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidThe ID of the Instancetrue
autoselectAutomatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by defaultfalse
hostidDestination Host ID to migrate Instance tofalse
storageidDestination storage pool ID to migrate Instance volumes to. Required for migrating the root disk volumefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the System VM
activeviewersessionsThe number of active console sessions for the console proxy System VM
agentstateThe agent state of the System VM
archCPU arch of the system VM
createdThe date and time the System VM was created
disconnectedThe last disconnected date of host
dns1The first DNS for the System VM
dns2The second DNS for the System VM
gatewayThe gateway for the System VM
guestvlanGuest VLAN range
hostcontrolstateThe control state of the host for the System VM
hostidThe host ID for the System VM
hostnameThe hostname for the System VM
hypervisorThe hypervisor on which the Template runs
isdynamicallyscalableTrue if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
linklocalipThe Control IP address for the System VM
linklocalmacaddressThe link local MAC address for the System VM
linklocalnetmaskThe link local netmask for the System VM
nameThe name of the System VM
networkdomainThe Network domain for the System VM
podidThe Pod ID for the System VM
podnameThe Pod name for the System VM
privateipThe private IP address for the System VM
privatemacaddressThe private MAC address for the System VM
privatenetmaskThe private netmask for the System VM
publicipThe public IP address for the System VM
publicmacaddressThe public MAC address for the System VM
publicnetmaskThe public netmask for the System VM
publicvlanPublic VLAN range
serviceofferingidthe ID of the service offering of the system virtual machine.
serviceofferingnamethe name of the service offering of the system virtual machine.
stateThe state of the System VM
storageipthe ip address for the system VM on the storage network
systemvmtypeThe System VM type
templateidThe Template ID for the System VM
templatenameThe Template name for the System VM
versionThe systemvm agent version
zoneidThe Zone ID for the System VM
zonenameThe Zone name for the System VM
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/migrateVPC.html b/static/api/apidocs-4.23/apis/migrateVPC.html new file mode 100644 index 0000000000..97d73ca5c7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/migrateVPC.html @@ -0,0 +1,279 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

migrateVPC

+

Moves a VPC to another physical network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
vpcidThe ID of the VPC true
vpcofferingidVPC offering IDtrue
resumeTrue if previous network migration cmd failedfalse
tiernetworkofferingsNetwork offering IDs for each network in the VPC. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the VPC
accountThe owner of the VPC
asnumberAS NUMBER
asnumberidUUID of AS NUMBER
bgppeersThe BGP peers for the VPC
cidrThe CIDR the VPC
createdThe date this VPC was created
displaytextAn alternate display text of the VPC.
distributedvpcrouterDoes VPC use distributed router for one hop forwarding and host based Network ACL's
dns1The first IPv4 DNS for the VPC
dns2The second IPv4 DNS for the VPC
domainThe domain name of the owner
domainidThe domain ID of the VPC owner
domainpathThe domain path of the owner
fordisplayIs VPC for display to the regular user
iconBase64 string representation of the resource icon
ip4routesThe routes for the VPC to ease adding route in upstream router
ip4routingThe IPv4 routing mode of VPC
ip6dns1The first IPv6 DNS for the VPC
ip6dns2The second IPv6 DNS for the VPC
ip6routesThe routes for the Network to ease adding route in upstream router
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.
nameThe name of the VPC
networkThe list of Networks belonging to the VPC
networkdomainThe Network domain of the VPC
projectThe project name of the VPC
projectidThe project ID of the VPC
publicmtuMTU configured on the public interfaces of the VPC VR
redundantvpcrouterIf this VPC has redundant router
regionlevelvpcTrue if VPC is region level
restartrequiredTrue VPC requires restart
stateState of the VPC. Can be Inactive/Enabled
vpcofferingconservemodetrue if VPC offering is ip conserve mode enabled
vpcofferingidVPC offering ID the VPC is created from
vpcofferingnameVPC offering name the VPC is created from
zoneidZone ID of the VPC
zonenameThe name of the zone the VPC belongs to
service(*)The list of supported services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
tags(*)The list of resource tags associated with the project
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/migrateVirtualMachine.html b/static/api/apidocs-4.23/apis/migrateVirtualMachine.html new file mode 100644 index 0000000000..292e822e57 --- /dev/null +++ b/static/api/apidocs-4.23/apis/migrateVirtualMachine.html @@ -0,0 +1,705 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

migrateVirtualMachine

+

Attempts Migration of an Instance to a different host or Root volume of the Instance to a different storage pool

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidThe ID of the Instancetrue
autoselectAutomatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by defaultfalse
hostidDestination Host ID to migrate Instance to.false
storageidDestination storage pool ID to migrate Instance volumes to. Required for migrating the root disk volumefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/migrateVirtualMachineWithVolume.html b/static/api/apidocs-4.23/apis/migrateVirtualMachineWithVolume.html new file mode 100644 index 0000000000..f037a441b5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/migrateVirtualMachineWithVolume.html @@ -0,0 +1,705 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

migrateVirtualMachineWithVolume

+

Attempts Migration of an Instance with its volumes to a different host

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidThe ID of the Instancetrue
autoselectAutomatically select a destination host for a running Instance, if hostId is not specified. false by defaultfalse
hostidDestination Host ID to migrate Instance to.false
migratetoStorage 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/migrateVolume.html b/static/api/apidocs-4.23/apis/migrateVolume.html new file mode 100644 index 0000000000..fccccab026 --- /dev/null +++ b/static/api/apidocs-4.23/apis/migrateVolume.html @@ -0,0 +1,312 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

migrateVolume

+

Migrate volume

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
storageidDestination storage pool ID to migrate the volume totrue
volumeidThe ID of the volumetrue
livemigrateIf the volume should be live migrated when it is attached to a running Instancefalse
newdiskofferingidThe 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the disk volume
accountThe Account associated with the disk volume
attachedThe date the volume was attached to an Instance
chaininfoThe chain info of the volume
clusteridCluster id of the volume
clusternameCluster name where the volume is allocated
createdThe date the disk volume was created
deleteprotectiontrue if volume has delete protection.
destroyedThe boolean state of whether the volume is destroyed or not
deviceidThe ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
diskBytesReadRateBytes read rate of the disk volume
diskBytesWriteRateBytes write rate of the disk volume
diskIopsReadRateIO requests read rate of the disk volume per the disk offering
diskIopsWriteRateIO requests write rate of the disk volume per the disk offering
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingdisplaytextThe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnameName of the disk offering
displayvolumeAn optional field whether to the display the volume to the end User or not.
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathpath of the Domain the disk volume belongs to
encryptformatthe format of the disk encryption if applicable
externaluuidVolume UUID that is given by virtualisation provider (only for VMware)
hypervisorHypervisor the volume belongs to
isextractableTrue if the volume is extractable, false otherwise
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isonameThe name of the ISO attached to the Instance
kmskeyKMS key name of the volume
kmskeyidKMS key id of the volume
kmskeyversionVersion number of the KMS key used for disk encryption if applicable
maxiopsMax IOPS of the disk volume
miniopsMin IOPS of the disk volume
nameName of the disk volume
pathThe path of the volume
physicalsizeThe bytes actually consumed on disk
podidPod id of the volume
podnamePod name of the volume
projectThe project name of the VPN
projectidThe project id of the VPN
provisioningtypeProvisioning type used to create volumes.
quiescevmNeed quiesce Instance or not when taking Snapshot
serviceofferingdisplaytextThe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnameName of the service offering for root disk
sizeSize of the disk volume
snapshotidID of the Snapshot from which this volume was created
stateThe state of the disk volume
statusThe status of the volume
storageName of the primary storage hosting the disk volume
storageidID of the primary storage hosting the disk volume; returned to admin User only
storagetypeShared or local storage
supportsstoragesnapshotTrue if storage Snapshot is supported for the volume, false otherwise
templatedisplaytextAn alternate display text of the Template for the Instance
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
typeType of the disk volume (ROOT or DATADISK)
utilizationThe disk utilization
virtualmachineidID of the Instance
virtualsizeThe bytes allocated
vmdisplaynameDisplay name of the Instance
vmnameName of the Instance
vmstateState of the Instance
vmtypeType of the Instance
volumecheckresultdetails for the volume check result, they may vary for different hypervisors
volumerepairresultdetails for the volume repair result, they may vary for different hypervisors
zoneidID of the availability zone
zonenameName of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/migrateVolumesToKMS.html b/static/api/apidocs-4.23/apis/migrateVolumesToKMS.html new file mode 100644 index 0000000000..377d7cbdd4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/migrateVolumesToKMS.html @@ -0,0 +1,141 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

migrateVolumesToKMS

+

Migrates encrypted volumes to KMS

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
kmskeyidKMS Key ID to use for migrating volumestrue
volumeidsList of volume IDs to migratetrue
accountMigrate volumes for specific accountfalse
domainidDomain IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account that executed the async command
accountidThe Account ID that executed the async command
cmdThe async command executed
completedThe completed date of the job
createdThe created date of the job
domainidThe domain ID that executed the async command
domainpathThe domain that executed the async command
jobinstanceidThe unique ID of the Instance/entity object related to the job
jobinstancetypeThe Instance/entity object related to the job
jobprocstatusThe progress information of the PENDING job
jobresultThe result reason
jobresultcodeThe result code for the job
jobresulttypeThe result type
managementserveridThe MSID of the management server on which the job is running
managementservernamethe management server name of the host
useridThe User that executed the async command
jobidthe ID of the async job
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/moveDomain.html b/static/api/apidocs-4.23/apis/moveDomain.html new file mode 100644 index 0000000000..74e07165f2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/moveDomain.html @@ -0,0 +1,276 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

moveDomain

+

Moves a domain and its children to a new parent domain.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
domainidThe ID of the domain to be moved.true
parentdomainidThe ID of the new parent domain of the domain to be moved.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the domain
backupavailablethe total number of backups available to this domain
backuplimitthe total number of backups which can be stored by this domain
backupstorageavailablethe total backup storage space (in GiB) available to the domain
backupstoragelimitthe total backup storage space (in GiB) the domain can own
backupstoragetotalthe total backup storage space (in GiB) owned by the domain
backuptotalthe total number of backups stored by this domain
bucketavailablethe total number of buckets available to this domain
bucketlimitthe total number of buckets which can be stored by this domain
buckettotalthe total number of buckets stored by this domain
cpuavailableThe total number of CPU cores available to be created for this domain
cpulimitThe total number of CPU cores the domain can own
cputotalThe total number of CPU cores owned by domain
createdThe date when this domain was created
domaindetailsDetails for the domain
gpuavailablethe total number of gpus available to be created for this domain
gpulimitthe total number of gpus the domain can own
gputotalthe total number of gpus owned by domain
haschildWhether the domain has one or more sub-domains
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this domain to acquire
iplimitThe total number of public IP addresses this domain can acquire
iptotalThe total number of public IP addresses allocated for this domain
levelThe level of the domain
memoryavailableThe total memory (in MB) available to be created for this domain
memorylimitThe total memory (in MB) the domain can own
memorytotalThe total memory (in MB) owned by domain
nameThe name of the domain
networkavailableThe total number of Networks available to be created for this domain
networkdomainThe Network domain
networklimitThe total number of Networks the domain can own
networktotalThe total number of Networks owned by domain
objectstorageavailablethe total object storage space (in GiB) available to the domain
objectstoragelimitthe total object storage space (in GiB) the domain can own
objectstoragetotalthe total object storage space (in GiB) owned by the domain
parentdomainidThe domain ID of the parent domain
parentdomainnameThe domain name of the parent domain
pathThe path of the domain
primarystorageavailableThe total primary storage space (in GiB) available to be used for this domain
primarystoragelimitThe total primary storage space (in GiB) the domain can own
primarystoragetotalThe total primary storage space (in GiB) owned by domain
projectavailableThe total number of projects available for administration by this domain
projectlimitThe total number of projects the domain can own
projecttotalThe total number of projects being administrated by this domain
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this domain
secondarystoragelimitThe total secondary storage space (in GiB) the domain can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by domain
snapshotavailableThe total number of Snapshots available for this domain
snapshotlimitThe total number of Snapshots which can be stored by this domain
snapshottotalThe total number of Snapshots stored by this domain
stateThe state of the domain
taggedresourcesThe tagged resource limit and count for the domain
templateavailableThe total number of Templates available to be created by this domain
templatelimitThe total number of Templates which can be created by this domain
templatetotalThe total number of Templates which have been created by this domain
vmavailableThe total number of Instances available for this domain to acquire
vmlimitThe total number of Instances that can be deployed by this domain
vmtotalThe total number of Instances deployed by this domain
volumeavailableThe total volume available for this domain
volumelimitThe total volume which can be used by this domain
volumetotalThe total volume being used by this domain
vpcavailableThe total number of VPCs available to be created for this domain
vpclimitThe total number of VPCs the domain can own
vpctotalThe total number of VPCs owned by domain
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/moveNetworkAclItem.html b/static/api/apidocs-4.23/apis/moveNetworkAclItem.html new file mode 100644 index 0000000000..dca3f9f398 --- /dev/null +++ b/static/api/apidocs-4.23/apis/moveNetworkAclItem.html @@ -0,0 +1,174 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

moveNetworkAclItem

+

Move an ACL rule to a position between two other ACL rules of the same ACL Network list

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the network ACL rule that is being moved to a new position.true
aclconsistencyhashMd5 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
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
nextaclruleidThe 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
previousaclruleidThe 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the ACL Item
aclidThe ID of the ACL this item belongs to
aclnameThe name of the ACL this item belongs to
actionAction of ACL Item. Allow/Deny
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
endportThe ending port of ACL's port range
fordisplayIs rule for display to the regular user
icmpcodeError code for this icmp message
icmptypeType of the icmp message being sent
numberNumber of the ACL Item
protocolThe protocol of the ACL
reasonAn explanation on why this ACL rule is being applied
startportThe starting port of ACL's port range
stateThe state of the rule
traffictypeThe traffic type for the ACL
tags(*)The list of resource tags associated with the Network ACLs
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/moveUser.html b/static/api/apidocs-4.23/apis/moveUser.html new file mode 100644 index 0000000000..5eaab776b9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/moveUser.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

moveUser

+

Moves a user to another account in the same domain.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the user to be moved.true
accountMoves the user under the specified account. If no account name is specified, it is necessary to provide an account id.false
accountidMoves the user under the specified account. If no account id is specified, it is necessary to provide an account name.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/notifyBaremetalProvisionDone.html b/static/api/apidocs-4.23/apis/notifyBaremetalProvisionDone.html new file mode 100644 index 0000000000..21d1fcaf7c --- /dev/null +++ b/static/api/apidocs-4.23/apis/notifyBaremetalProvisionDone.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

notifyBaremetalProvisionDone

+

Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
macMAC of the NIC used for provisiontrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/oauthlogin.html b/static/api/apidocs-4.23/apis/oauthlogin.html new file mode 100644 index 0000000000..470a079bbb --- /dev/null +++ b/static/api/apidocs-4.23/apis/oauthlogin.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

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.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
emailEmail id with which user tried to login using OAuth providertrue
providerName of the providertrue
domainPath 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
domainIdThe id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precedence.false
secretcodeCode that is provided by OAuth provider (Eg. google, github) after successful loginfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account name the User belongs to
domainidDomain ID that the user belongs to
firstnameFirst name of the user
is2faenabledIs two factor authentication enabled
is2faverifiedIs two factor authentication verified
issuerfor2faTwo factor authentication issuer
lastnameLast name of the user
managementserveridManagement Server ID that the user logged to
passwordchangerequiredIndicates whether the User is required to change password on next login.
providerfor2faTwo factor authentication provider
registeredIs user registered
sessionkeySession key that can be passed in subsequent Query command calls
timeoutThe time period before the session has expired
timezoneUser time zone
timezoneoffsetUser time zoneoffset
typeThe Account type (admin, domain-admin, read-only-admin, user)
useridUser ID
usernameUsername
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/patchSystemVm.html b/static/api/apidocs-4.23/apis/patchSystemVm.html new file mode 100644 index 0000000000..6cf982357f --- /dev/null +++ b/static/api/apidocs-4.23/apis/patchSystemVm.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

patchSystemVm

+

Attempts to live patch systemVMs - CPVM, SSVM

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
forcedIf true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter onlyfalse
idPatches System VM - CPVM/SSVM with the specified IDfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/prepareForMaintenance.html b/static/api/apidocs-4.23/apis/prepareForMaintenance.html new file mode 100644 index 0000000000..c6eede9bbe --- /dev/null +++ b/static/api/apidocs-4.23/apis/prepareForMaintenance.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

prepareForMaintenance

+

Prepares management server for maintenance by preventing new jobs from being accepted after completion of active jobs and migrating the agents

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
managementserveridThe UUID of the management servertrue
algorithmindirect agents load balancer algorithm (static, roundrobin, shuffle); when this is not set, already configured algorithm from setting 'indirect.agent.lb.algorithm' is consideredfalse
forcedForce management server to maintenance after the maintenance window timeout, default is falsefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
agentsThe host agents this management server is responsible for
agentscountThe number of host agents this management server is responsible for
maintenanceinitiatedIndicates whether maintenance has been initiated
managementserveridThe id of the management server
pendingjobscountThe number of jobs in progress
readyforshutdownIndicates whether CloudStack is ready to shutdown
shutdowntriggeredIndicates whether a shutdown has been triggered
statethe state of the management server
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/prepareForShutdown.html b/static/api/apidocs-4.23/apis/prepareForShutdown.html new file mode 100644 index 0000000000..03fe454b35 --- /dev/null +++ b/static/api/apidocs-4.23/apis/prepareForShutdown.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

prepareForShutdown

+

Prepares CloudStack for a safe manual shutdown by preventing new jobs from being accepted

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
managementserveridThe UUID of the management servertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
agentsThe host agents this management server is responsible for
agentscountThe number of host agents this management server is responsible for
maintenanceinitiatedIndicates whether maintenance has been initiated
managementserveridThe id of the management server
pendingjobscountThe number of jobs in progress
readyforshutdownIndicates whether CloudStack is ready to shutdown
shutdowntriggeredIndicates whether a shutdown has been triggered
statethe state of the management server
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/prepareHostForMaintenance.html b/static/api/apidocs-4.23/apis/prepareHostForMaintenance.html new file mode 100644 index 0000000000..c51c65890d --- /dev/null +++ b/static/api/apidocs-4.23/apis/prepareHostForMaintenance.html @@ -0,0 +1,345 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

prepareHostForMaintenance

+

Prepares a host for maintenance.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe host IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the host
annotationThe last annotation set on this host by an admin
archCPU Arch of the host
capabilitiesCapabilities of the host
clusteridThe cluster ID of the host
clusternameThe cluster name of the host
clusterstorageaccessgroupscomma-separated list of storage access groups on the cluster
clustertypeThe cluster type of the cluster that host belongs to
cpuallocatedThe amount of the host's CPU currently allocated
cpuallocatedpercentageThe amount of the host's CPU currently allocated in percentage
cpuallocatedvalueThe amount of the host's CPU currently allocated in MHz
cpuallocatedwithoverprovisioningThe amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor
cpuloadaverageThe average CPU load on the host
cpunumberThe CPU number of the host
cpusocketsThe number of CPU sockets on the host
cpuspeedThe CPU speed of the host
cpuusedThe amount of the host's CPU currently used
cpuwithoverprovisioningThe amount of the host's CPU after applying the cpu.overprovisioning.factor
createdThe date and time the host was created
detailsHost details in key/value pairs.
disconnectedTrue if the host is disconnected. False otherwise.
disksizeallocatedThe host's currently allocated disk size
disksizetotalThe total disk size of the host
encryptionsupportedTrue if the host supports encryption
eventsEvents available for the host
explicithosttagscomma-separated list of explicit host tags for the host
extensionidThe ID of extension for this cluster
extensionnameThe name of extension for this cluster
gputotalTotal GPUs on the Host
gpuusedUsed GPUs on the Host
guestosrulethe guest OS rule
hahostTrue if the host is Ha host (dedicated to Instances started by HA process; false otherwise
hasenoughcapacityTrue if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise
hosthaThe host HA information information
hosttagsComma-separated list of tags for the host
hypervisorThe host hypervisor
hypervisorversionThe hypervisor version
implicithosttagscomma-separated list of implicit host tags for the host
instanceconversionsupportedtrue if the host supports instance conversion (using virt-v2v)
ipaddressThe IP address of the host
islocalstorageactiveTrue if local storage is active, false otherwise
istagaruleWhether the informed tag is a JS interpretable rule or not.
lastannotatedThe last time this host was annotated
lastpingedThe date and time the host was last pinged
managementserveridThe management server ID of the host
managementservernamethe management server name of the host
memoryallocatedThe amount of the host's memory currently allocated
memoryallocatedbytesThe amount of the host's memory currently allocated in bytes
memoryallocatedpercentageThe amount of the host's memory currently allocated in percentage
memorytotalThe memory total of the host, this parameter is deprecated use memorywithoverprovisioning
memoryusedThe amount of the host's memory currently used
memorywithoverprovisioningThe amount of the host's memory after applying the mem.overprovisioning.factor
msid(only for details=core) the msid of the host's management server
nameThe name of the host
networkkbsreadThe incoming Network traffic on the host
networkkbswriteThe outgoing Network traffic on the host
oscategoryidThe OS category ID of the host
oscategorynameThe OS category name of the host
outofbandmanagementThe host out-of-band management information
podidThe Pod ID of the host
podnameThe Pod name of the host
podstorageaccessgroupscomma-separated list of storage access groups on the pod
removedThe date and time the host was removed
resourcestateThe resource state of the host
stateThe state of the host
storageaccessgroupscomma-separated list of storage access groups for the host
suitableformigrationTrue if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise
typeThe host type
ueficapabilityTrue if the host has capability to support UEFI boot
usernameThe admin that annotated this host
versionThe host version
virtualmachineidthe virtual machine id for host type ConsoleProxy and SecondaryStorageVM
zoneidThe Zone ID of the host
zonenameThe Zone name of the host
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
gpugroup(*)GPU cards present in the host
gpugroupnameGPU cards present in the host
vgpu(*)The list of enabled vGPUs
maxcapacityMaximum vGPU can be created with this vGPU type on the given GPU group
maxheadsMaximum displays per user
maxresolutionxMaximum X resolution per display
maxresolutionyMaximum Y resolution per display
maxvgpuperpgpuMaximum no. of vGPU per GPU card (pgpu)
remainingcapacityRemaining capacity in terms of no. of more Instances that can be deployed with this vGPU type
vgputypeModel Name of vGPU
videoramVideo RAM for this vGPU type
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/prepareTemplate.html b/static/api/apidocs-4.23/apis/prepareTemplate.html new file mode 100644 index 0000000000..1b253a74b4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/prepareTemplate.html @@ -0,0 +1,258 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

prepareTemplate

+

Load Template into primary storage

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
templateidTemplate ID of the Template to be prepared in primary storage(s).true
zoneidZone ID of the Template to be prepared in primary storage(s).true
storageidStorage 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe Account name to which the Template belongs
accountidThe Account id to which the Template belongs
archCPU Arch of the template
bitsThe processor bit size
bootableTrue if the ISO is bootable, false otherwise
checksumChecksum of the Template
childtemplatesIf root disk Template, then IDs of the datas disk Templates this Template owns
createdThe date this Template was created
crossZonesTrue if the Template is managed across all Zones, false otherwise
deployasisVMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is Template
detailsAdditional key/value details tied with Template
directdownloadKVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextThe Template display text
domainThe name of the domain to which the Template belongs
domainidThe ID of the domain to which the Template belongs
domainpathPath of the Domain the template belongs to
downloaddetailsLists the download progress of a Template across all secondary storages
extensionidThe ID of extension linked to this template
extensionnameThe name of extension linked to this template
forcksIf true it indicates that the template can be used for CKS cluster deployments
formatThe format of the Template.
hostidThe ID of the secondary storage host for the Template
hostnameThe name of the secondary storage host for the Template
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
isextractableTrue if the Template is extractable, false otherwise
isfeaturedTrue if this Template is a featured Template, false otherwise
ispublicTrue if this Template is a public Template, false otherwise
isreadyTrue if the Template is ready to be deployed from, false otherwise.
nameThe Template name
ostypeidThe ID of the OS type for this Template.
ostypenameThe name of the OS type for this Template.
parenttemplateidIf Datadisk Template, then id of the root disk Template this Template belongs to
passwordenabledTrue if the reset password feature is enabled, false otherwise
physicalsizeThe physical size of the Template
projectThe project name of the Template
projectidThe project ID of the Template
removedThe date this Template was removed
requireshvmTrue if Template requires HVM enabled, false otherwise
sizeThe size of the Template
sourcetemplateidThe Template ID of the parent Template if present
sshkeyenabledTrue if Template is sshkey enabled, false otherwise
statusThe status of the Template
templatetagThe tag of this Template
templatetypeThe type of the Template
urlThe URL which the Template/ISO is registered from
userdataidThe id of userdata linked to this Template
userdatanameThe name of userdata linked to this Template
userdataparamsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
zoneidThe ID of the zone for this Template
zonenameThe name of the zone for this Template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/provisionCertificate.html b/static/api/apidocs-4.23/apis/provisionCertificate.html new file mode 100644 index 0000000000..f72efed429 --- /dev/null +++ b/static/api/apidocs-4.23/apis/provisionCertificate.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

provisionCertificate

+

Issues and propagates client certificate on a connected host/agent using configured CA plugin

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hostidThe host/agent ID to which the certificate has to be provisioned (issued and propagated)true
forcedWhen true, uses SSH to re-provision the agent's certificate, bypassing the NIO agent connection. Use this when agents are disconnected due to a CA change. Supported for KVM hosts and SystemVMs. Default is falsefalse
providerName of the CA service provider, otherwise the default configured provider plugin will be usedfalse
reconnectWhether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is usedfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/provisionTemplateDirectDownloadCertificate.html b/static/api/apidocs-4.23/apis/provisionTemplateDirectDownloadCertificate.html new file mode 100644 index 0000000000..cc0eee04e7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/provisionTemplateDirectDownloadCertificate.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

provisionTemplateDirectDownloadCertificate

+

Provisions a host with a direct download certificate

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe id of the direct download certificate to provisiontrue
hostidThe host to provision the certificatetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
detailsIndicates the details in case of failure or host skipped
hostidThe ID of the host
hostnameThe name of the host
statusIndicates if the certificate has been revoked from the host, failed or skipped
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/purgeExpungedResources.html b/static/api/apidocs-4.23/apis/purgeExpungedResources.html new file mode 100644 index 0000000000..daa532b0ed --- /dev/null +++ b/static/api/apidocs-4.23/apis/purgeExpungedResources.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

purgeExpungedResources

+

Purge expunged resources

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
batchsizeThe size of batch used during purgingfalse
enddateThe end date range of the expunged resources used for purging (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss")false
resourcetypeThe type of the resource which need to be purged. Supported types: VirtualMachinefalse
startdateThe start date range of the expunged resources used for purging (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss")false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/queryAsyncJobResult.html b/static/api/apidocs-4.23/apis/queryAsyncJobResult.html new file mode 100644 index 0000000000..ff2258ee4a --- /dev/null +++ b/static/api/apidocs-4.23/apis/queryAsyncJobResult.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

queryAsyncJobResult

+

Retrieves the current status of asynchronous job.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
jobidThe ID of the asynchronous jobfalse
resourceidthe ID of the resource associated with the jobfalse
resourcetypethe type of the resource associated with the jobfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account that executed the async command
accountidThe Account ID that executed the async command
cmdThe async command executed
completedThe completed date of the job
createdThe created date of the job
domainidThe domain ID that executed the async command
domainpathThe domain that executed the async command
jobinstanceidThe unique ID of the Instance/entity object related to the job
jobinstancetypeThe Instance/entity object related to the job
jobprocstatusThe progress information of the PENDING job
jobresultThe result reason
jobresultcodeThe result code for the job
jobresulttypeThe result type
managementserveridThe MSID of the management server on which the job is running
managementservernamethe management server name of the host
useridThe User that executed the async command
jobidthe ID of the async job
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaBalance.html b/static/api/apidocs-4.23/apis/quotaBalance.html new file mode 100644 index 0000000000..2e7afd4742 --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaBalance.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaBalance

+

Create Quota balance statements for the provided Accounts or Projects.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountName of the Account for which balance statements will be generated. Deprecated, please use 'accountid' instead.false
accountidID of the Account for which balance statements will be generated.false
domainidID of the domain which the Account identified by 'account' belongs to.Deprecated, please use 'accountid' instead.false
enddateDate of the last Quota balance to be returned. Must be informed together with the startdate parameter, and can not be before startdate. 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
projectidID of the Project for which balance statements will be generated. Can not be specified with accountid.false
startdateDate of the first Quota balance to be returned. Must be before today. 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
balanceBalance's value.
balancesList of balances in the period.
currencyBalance's currency.
dateBalance's date.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaConfigureEmail.html b/static/api/apidocs-4.23/apis/quotaConfigureEmail.html new file mode 100644 index 0000000000..403ecfc08b --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaConfigureEmail.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaConfigureEmail

+

Configure a quota email template

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountidAccount ID for which to configure quota template email or min balancetrue
enableIf the quota email template should be enabledfalse
minbalanceNew quota account min balancefalse
templatenameQuota email template name which should be configuredfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
accountThe configured account's id.
enabledWhether the template is enabled.
minbalanceThe configured account's min balance.
templatenameThe template's name.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaCredits.html b/static/api/apidocs-4.23/apis/quotaCredits.html new file mode 100644 index 0000000000..b46f41010b --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaCredits.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaCredits

+

Add +-credits to an Account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
valueAmount of credits to be added (in case of a positive value) or subtracted (in case of a negative value).true
accountName of the Account for which Quota credits will be added. Deprecated, please use 'accountid' instead.false
accountidID of the Account for which Quota credits will be added. Cannot be specified with 'projectid'.false
domainidDomain of the Account specified by 'account' for which Quota credits will be added. Deprecated, please use 'accountid' instead.false
min_balanceAn email will be sent to the Account when the Quota credits get below this threshold.false
projectidID of the Project for which Quota credits will be added. Cannot be specified with 'accountid'.false
quota_enforceWhether to lock the Account when Quota credits are below zero.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
creditThe credit deposited.
creditedonWhen the credit was added.
creditoruseridID of the creditor user.
creditorusernameUsername of the creditor user.
currencyCredit's currency.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaCreditsList.html b/static/api/apidocs-4.23/apis/quotaCreditsList.html new file mode 100644 index 0000000000..dde760d306 --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaCreditsList.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaCreditsList

+

Lists quota credits of an account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountidID of the Account for which the credit statement will be generated. Cannot be specified with 'projectid'.false
domainidID of the Domain for which credit statement will be generated. Available only for administrators.false
enddateEnd date of the credit statement. If not provided, the current date will be considered as the end date. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "23:59:59"). If the recommended format is not used, the date will be considered in the server timezone.false
isrecursiveWhether to generate the credit statement for the provided domain and its children. Defaults to false.false
projectidID of the Project for which the credit statement will be generated. Cannot be specified with 'accountid'.false
startdateStart date of the credit statement. If not provided, the first day of the current month will be considered as the start 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
creditThe credit deposited.
creditedonWhen the credit was added.
creditoruseridID of the creditor user.
creditorusernameUsername of the creditor user.
currencyCredit's currency.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaEmailTemplateList.html b/static/api/apidocs-4.23/apis/quotaEmailTemplateList.html new file mode 100644 index 0000000000..717d3f7be3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaEmailTemplateList.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaEmailTemplateList

+

Lists all quota email Templates

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
keywordList by keywordfalse
pagefalse
pagesizefalse
templatetypeList by type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTYfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
last_updatedLast date/time when template was updated
localeThe quota email template locale
templatebodyThe quota email template content
templatesubjectThe quota email template subject
templatetypeTemplate type
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaEmailTemplateUpdate.html b/static/api/apidocs-4.23/apis/quotaEmailTemplateUpdate.html new file mode 100644 index 0000000000..f1d447e7fa --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaEmailTemplateUpdate.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaEmailTemplateUpdate

+

Updates existing email Templates for quota alerts

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
templatebodyThe quota email template body, max: 500k characterstrue
templatesubjectThe quota email template subject, max: 77 characterstrue
templatetypeType of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTYtrue
localeThe locale of the email textfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaIsEnabled.html b/static/api/apidocs-4.23/apis/quotaIsEnabled.html new file mode 100644 index 0000000000..365918d895 --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaIsEnabled.html @@ -0,0 +1,81 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaIsEnabled

+

Return true if the plugin is enabled

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
isenabledIs quota service enabled
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaListEmailConfiguration.html b/static/api/apidocs-4.23/apis/quotaListEmailConfiguration.html new file mode 100644 index 0000000000..ac4b629dda --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaListEmailConfiguration.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaListEmailConfiguration

+

List quota email template configurations

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
accountidAccount ID for which to list quota template email configurationstrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
accountThe configured account's id.
enabledWhether the template is enabled.
minbalanceThe configured account's min balance.
templatenameThe template's name.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaPresetVariablesList.html b/static/api/apidocs-4.23/apis/quotaPresetVariablesList.html new file mode 100644 index 0000000000..518ef834e3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaPresetVariablesList.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaPresetVariablesList

+

List the preset variables available for using in the Quota tariff activation rules given the usage type.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
usagetypeThe usage type for which the preset variables will be retrieved.true
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
descriptiondescription
variablevariable
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaResourceStatement.html b/static/api/apidocs-4.23/apis/quotaResourceStatement.html new file mode 100644 index 0000000000..b2faeec324 --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaResourceStatement.html @@ -0,0 +1,132 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaResourceStatement

+

Generates a detailed Quota statement for a specific resource.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the resource.true
enddateEnd date for the 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
startdateStart date for the 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
usagetypeUsage type of the Quota usage.true
accountidGenerate the statement for this Account. A resource may have belonged to different owners at distinct points in time, so this parameter can be used to only consider the period for which it belonged to a specific Account.false
domainidID of the Domain for which the Quota statement will be generated.false
isrecursiveWhether to include usage records from children of the filtered domain. Defaults to false.false
projectidGenerate the statement for this Project. A resource may have belonged to different owners at distinct points in time, so this parameter can be used to only consider the period for which it belonged to a specific Project.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
totalquotaTotal amount of quota used.
unitUnit of the usage type.
usagenameName of the usage type.
items(*)List of Quota tariff usages.
accountidUUID of the resource's owner.
enddateItem's end date.
quotaconsumedAmount of quota used.
startdateItem's start date.
tariffidID of the tariff.
tariffnameName of the tariff.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaStatement.html b/static/api/apidocs-4.23/apis/quotaStatement.html new file mode 100644 index 0000000000..387728cf56 --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaStatement.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaStatement

+

Create a Quota statement for the provided Account, Project, or Domain.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enddateEnd 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
startdateStart 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
accountName of the Account for which the Quota statement will be generated. Deprecated, please use accountid instead.false
accountidID of the Account for which the Quota statement will be generated. Can not be specified with projectid.false
domainidID of the Domain for which the Quota statement will be generated. May be used individually or with account.false
isrecursiveWhether to include usage records from children of the filtered domain. Defaults to false.false
projectidID of the Project for which the Quota statement will be generated. Can not be specified with accountid.false
showresourcesList the resources of each Quota type in the period.false
typeConsider only Quota usage records for the specified usage type in the statement.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
historyQuota consumption history.
nameName of the Usage type.
quotaQuota consumed.
resourcesItem's resources.
typeUsage type.
unitUnit of the Usage type.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaSummary.html b/static/api/apidocs-4.23/apis/quotaSummary.html new file mode 100644 index 0000000000..4f75a6e131 --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaSummary.html @@ -0,0 +1,153 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaSummary

+

Lists Quota balance summary of Accounts and Projects.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountName of the Account for which balance will be listed.false
accountidID of the Account for which balance will be listed. Can not be specified with projectid.false
accountstatetoshowPossible values are [ALL, ACTIVE, REMOVED]. ALL will list summaries for active and removed accounts; ACTIVE will list summaries only for active accounts; REMOVED will list summaries only for removed accounts. The default value is ACTIVE.false
domainidID of the Domain for which balance will be listed. May be used individually or with accountname.false
keywordList by keywordfalse
listallFalse (default) lists the Quota balance summary for calling Account. True lists balance summary for Accounts which the caller has access. If domain ID is informed, this parameter is considered as true.false
pagefalse
pagesizefalse
projectidID of the Project for which balance will be listed. Can not be specified with accountId.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountAccount's name
accountidAccount's ID
accountremovedIf the account is removed or not
balanceAccount's balance
currencyCurrency
domainDomain's path
domainidDomain's ID
domainremovedIf the domain is removed or not
enddateEnd date of the quota consumption
projectidProject's id
projectnameName of the project
projectremovedWhether the project is removed or not
quotaQuota consumed between the startdate and enddate
quotaenabledIf the account has the quota config enabled
startdateStart date of the quota consumption
stateAccount's state
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaTariffCreate.html b/static/api/apidocs-4.23/apis/quotaTariffCreate.html new file mode 100644 index 0000000000..6d2fef8738 --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaTariffCreate.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaTariffCreate

+

Creates a quota tariff for a resource.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameQuota tariff's nametrue
usagetypeInteger value for the usage type of the resource.true
valueThe quota tariff value of the resource as per the default unit.true
activationruleQuota 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
descriptionQuota tariff's description.false
enddateThe 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
positionPosition in the execution sequence for tariffs of the same typefalse
startdateThe 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the tariff
activationRuleActivation rule of the quota tariff
currencyCurrency
descriptionDescription
effectiveDateThe start date of the quota tariff
endDateThe end date of the quota tariff
nameName
positionPosition in the execution sequence for tariffs of the same type
removedWhen the quota tariff was removed
tariffValuetariffValue
usageDiscriminatorusageDiscriminator
usageNameusageName
usageTypeusageType
usageTypeDescriptionUsage type description
usageUnitusageUnit
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaTariffDelete.html b/static/api/apidocs-4.23/apis/quotaTariffDelete.html new file mode 100644 index 0000000000..10867e533b --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaTariffDelete.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaTariffDelete

+

Marks a quota tariff as removed.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the quota tarifftrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaTariffList.html b/static/api/apidocs-4.23/apis/quotaTariffList.html new file mode 100644 index 0000000000..cb6679f510 --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaTariffList.html @@ -0,0 +1,153 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaTariffList

+

Lists all quota tariff plans

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enddateThe 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
idThe quota tariff's id.false
keywordList by keywordfalse
listallFalse will list only not removed quota tariffs. If set to true, we will list all, including the removed ones. The default is false.false
listonlyremovedIf set to true, we will list only the removed tariffs. The default is false.false
nameThe name of the quota tariff.false
pagefalse
pagesizefalse
startdateThe 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
usagetypeUsage type of the resourcefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the tariff
activationRuleActivation rule of the quota tariff
currencyCurrency
descriptionDescription
effectiveDateThe start date of the quota tariff
endDateThe end date of the quota tariff
nameName
positionPosition in the execution sequence for tariffs of the same type
removedWhen the quota tariff was removed
tariffValuetariffValue
usageDiscriminatorusageDiscriminator
usageNameusageName
usageTypeusageType
usageTypeDescriptionUsage type description
usageUnitusageUnit
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaTariffUpdate.html b/static/api/apidocs-4.23/apis/quotaTariffUpdate.html new file mode 100644 index 0000000000..0be9d2f877 --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaTariffUpdate.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaTariffUpdate

+

Update the tariff plan for a resource

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameQuota tariff's nametrue
activationruleQuota 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
descriptionQuota tariff's description. Inform empty to remove the description.false
enddateThe 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
positionPosition in the execution sequence for tariffs of the same typefalse
startdateDEPRECATED. 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
usagetypeDEPRECATED. Integer value for the usage type of the resourcefalse
valueThe quota tariff value of the resource as per the default unit.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the tariff
activationRuleActivation rule of the quota tariff
currencyCurrency
descriptionDescription
effectiveDateThe start date of the quota tariff
endDateThe end date of the quota tariff
nameName
positionPosition in the execution sequence for tariffs of the same type
removedWhen the quota tariff was removed
tariffValuetariffValue
usageDiscriminatorusageDiscriminator
usageNameusageName
usageTypeusageType
usageTypeDescriptionUsage type description
usageUnitusageUnit
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaUpdate.html b/static/api/apidocs-4.23/apis/quotaUpdate.html new file mode 100644 index 0000000000..f278ebac30 --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaUpdate.html @@ -0,0 +1,81 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaUpdate

+

Update quota calculations, alerts and statements

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
updated_onTimestamp when the run got over
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/quotaValidateActivationRule.html b/static/api/apidocs-4.23/apis/quotaValidateActivationRule.html new file mode 100644 index 0000000000..64e02ad61d --- /dev/null +++ b/static/api/apidocs-4.23/apis/quotaValidateActivationRule.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

quotaValidateActivationRule

+

Validates if the given activation rule is valid for the informed usage type.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
activationruleQuota tariff's activation rule to validate. The activation rule is valid if it has no syntax errors and all variables are compatible with the given usage type.true
usagetypeThe Quota usage type used to validate the activation rule.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
activationruleThe validated activation rule.
isvalidWhether the activation rule is valid.
messageThe reason whether the activation rule is valid or not.
quotatypeThe Quota usage type used to validate the activation rule.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/readyForShutdown.html b/static/api/apidocs-4.23/apis/readyForShutdown.html new file mode 100644 index 0000000000..db89bdf8a4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/readyForShutdown.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

readyForShutdown

+

Returns the status of CloudStack, whether a shutdown has been triggered and if ready to shutdown

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
managementserveridThe UUID of the management servertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
agentsThe host agents this management server is responsible for
agentscountThe number of host agents this management server is responsible for
maintenanceinitiatedIndicates whether maintenance has been initiated
managementserveridThe id of the management server
pendingjobscountThe number of jobs in progress
readyforshutdownIndicates whether CloudStack is ready to shutdown
shutdowntriggeredIndicates whether a shutdown has been triggered
statethe state of the management server
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/rebootRouter.html b/static/api/apidocs-4.23/apis/rebootRouter.html new file mode 100644 index 0000000000..5dfbfe5ec6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/rebootRouter.html @@ -0,0 +1,363 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

rebootRouter

+

Starts a router.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the routertrue
forcedForce reboot the router (Router is force Stopped and then Started)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the router
accountThe Account associated with the router
archCPU arch of the router
createdThe date and time the router was created
dns1The first DNS for the router
dns2The second DNS for the router
domainThe domain associated with the router
domainidThe domain ID associated with the router
domainpathpath of the Domain the router belongs to
gatewayThe gateway for the router
guestipaddressThe guest IP address for the router
guestmacaddressThe guest MAC address for the router
guestnetmaskThe guest netmask for the router
guestnetworkidThe ID of the corresponding guest Network
guestnetworknameThe name of the corresponding guest Network
healthchecksfailedTrue if any health checks had failed
hostcontrolstateThe control state of the host for the router
hostidThe host ID for the router
hostnameThe hostname for the router
hypervisorThe hypervisor on which the Template runs
ip6dns1The first IPv6 DNS for the router
ip6dns2The second IPv6 DNS for the router
isredundantrouterIf this router is an redundant virtual router
linklocalipThe Control IP address for the router
linklocalmacaddressThe link local MAC address for the router
linklocalnetmaskThe link local netmask for the router
linklocalnetworkidThe ID of the corresponding link local Network
nameThe name of the router
networkdomainThe Network domain for the router
podidThe Pod ID for the router
podnameThe Pod name for the router
projectThe project name of the address
projectidThe project id of the IP address
publicipThe public IP address for the router
publicmacaddressThe public MAC address for the router
publicnetmaskThe public netmask for the router
publicnetworkidThe ID of the corresponding public Network
redundantstateThe state of redundant virtual router
requiresupgradeTrue if the router Template requires upgrade
roleRole of the domain router
scriptsversionThe version of scripts
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
softwareversionThe version of the code / software in the router
stateThe state of the router
templateidThe Template ID for the router
templatenameThe Template name for the router
versionThe version of Template
vpcidVPC the router belongs to
vpcnameThe name of VPC the router belongs to
zoneidThe Zone ID for the router
zonenameThe Zone name for the router
healthcheckresults(*)Last executed health check result for the router
checknameThe name of the health check on the router
checktypeThe type of the health check - basic or advanced
detailsDetailed response generated on running health check
lastupdatedThe date this VPC was created
statusthe result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}
successThe result of the health check if available
nic(*)The list of NICs associated with the router
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/rebootSystemVm.html b/static/api/apidocs-4.23/apis/rebootSystemVm.html new file mode 100644 index 0000000000..3f1aa4773d --- /dev/null +++ b/static/api/apidocs-4.23/apis/rebootSystemVm.html @@ -0,0 +1,201 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

rebootSystemVm

+

Reboots a system VM.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the System VMtrue
forcedForce reboot the System VM (System VM is Stopped and then Started)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the System VM
activeviewersessionsThe number of active console sessions for the console proxy System VM
agentstateThe agent state of the System VM
archCPU arch of the system VM
createdThe date and time the System VM was created
disconnectedThe last disconnected date of host
dns1The first DNS for the System VM
dns2The second DNS for the System VM
gatewayThe gateway for the System VM
guestvlanGuest VLAN range
hostcontrolstateThe control state of the host for the System VM
hostidThe host ID for the System VM
hostnameThe hostname for the System VM
hypervisorThe hypervisor on which the Template runs
isdynamicallyscalableTrue if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
linklocalipThe Control IP address for the System VM
linklocalmacaddressThe link local MAC address for the System VM
linklocalnetmaskThe link local netmask for the System VM
nameThe name of the System VM
networkdomainThe Network domain for the System VM
podidThe Pod ID for the System VM
podnameThe Pod name for the System VM
privateipThe private IP address for the System VM
privatemacaddressThe private MAC address for the System VM
privatenetmaskThe private netmask for the System VM
publicipThe public IP address for the System VM
publicmacaddressThe public MAC address for the System VM
publicnetmaskThe public netmask for the System VM
publicvlanPublic VLAN range
serviceofferingidthe ID of the service offering of the system virtual machine.
serviceofferingnamethe name of the service offering of the system virtual machine.
stateThe state of the System VM
storageipthe ip address for the system VM on the storage network
systemvmtypeThe System VM type
templateidThe Template ID for the System VM
templatenameThe Template name for the System VM
versionThe systemvm agent version
zoneidThe Zone ID for the System VM
zonenameThe Zone name for the System VM
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/rebootVirtualMachine.html b/static/api/apidocs-4.23/apis/rebootVirtualMachine.html new file mode 100644 index 0000000000..b575c9d87b --- /dev/null +++ b/static/api/apidocs-4.23/apis/rebootVirtualMachine.html @@ -0,0 +1,702 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

rebootVirtualMachine

+

Reboots an Instance.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instancetrue
bootintosetupBoot into hardware setup menu or notfalse
forcedForce reboot the Instance (It is Stopped and then Started)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/reconnectHost.html b/static/api/apidocs-4.23/apis/reconnectHost.html new file mode 100644 index 0000000000..57ef69a101 --- /dev/null +++ b/static/api/apidocs-4.23/apis/reconnectHost.html @@ -0,0 +1,345 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

reconnectHost

+

Reconnects a host.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe host IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the host
annotationThe last annotation set on this host by an admin
archCPU Arch of the host
capabilitiesCapabilities of the host
clusteridThe cluster ID of the host
clusternameThe cluster name of the host
clusterstorageaccessgroupscomma-separated list of storage access groups on the cluster
clustertypeThe cluster type of the cluster that host belongs to
cpuallocatedThe amount of the host's CPU currently allocated
cpuallocatedpercentageThe amount of the host's CPU currently allocated in percentage
cpuallocatedvalueThe amount of the host's CPU currently allocated in MHz
cpuallocatedwithoverprovisioningThe amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor
cpuloadaverageThe average CPU load on the host
cpunumberThe CPU number of the host
cpusocketsThe number of CPU sockets on the host
cpuspeedThe CPU speed of the host
cpuusedThe amount of the host's CPU currently used
cpuwithoverprovisioningThe amount of the host's CPU after applying the cpu.overprovisioning.factor
createdThe date and time the host was created
detailsHost details in key/value pairs.
disconnectedTrue if the host is disconnected. False otherwise.
disksizeallocatedThe host's currently allocated disk size
disksizetotalThe total disk size of the host
encryptionsupportedTrue if the host supports encryption
eventsEvents available for the host
explicithosttagscomma-separated list of explicit host tags for the host
extensionidThe ID of extension for this cluster
extensionnameThe name of extension for this cluster
gputotalTotal GPUs on the Host
gpuusedUsed GPUs on the Host
guestosrulethe guest OS rule
hahostTrue if the host is Ha host (dedicated to Instances started by HA process; false otherwise
hasenoughcapacityTrue if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise
hosthaThe host HA information information
hosttagsComma-separated list of tags for the host
hypervisorThe host hypervisor
hypervisorversionThe hypervisor version
implicithosttagscomma-separated list of implicit host tags for the host
instanceconversionsupportedtrue if the host supports instance conversion (using virt-v2v)
ipaddressThe IP address of the host
islocalstorageactiveTrue if local storage is active, false otherwise
istagaruleWhether the informed tag is a JS interpretable rule or not.
lastannotatedThe last time this host was annotated
lastpingedThe date and time the host was last pinged
managementserveridThe management server ID of the host
managementservernamethe management server name of the host
memoryallocatedThe amount of the host's memory currently allocated
memoryallocatedbytesThe amount of the host's memory currently allocated in bytes
memoryallocatedpercentageThe amount of the host's memory currently allocated in percentage
memorytotalThe memory total of the host, this parameter is deprecated use memorywithoverprovisioning
memoryusedThe amount of the host's memory currently used
memorywithoverprovisioningThe amount of the host's memory after applying the mem.overprovisioning.factor
msid(only for details=core) the msid of the host's management server
nameThe name of the host
networkkbsreadThe incoming Network traffic on the host
networkkbswriteThe outgoing Network traffic on the host
oscategoryidThe OS category ID of the host
oscategorynameThe OS category name of the host
outofbandmanagementThe host out-of-band management information
podidThe Pod ID of the host
podnameThe Pod name of the host
podstorageaccessgroupscomma-separated list of storage access groups on the pod
removedThe date and time the host was removed
resourcestateThe resource state of the host
stateThe state of the host
storageaccessgroupscomma-separated list of storage access groups for the host
suitableformigrationTrue if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise
typeThe host type
ueficapabilityTrue if the host has capability to support UEFI boot
usernameThe admin that annotated this host
versionThe host version
virtualmachineidthe virtual machine id for host type ConsoleProxy and SecondaryStorageVM
zoneidThe Zone ID of the host
zonenameThe Zone name of the host
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
gpugroup(*)GPU cards present in the host
gpugroupnameGPU cards present in the host
vgpu(*)The list of enabled vGPUs
maxcapacityMaximum vGPU can be created with this vGPU type on the given GPU group
maxheadsMaximum displays per user
maxresolutionxMaximum X resolution per display
maxresolutionyMaximum Y resolution per display
maxvgpuperpgpuMaximum no. of vGPU per GPU card (pgpu)
remainingcapacityRemaining capacity in terms of no. of more Instances that can be deployed with this vGPU type
vgputypeModel Name of vGPU
videoramVideo RAM for this vGPU type
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/recoverSharedFileSystem.html b/static/api/apidocs-4.23/apis/recoverSharedFileSystem.html new file mode 100644 index 0000000000..20fd886c02 --- /dev/null +++ b/static/api/apidocs-4.23/apis/recoverSharedFileSystem.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

recoverSharedFileSystem

+

Recover a Shared FileSystem by id

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the shared filesystem to recoverfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/recoverVirtualMachine.html b/static/api/apidocs-4.23/apis/recoverVirtualMachine.html new file mode 100644 index 0000000000..6ff105748e --- /dev/null +++ b/static/api/apidocs-4.23/apis/recoverVirtualMachine.html @@ -0,0 +1,696 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

recoverVirtualMachine

+

Recovers an Instance.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instancetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/recoverVolume.html b/static/api/apidocs-4.23/apis/recoverVolume.html new file mode 100644 index 0000000000..e803dcbe83 --- /dev/null +++ b/static/api/apidocs-4.23/apis/recoverVolume.html @@ -0,0 +1,303 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

recoverVolume

+

Recovers a Destroy volume.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the volumetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the disk volume
accountThe Account associated with the disk volume
attachedThe date the volume was attached to an Instance
chaininfoThe chain info of the volume
clusteridCluster id of the volume
clusternameCluster name where the volume is allocated
createdThe date the disk volume was created
deleteprotectiontrue if volume has delete protection.
destroyedThe boolean state of whether the volume is destroyed or not
deviceidThe ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
diskBytesReadRateBytes read rate of the disk volume
diskBytesWriteRateBytes write rate of the disk volume
diskIopsReadRateIO requests read rate of the disk volume per the disk offering
diskIopsWriteRateIO requests write rate of the disk volume per the disk offering
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingdisplaytextThe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnameName of the disk offering
displayvolumeAn optional field whether to the display the volume to the end User or not.
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathpath of the Domain the disk volume belongs to
encryptformatthe format of the disk encryption if applicable
externaluuidVolume UUID that is given by virtualisation provider (only for VMware)
hypervisorHypervisor the volume belongs to
isextractableTrue if the volume is extractable, false otherwise
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isonameThe name of the ISO attached to the Instance
kmskeyKMS key name of the volume
kmskeyidKMS key id of the volume
kmskeyversionVersion number of the KMS key used for disk encryption if applicable
maxiopsMax IOPS of the disk volume
miniopsMin IOPS of the disk volume
nameName of the disk volume
pathThe path of the volume
physicalsizeThe bytes actually consumed on disk
podidPod id of the volume
podnamePod name of the volume
projectThe project name of the VPN
projectidThe project id of the VPN
provisioningtypeProvisioning type used to create volumes.
quiescevmNeed quiesce Instance or not when taking Snapshot
serviceofferingdisplaytextThe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnameName of the service offering for root disk
sizeSize of the disk volume
snapshotidID of the Snapshot from which this volume was created
stateThe state of the disk volume
statusThe status of the volume
storageName of the primary storage hosting the disk volume
storageidID of the primary storage hosting the disk volume; returned to admin User only
storagetypeShared or local storage
supportsstoragesnapshotTrue if storage Snapshot is supported for the volume, false otherwise
templatedisplaytextAn alternate display text of the Template for the Instance
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
typeType of the disk volume (ROOT or DATADISK)
utilizationThe disk utilization
virtualmachineidID of the Instance
virtualsizeThe bytes allocated
vmdisplaynameDisplay name of the Instance
vmnameName of the Instance
vmstateState of the Instance
vmtypeType of the Instance
volumecheckresultdetails for the volume check result, they may vary for different hypervisors
volumerepairresultdetails for the volume repair result, they may vary for different hypervisors
zoneidID of the availability zone
zonenameName of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/registerCniConfiguration.html b/static/api/apidocs-4.23/apis/registerCniConfiguration.html new file mode 100644 index 0000000000..7036e4d871 --- /dev/null +++ b/static/api/apidocs-4.23/apis/registerCniConfiguration.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

registerCniConfiguration

+

Register a CNI Configuration to be used with CKS cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of the user datatrue
accountan optional account for the user data. Must be used with domainId.false
cniconfigCNI Configuration content to be registered as User datafalse
domainidan optional domainId for the user data. If the account parameter is used, domainId must also be used.false
paramscomma separated list of variables declared in user data contentfalse
projectidan optional project for the user datafalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/registerExtension.html b/static/api/apidocs-4.23/apis/registerExtension.html new file mode 100644 index 0000000000..b363671056 --- /dev/null +++ b/static/api/apidocs-4.23/apis/registerExtension.html @@ -0,0 +1,144 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

registerExtension

+

Register an extension with a resource

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
extensionidID of the extensiontrue
resourceidID of the resource to register the extension withtrue
resourcetypeType of the resourcetrue
detailsDetails in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvaluefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the extension
createdCreation timestamp of the extension
descriptionDescription of the extension
detailsThe details of the extension
isuserdefinedTrue if the extension is added by admin
nameName of the extension
pathThe path of the entry point fo the extension
pathreadyTrue if the extension path is in ready state across management servers
removedRemoval timestamp of the extension, if applicable
reservedresourcedetailsResource detail names as comma separated string that should be reserved and not visible to end users
stateThe state of the extension
typeType of the extension
resources(*)List of resources to which extension is registered to
idID of the resource associated with the extension
createdCreation timestamp of the mapping
detailsthe details of the resource map
nameName of the resource associated with this mapping
typeType of the resource
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/registerIso.html b/static/api/apidocs-4.23/apis/registerIso.html new file mode 100644 index 0000000000..22b6b020b1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/registerIso.html @@ -0,0 +1,308 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

registerIso

+

Registers an existing ISO into the CloudStack Cloud.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name of the ISOtrue
urlThe URL to where the ISO is currently being hostedtrue
zoneidThe ID of the zone you wish to register the ISO to.true
accountAn optional Account name. Must be used with domainId.false
archthe CPU arch of the ISO. Valid options are: x86_64, aarch64, s390xfalse
bootableTrue if this ISO is bootable. If not passed explicitly its assumed to be truefalse
checksumThe 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
directdownloadTrue if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deploymentfalse
displaytextThe display text of the ISO, defaults to the 'name'false
domainidAn optional domainId. If the Account parameter is used, domainId must also be used.false
imagestoreuuidImage store UUIDfalse
isdynamicallyscalableTrue if ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memoryfalse
isextractableTrue if the ISO or its derivatives are extractable; default is falsefalse
isfeaturedTrue if you want this ISO to be featuredfalse
ispublicTrue if you want to register the ISO to be publicly available to all Users, false otherwise.false
ostypeidThe ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passedfalse
passwordenabledTrue if password reset feature is supported; default is falsefalse
projectidRegister ISO for the projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe Account name to which the Template belongs
accountidThe Account id to which the Template belongs
archCPU Arch of the template
bitsThe processor bit size
bootableTrue if the ISO is bootable, false otherwise
checksumChecksum of the Template
childtemplatesIf root disk Template, then IDs of the datas disk Templates this Template owns
createdThe date this Template was created
crossZonesTrue if the Template is managed across all Zones, false otherwise
deployasisVMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is Template
detailsAdditional key/value details tied with Template
directdownloadKVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextThe Template display text
domainThe name of the domain to which the Template belongs
domainidThe ID of the domain to which the Template belongs
domainpathPath of the Domain the template belongs to
downloaddetailsLists the download progress of a Template across all secondary storages
extensionidThe ID of extension linked to this template
extensionnameThe name of extension linked to this template
forcksIf true it indicates that the template can be used for CKS cluster deployments
formatThe format of the Template.
hostidThe ID of the secondary storage host for the Template
hostnameThe name of the secondary storage host for the Template
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
isextractableTrue if the Template is extractable, false otherwise
isfeaturedTrue if this Template is a featured Template, false otherwise
ispublicTrue if this Template is a public Template, false otherwise
isreadyTrue if the Template is ready to be deployed from, false otherwise.
nameThe Template name
ostypeidThe ID of the OS type for this Template.
ostypenameThe name of the OS type for this Template.
parenttemplateidIf Datadisk Template, then id of the root disk Template this Template belongs to
passwordenabledTrue if the reset password feature is enabled, false otherwise
physicalsizeThe physical size of the Template
projectThe project name of the Template
projectidThe project ID of the Template
removedThe date this Template was removed
requireshvmTrue if Template requires HVM enabled, false otherwise
sizeThe size of the Template
sourcetemplateidThe Template ID of the parent Template if present
sshkeyenabledTrue if Template is sshkey enabled, false otherwise
statusThe status of the Template
templatetagThe tag of this Template
templatetypeThe type of the Template
urlThe URL which the Template/ISO is registered from
userdataidThe id of userdata linked to this Template
userdatanameThe name of userdata linked to this Template
userdataparamsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
zoneidThe ID of the zone for this Template
zonenameThe name of the zone for this Template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/registerNetscalerControlCenter.html b/static/api/apidocs-4.23/apis/registerNetscalerControlCenter.html new file mode 100644 index 0000000000..383e86d62c --- /dev/null +++ b/static/api/apidocs-4.23/apis/registerNetscalerControlCenter.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

registerNetscalerControlCenter

+

Adds a netscaler control center device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
ipaddressURL of the netscaler controlcenter appliance.true
numretriesCredentials to reach netscaler controlcenter devicetrue
passwordCredentials to reach netscaler controlcenter devicetrue
usernameCredentials to reach netscaler controlcenter devicetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
gslbproviderTrue if NetScaler device is provisioned to be a GSLB service provider
gslbproviderprivateipPrivate IP of the NetScaler representing GSLB site
gslbproviderpublicipPublic IP of the NetScaler representing GSLB site
ipaddressThe management IP address of the external load balancer
isexclusivegslbproviderTrue if NetScaler device is provisioned exclusively to be a GSLB service provider
lbdevicecapacityDevice capacity
lbdevicededicatedTrue if device is dedicated for an account
lbdeviceidDevice ID of the netscaler load balancer
lbdevicenameDevice name
lbdevicestateDevice state
physicalnetworkidThe physical Network to which this netscaler device belongs to
podidsUsed 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.
privateinterfaceThe private interface of the load balancer
providerName of the provider
publicinterfaceThe public interface of the load balancer
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/registerNetscalerServicePackage.html b/static/api/apidocs-4.23/apis/registerNetscalerServicePackage.html new file mode 100644 index 0000000000..ac3b860d7c --- /dev/null +++ b/static/api/apidocs-4.23/apis/registerNetscalerServicePackage.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

registerNetscalerServicePackage

+

Registers NCC Service Package

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
descriptionDescription of Service Packagetrue
nameName of the service Package.true
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
idService Package UUID
descriptionDescription of Service Package
nameService Package Name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/registerOauthProvider.html b/static/api/apidocs-4.23/apis/registerOauthProvider.html new file mode 100644 index 0000000000..a457aa4e73 --- /dev/null +++ b/static/api/apidocs-4.23/apis/registerOauthProvider.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

registerOauthProvider

+

Register the OAuth2 provider in CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
clientidClient ID pre-registered in the specific OAuth providertrue
descriptionDescription of the OAuth Providertrue
providerName of the provider from the list of OAuth providers supported in CloudStacktrue
redirecturiRedirect URI pre-registered in the specific OAuth providertrue
secretkeySecret Key pre-registered in the specific OAuth providertrue
authorizeurlAuthorize URL for OAuth initialization (only required for keycloak provider)false
detailsAny OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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false
domainDomain path for domain-specific OAuth provider. Ignored when Domain ID is passed.false
domainidDomain ID for domain-specific OAuth provider. If not provided, registers as global providerfalse
tokenurlToken URL for OAuth finalization (only required for keycloak provider)false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/registerSSHKeyPair.html b/static/api/apidocs-4.23/apis/registerSSHKeyPair.html new file mode 100644 index 0000000000..3f79402c01 --- /dev/null +++ b/static/api/apidocs-4.23/apis/registerSSHKeyPair.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

registerSSHKeyPair

+

Register a public key in a keypair under a certain name

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of the keypairtrue
publickeyPublic key material of the keypairtrue
accountAn optional Account for the SSH key. Must be used with domainId.false
domainidAn optional domainId for the SSH key. If the Account parameter is used, domainId must also be used.false
projectidAn optional project for the SSH keyfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the SSH keypair
accountThe owner of the keypair
domainThe domain name of the keypair owner
domainidThe domain id of the keypair owner
fingerprintFingerprint of the public key
nameName of the keypair
projectThe project name of the keypair owner
projectidThe project id of the keypair owner
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/registerTemplate.html b/static/api/apidocs-4.23/apis/registerTemplate.html new file mode 100644 index 0000000000..b22b6c2670 --- /dev/null +++ b/static/api/apidocs-4.23/apis/registerTemplate.html @@ -0,0 +1,344 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

registerTemplate

+

Registers an existing Template into the CloudStack cloud.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
formatThe format for the Template. Possible values include QCOW2, RAW, VHD and OVA.true
hypervisorThe target hypervisor for the Templatetrue
nameThe name of the Templatetrue
urlThe URL of where the Template is hosted. Possible URL include http:// and https://true
accountAn optional accountName. Must be used with domainId.false
archthe CPU arch of the template. Valid options are: x86_64, aarch64, s390xfalse
bits32 or 64 bits support. 64 by defaultfalse
checksumThe 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
deployasis(VMware only) true if Instance deployments should preserve all the configurations defined for this Templatefalse
detailsTemplate details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61false
directdownloadTrue if Template should bypass Secondary Storage and be downloaded to Primary Storage on deploymentfalse
displaytextThe display text of the Template, defaults to 'name'.false
domainidAn optional domainId. If the account parameter is used, domainId must also be used.false
extensionidID of the extensionfalse
externaldetailsDetails in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvaluefalse
forcksif true, the templates would be available for deploying CKS clustersfalse
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance cpu/memoryfalse
isextractableTrue if the Template or its derivatives are extractable; default is falsefalse
isfeaturedTrue if this Template is a featured Template, false otherwisefalse
ispublicTrue if the Template is available to all accounts; default is truefalse
isroutingTrue if the Template type is routing i.e., if Template is used to deploy routerfalse
ostypeidThe 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 Templatefalse
passwordenabledTrue if the Template supports the password reset feature; default is falsefalse
projectidRegister Template for the projectfalse
requireshvmTrue if this Template requires HVMfalse
sshkeyenabledTrue if the Template supports the sshkey upload feature; default is falsefalse
templatetagThe tag for this Template.false
templatetypethe type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).false
zoneidThe ID of the zone the Template is to be hosted onfalse
zoneidsA 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe Account name to which the Template belongs
accountidThe Account id to which the Template belongs
archCPU Arch of the template
bitsThe processor bit size
bootableTrue if the ISO is bootable, false otherwise
checksumChecksum of the Template
childtemplatesIf root disk Template, then IDs of the datas disk Templates this Template owns
createdThe date this Template was created
crossZonesTrue if the Template is managed across all Zones, false otherwise
deployasisVMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is Template
detailsAdditional key/value details tied with Template
directdownloadKVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextThe Template display text
domainThe name of the domain to which the Template belongs
domainidThe ID of the domain to which the Template belongs
domainpathPath of the Domain the template belongs to
downloaddetailsLists the download progress of a Template across all secondary storages
extensionidThe ID of extension linked to this template
extensionnameThe name of extension linked to this template
forcksIf true it indicates that the template can be used for CKS cluster deployments
formatThe format of the Template.
hostidThe ID of the secondary storage host for the Template
hostnameThe name of the secondary storage host for the Template
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
isextractableTrue if the Template is extractable, false otherwise
isfeaturedTrue if this Template is a featured Template, false otherwise
ispublicTrue if this Template is a public Template, false otherwise
isreadyTrue if the Template is ready to be deployed from, false otherwise.
nameThe Template name
ostypeidThe ID of the OS type for this Template.
ostypenameThe name of the OS type for this Template.
parenttemplateidIf Datadisk Template, then id of the root disk Template this Template belongs to
passwordenabledTrue if the reset password feature is enabled, false otherwise
physicalsizeThe physical size of the Template
projectThe project name of the Template
projectidThe project ID of the Template
removedThe date this Template was removed
requireshvmTrue if Template requires HVM enabled, false otherwise
sizeThe size of the Template
sourcetemplateidThe Template ID of the parent Template if present
sshkeyenabledTrue if Template is sshkey enabled, false otherwise
statusThe status of the Template
templatetagThe tag of this Template
templatetypeThe type of the Template
urlThe URL which the Template/ISO is registered from
userdataidThe id of userdata linked to this Template
userdatanameThe name of userdata linked to this Template
userdataparamsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
zoneidThe ID of the zone for this Template
zonenameThe name of the zone for this Template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/registerUserData.html b/static/api/apidocs-4.23/apis/registerUserData.html new file mode 100644 index 0000000000..8324c7cf91 --- /dev/null +++ b/static/api/apidocs-4.23/apis/registerUserData.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

registerUserData

+

Register a new User Data.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of the user datatrue
userdataBase64 encoded User Data 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 32KB of data after base64 encoding, which can be increased upto 1MB using the vm.userdata.max.length settingtrue
accountan optional account for the user data. Must be used with domainId.false
domainidan optional domainId for the user data. If the account parameter is used, domainId must also be used.false
paramscomma separated list of variables declared in user data contentfalse
projectidan optional project for the user datafalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/registerUserKeys.html b/static/api/apidocs-4.23/apis/registerUserKeys.html new file mode 100644 index 0000000000..1f097ca9be --- /dev/null +++ b/static/api/apidocs-4.23/apis/registerUserKeys.html @@ -0,0 +1,159 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

registerUserKeys

+

Registers an API key pair (API and secret keys) for a user.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the user.true
descriptionAPI key pair description.false
enddateExpiration date of the API key pair. 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
nameAPI key pair name.false
rulesThe rules of the API key pair. If no rules are informed, defaults to allowing all account permissions. Otherwise, only the explicitly informed permissions for the key pair will be considered. Lower indexed rules take precedence over higher. Thus, in the following example: "rules[0].rule=deleteUserKeys rules[0].permission=deny rules[1].rule=*UserKey* rules[1].permission=allow", all rules matching the expression "*UserKeys*" will be allowed, except for "deleteUserKeys".false
startdateStart date of the API key pair. 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the API key pair.
accountidAccount ID.
accountnameAccount name.
accounttypeAccount type.
apikeyThe API key of the registered user.
createdAPI key pair creation timestamp.
descriptionAPI key pair description.
domainName of the domain which the account belongs to.
domainidID of the domain which the account belongs to.
domainpathPath of the domain which the account belongs to.
enddateAPI key pair expiration date.
nameName of the API key pair
permissionsPermissions of the API key pair.
roleidID of the role.
rolenameName of the role.
roletypeType of the role (Admin, ResourceAdmin, DomainAdmin, User).
secretkeyThe secret key of the registered user.
startdateAPI key pair start date.
stateState of the API key pair.
useridID of the user that owns the keypair.
usernameUsername of the keypair's owner.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/registerVnfTemplate.html b/static/api/apidocs-4.23/apis/registerVnfTemplate.html new file mode 100644 index 0000000000..37b6ea84d0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/registerVnfTemplate.html @@ -0,0 +1,350 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

registerVnfTemplate

+

Registers an existing VNF template into the CloudStack cloud.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
formatThe format for the Template. Possible values include QCOW2, RAW, VHD and OVA.true
hypervisorThe target hypervisor for the Templatetrue
nameThe name of the Templatetrue
urlThe URL of where the Template is hosted. Possible URL include http:// and https://true
accountAn optional accountName. Must be used with domainId.false
archthe CPU arch of the template. Valid options are: x86_64, aarch64, s390xfalse
bits32 or 64 bits support. 64 by defaultfalse
checksumThe 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
deployasis(VMware only) true if Instance deployments should preserve all the configurations defined for this Templatefalse
detailsTemplate details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61false
directdownloadTrue if Template should bypass Secondary Storage and be downloaded to Primary Storage on deploymentfalse
displaytextThe display text of the Template, defaults to 'name'.false
domainidAn optional domainId. If the account parameter is used, domainId must also be used.false
extensionidID of the extensionfalse
externaldetailsDetails in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvaluefalse
forcksif true, the templates would be available for deploying CKS clustersfalse
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance cpu/memoryfalse
isextractableTrue if the Template or its derivatives are extractable; default is falsefalse
isfeaturedTrue if this Template is a featured Template, false otherwisefalse
ispublicTrue if the Template is available to all accounts; default is truefalse
isroutingTrue if the Template type is routing i.e., if Template is used to deploy routerfalse
ostypeidThe 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 Templatefalse
passwordenabledTrue if the Template supports the password reset feature; default is falsefalse
projectidRegister Template for the projectfalse
requireshvmTrue if this Template requires HVMfalse
sshkeyenabledTrue if the Template supports the sshkey upload feature; default is falsefalse
templatetagThe tag for this Template.false
templatetypethe type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).false
vnfdetailsVNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0false
vnfnicsVNF 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=SecondNICfalse
zoneidThe ID of the zone the Template is to be hosted onfalse
zoneidsA 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe Account name to which the Template belongs
accountidThe Account id to which the Template belongs
archCPU Arch of the template
bitsThe processor bit size
bootableTrue if the ISO is bootable, false otherwise
checksumChecksum of the Template
childtemplatesIf root disk Template, then IDs of the datas disk Templates this Template owns
createdThe date this Template was created
crossZonesTrue if the Template is managed across all Zones, false otherwise
deployasisVMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is Template
detailsAdditional key/value details tied with Template
directdownloadKVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextThe Template display text
domainThe name of the domain to which the Template belongs
domainidThe ID of the domain to which the Template belongs
domainpathPath of the Domain the template belongs to
downloaddetailsLists the download progress of a Template across all secondary storages
extensionidThe ID of extension linked to this template
extensionnameThe name of extension linked to this template
forcksIf true it indicates that the template can be used for CKS cluster deployments
formatThe format of the Template.
hostidThe ID of the secondary storage host for the Template
hostnameThe name of the secondary storage host for the Template
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
isextractableTrue if the Template is extractable, false otherwise
isfeaturedTrue if this Template is a featured Template, false otherwise
ispublicTrue if this Template is a public Template, false otherwise
isreadyTrue if the Template is ready to be deployed from, false otherwise.
nameThe Template name
ostypeidThe ID of the OS type for this Template.
ostypenameThe name of the OS type for this Template.
parenttemplateidIf Datadisk Template, then id of the root disk Template this Template belongs to
passwordenabledTrue if the reset password feature is enabled, false otherwise
physicalsizeThe physical size of the Template
projectThe project name of the Template
projectidThe project ID of the Template
removedThe date this Template was removed
requireshvmTrue if Template requires HVM enabled, false otherwise
sizeThe size of the Template
sourcetemplateidThe Template ID of the parent Template if present
sshkeyenabledTrue if Template is sshkey enabled, false otherwise
statusThe status of the Template
templatetagThe tag of this Template
templatetypeThe type of the Template
urlThe URL which the Template/ISO is registered from
userdataidThe id of userdata linked to this Template
userdatanameThe name of userdata linked to this Template
userdataparamsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
zoneidThe ID of the zone for this Template
zonenameThe name of the zone for this Template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/releaseASNumber.html b/static/api/apidocs-4.23/apis/releaseASNumber.html new file mode 100644 index 0000000000..b6d4ce495c --- /dev/null +++ b/static/api/apidocs-4.23/apis/releaseASNumber.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

releaseASNumber

+

Releases an AS Number back to the pool

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
asnumberthe AS Number to be releasedtrue
zoneidthe zone IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/releaseBgpPeer.html b/static/api/apidocs-4.23/apis/releaseBgpPeer.html new file mode 100644 index 0000000000..f26724c85d --- /dev/null +++ b/static/api/apidocs-4.23/apis/releaseBgpPeer.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

releaseBgpPeer

+

Releases an existing dedicated Bgp Peer.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idId of the Bgp Peertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idid of the bgp peer
accountthe account of the bgp peer
asnumberAS number of bgp peer
createddate when this bgp peer was created.
detailsadditional key/value details of the bgp peer
domainthe domain name of the bgp peer
domainidthe domain ID of the bgp peer
ip6addressIPv6 address of bgp peer
ipaddressIPv4 address of bgp peer
passwordpassword of bgp peer
projectthe project name of the bgp peer
projectidthe project id of the bgp peer
zoneidid of zone to which the bgp peer belongs to.
zonenamename of zone to which the bgp peer belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/releaseDedicatedCluster.html b/static/api/apidocs-4.23/apis/releaseDedicatedCluster.html new file mode 100644 index 0000000000..c166c55120 --- /dev/null +++ b/static/api/apidocs-4.23/apis/releaseDedicatedCluster.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

releaseDedicatedCluster

+

Release the dedication for cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
clusteridThe ID of the Clustertrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/releaseDedicatedGuestVlanRange.html b/static/api/apidocs-4.23/apis/releaseDedicatedGuestVlanRange.html new file mode 100644 index 0000000000..9268d5d074 --- /dev/null +++ b/static/api/apidocs-4.23/apis/releaseDedicatedGuestVlanRange.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

releaseDedicatedGuestVlanRange

+

Releases a dedicated guest vlan range to the system

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the dedicated guest VLAN rangetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/releaseDedicatedHost.html b/static/api/apidocs-4.23/apis/releaseDedicatedHost.html new file mode 100644 index 0000000000..e62ad99da0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/releaseDedicatedHost.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

releaseDedicatedHost

+

Release the dedication for host

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
hostidThe ID of the hosttrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/releaseDedicatedPod.html b/static/api/apidocs-4.23/apis/releaseDedicatedPod.html new file mode 100644 index 0000000000..50cd08ec51 --- /dev/null +++ b/static/api/apidocs-4.23/apis/releaseDedicatedPod.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

releaseDedicatedPod

+

Release the dedication for the pod

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
podidThe ID of the Podtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/releaseDedicatedZone.html b/static/api/apidocs-4.23/apis/releaseDedicatedZone.html new file mode 100644 index 0000000000..baf54f404c --- /dev/null +++ b/static/api/apidocs-4.23/apis/releaseDedicatedZone.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

releaseDedicatedZone

+

Release dedication of zone

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
zoneidThe ID of the Zonetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/releaseHostReservation.html b/static/api/apidocs-4.23/apis/releaseHostReservation.html new file mode 100644 index 0000000000..0ca57c3277 --- /dev/null +++ b/static/api/apidocs-4.23/apis/releaseHostReservation.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

releaseHostReservation

+

Releases host reservation.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe host IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/releaseIpAddress.html b/static/api/apidocs-4.23/apis/releaseIpAddress.html new file mode 100644 index 0000000000..52afce8a1c --- /dev/null +++ b/static/api/apidocs-4.23/apis/releaseIpAddress.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

releaseIpAddress

+

Releases an IP address from the Account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the public IP address to releasetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/releaseIpv4SubnetForZone.html b/static/api/apidocs-4.23/apis/releaseIpv4SubnetForZone.html new file mode 100644 index 0000000000..a88ce68e7d --- /dev/null +++ b/static/api/apidocs-4.23/apis/releaseIpv4SubnetForZone.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

releaseIpv4SubnetForZone

+

Releases an existing dedicated IPv4 subnet for a zone.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idId of the guest network IPv4 subnettrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idid of the guest IPv4 subnet
accountthe account of the IPv4 subnet
createddate when this IPv4 subnet was created.
domainthe domain name of the IPv4 subnet
domainidthe domain ID of the IPv4 subnet
projectthe project name of the IPv4 subnet
projectidthe project id of the IPv4 subnet
subnetguest IPv4 subnet
zoneidid of zone to which the IPv4 subnet belongs to.
zonenamename of zone to which the IPv4 subnet belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/releasePodIpAddress.html b/static/api/apidocs-4.23/apis/releasePodIpAddress.html new file mode 100644 index 0000000000..8430418eed --- /dev/null +++ b/static/api/apidocs-4.23/apis/releasePodIpAddress.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

releasePodIpAddress

+

Releases a Pod IP back to the Pod

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idUUID of the Pod IPtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/releasePublicIpRange.html b/static/api/apidocs-4.23/apis/releasePublicIpRange.html new file mode 100644 index 0000000000..32e50f091b --- /dev/null +++ b/static/api/apidocs-4.23/apis/releasePublicIpRange.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

releasePublicIpRange

+

Releases a Public IP range back to the system pool

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Public IP rangetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeAnnotation.html b/static/api/apidocs-4.23/apis/removeAnnotation.html new file mode 100644 index 0000000000..7b20b84a8c --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeAnnotation.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeAnnotation

+

Remove an annotation.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the annotationtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe UUID of the annotation
adminsonlyTrue if the annotation is available for admins only
annotationThe contents of the annotation
createdThe creation timestamp for this annotation
entityidThe UUID of the entity to which this annotation pertains
entitynameThe name of the entity to which this annotation pertains
entitytypeThe type of the annotated entity
removedThe removal timestamp for this annotation
useridThe UUID of the User that entered the annotation
usernameThe username of the User that entered the annotation
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeCertFromLoadBalancer.html b/static/api/apidocs-4.23/apis/removeCertFromLoadBalancer.html new file mode 100644 index 0000000000..40016777a9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeCertFromLoadBalancer.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeCertFromLoadBalancer

+

Removes a certificate from a load balancer rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
lbruleidThe ID of the load balancer ruletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeFromGlobalLoadBalancerRule.html b/static/api/apidocs-4.23/apis/removeFromGlobalLoadBalancerRule.html new file mode 100644 index 0000000000..86c29d32b5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeFromGlobalLoadBalancerRule.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeFromGlobalLoadBalancerRule

+

Removes a load balancer rule association with global load balancer rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the load balancer ruletrue
loadbalancerrulelistThe list load balancer rules that will be assigned to global load balancer ruletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeFromLoadBalancerRule.html b/static/api/apidocs-4.23/apis/removeFromLoadBalancerRule.html new file mode 100644 index 0000000000..f0310c79bc --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeFromLoadBalancerRule.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeFromLoadBalancerRule

+

Removes an Instance or a list of Instances from a load balancer rule.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the load balancer ruletrue
virtualmachineidsThe list of IDs of the Instances that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)false
vmidipmapVM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeGuestOs.html b/static/api/apidocs-4.23/apis/removeGuestOs.html new file mode 100644 index 0000000000..599d68ac49 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeGuestOs.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeGuestOs

+

Removes a Guest OS from listing.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the guest OStrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeGuestOsMapping.html b/static/api/apidocs-4.23/apis/removeGuestOsMapping.html new file mode 100644 index 0000000000..a263fabd96 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeGuestOsMapping.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeGuestOsMapping

+

Removes a Guest OS Mapping.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the guest OS mappingtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeGuiTheme.html b/static/api/apidocs-4.23/apis/removeGuiTheme.html new file mode 100644 index 0000000000..0879965969 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeGuiTheme.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeGuiTheme

+

Removes an existing GUI theme.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe unique identifier of the GUI theme to be removed.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the custom GUI theme.
accountidsA set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.
commonnamesA set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com
createdWhen the GUI theme was created.
cssThe CSS to be retrieved and imported into the GUI when matching the theme access configurations.
descriptionDescription of the GUI theme.
domainidsA set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.
ispublicDefines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.
jsonconfigurationThe JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.
loginbasedomainThe ACS domain to be used as base for the login when accessing the GUI through the common name defined in the theme. If a common name is not defined, this parameter is ignored on the GUI.
nameName of the GUI theme.
recursivedomainsWhether to consider the subdomains of the informed domain IDs.
removedWhen the GUI theme was removed.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeIpFromNic.html b/static/api/apidocs-4.23/apis/removeIpFromNic.html new file mode 100644 index 0000000000..8512b827dd --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeIpFromNic.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeIpFromNic

+

Removes secondary IP from the NIC.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the secondary ip address to NICtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeManagementServer.html b/static/api/apidocs-4.23/apis/removeManagementServer.html new file mode 100644 index 0000000000..d602acba59 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeManagementServer.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeManagementServer

+

Removes a Management Server.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the Management Servertrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeNetworkPermissions.html b/static/api/apidocs-4.23/apis/removeNetworkPermissions.html new file mode 100644 index 0000000000..e0275d0708 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeNetworkPermissions.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeNetworkPermissions

+

Removes Network permissions.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
networkidThe Network IDtrue
accountidsA comma delimited list of account IDs within owner's domain. If specified, "op" parameter has to be passed in.false
accountsA comma delimited list of Accounts within owner's domain. If specified, "op" parameter has to be passed in.false
projectidsA comma delimited list of projects within owner's domain. If specified, "op" parameter has to be passed in.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeNicFromVirtualMachine.html b/static/api/apidocs-4.23/apis/removeNicFromVirtualMachine.html new file mode 100644 index 0000000000..760ec8db76 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeNicFromVirtualMachine.html @@ -0,0 +1,699 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeNicFromVirtualMachine

+

Removes Instance from specified network by deleting a NIC

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
nicidNIC IDtrue
virtualmachineidInstance IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeNodesFromKubernetesCluster.html b/static/api/apidocs-4.23/apis/removeNodesFromKubernetesCluster.html new file mode 100644 index 0000000000..2e658f3a03 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeNodesFromKubernetesCluster.html @@ -0,0 +1,243 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeNodesFromKubernetesCluster

+

Removes external nodes from a CKS cluster.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the Kubernetes clustertrue
nodeidscomma separated list of node (physical or virtual machines) IDs that need to beremoved from the Kubernetes cluster (CKS)true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Kubernetes cluster
accountThe Account associated with the Kubernetes cluster
associatednetworknameThe name of the network of the Kubernetes cluster
autoscalingenabledWhether autoscaling is enabled for the cluster
clustertypeThe type of the cluster
cniconfignameName of CNI Configuration associated with the cluster
cniconfigurationidID of CNI Configuration associated with the cluster
consoleendpointURL end point for the Kubernetes cluster dashboard UI
controlaffinitygroupidsThe IDs of affinity groups associated with control nodes
controlaffinitygroupnamesThe names of affinity groups associated with control nodes
controlnodesThe control nodes count for the Kubernetes cluster
controlofferingidthe ID of the service offering of the control nodes on the Kubernetes cluster
controlofferingnamethe name of the service offering of the control nodes on the Kubernetes cluster
cpunumberThe cpu cores of the Kubernetes cluster
createdThe date when this Kubernetes cluster was created
csienabledIndicates if the CloudStack CSI driver has been setup in the cluster
descriptionThe description of the Kubernetes cluster
domainThe name of the domain in which the Kubernetes cluster exists
domainidThe ID of the domain in which the Kubernetes cluster exists
domainpathPath of the domain to which the Kubernetes cluster belongs
endpointURL end point for the Kubernetes cluster
etcdaffinitygroupidsThe IDs of affinity groups associated with etcd nodes
etcdaffinitygroupnamesThe names of affinity groups associated with etcd nodes
etcdipsPublic IP Addresses of the etcd nodes
etcdnodesthe number of the etcd nodes on the Kubernetes cluster
etcdofferingidthe ID of the service offering of the etcd nodes on the Kubernetes cluster
etcdofferingnamethe name of the service offering of the etcd nodes on the Kubernetes cluster
ipaddressPublic IP Address of the cluster
ipaddressidPublic IP Address ID of the cluster
keypairKeypair details
kubernetesversionidThe ID of the Kubernetes version for the Kubernetes cluster
kubernetesversionnameThe name of the Kubernetes version for the Kubernetes cluster
masternodesThe master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.
maxsizeMaximum size of the cluster
memoryThe memory the Kubernetes cluster
minsizeMinimum size of the cluster
nameThe name of the Kubernetes cluster
networkidThe ID of the network of the Kubernetes cluster
projectThe project name of the Kubernetes cluster
projectidThe project id of the Kubernetes cluster
serviceofferingidThe ID of the service offering of the Kubernetes cluster
serviceofferingnameThe name of the service offering of the Kubernetes cluster
sizeThe size (worker nodes count) of the Kubernetes cluster
stateThe state of the Kubernetes cluster
templateidThe ID of the Template of the Kubernetes cluster
templatenamethe name of the template of the Kubernetes cluster
virtualmachinesThe list of virtualmachines associated with this Kubernetes cluster
workeraffinitygroupidsThe IDs of affinity groups associated with worker nodes
workeraffinitygroupnamesThe names of affinity groups associated with worker nodes
workerofferingidthe ID of the service offering of the worker nodes on the Kubernetes cluster
workerofferingnamethe name of the service offering of the worker nodes on the Kubernetes cluster
zoneidThe name of the zone of the Kubernetes cluster
zonenameThe name of the zone of the Kubernetes cluster
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeQuarantinedIp.html b/static/api/apidocs-4.23/apis/removeQuarantinedIp.html new file mode 100644 index 0000000000..4dde443160 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeQuarantinedIp.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeQuarantinedIp

+

Removes a public IP address from quarantine. Only IPs in active quarantine can be removed.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
removalreasonThe reason for removing the public IP address from quarantine prematurely.true
idThe 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
ipaddressThe public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the quarantine process.
createdWhen the quarantine was created.
enddateEnd date for the quarantine.
ipaddressThe public IP address in quarantine.
previousowneridAccount ID of the previous public IP address owner.
previousownernameAccount name of the previous public IP address owner.
removalreasonThe reason for removing the IP from quarantine prematurely.
removedWhen the quarantine was removed.
removeraccountidID of the account that removed the IP from quarantine.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeRawUsageRecords.html b/static/api/apidocs-4.23/apis/removeRawUsageRecords.html new file mode 100644 index 0000000000..e33ad557fb --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeRawUsageRecords.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeRawUsageRecords

+

Safely removes raw records from cloud_usage table

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
intervalSpecify 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 todaytrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeRegion.html b/static/api/apidocs-4.23/apis/removeRegion.html new file mode 100644 index 0000000000..478b66eca9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeRegion.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeRegion

+

Removes specified region

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the region to deletetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeResourceDetail.html b/static/api/apidocs-4.23/apis/removeResourceDetail.html new file mode 100644 index 0000000000..bfc5a4224b --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeResourceDetail.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeResourceDetail

+

Removes detail for the Resource.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
resourceidDelete details for resource idtrue
resourcetypeDelete detail by resource typetrue
keyDelete details matching key/value pairsfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeSecondaryStorageSelector.html b/static/api/apidocs-4.23/apis/removeSecondaryStorageSelector.html new file mode 100644 index 0000000000..07cbe6e8fd --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeSecondaryStorageSelector.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeSecondaryStorageSelector

+

Removes an existing secondary storage selector.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe unique identifier of the secondary storage selector to be removed.true
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeTungstenFabricNetworkGatewayFromLogicalRouter.html b/static/api/apidocs-4.23/apis/removeTungstenFabricNetworkGatewayFromLogicalRouter.html new file mode 100644 index 0000000000..4d9669e5f6 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeTungstenFabricNetworkGatewayFromLogicalRouter.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeTungstenFabricNetworkGatewayFromLogicalRouter

+

Remove Tungsten-Fabric network gateway from logical router

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
logicalrouteruuidTungsten-Fabric logical router uuidtrue
networkuuidTungsten-Fabric network uuidtrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric logical router name
networkList Tungsten-Fabric policy network name
uuidTungsten-Fabric logical router uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeTungstenFabricPolicy.html b/static/api/apidocs-4.23/apis/removeTungstenFabricPolicy.html new file mode 100644 index 0000000000..fd6f426ba0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeTungstenFabricPolicy.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeTungstenFabricPolicy

+

Remove Tungsten-Fabric policy

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
networkuuidThe uuid of Tungsten-Fabric networktrue
policyuuidThe uuid of Tungsten-Fabric policytrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric policy name
networkList Tungsten-Fabric policy network name
uuidTungsten-Fabric tag type uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeTungstenFabricPolicyRule.html b/static/api/apidocs-4.23/apis/removeTungstenFabricPolicyRule.html new file mode 100644 index 0000000000..9d5cf95312 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeTungstenFabricPolicyRule.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeTungstenFabricPolicyRule

+

Remove Tungsten-Fabric policy

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
policyuuidThe Uuid of Tungsten-Fabric policytrue
ruleuuidThe Uuid of Tungsten-Fabric policy ruletrue
zoneidThe ID of zonetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric policy name
networkList Tungsten-Fabric policy network name
uuidTungsten-Fabric tag type uuid
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeTungstenFabricTag.html b/static/api/apidocs-4.23/apis/removeTungstenFabricTag.html new file mode 100644 index 0000000000..51385080dc --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeTungstenFabricTag.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeTungstenFabricTag

+

Remove Tungsten-Fabric tag

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
taguuidThe UUID of Tungsten-Fabric tagtrue
zoneidThe ID of Zonetrue
applicationpolicysetuuidThe UUID of Tungsten-Fabric application policy setfalse
networkuuidThe UUID of Networksfalse
nicuuidThe UUID of NICsfalse
policyuuidThe UUID of Tungsten-Fabric policyfalse
vmuuidThe UUID of Instancesfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
nameTungsten-Fabric tag name
networkList Tungsten-Fabric network
nicList Tungsten-Fabric NIC
policyList Tungsten-Fabric policy
uuidTungsten-Fabric tag type uuid
vmList Tungsten-Fabric Instance
zoneidTungsten-Fabric provider zone id
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeVirtualMachineFromBackupOffering.html b/static/api/apidocs-4.23/apis/removeVirtualMachineFromBackupOffering.html new file mode 100644 index 0000000000..039de59166 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeVirtualMachineFromBackupOffering.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeVirtualMachineFromBackupOffering

+

Removes an Instance from any existing backup offering

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidID of the Instancetrue
forcedWhether to force remove Instance from the backup offering that may also delete Instance backups.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeVirtualMachinesFromKubernetesCluster.html b/static/api/apidocs-4.23/apis/removeVirtualMachinesFromKubernetesCluster.html new file mode 100644 index 0000000000..befcd9d92d --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeVirtualMachinesFromKubernetesCluster.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeVirtualMachinesFromKubernetesCluster

+

Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Kubernetes clustertrue
virtualmachineidsThe IDs of the VMs to remove from the clustertrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
idThe ID of the Kubernetes cluster
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeVmwareDc.html b/static/api/apidocs-4.23/apis/removeVmwareDc.html new file mode 100644 index 0000000000..86a7515f44 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeVmwareDc.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeVmwareDc

+

Remove a VMware datacenter from a zone.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
zoneidThe id of Zone from which VMware datacenter has to be removed.true
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/removeVpnUser.html b/static/api/apidocs-4.23/apis/removeVpnUser.html new file mode 100644 index 0000000000..1b5c6a8f00 --- /dev/null +++ b/static/api/apidocs-4.23/apis/removeVpnUser.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

removeVpnUser

+

Removes VPN User

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
usernameUsername for the VPN Usertrue
accountAn optional Account for the VPN User. Must be used with domainId.false
domainidAn optional domainId for the VPN User. If the Account parameter is used, domainId must also be used.false
projectidRemove VPN User from the projectfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/replaceNetworkACLList.html b/static/api/apidocs-4.23/apis/replaceNetworkACLList.html new file mode 100644 index 0000000000..60b3f7ff8a --- /dev/null +++ b/static/api/apidocs-4.23/apis/replaceNetworkACLList.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

replaceNetworkACLList

+

Replaces ACL associated with a network or private gateway

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
aclidThe ID of the network ACLtrue
gatewayidThe ID of the private gatewayfalse
networkidThe ID of the networkfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/reserveIpAddress.html b/static/api/apidocs-4.23/apis/reserveIpAddress.html new file mode 100644 index 0000000000..a1cb270092 --- /dev/null +++ b/static/api/apidocs-4.23/apis/reserveIpAddress.html @@ -0,0 +1,243 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

reserveIpAddress

+

Reserve a public IP to an Account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the public IP address to reservetrue
accountThe Account to reserve with this IP addressfalse
domainidThe ID of the domain to reserve with this IP addressfalse
fordisplayAn optional field, whether to the display the IP to the end User or notfalse
projectidThe ID of the project to reserve with this IP addressfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idPublic IP address ID
accountThe Account the public IP address is associated with
allocatedDate the public IP address was acquired
associatednetworkidThe ID of the Network associated with the IP address
associatednetworknameThe name of the Network associated with the IP address
domainThe domain the public IP address is associated with
domainidThe domain ID the public IP address is associated with
domainpathpath of the domain to which the public IP address belongs
fordisplayIs public IP for display to the regular user
forprovidertrue if range is dedicated for external network providers
forsystemvmstrue if range is dedicated for System VMs
forvirtualnetworkThe virtual Network for the IP address
hasrulesWhether the IP address has Firewall/PortForwarding/LoadBalancing rules defined
ipaddressPublic IP address
isportableIs public IP portable across the zones
issourcenatTrue if the IP address is a source NAT address, false otherwise
isstaticnatTrue if this IP is for static NAT, false otherwise
issystemTrue if this IP is system IP (was allocated as a part of deployVm or createLbRule)
networkidThe ID of the Network where IP belongs to
networknameThe name of the Network where IP belongs to
physicalnetworkidThe physical Network this belongs to
projectThe project name of the address
projectidThe project id of the IP address
purposePurpose of the IP address. In Acton this value is not null for IPs with isSystem=true, and can have either StaticNat or LB value
stateState of the IP address. Can be: Allocating, Allocated, Releasing, Reserved and Free
virtualmachinedisplaynameInstance display name the IP address is assigned to (not null only for static NAT IP)
virtualmachineidInstance id the IP address is assigned to
virtualmachinenameInstance name the IP address is assigned to
virtualmachinetypeInstance type the IP address is assigned to
vlanidThe ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only
vlannameThe VLAN associated with the IP address
vmipaddressInstance (DNAT) IP address (not null only for static NAT IP)
vpcidVPC ID the IP belongs to
vpcnameVPC name the IP belongs to
zoneidThe ID of the zone the public IP address belongs to
zonenameThe name of the zone the public IP address belongs to
tags(*)The list of resource tags associated with IP address
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/resetApiLimit.html b/static/api/apidocs-4.23/apis/resetApiLimit.html new file mode 100644 index 0000000000..e9cfdda50f --- /dev/null +++ b/static/api/apidocs-4.23/apis/resetApiLimit.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

resetApiLimit

+

Reset api count

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
accountThe ID of the Account whose limit to be resetfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/resetConfiguration.html b/static/api/apidocs-4.23/apis/resetConfiguration.html new file mode 100644 index 0000000000..06fcbdf98c --- /dev/null +++ b/static/api/apidocs-4.23/apis/resetConfiguration.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

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

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name of the configurationtrue
accountidThe ID of the Account to reset the parameter value for corresponding accountfalse
clusteridThe ID of the Cluster to reset the parameter value for corresponding clusterfalse
domainidThe ID of the Domain to reset the parameter value for corresponding domainfalse
imagestoreidThe ID of the Image Store to reset the parameter value for corresponding image storefalse
managementserveridthe ID of the Management Server to update the parameter value for corresponding management serverfalse
storageidThe ID of the Storage pool to reset the parameter value for corresponding storage poolfalse
zoneidThe ID of the Zone to reset the parameter value for corresponding zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe value of the configuration
categoryThe category of the configuration
componentThe component of the configuration
defaultvalueThe default value of the configuration
descriptionThe description of the configuration
displaytextThe display text of the configuration
groupThe group of the configuration
isdynamicTrue if the configuration is dynamic
nameThe name of the configuration
optionsThe possible options of the configuration value
parentThe name of the parent configuration
scopeScope (zone/cluster/pool/account) of the parameter that needs to be updated
subgroupThe subgroup of the configuration
typeThe type of the configuration value
valueThe value of the configuration
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/resetNetworkPermissions.html b/static/api/apidocs-4.23/apis/resetNetworkPermissions.html new file mode 100644 index 0000000000..045c361c0b --- /dev/null +++ b/static/api/apidocs-4.23/apis/resetNetworkPermissions.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

resetNetworkPermissions

+

Resets Network permissions.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
networkidThe Network IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/resetPassword.html b/static/api/apidocs-4.23/apis/resetPassword.html new file mode 100644 index 0000000000..2f5c0f0344 --- /dev/null +++ b/static/api/apidocs-4.23/apis/resetPassword.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

resetPassword

+

Resets the password for the user using the token generated via forgotPassword command.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
passwordNew password in clear text (Default hashed to SHA256SALT).true
tokenToken generated via forgotPassword command.true
usernameUsernametrue
domainPath 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
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/resetPasswordForVirtualMachine.html b/static/api/apidocs-4.23/apis/resetPasswordForVirtualMachine.html new file mode 100644 index 0000000000..68537bd340 --- /dev/null +++ b/static/api/apidocs-4.23/apis/resetPasswordForVirtualMachine.html @@ -0,0 +1,699 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

resetPasswordForVirtualMachine

+

Resets the password for Instance. The Instance must be in a "Stopped" state and the Template must already support this feature for this command to take effect. [async]

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instancetrue
passwordThe new password of the virtual machine. If null, a random password will be generated for the VM.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/resetSSHKeyForVirtualMachine.html b/static/api/apidocs-4.23/apis/resetSSHKeyForVirtualMachine.html new file mode 100644 index 0000000000..df3fdc55ff --- /dev/null +++ b/static/api/apidocs-4.23/apis/resetSSHKeyForVirtualMachine.html @@ -0,0 +1,711 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

resetSSHKeyForVirtualMachine

+

Resets the SSH Key for Instance. The Instance must be in a "Stopped" state. [async]

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instancetrue
accountAn optional Account for the SSH key. Must be used with domainId.false
domainidAn optional domainId for the Instance. If the Account parameter is used, domainId must also be used.false
keypairName of the SSH key pair used to login to the Instancefalse
keypairsNames of the SSH key pairs to be used to login to the Instancefalse
projectidAn optional project for the SSH keyfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/resetUserDataForVirtualMachine.html b/static/api/apidocs-4.23/apis/resetUserDataForVirtualMachine.html new file mode 100644 index 0000000000..a196267e01 --- /dev/null +++ b/static/api/apidocs-4.23/apis/resetUserDataForVirtualMachine.html @@ -0,0 +1,714 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

resetUserDataForVirtualMachine

+

Resets the UserData for Instance. The Instance must be in a "Stopped" state. [async]

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instancetrue
accountAn optional Account for the Instance. Must be used with domainId.false
domainidAn optional domainId for the Instance. If the Account parameter is used, domainId must also be used.false
projectidAn optional project for the Instancefalse
userdataAn optional binary data that can be sent to the Instance 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 valuefalse
userdatadetailsUsed to specify the parameters values for the variables in userdata.false
userdataidThe ID of the userdatafalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/resetVpnConnection.html b/static/api/apidocs-4.23/apis/resetVpnConnection.html new file mode 100644 index 0000000000..3c32a25883 --- /dev/null +++ b/static/api/apidocs-4.23/apis/resetVpnConnection.html @@ -0,0 +1,165 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

resetVpnConnection

+

Reset site to site VPN connection

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of VPN connectiontrue
accountAn optional Account for connection. Must be used with domainId.false
domainidAn optional domainId for connection. If the Account parameter is used, domainId must also be used.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe connection ID
accountThe owner
cidrlistGuest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).
createdThe date and time the host was created
domainThe domain name of the owner
domainidThe domain id of the owner
domainpaththe domain path of the owner
dpdIf DPD is enabled for customer gateway
esplifetimeLifetime of ESP SA of customer gateway
esppolicyESP policy of the customer gateway
forceencapIf Force NAT Encapsulation is enabled for customer gateway
fordisplayIs connection for display to the regular user
gatewayPublic IP address id of the customer gateway
ikelifetimeLifetime of IKE SA of customer gateway
ikepolicyIKE policy of the customer gateway
ikeversionWhich IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike
ipsecpskIPsec Preshared-Key of the customer gateway
passiveState of VPN connection
projectThe project name
projectidThe project id
publicipThe public IP address
removedThe date and time the host was removed
s2scustomergatewayidThe customer gateway ID
s2svpngatewayidThe VPN gateway ID
splitconnectionsSplit multiple remote Networks into multiple phase 2 SAs. Often used with Cisco some products.
stateState of VPN connection
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/resizeVolume.html b/static/api/apidocs-4.23/apis/resizeVolume.html new file mode 100644 index 0000000000..211f83b2cd --- /dev/null +++ b/static/api/apidocs-4.23/apis/resizeVolume.html @@ -0,0 +1,321 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

resizeVolume

+

Resizes a volume

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the disk volumetrue
automigrateFlag to allow automatic migration of the volume to another suitable storage pool that accommodates the new sizefalse
diskofferingidNew disk offering IDfalse
maxiopsNew maximum number of IOPSfalse
miniopsNew minimum number of IOPSfalse
shrinkokVerify OK to Shrinkfalse
sizeNew volume size in GBfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the disk volume
accountThe Account associated with the disk volume
attachedThe date the volume was attached to an Instance
chaininfoThe chain info of the volume
clusteridCluster id of the volume
clusternameCluster name where the volume is allocated
createdThe date the disk volume was created
deleteprotectiontrue if volume has delete protection.
destroyedThe boolean state of whether the volume is destroyed or not
deviceidThe ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
diskBytesReadRateBytes read rate of the disk volume
diskBytesWriteRateBytes write rate of the disk volume
diskIopsReadRateIO requests read rate of the disk volume per the disk offering
diskIopsWriteRateIO requests write rate of the disk volume per the disk offering
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingdisplaytextThe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnameName of the disk offering
displayvolumeAn optional field whether to the display the volume to the end User or not.
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathpath of the Domain the disk volume belongs to
encryptformatthe format of the disk encryption if applicable
externaluuidVolume UUID that is given by virtualisation provider (only for VMware)
hypervisorHypervisor the volume belongs to
isextractableTrue if the volume is extractable, false otherwise
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isonameThe name of the ISO attached to the Instance
kmskeyKMS key name of the volume
kmskeyidKMS key id of the volume
kmskeyversionVersion number of the KMS key used for disk encryption if applicable
maxiopsMax IOPS of the disk volume
miniopsMin IOPS of the disk volume
nameName of the disk volume
pathThe path of the volume
physicalsizeThe bytes actually consumed on disk
podidPod id of the volume
podnamePod name of the volume
projectThe project name of the VPN
projectidThe project id of the VPN
provisioningtypeProvisioning type used to create volumes.
quiescevmNeed quiesce Instance or not when taking Snapshot
serviceofferingdisplaytextThe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnameName of the service offering for root disk
sizeSize of the disk volume
snapshotidID of the Snapshot from which this volume was created
stateThe state of the disk volume
statusThe status of the volume
storageName of the primary storage hosting the disk volume
storageidID of the primary storage hosting the disk volume; returned to admin User only
storagetypeShared or local storage
supportsstoragesnapshotTrue if storage Snapshot is supported for the volume, false otherwise
templatedisplaytextAn alternate display text of the Template for the Instance
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
typeType of the disk volume (ROOT or DATADISK)
utilizationThe disk utilization
virtualmachineidID of the Instance
virtualsizeThe bytes allocated
vmdisplaynameDisplay name of the Instance
vmnameName of the Instance
vmstateState of the Instance
vmtypeType of the Instance
volumecheckresultdetails for the volume check result, they may vary for different hypervisors
volumerepairresultdetails for the volume repair result, they may vary for different hypervisors
zoneidID of the availability zone
zonenameName of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/restartNetwork.html b/static/api/apidocs-4.23/apis/restartNetwork.html new file mode 100644 index 0000000000..967e12dfdc --- /dev/null +++ b/static/api/apidocs-4.23/apis/restartNetwork.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

restartNetwork

+

Restarts the Network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the network to restart.true
cleanupIf cleanup old network elementsfalse
livepatchLive patches the router software before restarting it. This parameter will only work when 'cleanup' is false.false
makeredundantTurn the network into a network with redundant routers.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/restartSharedFileSystem.html b/static/api/apidocs-4.23/apis/restartSharedFileSystem.html new file mode 100644 index 0000000000..901a11af3d --- /dev/null +++ b/static/api/apidocs-4.23/apis/restartSharedFileSystem.html @@ -0,0 +1,90 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

restartSharedFileSystem

+

Restart a Shared FileSystem

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the shared filesystemtrue
cleanupis cleanup requiredfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/restartVPC.html b/static/api/apidocs-4.23/apis/restartVPC.html new file mode 100644 index 0000000000..68274d296d --- /dev/null +++ b/static/api/apidocs-4.23/apis/restartVPC.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

restartVPC

+

Restarts a VPC

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the VPCtrue
cleanupShould we cleanup the old Network elementsfalse
livepatchLive patches the router software before restarting it. This parameter will only work when 'cleanup' is false.false
makeredundantTurn a single VPC into a redundant one.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/restoreBackup.html b/static/api/apidocs-4.23/apis/restoreBackup.html new file mode 100644 index 0000000000..1669b46912 --- /dev/null +++ b/static/api/apidocs-4.23/apis/restoreBackup.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

restoreBackup

+

Restores an existing stopped or deleted Instance using an Instance backup

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the backuptrue
hostidIf quickrestore is true, which host to start the VM on; otherwise, ignored. Currently this parameter is only supported by the KBOSS provider.false
quickrestoreWhether to use the quick restore process or not. Currently this parameter is only supported by the KBOSS provider.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/restoreVirtualMachine.html b/static/api/apidocs-4.23/apis/restoreVirtualMachine.html new file mode 100644 index 0000000000..d6e34e409b --- /dev/null +++ b/static/api/apidocs-4.23/apis/restoreVirtualMachine.html @@ -0,0 +1,711 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

restoreVirtualMachine

+

Restore an Instance to original Template/ISO or new Template/ISO

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidInstance IDtrue
detailsused to specify the custom parametersfalse
diskofferingidOverride root volume's diskoffering.false
expungeOptional field to expunge old root volume after restore.false
rootdisksizeOverride root volume's size (in GB). Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are providedfalse
templateidAn optional Template Id to restore Instance from the new Template. This can be an ISO id in case of restore Instance deployed using ISOfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/restoreVolumeFromBackupAndAttachToVM.html b/static/api/apidocs-4.23/apis/restoreVolumeFromBackupAndAttachToVM.html new file mode 100644 index 0000000000..3f5e1777bb --- /dev/null +++ b/static/api/apidocs-4.23/apis/restoreVolumeFromBackupAndAttachToVM.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

restoreVolumeFromBackupAndAttachToVM

+

Restore and attach a backed up volume to Instance

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
backupidID of the Instance backuptrue
virtualmachineidID of the Instance where to attach the restored volumetrue
volumeidID of the volume backed uptrue
hostidIf quickrestore is true, which host to start the VM on; otherwise, ignored. Currently this parameter is only supported by the KBOSS provider.false
quickrestoreWhether to use the quick restore process or not. Currently this parameter is only supported by the KBOSS provider.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/revertSnapshot.html b/static/api/apidocs-4.23/apis/revertSnapshot.html new file mode 100644 index 0000000000..a3df6a98e5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/revertSnapshot.html @@ -0,0 +1,186 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

revertSnapshot

+

This is supposed to revert a volume Snapshot. This command is only supported with KVM so far

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Snapshottrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the Snapshot
accountThe Account associated with the Snapshot
chainsizechain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true
createdThe date the Snapshot was created
datastoreidID of the datastore for the snapshot entry
datastorenamename of the datastore for the snapshot entry
datastorestatestate of the snapshot on the datastore
datastoretypetype of the datastore for the snapshot entry
domainThe domain name of the Snapshot's Account
domainidThe domain ID of the Snapshot's Account
domainpathpath of the Domain the snapshot's account belongs to
downloaddetailsdownload progress of a snapshot
intervaltypeValid types are hourly, daily, weekly, monthy, Template, and none.
locationtypeValid location types are primary and secondary.
nameName of the Snapshot
osdisplaynameDisplay name of the os on volume
ostypeidID of the os on volume
parentThe parent ID of the Snapshot
parentnameThe parent name of the Snapshot
physicalsizePhysical size of backed up Snapshot on image store
projectThe project name of the Snapshot
projectidThe project id of the Snapshot
revertableIndicates whether the underlying storage supports reverting the volume to this Snapshot
snapshottypeThe type of the Snapshot
stateThe 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
statusthe status of the template
virtualsizeVirtual size of backedup Snapshot on image store
volumeidID of the disk volume
volumenameName of the disk volume
volumestatestate of the disk volume
volumetypeType of the disk volume
zoneidID of the availability zone
zonenamename of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/revertToVMSnapshot.html b/static/api/apidocs-4.23/apis/revertToVMSnapshot.html new file mode 100644 index 0000000000..8d04d90d7e --- /dev/null +++ b/static/api/apidocs-4.23/apis/revertToVMSnapshot.html @@ -0,0 +1,696 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

revertToVMSnapshot

+

Revert Instance from a vmsnapshot.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
vmsnapshotidThe ID of the Instance Snapshottrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/revokeCertificate.html b/static/api/apidocs-4.23/apis/revokeCertificate.html new file mode 100644 index 0000000000..719ac9da4e --- /dev/null +++ b/static/api/apidocs-4.23/apis/revokeCertificate.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

revokeCertificate

+

Revokes certificate using configured CA plugin

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
serialThe certificate serial number, as a hex valuetrue
cnThe certificate CNfalse
providerName of the CA service provider, otherwise the default configured provider plugin will be usedfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/revokeSecurityGroupEgress.html b/static/api/apidocs-4.23/apis/revokeSecurityGroupEgress.html new file mode 100644 index 0000000000..f2748f6fc2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/revokeSecurityGroupEgress.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

revokeSecurityGroupEgress

+

Deletes a particular egress rule from this security group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the egress ruletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/revokeSecurityGroupIngress.html b/static/api/apidocs-4.23/apis/revokeSecurityGroupIngress.html new file mode 100644 index 0000000000..42cd7b71a3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/revokeSecurityGroupIngress.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

revokeSecurityGroupIngress

+

Deletes a particular ingress rule from this security group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the ingress ruletrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/revokeTemplateDirectDownloadCertificate.html b/static/api/apidocs-4.23/apis/revokeTemplateDirectDownloadCertificate.html new file mode 100644 index 0000000000..23ab323ab2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/revokeTemplateDirectDownloadCertificate.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

revokeTemplateDirectDownloadCertificate

+

Revoke a direct download certificate from hosts in a zone

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
zoneid(Optional) zone to revoke certificatetrue
hostid(Optional) the host ID to revoke certificatefalse
hypervisor(Optional) hypervisor typefalse
idID of the certificatefalse
name(Optional) alias of the SSL certificatefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
detailsIndicates the details in case of failure or host skipped
hostidThe ID of the host
hostnameThe name of the host
statusIndicates if the certificate has been revoked from the host, failed or skipped
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/rotateKMSKey.html b/static/api/apidocs-4.23/apis/rotateKMSKey.html new file mode 100644 index 0000000000..53468d554c --- /dev/null +++ b/static/api/apidocs-4.23/apis/rotateKMSKey.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

rotateKMSKey

+

Rotates KMS key (KEK) by creating new version and scheduling gradual re-encryption

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idKMS Key UUID to rotatetrue
hsmprofileidThe target HSM profile ID for the new KEK version. If provided, migrates the key to this HSM.false
keybitsKey size for new KEK (default: same as current)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account that executed the async command
accountidThe Account ID that executed the async command
cmdThe async command executed
completedThe completed date of the job
createdThe created date of the job
domainidThe domain ID that executed the async command
domainpathThe domain that executed the async command
jobinstanceidThe unique ID of the Instance/entity object related to the job
jobinstancetypeThe Instance/entity object related to the job
jobprocstatusThe progress information of the PENDING job
jobresultThe result reason
jobresultcodeThe result code for the job
jobresulttypeThe result type
managementserveridThe MSID of the management server on which the job is running
managementservernamethe management server name of the host
useridThe User that executed the async command
jobidthe ID of the async job
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/runCustomAction.html b/static/api/apidocs-4.23/apis/runCustomAction.html new file mode 100644 index 0000000000..1f81ab72bb --- /dev/null +++ b/static/api/apidocs-4.23/apis/runCustomAction.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

runCustomAction

+

Run the custom action

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
customactionidID of the custom actiontrue
resourceidID of the instancetrue
parametersParameters in key/value pairs using format parameters[i].keyname=keyvalue. Example: parameters[0].endpoint.url=urlvaluefalse
resourcetypeType of the resourcefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idID of the action
nameName of the action
resultResult of the action execution
successWhether custom action succeed or not
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/runDiagnostics.html b/static/api/apidocs-4.23/apis/runDiagnostics.html new file mode 100644 index 0000000000..51b4d266a8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/runDiagnostics.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

runDiagnostics

+

Execute network-utility command (ping/arping/tracert) on System VMs remotely

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
ipaddressThe IP/Domain address to test connection totrue
targetidThe ID of the System VM to diagnosetrue
typeThe System VM diagnostics type valid options are: ping, traceroute, arpingtrue
paramsAdditional command line options that apply for each commandfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
exitcodeThe command execution return code
stderrThe standard error output from the command execution
stdoutThe standard output from the command execution
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/samlSlo.html b/static/api/apidocs-4.23/apis/samlSlo.html new file mode 100644 index 0000000000..f3be304f22 --- /dev/null +++ b/static/api/apidocs-4.23/apis/samlSlo.html @@ -0,0 +1,81 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

samlSlo

+

SAML Global Log Out API

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
descriptionResponse description
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/samlSso.html b/static/api/apidocs-4.23/apis/samlSso.html new file mode 100644 index 0000000000..8c80e262c9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/samlSso.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

samlSso

+

SP initiated SAML Single Sign On

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idpidIdentity Provider Entity IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account name the User belongs to
domainidDomain ID that the user belongs to
firstnameFirst name of the user
is2faenabledIs two factor authentication enabled
is2faverifiedIs two factor authentication verified
issuerfor2faTwo factor authentication issuer
lastnameLast name of the user
managementserveridManagement Server ID that the user logged to
passwordchangerequiredIndicates whether the User is required to change password on next login.
providerfor2faTwo factor authentication provider
registeredIs user registered
sessionkeySession key that can be passed in subsequent Query command calls
timeoutThe time period before the session has expired
timezoneUser time zone
timezoneoffsetUser time zoneoffset
typeThe Account type (admin, domain-admin, read-only-admin, user)
useridUser ID
usernameUsername
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/scaleKubernetesCluster.html b/static/api/apidocs-4.23/apis/scaleKubernetesCluster.html new file mode 100644 index 0000000000..e4d7bfd8e7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/scaleKubernetesCluster.html @@ -0,0 +1,261 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

scaleKubernetesCluster

+

Scales a created, running or stopped CloudManaged Kubernetes cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Kubernetes clustertrue
autoscalingenabledWhether autoscaling is enabled for the clusterfalse
maxsizeMaximum number of worker nodes in the clusterfalse
minsizeMinimum number of worker nodes in the clusterfalse
nodeidsThe IDs of the nodes to be removedfalse
nodeofferings(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameterfalse
serviceofferingidThe ID of the service offering for the virtual machines in the cluster.false
sizeNumber of Kubernetes cluster nodesfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Kubernetes cluster
accountThe Account associated with the Kubernetes cluster
associatednetworknameThe name of the network of the Kubernetes cluster
autoscalingenabledWhether autoscaling is enabled for the cluster
clustertypeThe type of the cluster
cniconfignameName of CNI Configuration associated with the cluster
cniconfigurationidID of CNI Configuration associated with the cluster
consoleendpointURL end point for the Kubernetes cluster dashboard UI
controlaffinitygroupidsThe IDs of affinity groups associated with control nodes
controlaffinitygroupnamesThe names of affinity groups associated with control nodes
controlnodesThe control nodes count for the Kubernetes cluster
controlofferingidthe ID of the service offering of the control nodes on the Kubernetes cluster
controlofferingnamethe name of the service offering of the control nodes on the Kubernetes cluster
cpunumberThe cpu cores of the Kubernetes cluster
createdThe date when this Kubernetes cluster was created
csienabledIndicates if the CloudStack CSI driver has been setup in the cluster
descriptionThe description of the Kubernetes cluster
domainThe name of the domain in which the Kubernetes cluster exists
domainidThe ID of the domain in which the Kubernetes cluster exists
domainpathPath of the domain to which the Kubernetes cluster belongs
endpointURL end point for the Kubernetes cluster
etcdaffinitygroupidsThe IDs of affinity groups associated with etcd nodes
etcdaffinitygroupnamesThe names of affinity groups associated with etcd nodes
etcdipsPublic IP Addresses of the etcd nodes
etcdnodesthe number of the etcd nodes on the Kubernetes cluster
etcdofferingidthe ID of the service offering of the etcd nodes on the Kubernetes cluster
etcdofferingnamethe name of the service offering of the etcd nodes on the Kubernetes cluster
ipaddressPublic IP Address of the cluster
ipaddressidPublic IP Address ID of the cluster
keypairKeypair details
kubernetesversionidThe ID of the Kubernetes version for the Kubernetes cluster
kubernetesversionnameThe name of the Kubernetes version for the Kubernetes cluster
masternodesThe master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.
maxsizeMaximum size of the cluster
memoryThe memory the Kubernetes cluster
minsizeMinimum size of the cluster
nameThe name of the Kubernetes cluster
networkidThe ID of the network of the Kubernetes cluster
projectThe project name of the Kubernetes cluster
projectidThe project id of the Kubernetes cluster
serviceofferingidThe ID of the service offering of the Kubernetes cluster
serviceofferingnameThe name of the service offering of the Kubernetes cluster
sizeThe size (worker nodes count) of the Kubernetes cluster
stateThe state of the Kubernetes cluster
templateidThe ID of the Template of the Kubernetes cluster
templatenamethe name of the template of the Kubernetes cluster
virtualmachinesThe list of virtualmachines associated with this Kubernetes cluster
workeraffinitygroupidsThe IDs of affinity groups associated with worker nodes
workeraffinitygroupnamesThe names of affinity groups associated with worker nodes
workerofferingidthe ID of the service offering of the worker nodes on the Kubernetes cluster
workerofferingnamethe name of the service offering of the worker nodes on the Kubernetes cluster
zoneidThe name of the zone of the Kubernetes cluster
zonenameThe name of the zone of the Kubernetes cluster
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/scaleSystemVm.html b/static/api/apidocs-4.23/apis/scaleSystemVm.html new file mode 100644 index 0000000000..eebbe5e9fc --- /dev/null +++ b/static/api/apidocs-4.23/apis/scaleSystemVm.html @@ -0,0 +1,204 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

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.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the system vmtrue
serviceofferingidThe service offering ID to apply to the system vmtrue
detailsName value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=valuefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the System VM
activeviewersessionsThe number of active console sessions for the console proxy System VM
agentstateThe agent state of the System VM
archCPU arch of the system VM
createdThe date and time the System VM was created
disconnectedThe last disconnected date of host
dns1The first DNS for the System VM
dns2The second DNS for the System VM
gatewayThe gateway for the System VM
guestvlanGuest VLAN range
hostcontrolstateThe control state of the host for the System VM
hostidThe host ID for the System VM
hostnameThe hostname for the System VM
hypervisorThe hypervisor on which the Template runs
isdynamicallyscalableTrue if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
linklocalipThe Control IP address for the System VM
linklocalmacaddressThe link local MAC address for the System VM
linklocalnetmaskThe link local netmask for the System VM
nameThe name of the System VM
networkdomainThe Network domain for the System VM
podidThe Pod ID for the System VM
podnameThe Pod name for the System VM
privateipThe private IP address for the System VM
privatemacaddressThe private MAC address for the System VM
privatenetmaskThe private netmask for the System VM
publicipThe public IP address for the System VM
publicmacaddressThe public MAC address for the System VM
publicnetmaskThe public netmask for the System VM
publicvlanPublic VLAN range
serviceofferingidthe ID of the service offering of the system virtual machine.
serviceofferingnamethe name of the service offering of the system virtual machine.
stateThe state of the System VM
storageipthe ip address for the system VM on the storage network
systemvmtypeThe System VM type
templateidThe Template ID for the System VM
templatenameThe Template name for the System VM
versionThe systemvm agent version
zoneidThe Zone ID for the System VM
zonenameThe Zone name for the System VM
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/scaleVirtualMachine.html b/static/api/apidocs-4.23/apis/scaleVirtualMachine.html new file mode 100644 index 0000000000..233a4f57d8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/scaleVirtualMachine.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

scaleVirtualMachine

+

Scales the Instance 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.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instancetrue
serviceofferingidThe ID of the service offering for the Instancetrue
automigrateFlag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offeringfalse
detailsName value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=valuefalse
maxiopsNew maximum number of IOPS for the custom disk offeringfalse
miniopsNew minimum number of IOPS for the custom disk offeringfalse
shrinkokVerify OK to Shrinkfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/searchLdap.html b/static/api/apidocs-4.23/apis/searchLdap.html new file mode 100644 index 0000000000..d20bab7b6d --- /dev/null +++ b/static/api/apidocs-4.23/apis/searchLdap.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

searchLdap

+

Searches LDAP based on the username attribute

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
queryQuery to search usingtrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
conflictingusersourceThe authentication source for this user as known to the system or empty if the user is not yet in cloudstack.
domainThe user's domain
emailThe user's email
firstnameThe user's firstname
lastnameThe user's lastname
principalThe user's principle
usernameThe user's username
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/setupUserTwoFactorAuthentication.html b/static/api/apidocs-4.23/apis/setupUserTwoFactorAuthentication.html new file mode 100644 index 0000000000..114600db6f --- /dev/null +++ b/static/api/apidocs-4.23/apis/setupUserTwoFactorAuthentication.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

setupUserTwoFactorAuthentication

+

Setup the 2FA for the user.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enableEnabled by default, provide false to disable 2FAfalse
providerTwo factor authentication codefalse
useridOptional: the id of the User for which 2FA has to be disabledfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idThe user ID
accountidThe Account ID of the user
secretcodeSecret code that needs to be registered with authenticator
usernameThe user name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/startBackup.html b/static/api/apidocs-4.23/apis/startBackup.html new file mode 100644 index 0000000000..df9906c44f --- /dev/null +++ b/static/api/apidocs-4.23/apis/startBackup.html @@ -0,0 +1,177 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

startBackup

+

Start a VM backup session using pull mode backup-begin on the KVM host. This API is intended for testing only and is disabled by default.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidID of the VMtrue
descriptionthe description for the backupfalse
namethe name of the backupfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the Instance backup
accountAccount name
accountidAccount id
backupofferingidBackup offering id
backupofferingnameBackup offering name
compressionstatusBackup compression status.
createdBackup date
descriptiondescription for the backup
domainDomain name
domainidDomain ID
externalidExternal backup id
fromcheckpointidPrevious active checkpoint ID for incremental backups
hostidHost ID where the backup is running
intervaltypeInterval type of the backup
isbackupvmexpungedIndicates whether the VM from which the backup was taken is expunged or not
namename of the backup
sizeBackup size in bytes
statusBackup status
tocheckpointidNext checkpoint ID for incremental backups
typeBackup type
uncompressedsizeBackup uncompressed size in bytes. Only defined if backup is compressed.
validationstatusBackup validation status.
virtualmachineidID of the Instance
virtualmachinenameName of the Instance
virtualsizeBackup protected (virtual) size in bytes
vmbackupofferingremovedThe backup offering corresponding to this backup was removed from the VM
vmdetailsLists the vm specific details for the backup
volumesBacked up volumes
zoneZone name
zoneidZone ID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/startInternalLoadBalancerVM.html b/static/api/apidocs-4.23/apis/startInternalLoadBalancerVM.html new file mode 100644 index 0000000000..9714fd919c --- /dev/null +++ b/static/api/apidocs-4.23/apis/startInternalLoadBalancerVM.html @@ -0,0 +1,360 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

startInternalLoadBalancerVM

+

Starts an existing Internal LB Instance.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Internal LB Instancetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the router
accountThe Account associated with the router
archCPU arch of the router
createdThe date and time the router was created
dns1The first DNS for the router
dns2The second DNS for the router
domainThe domain associated with the router
domainidThe domain ID associated with the router
domainpathpath of the Domain the router belongs to
gatewayThe gateway for the router
guestipaddressThe guest IP address for the router
guestmacaddressThe guest MAC address for the router
guestnetmaskThe guest netmask for the router
guestnetworkidThe ID of the corresponding guest Network
guestnetworknameThe name of the corresponding guest Network
healthchecksfailedTrue if any health checks had failed
hostcontrolstateThe control state of the host for the router
hostidThe host ID for the router
hostnameThe hostname for the router
hypervisorThe hypervisor on which the Template runs
ip6dns1The first IPv6 DNS for the router
ip6dns2The second IPv6 DNS for the router
isredundantrouterIf this router is an redundant virtual router
linklocalipThe Control IP address for the router
linklocalmacaddressThe link local MAC address for the router
linklocalnetmaskThe link local netmask for the router
linklocalnetworkidThe ID of the corresponding link local Network
nameThe name of the router
networkdomainThe Network domain for the router
podidThe Pod ID for the router
podnameThe Pod name for the router
projectThe project name of the address
projectidThe project id of the IP address
publicipThe public IP address for the router
publicmacaddressThe public MAC address for the router
publicnetmaskThe public netmask for the router
publicnetworkidThe ID of the corresponding public Network
redundantstateThe state of redundant virtual router
requiresupgradeTrue if the router Template requires upgrade
roleRole of the domain router
scriptsversionThe version of scripts
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
softwareversionThe version of the code / software in the router
stateThe state of the router
templateidThe Template ID for the router
templatenameThe Template name for the router
versionThe version of Template
vpcidVPC the router belongs to
vpcnameThe name of VPC the router belongs to
zoneidThe Zone ID for the router
zonenameThe Zone name for the router
healthcheckresults(*)Last executed health check result for the router
checknameThe name of the health check on the router
checktypeThe type of the health check - basic or advanced
detailsDetailed response generated on running health check
lastupdatedThe date this VPC was created
statusthe result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}
successThe result of the health check if available
nic(*)The list of NICs associated with the router
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/startKubernetesCluster.html b/static/api/apidocs-4.23/apis/startKubernetesCluster.html new file mode 100644 index 0000000000..66b580d7fe --- /dev/null +++ b/static/api/apidocs-4.23/apis/startKubernetesCluster.html @@ -0,0 +1,240 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

startKubernetesCluster

+

Starts a stopped CloudManaged Kubernetes cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Kubernetes clustertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Kubernetes cluster
accountThe Account associated with the Kubernetes cluster
associatednetworknameThe name of the network of the Kubernetes cluster
autoscalingenabledWhether autoscaling is enabled for the cluster
clustertypeThe type of the cluster
cniconfignameName of CNI Configuration associated with the cluster
cniconfigurationidID of CNI Configuration associated with the cluster
consoleendpointURL end point for the Kubernetes cluster dashboard UI
controlaffinitygroupidsThe IDs of affinity groups associated with control nodes
controlaffinitygroupnamesThe names of affinity groups associated with control nodes
controlnodesThe control nodes count for the Kubernetes cluster
controlofferingidthe ID of the service offering of the control nodes on the Kubernetes cluster
controlofferingnamethe name of the service offering of the control nodes on the Kubernetes cluster
cpunumberThe cpu cores of the Kubernetes cluster
createdThe date when this Kubernetes cluster was created
csienabledIndicates if the CloudStack CSI driver has been setup in the cluster
descriptionThe description of the Kubernetes cluster
domainThe name of the domain in which the Kubernetes cluster exists
domainidThe ID of the domain in which the Kubernetes cluster exists
domainpathPath of the domain to which the Kubernetes cluster belongs
endpointURL end point for the Kubernetes cluster
etcdaffinitygroupidsThe IDs of affinity groups associated with etcd nodes
etcdaffinitygroupnamesThe names of affinity groups associated with etcd nodes
etcdipsPublic IP Addresses of the etcd nodes
etcdnodesthe number of the etcd nodes on the Kubernetes cluster
etcdofferingidthe ID of the service offering of the etcd nodes on the Kubernetes cluster
etcdofferingnamethe name of the service offering of the etcd nodes on the Kubernetes cluster
ipaddressPublic IP Address of the cluster
ipaddressidPublic IP Address ID of the cluster
keypairKeypair details
kubernetesversionidThe ID of the Kubernetes version for the Kubernetes cluster
kubernetesversionnameThe name of the Kubernetes version for the Kubernetes cluster
masternodesThe master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.
maxsizeMaximum size of the cluster
memoryThe memory the Kubernetes cluster
minsizeMinimum size of the cluster
nameThe name of the Kubernetes cluster
networkidThe ID of the network of the Kubernetes cluster
projectThe project name of the Kubernetes cluster
projectidThe project id of the Kubernetes cluster
serviceofferingidThe ID of the service offering of the Kubernetes cluster
serviceofferingnameThe name of the service offering of the Kubernetes cluster
sizeThe size (worker nodes count) of the Kubernetes cluster
stateThe state of the Kubernetes cluster
templateidThe ID of the Template of the Kubernetes cluster
templatenamethe name of the template of the Kubernetes cluster
virtualmachinesThe list of virtualmachines associated with this Kubernetes cluster
workeraffinitygroupidsThe IDs of affinity groups associated with worker nodes
workeraffinitygroupnamesThe names of affinity groups associated with worker nodes
workerofferingidthe ID of the service offering of the worker nodes on the Kubernetes cluster
workerofferingnamethe name of the service offering of the worker nodes on the Kubernetes cluster
zoneidThe name of the zone of the Kubernetes cluster
zonenameThe name of the zone of the Kubernetes cluster
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/startRollingMaintenance.html b/static/api/apidocs-4.23/apis/startRollingMaintenance.html new file mode 100644 index 0000000000..bf8d79ce20 --- /dev/null +++ b/static/api/apidocs-4.23/apis/startRollingMaintenance.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

startRollingMaintenance

+

Start rolling maintenance

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
clusteridsThe IDs of the clusters to start maintenance onfalse
forcedIf rolling mechanism should continue in case of an errorfalse
hostidsThe IDs of the hosts to start maintenance onfalse
payloadThe command to execute while hosts are on maintenancefalse
podidsThe IDs of the pods to start maintenance onfalse
timeoutOptional operation timeout (in seconds) that overrides the global timeout settingfalse
zoneidsThe IDs of the zones to start maintenance onfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
detailsIn case of failure, details are displayed
successIndicates if the rolling maintenance operation was successful
hostsskipped(*)The hosts skipped
hostidThe ID of the skipped host
hostnameThe name of the skipped host
reasonThe reason to skip the host
hostsupdated(*)The hosts updated
enddateEnd date of the update on the host
hostidThe ID of the updated host
hostnameThe name of the updated host
outputOutput of the maintenance script on the host
startdateStart date of the update on the host
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/startRouter.html b/static/api/apidocs-4.23/apis/startRouter.html new file mode 100644 index 0000000000..6548bdae29 --- /dev/null +++ b/static/api/apidocs-4.23/apis/startRouter.html @@ -0,0 +1,360 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

startRouter

+

Starts a router.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the routertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the router
accountThe Account associated with the router
archCPU arch of the router
createdThe date and time the router was created
dns1The first DNS for the router
dns2The second DNS for the router
domainThe domain associated with the router
domainidThe domain ID associated with the router
domainpathpath of the Domain the router belongs to
gatewayThe gateway for the router
guestipaddressThe guest IP address for the router
guestmacaddressThe guest MAC address for the router
guestnetmaskThe guest netmask for the router
guestnetworkidThe ID of the corresponding guest Network
guestnetworknameThe name of the corresponding guest Network
healthchecksfailedTrue if any health checks had failed
hostcontrolstateThe control state of the host for the router
hostidThe host ID for the router
hostnameThe hostname for the router
hypervisorThe hypervisor on which the Template runs
ip6dns1The first IPv6 DNS for the router
ip6dns2The second IPv6 DNS for the router
isredundantrouterIf this router is an redundant virtual router
linklocalipThe Control IP address for the router
linklocalmacaddressThe link local MAC address for the router
linklocalnetmaskThe link local netmask for the router
linklocalnetworkidThe ID of the corresponding link local Network
nameThe name of the router
networkdomainThe Network domain for the router
podidThe Pod ID for the router
podnameThe Pod name for the router
projectThe project name of the address
projectidThe project id of the IP address
publicipThe public IP address for the router
publicmacaddressThe public MAC address for the router
publicnetmaskThe public netmask for the router
publicnetworkidThe ID of the corresponding public Network
redundantstateThe state of redundant virtual router
requiresupgradeTrue if the router Template requires upgrade
roleRole of the domain router
scriptsversionThe version of scripts
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
softwareversionThe version of the code / software in the router
stateThe state of the router
templateidThe Template ID for the router
templatenameThe Template name for the router
versionThe version of Template
vpcidVPC the router belongs to
vpcnameThe name of VPC the router belongs to
zoneidThe Zone ID for the router
zonenameThe Zone name for the router
healthcheckresults(*)Last executed health check result for the router
checknameThe name of the health check on the router
checktypeThe type of the health check - basic or advanced
detailsDetailed response generated on running health check
lastupdatedThe date this VPC was created
statusthe result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}
successThe result of the health check if available
nic(*)The list of NICs associated with the router
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/startSharedFileSystem.html b/static/api/apidocs-4.23/apis/startSharedFileSystem.html new file mode 100644 index 0000000000..a8cfde2b83 --- /dev/null +++ b/static/api/apidocs-4.23/apis/startSharedFileSystem.html @@ -0,0 +1,300 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

startSharedFileSystem

+

Start a Shared FileSystem

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the shared filesystemtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the shared filesystem
accountthe account associated with the shared filesystem
descriptiondescription of the shared filesystem
diskioreadthe read (IO) of disk on the shared filesystem
diskiowritethe write (IO) of disk on the shared filesystem
diskkbsreadthe shared filesystem's disk read in KiB
diskkbswritethe shared filesystem's disk write in KiB
diskofferingdisplaytextdisk offering display text for the shared filesystem
diskofferingiddisk offering ID for the shared filesystem
diskofferingnamedisk offering for the shared filesystem
domainthe domain associated with the shared filesystem
domainidthe ID of the domain associated with the shared filesystem
domainpathpath of the domain to which the shared filesystem
filesystemthe filesystem format
iscustomdiskofferingdisk offering for the shared filesystem has custom size
namename of the shared filesystem
networkidNetwork ID of the shared filesystem
networknameNetwork name of the shared filesystem
pathpath to mount the shared filesystem
physicalsizethe bytes actually consumed on disk
projectthe project name of the shared filesystem
projectidthe project ID of the shared filesystem
providerthe shared filesystem provider
provisioningtypeprovisioning type used in the shared filesystem
serviceofferingidservice offering ID for the shared filesystem
serviceofferingnameservice offering for the shared filesystem
sizesize of the shared filesystem
sizegbsize of the shared filesystem in GiB
statethe state of the shared filesystem
storagename of the storage pool hosting the data volume
storageidID of the storage pool hosting the data volume
utilizationthe disk utilization
virtualmachineidID of the storage fs vm
virtualsizethe bytes allocated
vmstateID of the storage fs vm
volumeidID of the storage fs data volume
volumenamename of the storage fs data volume
zoneidID of the availability zone
zonenameName of the availability zone
nic(*)the list of nics associated with the shared filesystem
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/startSystemVm.html b/static/api/apidocs-4.23/apis/startSystemVm.html new file mode 100644 index 0000000000..fab1f4494e --- /dev/null +++ b/static/api/apidocs-4.23/apis/startSystemVm.html @@ -0,0 +1,198 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

startSystemVm

+

Starts a System VM.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the System VMtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the System VM
activeviewersessionsThe number of active console sessions for the console proxy System VM
agentstateThe agent state of the System VM
archCPU arch of the system VM
createdThe date and time the System VM was created
disconnectedThe last disconnected date of host
dns1The first DNS for the System VM
dns2The second DNS for the System VM
gatewayThe gateway for the System VM
guestvlanGuest VLAN range
hostcontrolstateThe control state of the host for the System VM
hostidThe host ID for the System VM
hostnameThe hostname for the System VM
hypervisorThe hypervisor on which the Template runs
isdynamicallyscalableTrue if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
linklocalipThe Control IP address for the System VM
linklocalmacaddressThe link local MAC address for the System VM
linklocalnetmaskThe link local netmask for the System VM
nameThe name of the System VM
networkdomainThe Network domain for the System VM
podidThe Pod ID for the System VM
podnameThe Pod name for the System VM
privateipThe private IP address for the System VM
privatemacaddressThe private MAC address for the System VM
privatenetmaskThe private netmask for the System VM
publicipThe public IP address for the System VM
publicmacaddressThe public MAC address for the System VM
publicnetmaskThe public netmask for the System VM
publicvlanPublic VLAN range
serviceofferingidthe ID of the service offering of the system virtual machine.
serviceofferingnamethe name of the service offering of the system virtual machine.
stateThe state of the System VM
storageipthe ip address for the system VM on the storage network
systemvmtypeThe System VM type
templateidThe Template ID for the System VM
templatenameThe Template name for the System VM
versionThe systemvm agent version
zoneidThe Zone ID for the System VM
zonenameThe Zone name for the System VM
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/startVirtualMachine.html b/static/api/apidocs-4.23/apis/startVirtualMachine.html new file mode 100644 index 0000000000..696bcc0ed0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/startVirtualMachine.html @@ -0,0 +1,714 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

startVirtualMachine

+

Starts an Instance.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instancetrue
bootintosetupBoot into hardware setup menu or notfalse
clusteridDestination Cluster ID to deploy the Instance to - parameter available for root admin onlyfalse
considerlasthostTrue by default, CloudStack will firstly try to start the Instance 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 Instance by normal process.false
deploymentplannerDeployment planner to use for Instance allocation. Available to ROOT admin onlyfalse
hostidDestination Host ID to deploy the Instance to - parameter available for root admin onlyfalse
podidDestination Pod ID to deploy the Instance to - parameter available for root admin onlyfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/stopInternalLoadBalancerVM.html b/static/api/apidocs-4.23/apis/stopInternalLoadBalancerVM.html new file mode 100644 index 0000000000..5044d435e4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/stopInternalLoadBalancerVM.html @@ -0,0 +1,363 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

stopInternalLoadBalancerVM

+

Stops an Internal LB Instance.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the internal LB Instancetrue
forcedForce stop the Instance (Instance 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 Instance is stopped and should be marked as such.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the router
accountThe Account associated with the router
archCPU arch of the router
createdThe date and time the router was created
dns1The first DNS for the router
dns2The second DNS for the router
domainThe domain associated with the router
domainidThe domain ID associated with the router
domainpathpath of the Domain the router belongs to
gatewayThe gateway for the router
guestipaddressThe guest IP address for the router
guestmacaddressThe guest MAC address for the router
guestnetmaskThe guest netmask for the router
guestnetworkidThe ID of the corresponding guest Network
guestnetworknameThe name of the corresponding guest Network
healthchecksfailedTrue if any health checks had failed
hostcontrolstateThe control state of the host for the router
hostidThe host ID for the router
hostnameThe hostname for the router
hypervisorThe hypervisor on which the Template runs
ip6dns1The first IPv6 DNS for the router
ip6dns2The second IPv6 DNS for the router
isredundantrouterIf this router is an redundant virtual router
linklocalipThe Control IP address for the router
linklocalmacaddressThe link local MAC address for the router
linklocalnetmaskThe link local netmask for the router
linklocalnetworkidThe ID of the corresponding link local Network
nameThe name of the router
networkdomainThe Network domain for the router
podidThe Pod ID for the router
podnameThe Pod name for the router
projectThe project name of the address
projectidThe project id of the IP address
publicipThe public IP address for the router
publicmacaddressThe public MAC address for the router
publicnetmaskThe public netmask for the router
publicnetworkidThe ID of the corresponding public Network
redundantstateThe state of redundant virtual router
requiresupgradeTrue if the router Template requires upgrade
roleRole of the domain router
scriptsversionThe version of scripts
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
softwareversionThe version of the code / software in the router
stateThe state of the router
templateidThe Template ID for the router
templatenameThe Template name for the router
versionThe version of Template
vpcidVPC the router belongs to
vpcnameThe name of VPC the router belongs to
zoneidThe Zone ID for the router
zonenameThe Zone name for the router
healthcheckresults(*)Last executed health check result for the router
checknameThe name of the health check on the router
checktypeThe type of the health check - basic or advanced
detailsDetailed response generated on running health check
lastupdatedThe date this VPC was created
statusthe result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}
successThe result of the health check if available
nic(*)The list of NICs associated with the router
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/stopKubernetesCluster.html b/static/api/apidocs-4.23/apis/stopKubernetesCluster.html new file mode 100644 index 0000000000..c1ff42f9f9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/stopKubernetesCluster.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

stopKubernetesCluster

+

Stops a running CloudManaged Kubernetes cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Kubernetes clustertrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/stopNetScalerVpx.html b/static/api/apidocs-4.23/apis/stopNetScalerVpx.html new file mode 100644 index 0000000000..88e9297b62 --- /dev/null +++ b/static/api/apidocs-4.23/apis/stopNetScalerVpx.html @@ -0,0 +1,363 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

stopNetScalerVpx

+

Stops a NetScalervm.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the NetScaler vmtrue
forcedForce 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the router
accountThe Account associated with the router
archCPU arch of the router
createdThe date and time the router was created
dns1The first DNS for the router
dns2The second DNS for the router
domainThe domain associated with the router
domainidThe domain ID associated with the router
domainpathpath of the Domain the router belongs to
gatewayThe gateway for the router
guestipaddressThe guest IP address for the router
guestmacaddressThe guest MAC address for the router
guestnetmaskThe guest netmask for the router
guestnetworkidThe ID of the corresponding guest Network
guestnetworknameThe name of the corresponding guest Network
healthchecksfailedTrue if any health checks had failed
hostcontrolstateThe control state of the host for the router
hostidThe host ID for the router
hostnameThe hostname for the router
hypervisorThe hypervisor on which the Template runs
ip6dns1The first IPv6 DNS for the router
ip6dns2The second IPv6 DNS for the router
isredundantrouterIf this router is an redundant virtual router
linklocalipThe Control IP address for the router
linklocalmacaddressThe link local MAC address for the router
linklocalnetmaskThe link local netmask for the router
linklocalnetworkidThe ID of the corresponding link local Network
nameThe name of the router
networkdomainThe Network domain for the router
podidThe Pod ID for the router
podnameThe Pod name for the router
projectThe project name of the address
projectidThe project id of the IP address
publicipThe public IP address for the router
publicmacaddressThe public MAC address for the router
publicnetmaskThe public netmask for the router
publicnetworkidThe ID of the corresponding public Network
redundantstateThe state of redundant virtual router
requiresupgradeTrue if the router Template requires upgrade
roleRole of the domain router
scriptsversionThe version of scripts
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
softwareversionThe version of the code / software in the router
stateThe state of the router
templateidThe Template ID for the router
templatenameThe Template name for the router
versionThe version of Template
vpcidVPC the router belongs to
vpcnameThe name of VPC the router belongs to
zoneidThe Zone ID for the router
zonenameThe Zone name for the router
healthcheckresults(*)Last executed health check result for the router
checknameThe name of the health check on the router
checktypeThe type of the health check - basic or advanced
detailsDetailed response generated on running health check
lastupdatedThe date this VPC was created
statusthe result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}
successThe result of the health check if available
nic(*)The list of NICs associated with the router
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/stopRouter.html b/static/api/apidocs-4.23/apis/stopRouter.html new file mode 100644 index 0000000000..3bab1a0aaa --- /dev/null +++ b/static/api/apidocs-4.23/apis/stopRouter.html @@ -0,0 +1,363 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

stopRouter

+

Stops a router.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the routertrue
forcedForce stop the Instance (Instance 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 Instance is stopped and should be marked as such.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the router
accountThe Account associated with the router
archCPU arch of the router
createdThe date and time the router was created
dns1The first DNS for the router
dns2The second DNS for the router
domainThe domain associated with the router
domainidThe domain ID associated with the router
domainpathpath of the Domain the router belongs to
gatewayThe gateway for the router
guestipaddressThe guest IP address for the router
guestmacaddressThe guest MAC address for the router
guestnetmaskThe guest netmask for the router
guestnetworkidThe ID of the corresponding guest Network
guestnetworknameThe name of the corresponding guest Network
healthchecksfailedTrue if any health checks had failed
hostcontrolstateThe control state of the host for the router
hostidThe host ID for the router
hostnameThe hostname for the router
hypervisorThe hypervisor on which the Template runs
ip6dns1The first IPv6 DNS for the router
ip6dns2The second IPv6 DNS for the router
isredundantrouterIf this router is an redundant virtual router
linklocalipThe Control IP address for the router
linklocalmacaddressThe link local MAC address for the router
linklocalnetmaskThe link local netmask for the router
linklocalnetworkidThe ID of the corresponding link local Network
nameThe name of the router
networkdomainThe Network domain for the router
podidThe Pod ID for the router
podnameThe Pod name for the router
projectThe project name of the address
projectidThe project id of the IP address
publicipThe public IP address for the router
publicmacaddressThe public MAC address for the router
publicnetmaskThe public netmask for the router
publicnetworkidThe ID of the corresponding public Network
redundantstateThe state of redundant virtual router
requiresupgradeTrue if the router Template requires upgrade
roleRole of the domain router
scriptsversionThe version of scripts
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
softwareversionThe version of the code / software in the router
stateThe state of the router
templateidThe Template ID for the router
templatenameThe Template name for the router
versionThe version of Template
vpcidVPC the router belongs to
vpcnameThe name of VPC the router belongs to
zoneidThe Zone ID for the router
zonenameThe Zone name for the router
healthcheckresults(*)Last executed health check result for the router
checknameThe name of the health check on the router
checktypeThe type of the health check - basic or advanced
detailsDetailed response generated on running health check
lastupdatedThe date this VPC was created
statusthe result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}
successThe result of the health check if available
nic(*)The list of NICs associated with the router
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/stopSharedFileSystem.html b/static/api/apidocs-4.23/apis/stopSharedFileSystem.html new file mode 100644 index 0000000000..45a15e7bf4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/stopSharedFileSystem.html @@ -0,0 +1,303 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

stopSharedFileSystem

+

Stop a Shared FileSystem

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the shared filesystemtrue
forcedForce stop the shared filesystem.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the shared filesystem
accountthe account associated with the shared filesystem
descriptiondescription of the shared filesystem
diskioreadthe read (IO) of disk on the shared filesystem
diskiowritethe write (IO) of disk on the shared filesystem
diskkbsreadthe shared filesystem's disk read in KiB
diskkbswritethe shared filesystem's disk write in KiB
diskofferingdisplaytextdisk offering display text for the shared filesystem
diskofferingiddisk offering ID for the shared filesystem
diskofferingnamedisk offering for the shared filesystem
domainthe domain associated with the shared filesystem
domainidthe ID of the domain associated with the shared filesystem
domainpathpath of the domain to which the shared filesystem
filesystemthe filesystem format
iscustomdiskofferingdisk offering for the shared filesystem has custom size
namename of the shared filesystem
networkidNetwork ID of the shared filesystem
networknameNetwork name of the shared filesystem
pathpath to mount the shared filesystem
physicalsizethe bytes actually consumed on disk
projectthe project name of the shared filesystem
projectidthe project ID of the shared filesystem
providerthe shared filesystem provider
provisioningtypeprovisioning type used in the shared filesystem
serviceofferingidservice offering ID for the shared filesystem
serviceofferingnameservice offering for the shared filesystem
sizesize of the shared filesystem
sizegbsize of the shared filesystem in GiB
statethe state of the shared filesystem
storagename of the storage pool hosting the data volume
storageidID of the storage pool hosting the data volume
utilizationthe disk utilization
virtualmachineidID of the storage fs vm
virtualsizethe bytes allocated
vmstateID of the storage fs vm
volumeidID of the storage fs data volume
volumenamename of the storage fs data volume
zoneidID of the availability zone
zonenameName of the availability zone
nic(*)the list of nics associated with the shared filesystem
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/stopSystemVm.html b/static/api/apidocs-4.23/apis/stopSystemVm.html new file mode 100644 index 0000000000..3427d55ec1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/stopSystemVm.html @@ -0,0 +1,201 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

stopSystemVm

+

Stops a system VM.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the System VMtrue
forcedForce stop the Instance (Instance 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 Instance is stopped and should be marked as such.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the System VM
activeviewersessionsThe number of active console sessions for the console proxy System VM
agentstateThe agent state of the System VM
archCPU arch of the system VM
createdThe date and time the System VM was created
disconnectedThe last disconnected date of host
dns1The first DNS for the System VM
dns2The second DNS for the System VM
gatewayThe gateway for the System VM
guestvlanGuest VLAN range
hostcontrolstateThe control state of the host for the System VM
hostidThe host ID for the System VM
hostnameThe hostname for the System VM
hypervisorThe hypervisor on which the Template runs
isdynamicallyscalableTrue if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
linklocalipThe Control IP address for the System VM
linklocalmacaddressThe link local MAC address for the System VM
linklocalnetmaskThe link local netmask for the System VM
nameThe name of the System VM
networkdomainThe Network domain for the System VM
podidThe Pod ID for the System VM
podnameThe Pod name for the System VM
privateipThe private IP address for the System VM
privatemacaddressThe private MAC address for the System VM
privatenetmaskThe private netmask for the System VM
publicipThe public IP address for the System VM
publicmacaddressThe public MAC address for the System VM
publicnetmaskThe public netmask for the System VM
publicvlanPublic VLAN range
serviceofferingidthe ID of the service offering of the system virtual machine.
serviceofferingnamethe name of the service offering of the system virtual machine.
stateThe state of the System VM
storageipthe ip address for the system VM on the storage network
systemvmtypeThe System VM type
templateidThe Template ID for the System VM
templatenameThe Template name for the System VM
versionThe systemvm agent version
zoneidThe Zone ID for the System VM
zonenameThe Zone name for the System VM
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/stopVirtualMachine.html b/static/api/apidocs-4.23/apis/stopVirtualMachine.html new file mode 100644 index 0000000000..e467e29ce8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/stopVirtualMachine.html @@ -0,0 +1,699 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

stopVirtualMachine

+

Stops an Instance.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instancetrue
forcedForce stop the Instance (Instance 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 Instance is stopped and should be marked as such.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/suspendProject.html b/static/api/apidocs-4.23/apis/suspendProject.html new file mode 100644 index 0000000000..3fbf69069c --- /dev/null +++ b/static/api/apidocs-4.23/apis/suspendProject.html @@ -0,0 +1,300 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

suspendProject

+

Suspends a project

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idID of the project to be suspendedtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the project
backupavailablethe total number of backups available to this project
backuplimitthe total number of backups which can be stored by this project
backupstorageavailablethe total backup storage space (in GiB) available to the project
backupstoragelimitthe total backup storage space (in GiB) the project can own
backupstoragetotalthe total backup storage space (in GiB) owned by the project
backuptotalthe total number of backups stored by this project
bucketavailablethe total number of buckets available to this project
bucketlimitthe total number of buckets which can be stored by this project
buckettotalthe total number of buckets stored by this project
cpuavailableThe total number of CPU cores available to be created for this project
cpulimitThe total number of CPU cores the project can own
cputotalThe total number of CPU cores owned by project
createdThe date this project was created
displaytextThe displaytext of the project
domainThe domain name where the project belongs to
domainidThe domain ID the project belongs to
gpuavailablethe total number of gpus available to be created for this project
gpulimitthe total number of gpus the project can own
gputotalthe total number of gpus owned by project
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this project to acquire
iplimitThe total number of public IP addresses this project can acquire
iptotalThe total number of public IP addresses allocated for this project
memoryavailableThe total memory (in MB) available to be created for this project
memorylimitThe total memory (in MB) the project can own
memorytotalThe total memory (in MB) owned by project
nameThe name of the project
networkavailableThe total number of Networks available to be created for this project
networklimitThe total number of Networks the project can own
networktotalThe total number of Networks owned by project
objectstorageavailablethe total object storage space (in GiB) available to the project
objectstoragelimitthe total object storage space (in GiB) the project can own
objectstoragetotalthe total object storage space (in GiB) owned by the project
ownerThe Account name of the project's owners
primarystorageavailableThe total primary storage space (in GiB) available to be used for this project
primarystoragelimitThe total primary storage space (in GiB) the project can own
primarystoragetotalThe total primary storage space (in GiB) owned by project
projectaccountnameThe project Account name of the project
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this project
secondarystoragelimitThe total secondary storage space (in GiB) the project can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by project
snapshotavailableThe total number of Snapshots available for this project
snapshotlimitThe total number of Snapshots which can be stored by this project
snapshottotalThe total number of Snapshots stored by this project
stateThe state of the project
taggedresourcesThe tagged resource limit and count for the project
templateavailableThe total number of Templates available to be created by this project
templatelimitThe total number of Templates which can be created by this project
templatetotalThe total number of Templates which have been created by this project
vmavailableThe total number of Instances available for this project to acquire
vmlimitThe total number of Instances that can be deployed by this project
vmrunningThe total number of Instances running for this project
vmstoppedThe total number of Instances stopped for this project
vmtotalThe total number of Instances deployed by this project
volumeavailableThe total volume available for this project
volumelimitThe total volume which can be used by this project
volumetotalThe total volume being used by this project
vpcavailableThe total number of VPCs available to be created for this project
vpclimitThe total number of VPCs the project can own
vpctotalThe total number of VPCs owned by project
tags(*)The list of resource tags associated with Instance
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/syncStoragePool.html b/static/api/apidocs-4.23/apis/syncStoragePool.html new file mode 100644 index 0000000000..6abfdf9228 --- /dev/null +++ b/static/api/apidocs-4.23/apis/syncStoragePool.html @@ -0,0 +1,186 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

syncStoragePool

+

Sync storage pool with management server (currently supported for Datastore Cluster in VMware and syncs the datastores in it)

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idStorage pool idtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the storage pool
allocatediopsTotal min IOPS currently in use by volumes
capacitybytesbytes CloudStack can provision from this storage pool
capacityiopsIOPS CloudStack can provision from this storage pool
clusteridThe ID of the cluster for the storage pool
clusternameThe name of the cluster for the storage pool
createdThe date and time the storage pool was created
detailsthe storage pool details
disksizeallocatedThe pool's currently allocated disk size
disksizetotalThe total disk size of the storage pool
disksizeusedThe pool's currently used disk size
hypervisorThe hypervisor type of the storage pool
ipaddressThe IP address of the storage pool
istagaruleWhether the informed tag is a JS interpretable rule or not.
managedwhether this pool is managed or not
nameThe name of the storage pool
nfsmountoptsthe nfs mount options for the storage pool
overprovisionfactorThe overprovisionfactor for the storage pool
pathThe storage pool path
podidThe Pod ID of the storage pool
podnameThe Pod name of the storage pool
providerStorage provider for this pool
scopeThe scope of the storage pool
stateThe state of the storage pool
storageaccessgroupsthe storage access groups for the storage pool
storagecapabilitiesThe storage pool capabilities
storagecustomstatsthe storage pool custom stats
suitableformigrationTrue if this pool is suitable to migrate a volume, false otherwise
tagsThe tags for the storage pool
typeThe storage pool type
usediopstotal IOPS currently in use
zoneidThe Zone ID of the storage pool
zonenameThe Zone name of the storage pool
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/synchronizeTungstenFabricData.html b/static/api/apidocs-4.23/apis/synchronizeTungstenFabricData.html new file mode 100644 index 0000000000..696b0b9c34 --- /dev/null +++ b/static/api/apidocs-4.23/apis/synchronizeTungstenFabricData.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

synchronizeTungstenFabricData

+

Synchronize Tungsten-Fabric data

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idProvider IDtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/triggerShutdown.html b/static/api/apidocs-4.23/apis/triggerShutdown.html new file mode 100644 index 0000000000..46ae5b740c --- /dev/null +++ b/static/api/apidocs-4.23/apis/triggerShutdown.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

triggerShutdown

+

Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobs have been completed.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
managementserveridThe UUID of the management servertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
agentsThe host agents this management server is responsible for
agentscountThe number of host agents this management server is responsible for
maintenanceinitiatedIndicates whether maintenance has been initiated
managementserveridThe id of the management server
pendingjobscountThe number of jobs in progress
readyforshutdownIndicates whether CloudStack is ready to shutdown
shutdowntriggeredIndicates whether a shutdown has been triggered
statethe state of the management server
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/unlinkDomainFromLdap.html b/static/api/apidocs-4.23/apis/unlinkDomainFromLdap.html new file mode 100644 index 0000000000..d246cdb001 --- /dev/null +++ b/static/api/apidocs-4.23/apis/unlinkDomainFromLdap.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

unlinkDomainFromLdap

+

remove the linkage of a Domain to a group or OU in ldap

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
domainidThe ID of the Domain which has to be unlinked from LDAP.true
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/unmanageGpuDevice.html b/static/api/apidocs-4.23/apis/unmanageGpuDevice.html new file mode 100644 index 0000000000..c1e0388134 --- /dev/null +++ b/static/api/apidocs-4.23/apis/unmanageGpuDevice.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

unmanageGpuDevice

+

Unmanage a GPU device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idscomma separated list of IDs of the GPU devicetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/unmanageVirtualMachine.html b/static/api/apidocs-4.23/apis/unmanageVirtualMachine.html new file mode 100644 index 0000000000..99b6500272 --- /dev/null +++ b/static/api/apidocs-4.23/apis/unmanageVirtualMachine.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

unmanageVirtualMachine

+

Unmanage a Guest Instance.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instance to unmanagetrue
forcedForce unmanaging Instance with config drive. Applicable only for KVM Hypervisor.false
hostidID of the host which will be used for unmanaging the Instance. Applicable only for KVM hypervisor and stopped Instances. Domain XML will be stored on this host.false
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
detailsDetails of the unmanage Instance operation
hostidThe ID of the host used for unmanaged Instance
successResult of the unmanage Instance operation
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/unmanageVolume.html b/static/api/apidocs-4.23/apis/unmanageVolume.html new file mode 100644 index 0000000000..157d1e8ae4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/unmanageVolume.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

unmanageVolume

+

Unmanage a volume on storage pool.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the volume to unmanagetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/unregisterExtension.html b/static/api/apidocs-4.23/apis/unregisterExtension.html new file mode 100644 index 0000000000..11532ec55a --- /dev/null +++ b/static/api/apidocs-4.23/apis/unregisterExtension.html @@ -0,0 +1,141 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

unregisterExtension

+

Unregister an extension with a resource

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
extensionidID of the extensiontrue
resourceidID of the resource to register the extension withtrue
resourcetypeType of the resourcetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the extension
createdCreation timestamp of the extension
descriptionDescription of the extension
detailsThe details of the extension
isuserdefinedTrue if the extension is added by admin
nameName of the extension
pathThe path of the entry point fo the extension
pathreadyTrue if the extension path is in ready state across management servers
removedRemoval timestamp of the extension, if applicable
reservedresourcedetailsResource detail names as comma separated string that should be reserved and not visible to end users
stateThe state of the extension
typeType of the extension
resources(*)List of resources to which extension is registered to
idID of the resource associated with the extension
createdCreation timestamp of the mapping
detailsthe details of the resource map
nameName of the resource associated with this mapping
typeType of the resource
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateAccount.html b/static/api/apidocs-4.23/apis/updateAccount.html new file mode 100644 index 0000000000..3d1bd06582 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateAccount.html @@ -0,0 +1,405 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateAccount

+

Updates Account information for the authenticated user

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountCurrent Account namefalse
accountdetailsDetails for the Account used to store specific parametersfalse
apikeyaccessDetermines if Api key access for this user is enabled, disabled or inherits the value from its parent, the domain level setting api.key.accessfalse
domainidThe UUID of the domain where the Account existsfalse
idAccount UUIDfalse
networkdomainNetwork domain for the Account's networks; empty string will update domainName with NULL valuefalse
newnameNew name for the Accountfalse
roleidThe UUID of the dynamic role to set for the Accountfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Account
accountdetailsDetails for the account
accounttypeAccount type (admin, domain-admin, user)
apikeyaccesswhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
backupavailablethe total number of backups available to this account
backuplimitthe total number of backups which can be stored by this account
backupstorageavailablethe total backup storage space (in GiB) available to the account
backupstoragelimitthe total backup storage space (in GiB) the account can own
backupstoragetotalthe total backup storage space (in GiB) owned by the account
backuptotalthe total number of backups stored by this account
bucketavailablethe total number of buckets available to this account
bucketlimitthe total number of buckets which can be stored by this account
buckettotalthe total number of buckets stored by this account
cpuavailableThe total number of CPU cores available to be created for this account
cpulimitThe total number of CPU cores the account can own
cputotalThe total number of CPU cores owned by account
createdThe date when this account was created
defaultzoneidThe default zone of the Account
domainName of the Domain the Account belongs to
domainidID of the Domain the Account belongs to
domainpathPath of the Domain the Account belongs to
gpuavailablethe total number of gpus available to be created for this account
gpulimitthe total number of gpus the account can own
gputotalthe total number of gpus owned by account
groupsThe list of ACL groups that account belongs to
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this Account to acquire
iplimitThe total number of public IP addresses this Account can acquire
iptotalThe total number of public IP addresses allocated for this Account
iscleanuprequiredTrue if the account requires cleanup
isdefaultTrue if account is default, false otherwise
memoryavailableThe total memory (in MB) available to be created for this account
memorylimitThe total memory (in MB) the account can own
memorytotalThe total memory (in MB) owned by account
nameThe name of the Account
networkavailableThe total number of Networks available to be created for this Account
networkdomainThe Network domain
networklimitThe total number of Networks the Account can own
networktotalThe total number of Networks owned by Account
objectstorageavailablethe total object storage space (in GiB) available to the account
objectstoragelimitthe total object storage space (in GiB) the account can own
objectstoragetotalthe total object storage space (in GiB) owned by the account
primarystorageavailableThe total primary storage space (in GiB) available to be used for this account
primarystoragelimitThe total primary storage space (in GiB) the account can own
primarystoragetotalThe total primary storage space (in GiB) owned by account
projectavailableThe total number of projects available for administration by this Account
projectlimitThe total number of projects the Account can own
projecttotalThe total number of projects being administrated by this Account
receivedbytesThe total number of Network traffic bytes received
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role (Admin, ResourceAdmin, DomainAdmin, User)
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this account
secondarystoragelimitThe total secondary storage space (in GiB) the account can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by account
sentbytesThe total number of Network traffic bytes sent
snapshotavailableThe total number of Snapshots available for this Account
snapshotlimitThe total number of Snapshots which can be stored by this Account
snapshottotalThe total number of Snapshots stored by this Account
stateThe state of the account
taggedresourcesThe tagged resource limit and count for the account
templateavailableThe total number of Templates available to be created by this Account
templatelimitThe total number of Templates which can be created by this Account
templatetotalThe total number of Templates which have been created by this Account
vmavailableThe total number of Instances available for this Account to acquire
vmlimitThe total number of Instances that can be deployed by this Account
vmrunningThe total number of Instances running for this Account
vmstoppedThe total number of Instances stopped for this Account
vmtotalThe total number of Instances deployed by this Account
volumeavailableThe total volume available for this Account
volumelimitThe total volume which can be used by this Account
volumetotalThe total volume being used by this Account
vpcavailableThe total number of VPCs available to be created for this account
vpclimitThe total number of VPCs the Account can own
vpctotalThe total number of VPCs owned by account
user(*)The list of users associated with account
idThe user ID
accountThe Account name of the user
accountidThe Account ID of the user
accounttypeThe Account type of the user
apikeyThe API key of the user
apikeyaccessWhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
createdThe date and time the user Account was created
domainThe domain name of the user
domainidThe domain ID of the user
emailThe user email address
firstnameThe user firstname
iconBase64 string representation of the resource icon
is2faenabledTrue if user has two factor authentication enabled
is2famandatedTrue if user has two factor authentication is mandated
iscallerchilddomainThe boolean value representing if the updating target is in caller's child domain
isdefaultTrue if user is default, false otherwise
lastnameThe user lastname
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role
secretkeyThe secret key of the user
stateThe user state
timezoneThe timezone user was created in
usernameThe user name
usersourceThe source type of the user in lowercase, such as native, ldap, saml2
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateAnnotationVisibility.html b/static/api/apidocs-4.23/apis/updateAnnotationVisibility.html new file mode 100644 index 0000000000..030aa4baab --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateAnnotationVisibility.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateAnnotationVisibility

+

Update an annotation visibility.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the annotationtrue
adminsonlyThe annotation is visible for admins onlytrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe UUID of the annotation
adminsonlyTrue if the annotation is available for admins only
annotationThe contents of the annotation
createdThe creation timestamp for this annotation
entityidThe UUID of the entity to which this annotation pertains
entitynameThe name of the entity to which this annotation pertains
entitytypeThe type of the annotated entity
removedThe removal timestamp for this annotation
useridThe UUID of the User that entered the annotation
usernameThe username of the User that entered the annotation
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateAutoScalePolicy.html b/static/api/apidocs-4.23/apis/updateAutoScalePolicy.html new file mode 100644 index 0000000000..e109faff3f --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateAutoScalePolicy.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateAutoScalePolicy

+

Updates an existing autoscale policy.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the autoscale policytrue
conditionidsThe list of IDs of the conditions that are being evaluated on every intervalfalse
durationThe duration in which the conditions have to be true before action is takenfalse
nameThe name of the autoscale policyfalse
quiettimeThe cool down period in which the policy should not be evaluated after the action has been takenfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe autoscale policy ID
accountThe Account owning the autoscale policy
actionThe action to be executed if all the conditions evaluate to true for the specified duration.
conditionsThe list of IDs of the conditions that are being evaluated on every interval
domainThe domain name of the autoscale policy
domainidThe domain ID of the autoscale policy
domainpathpath of the domain to which the autoscale policy belongs
durationThe duration for which the conditions have to be true before action is taken
nameName of the autoscale policy
projectThe project name of the autoscale policy
projectidThe project id autoscale policy
quiettimeThe cool down period for which the policy should not be evaluated after the action has been taken
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateAutoScaleVmGroup.html b/static/api/apidocs-4.23/apis/updateAutoScaleVmGroup.html new file mode 100644 index 0000000000..9996dce947 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateAutoScaleVmGroup.html @@ -0,0 +1,183 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateAutoScaleVmGroup

+

Updates an existing autoscale Instance group.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the autoscale grouptrue
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayAn optional field, whether to the display the group to the end user or notfalse
intervalThe frequency in which the performance counters to be collectedfalse
maxmembersThe maximum number of members in the vmgroup, The number of Instances in the Instance group will be equal to or less than this number.false
minmembersThe minimum number of members in the vmgroup, the number of Instances in the Instance group will be equal to or more than this number.false
nameThe name of the autoscale vmgroupfalse
scaledownpolicyidsList of scaledown autoscale policiesfalse
scaleuppolicyidsList of scaleup autoscale policiesfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe autoscale Instance group ID
accountThe Account owning the Instance group
associatednetworkidThe id of the guest Network the LB rule belongs to
associatednetworknameThe name of the guest Network the LB rule belongs to
availablevirtualmachinecountThe number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group
createdThe date when this Instance group was created
domainThe domain name of the Instance group
domainidThe domain ID of the Instance group
domainpathpath of the domain to which the vm group belongs
fordisplayIs group for display to the regular User
intervalThe frequency at which the conditions have to be evaluated
lbproviderThe LB provider of the guest Network the LB rule belongs to
lbruleidThe Load balancer rule ID
maxmembersThe maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.
minmembersThe minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.
nameThe name of the autoscale Instance group
privateportThe private port
projectThe project name of the Instance group
projectidThe project id of the Instance group
publicipThe public IP address
publicipidThe public IP address ID
publicportThe public port
scaledownpoliciesList of scaledown autoscale policies
scaleuppoliciesList of scaleup autoscale policies
stateThe current state of the AutoScale Instance Group
vmprofileidThe autoscale profile that contains information about the Instances in the Instance group.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateAutoScaleVmProfile.html b/static/api/apidocs-4.23/apis/updateAutoScaleVmProfile.html new file mode 100644 index 0000000000..0006fdc5b0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateAutoScaleVmProfile.html @@ -0,0 +1,173 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateAutoScaleVmProfile

+

Updates an existing autoscale Instance profile.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the autoscale Instance profiletrue
autoscaleuseridThe ID of the user used to launch and destroy the Instancesfalse
counterparamcounterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161false
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
expungevmgraceperiodThe time allowed for existing connections to get closed before an Instance is destroyedfalse
fordisplayAn optional field, whether to the display the profile to the end user or notfalse
otherdeployparamsParameters other than zoneId/serviceOfferringId/templateId of the auto deployed Instance. +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
serviceofferingidThe service offering of the auto deployed Instancefalse
templateidThe Template of the auto deployed Instancefalse
userdataAn optional binary data that can be sent to the Instance 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 valuefalse
userdatadetailsused to specify the parameters values for the variables in userdata.false
userdataidthe ID of the userdatafalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe autoscale Instance profile ID
accountThe Account owning the Instance group
autoscaleuseridThe ID of the User used to launch and destroy the Instances
domainThe domain name of the Instance profile
domainidThe domain ID of the Instance profile
domainpathpath of the domain to which the vm profile belongs
expungevmgraceperiodThe time allowed for existing connections to get closed before an Instance is destroyed
fordisplayIs profile for display to the regular User
otherdeployparamsParameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance
projectThe project name of the Instance profile
projectidThe project id Instance profile
serviceofferingidThe service offering to be used while deploying an Instance
templateidThe Template to be used while deploying an Instance
userdataBase64 encoded Instance user data
userdatadetailslist of variables and values for the variables declared in userdata
userdataidthe id of userdata used for the VM
userdatanamethe name of userdata used for the VM
userdatapolicythe userdata override policy with the userdata provided while deploying VM
zoneidThe availability zone to be used while deploying an Instance
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateBackupOffering.html b/static/api/apidocs-4.23/apis/updateBackupOffering.html new file mode 100644 index 0000000000..2f5a21e3ea --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateBackupOffering.html @@ -0,0 +1,132 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateBackupOffering

+

Updates a backup offering.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Backup Offering to be updatedtrue
allowuserdrivenbackupsWhether to allow user driven backups or notfalse
descriptionThe description of the Backup Offering to be updatedfalse
domainidthe ID of the containing domain(s) as comma separated string, public for public offeringsfalse
nameThe name of the Backup Offering to be updatedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the backup offering
allowuserdrivenbackupsWhether the offering allows User driven ad-hoc/scheduled backups
backupofferingdetailsDetails for the backup offering
createdThe date this backup offering was created
crosszoneinstancecreationthe backups with this offering can be used to create Instances on all Zones
descriptionDescription for the backup offering
domainthe domain name(s) this backup offering belongs to.
domainidthe domain ID(s) this backup offering belongs to.
externalidExternal ID on the provider side
nameName for the backup offering
providerprovider name
zoneidZone ID
zonenameZone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateBackupRepository.html b/static/api/apidocs-4.23/apis/updateBackupRepository.html new file mode 100644 index 0000000000..6c54d9b60c --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateBackupRepository.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateBackupRepository

+

Update a backup repository

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the backup repositorytrue
addressaddress of the backup repositoryfalse
crosszoneinstancecreationbackups in this repository can be used to create Instances on all Zonesfalse
mountoptsshared storage mount optionsfalse
namename of the backup repositoryfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the backup repository
addressthe address / url of the backup repository
capacitybytescapacity of the backup repository
createdthe date and time the backup repository was added
crosszoneinstancecreationthe backups in this repository can be used to create Instances on all Zones
mountoptsmount options
namethe name of the backup repository
providername of the provider
typebackup type
zoneidthe Zone ID of the backup repository
zonenamethe Zone name of the backup repository
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateBackupSchedule.html b/static/api/apidocs-4.23/apis/updateBackupSchedule.html new file mode 100644 index 0000000000..4d66359a30 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateBackupSchedule.html @@ -0,0 +1,189 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateBackupSchedule

+

Updates a User-defined Instance backup schedule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
intervaltypeValid values are HOURLY, DAILY, WEEKLY, and MONTHLYtrue
scheduleCustom 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
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.true
virtualmachineidID of the Instance for which schedule is to be definedtrue
isolatedWhether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.false
maxbackupsThe maximum number of backups to keep for a VM. If "0", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.false
quiescevmQuiesce the Instance before checkpointing the disks for backup. Applicable only to NAS and KBOSS backup providers. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the Instance backup
accountAccount name
accountidAccount id
backupofferingidBackup offering id
backupofferingnameBackup offering name
compressionstatusBackup compression status.
createdBackup date
descriptiondescription for the backup
domainDomain name
domainidDomain ID
externalidExternal backup id
fromcheckpointidPrevious active checkpoint ID for incremental backups
hostidHost ID where the backup is running
intervaltypeInterval type of the backup
isbackupvmexpungedIndicates whether the VM from which the backup was taken is expunged or not
namename of the backup
sizeBackup size in bytes
statusBackup status
tocheckpointidNext checkpoint ID for incremental backups
typeBackup type
uncompressedsizeBackup uncompressed size in bytes. Only defined if backup is compressed.
validationstatusBackup validation status.
virtualmachineidID of the Instance
virtualmachinenameName of the Instance
virtualsizeBackup protected (virtual) size in bytes
vmbackupofferingremovedThe backup offering corresponding to this backup was removed from the VM
vmdetailsLists the vm specific details for the backup
volumesBacked up volumes
zoneZone name
zoneidZone ID
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateBgpPeer.html b/static/api/apidocs-4.23/apis/updateBgpPeer.html new file mode 100644 index 0000000000..93e62d1383 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateBgpPeer.html @@ -0,0 +1,141 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateBgpPeer

+

Updates an existing Bgp Peer.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idId of the Bgp Peertrue
asnumberThe AS number of the Bgp Peer.false
cleanupdetailsoptional 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
detailsBGP peer details in key/value pairs.false
ip6addressThe IPv6 address of the Bgp Peer.false
ipaddressThe IPv4 address of the Bgp Peer.false
passwordThe password of the Bgp Peer.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idid of the bgp peer
accountthe account of the bgp peer
asnumberAS number of bgp peer
createddate when this bgp peer was created.
detailsadditional key/value details of the bgp peer
domainthe domain name of the bgp peer
domainidthe domain ID of the bgp peer
ip6addressIPv6 address of bgp peer
ipaddressIPv4 address of bgp peer
passwordpassword of bgp peer
projectthe project name of the bgp peer
projectidthe project id of the bgp peer
zoneidid of zone to which the bgp peer belongs to.
zonenamename of zone to which the bgp peer belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateBucket.html b/static/api/apidocs-4.23/apis/updateBucket.html new file mode 100644 index 0000000000..e6be906c32 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateBucket.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateBucket

+

Updates Bucket properties

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Buckettrue
encryptionEnable/Disable Bucket encryptionfalse
policyBucket Access Policyfalse
quotaBucket Quota in GiBfalse
versioningEnable/Disable Bucket Versioningfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateCloudToUseObjectStore.html b/static/api/apidocs-4.23/apis/updateCloudToUseObjectStore.html new file mode 100644 index 0000000000..197bc82352 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateCloudToUseObjectStore.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateCloudToUseObjectStore

+

Migrate current NFS secondary storages to use object store.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
providerThe image store provider nametrue
detailsThe details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsssfalse
nameThe name for the image storefalse
urlThe URL for the image storefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the image store
disksizetotalThe total disk size of the host
disksizeusedThe host's currently used disk size
nameThe name of the image store
protocolThe protocol of the image store
providernameThe provider name of the image store
readonlyDefines if store is read-only
scopeThe scope of the image store
urlThe URL of the image store
zoneidThe Zone ID of the image store
zonenameThe Zone name of the image store
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateCluster.html b/static/api/apidocs-4.23/apis/updateCluster.html new file mode 100644 index 0000000000..4a690b40db --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateCluster.html @@ -0,0 +1,204 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateCluster

+

Updates an existing cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Clustertrue
allocationstateAllocation state of this cluster for allocation of new resourcesfalse
archthe CPU arch of the cluster. Valid options are: x86_64, aarch64, s390xfalse
clusternameThe cluster namefalse
clustertypeHypervisor type of the clusterfalse
externaldetailsDetails in key/value pairs to be added to the extension-resource mapping. Use the format externaldetails[i].<key>=<value>. Example: externaldetails[0].endpoint.url=https://example.comfalse
hypervisorHypervisor type of the clusterfalse
managedstateWhether this cluster is managed by cloudstackfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe cluster ID
allocationstateThe allocation state of the cluster
archCPU Arch of the hosts in the cluster
clustertypeThe type of the cluster
cpuovercommitratioThe CPU overcommit ratio of the cluster
extensionidThe ID of extension for this cluster
extensionnameThe name of extension for this cluster
hypervisortypeThe hypervisor type of the cluster
managedstateWhether this cluster is managed by Cloudstack
memoryovercommitratioThe memory overcommit ratio of the cluster
nameThe cluster name
ovm3vipOvm3 VIP to use for pooling and/or clustering
podidThe Pod ID of the cluster
podnameThe Pod name of the cluster
podstorageaccessgroupscomma-separated list of storage access groups on the pod
resourcedetailsMeta data associated with the zone (key/value pairs)
storageaccessgroupscomma-separated list of storage access groups for the host
zoneidThe Zone ID of the cluster
zonenameThe Zone name of the cluster
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
capacity(*)The capacity of the Cluster
capacityallocatedThe capacity currently in allocated
capacitytotalThe total capacity available
capacityusedThe capacity currently in use
clusteridThe Cluster ID
clusternameThe Cluster name
nameThe capacity name
percentusedThe percentage of capacity currently in use
podidThe Pod ID
podnameThe Pod name
tagThe tag for the capacity type
typeThe capacity type
zoneidThe Zone ID
zonenameThe Zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateCondition.html b/static/api/apidocs-4.23/apis/updateCondition.html new file mode 100644 index 0000000000..420c3118ef --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateCondition.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateCondition

+

Updates a condition for Instance auto scaling

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the condition.true
relationaloperatorRelational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.true
thresholdValue for which the Counter will be evaluated with the Operator selected.true
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateConfiguration.html b/static/api/apidocs-4.23/apis/updateConfiguration.html new file mode 100644 index 0000000000..4e0f003dd3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateConfiguration.html @@ -0,0 +1,150 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateConfiguration

+

Updates a configuration.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameThe name of the configurationtrue
accountidThe ID of the Account to update the parameter value for corresponding accountfalse
clusteridThe ID of the Cluster to update the parameter value for corresponding clusterfalse
domainidThe ID of the Domain to update the parameter value for corresponding domainfalse
imagestoreuuidThe ID of the Image Store to update the parameter value for corresponding image storefalse
managementserveridthe ID of the Management Server to update the parameter value for corresponding management serverfalse
storageidThe ID of the Storage pool to update the parameter value for corresponding storage poolfalse
valueThe value of the configurationfalse
zoneidThe ID of the Zone to update the parameter value for corresponding zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe value of the configuration
categoryThe category of the configuration
componentThe component of the configuration
defaultvalueThe default value of the configuration
descriptionThe description of the configuration
displaytextThe display text of the configuration
groupThe group of the configuration
isdynamicTrue if the configuration is dynamic
nameThe name of the configuration
optionsThe possible options of the configuration value
parentThe name of the parent configuration
scopeScope (zone/cluster/pool/account) of the parameter that needs to be updated
subgroupThe subgroup of the configuration
typeThe type of the configuration value
valueThe value of the configuration
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateCustomAction.html b/static/api/apidocs-4.23/apis/updateCustomAction.html new file mode 100644 index 0000000000..50b3164f20 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateCustomAction.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateCustomAction

+

Update the custom action

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the custom actiontrue
allowedroletypesList of role types allowed for the actionfalse
cleanupdetailsOptional boolean field, which indicates if details should be cleaned up or not (If set to true, details removed for this action, details field ignored; if false or not set, no action)false
cleanupparametersOptional boolean field, which indicates if parameters should be cleaned up or not (If set to true, parameters will be removed for this action, parameters field ignored; if false or not set, no action)false
descriptionThe description of the commandfalse
detailsDetails in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0false
enabledWhether the action is enabled or notfalse
errormessageError message that will be used on failure during execution of the action. Name of the action and and extension can be used in the - actionName, extensionName. Example: Failed to complete {{actionName}} for {{extensionNamefalse
parametersParameters mapping for the action using keys - name, type, required. 'name' is mandatory. If 'type' is not specified then STRING will be used. If 'required' is not specified then false will be used. Example: parameters[0].name=xxx&parameters[0].type=BOOLEAN&parameters[0].required=truefalse
resourcetypeType of the resource for actionsfalse
successmessageSuccess message that will be used on successful execution of the action. Name of the action and and extension can be used in the - actionName, extensionName. Example: Successfully complete {{actionName}} for {{extensionNamefalse
timeoutSpecifies the timeout in seconds to wait for the action to complete before failing. Default value is 3 secondsfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateDefaultNicForVirtualMachine.html b/static/api/apidocs-4.23/apis/updateDefaultNicForVirtualMachine.html new file mode 100644 index 0000000000..dc842d70aa --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateDefaultNicForVirtualMachine.html @@ -0,0 +1,699 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateDefaultNicForVirtualMachine

+

Changes the default NIC on an Instance

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
nicidNIC IDtrue
virtualmachineidInstance IDtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateDiskOffering.html b/static/api/apidocs-4.23/apis/updateDiskOffering.html new file mode 100644 index 0000000000..1020d54de8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateDiskOffering.html @@ -0,0 +1,255 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateDiskOffering

+

Updates a disk offering.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the disk offeringtrue
bytesreadrateBytes read rate of the disk offeringfalse
bytesreadratemaxBurst bytes read rate of the disk offeringfalse
bytesreadratemaxlengthLength (in seconds) of the burstfalse
byteswriterateBytes write rate of the disk offeringfalse
byteswriteratemaxBurst bytes write rate of the disk offeringfalse
byteswriteratemaxlengthLength (in seconds) of the burstfalse
cachemodeThe cache mode to use for this disk offeringfalse
displayofferingAn optional field, whether to display the offering to the end user or not.false
displaytextUpdates alternate display text of the disk offering with this valuefalse
domainidThe ID of the containing domain(s) as comma separated string, public for public offeringsfalse
iopsreadrateI/O requests read rate of the disk offeringfalse
iopsreadratemaxBurst requests read rate of the disk offeringfalse
iopsreadratemaxlengthLength (in seconds) of the burstfalse
iopswriterateI/O requests write rate of the disk offeringfalse
iopswriteratemaxBurst io requests write rate of the disk offeringfalse
iopswriteratemaxlengthLength (in seconds) of the burstfalse
nameUpdates name of the disk offering with this valuefalse
sortkeySort key of the disk offering, integerfalse
statestate of the disk offeringfalse
tagsComma-separated list of tags for the disk offering, tags should match with existing storage pool tagsfalse
zoneidThe ID of the containing zone(s) as comma separated string, all for all zones offeringsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idUnique ID of the disk offering
cacheModeThe cache mode to use for this disk offering. none, writeback or writethrough
createdThe date this disk offering was created
detailsAdditional key/value details tied with this disk offering
diskBytesReadRateBytes read rate of the disk offering
diskBytesReadRateMaxBurst bytes read rate of the disk offering
diskBytesReadRateMaxLengthLength (in seconds) of the burst
diskBytesWriteRateBytes write rate of the disk offering
diskBytesWriteRateMaxBurst bytes write rate of the disk offering
diskBytesWriteRateMaxLengthLength (in seconds) of the burst
diskIopsReadRateI/O requests read rate of the disk offering
diskIopsReadRateMaxBurst io requests read rate of the disk offering
diskIopsReadRateMaxLengthLength (in second) of the burst
diskIopsWriteRateI/O requests write rate of the disk offering
diskIopsWriteRateMaxBurst io requests write rate of the disk offering
diskIopsWriteRateMaxLengthLength (in seconds) of the burst
disksizeThe size of the disk offering in GB
disksizestrictnessTo allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed
displayofferingWhether to display the offering to the end user or not.
displaytextAn alternate display text of the disk offering.
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
encryptWhether disks using this offering will be encrypted on primary storage
hypervisorsnapshotreserveHypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
iscustomizedTrue if disk offering uses custom size, false otherwise
iscustomizediopsTrue if disk offering uses custom IOPS, false otherwise
maxiopsThe max IOPS of the disk offering
miniopsThe min IOPS of the disk offering
nameThe name of the disk offering
provisioningtypeProvisioning type used to create volumes. Valid values are thin, sparse, fat.
statestate of the disk offering
storagetypeThe storage type for this disk offering
suitableforvirtualmachineReturns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false
tagsThe tags for the disk offering
vspherestoragepolicyThe vsphere storage policy tagged to the disk offering in case of VMware
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateDnsServer.html b/static/api/apidocs-4.23/apis/updateDnsServer.html new file mode 100644 index 0000000000..f993e22b7b --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateDnsServer.html @@ -0,0 +1,141 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateDnsServer

+

Update DNS server

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the DNS server to updatetrue
dnsapikeyAPI Key or Credentials for the external providerfalse
ispublicWhether this DNS server can be used by accounts other than the owner to create and manage DNS zonesfalse
nameName of the DNS serverfalse
nameserversComma separated list of name servers; used to create NS records for the DNS Zone (for example, ns1.example.com, ns2.example.com)false
portPort number of the external DNS serverfalse
publicdomainsuffixDomain suffix that restricts DNS zones created by non-owner accounts to subdomains of this suffix (for example, sub.example.com under example.com)false
stateUpdate state for the DNS server (Enabled, Disabled)false
urlAPI URL of the providerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the DNS server
accountthe account associated with the DNS server
domainthe name of the domain associated with the DNS server
domainidthe ID of the domain associated with the DNS server
ispublicIs the DNS server publicly available
nameName of the DNS server
nameserversName servers entries associated to DNS server
portThe port of the DNS server
providerThe provider type of the DNS server
publicdomainsuffixThe public domain suffix for the DNS server
stateThe state of the account
urlURL of the DNS server API
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateDnsZone.html b/static/api/apidocs-4.23/apis/updateDnsZone.html new file mode 100644 index 0000000000..70d11f39dd --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateDnsZone.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateDnsZone

+

Updates a DNS Zone's metadata

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the DNS zonetrue
descriptionThe description of the DNS zone to be updatedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the DNS zone
accountthe account associated with the DNS zone
descriptionDescription for the DNS zone
dnsserveraccountthe account name of the DNS server owner
dnsserveridID of the DNS server this zone belongs to
dnsservernamethe name of the DNS server hosting this zone
domainthe name of the domain associated with the DNS zone
domainidthe ID of the domain associated with the DNS server
nameName of the DNS zone
networkidID of the network this zone is associated with
networknameName of the network this zone is associated with
stateThe state of the zone (Active/Inactive)
typeThe type of the zone (Public/Private)
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateDomain.html b/static/api/apidocs-4.23/apis/updateDomain.html new file mode 100644 index 0000000000..4a1a087270 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateDomain.html @@ -0,0 +1,279 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateDomain

+

Updates a domain with a new name

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of domain to updatetrue
nameUpdates domain with this namefalse
networkdomainNetwork domain for the domain's networks; empty string will update domainName with NULL valuefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the domain
backupavailablethe total number of backups available to this domain
backuplimitthe total number of backups which can be stored by this domain
backupstorageavailablethe total backup storage space (in GiB) available to the domain
backupstoragelimitthe total backup storage space (in GiB) the domain can own
backupstoragetotalthe total backup storage space (in GiB) owned by the domain
backuptotalthe total number of backups stored by this domain
bucketavailablethe total number of buckets available to this domain
bucketlimitthe total number of buckets which can be stored by this domain
buckettotalthe total number of buckets stored by this domain
cpuavailableThe total number of CPU cores available to be created for this domain
cpulimitThe total number of CPU cores the domain can own
cputotalThe total number of CPU cores owned by domain
createdThe date when this domain was created
domaindetailsDetails for the domain
gpuavailablethe total number of gpus available to be created for this domain
gpulimitthe total number of gpus the domain can own
gputotalthe total number of gpus owned by domain
haschildWhether the domain has one or more sub-domains
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this domain to acquire
iplimitThe total number of public IP addresses this domain can acquire
iptotalThe total number of public IP addresses allocated for this domain
levelThe level of the domain
memoryavailableThe total memory (in MB) available to be created for this domain
memorylimitThe total memory (in MB) the domain can own
memorytotalThe total memory (in MB) owned by domain
nameThe name of the domain
networkavailableThe total number of Networks available to be created for this domain
networkdomainThe Network domain
networklimitThe total number of Networks the domain can own
networktotalThe total number of Networks owned by domain
objectstorageavailablethe total object storage space (in GiB) available to the domain
objectstoragelimitthe total object storage space (in GiB) the domain can own
objectstoragetotalthe total object storage space (in GiB) owned by the domain
parentdomainidThe domain ID of the parent domain
parentdomainnameThe domain name of the parent domain
pathThe path of the domain
primarystorageavailableThe total primary storage space (in GiB) available to be used for this domain
primarystoragelimitThe total primary storage space (in GiB) the domain can own
primarystoragetotalThe total primary storage space (in GiB) owned by domain
projectavailableThe total number of projects available for administration by this domain
projectlimitThe total number of projects the domain can own
projecttotalThe total number of projects being administrated by this domain
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this domain
secondarystoragelimitThe total secondary storage space (in GiB) the domain can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by domain
snapshotavailableThe total number of Snapshots available for this domain
snapshotlimitThe total number of Snapshots which can be stored by this domain
snapshottotalThe total number of Snapshots stored by this domain
stateThe state of the domain
taggedresourcesThe tagged resource limit and count for the domain
templateavailableThe total number of Templates available to be created by this domain
templatelimitThe total number of Templates which can be created by this domain
templatetotalThe total number of Templates which have been created by this domain
vmavailableThe total number of Instances available for this domain to acquire
vmlimitThe total number of Instances that can be deployed by this domain
vmtotalThe total number of Instances deployed by this domain
volumeavailableThe total volume available for this domain
volumelimitThe total volume which can be used by this domain
volumetotalThe total volume being used by this domain
vpcavailableThe total number of VPCs available to be created for this domain
vpclimitThe total number of VPCs the domain can own
vpctotalThe total number of VPCs owned by domain
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateEgressFirewallRule.html b/static/api/apidocs-4.23/apis/updateEgressFirewallRule.html new file mode 100644 index 0000000000..8e7fe50a0a --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateEgressFirewallRule.html @@ -0,0 +1,168 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateEgressFirewallRule

+

Updates egress firewall rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the egress firewall ruletrue
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayAn optional field, whether to the display the rule to the end user or notfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the firewall rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
destcidrlistThe CIDR list to forward traffic to. Multiple entries are separated by a single comma character (,).
endportThe ending port of firewall rule's port range
fordisplayIs rule for display to the regular user
icmpcodeError code for this ICMP message
icmptypeType of the ICMP message being sent
ipaddressThe public IP address for the firewall rule
ipaddressidThe public IP address ID for the firewall rule
networkidThe Network ID of the firewall rule
protocolThe protocol of the firewall rule
startportThe starting port of firewall rule's port range
stateThe state of the rule
traffictypeThe traffic type for the firewall rule
vpcidThe VPC ID of the firewall rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateExtension.html b/static/api/apidocs-4.23/apis/updateExtension.html new file mode 100644 index 0000000000..2f7d0f1b3c --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateExtension.html @@ -0,0 +1,153 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateExtension

+

Update the extension

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the extensiontrue
cleanupdetailsOptional boolean field, which indicates if details should be cleaned up or not (If set to true, details removed for this extension, details field ignored; if false or not set, no action)false
descriptionDescription of the extensionfalse
detailsDetails in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvaluefalse
orchestratorrequirespreparevmOnly honored when type is Orchestrator. Whether prepare VM is needed or notfalse
reservedresourcedetailsResource detail names as comma separated string that should be reserved and not visible to end usersfalse
stateState of the extensionfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the extension
createdCreation timestamp of the extension
descriptionDescription of the extension
detailsThe details of the extension
isuserdefinedTrue if the extension is added by admin
nameName of the extension
pathThe path of the entry point fo the extension
pathreadyTrue if the extension path is in ready state across management servers
removedRemoval timestamp of the extension, if applicable
reservedresourcedetailsResource detail names as comma separated string that should be reserved and not visible to end users
stateThe state of the extension
typeType of the extension
resources(*)List of resources to which extension is registered to
idID of the resource associated with the extension
createdCreation timestamp of the mapping
detailsthe details of the resource map
nameName of the resource associated with this mapping
typeType of the resource
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateFirewallRule.html b/static/api/apidocs-4.23/apis/updateFirewallRule.html new file mode 100644 index 0000000000..36710d21aa --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateFirewallRule.html @@ -0,0 +1,168 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateFirewallRule

+

Updates firewall rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the firewall ruletrue
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayAn optional field, whether to the display the rule to the end user or notfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the firewall rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
destcidrlistThe CIDR list to forward traffic to. Multiple entries are separated by a single comma character (,).
endportThe ending port of firewall rule's port range
fordisplayIs rule for display to the regular user
icmpcodeError code for this ICMP message
icmptypeType of the ICMP message being sent
ipaddressThe public IP address for the firewall rule
ipaddressidThe public IP address ID for the firewall rule
networkidThe Network ID of the firewall rule
protocolThe protocol of the firewall rule
startportThe starting port of firewall rule's port range
stateThe state of the rule
traffictypeThe traffic type for the firewall rule
vpcidThe VPC ID of the firewall rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateGlobalLoadBalancerRule.html b/static/api/apidocs-4.23/apis/updateGlobalLoadBalancerRule.html new file mode 100644 index 0000000000..914f099cab --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateGlobalLoadBalancerRule.html @@ -0,0 +1,234 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateGlobalLoadBalancerRule

+

Update global load balancer rules.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the global load balancer ruletrue
descriptionThe description of the load balancer rulefalse
gslblbmethodLoad 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
gslbstickysessionmethodnameSession sticky method (sourceip) if not specified defaults to sourceipfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idGlobal Load balancer rule ID
accountThe Account of the Load balancer rule
descriptionThe description of the global Load balancer rule
domainThe domain of the Load balancer rule
domainidThe domain ID of the Load balancer rule
domainpathpath of the domain to which the load balancer rule belongs
gslbdomainnameDNS domain name given for the global Load balancer
gslblbmethodLoad balancing method used for the global Load balancer
gslbservicetypeGSLB service type
gslbstickysessionmethodnameSession persistence method used for the global Load balancer
nameName of the global Load balancer rule
projectThe project name of the Load balancer
projectidThe project ID of the Load balancer
regionidRegion ID in which global Load balancer is created
loadbalancerrule(*)List of Load balancer rules that are part of GSLB rule
idThe Load balancer rule ID
accountThe Account of the Load balancer rule
algorithmThe Load balancer algorithm (source, roundrobin, leastconn)
cidrlistThe CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).
descriptionThe description of the Load balancer
domainThe domain of the Load balancer rule
domainidThe domain ID of the Load balancer rule
domainpathpath of the domain to which the load balancer rule belongs
fordisplayIs rule for display to the regular user
nameThe name of the Load balancer
networkidThe ID of the guest Network the LB rule belongs to
privateportThe private port
projectThe project name of the Load balancer
projectidThe project ID of the Load balancer
protocolThe protocol of the Load Balancer rule
publicipThe public IP address
publicipidThe public IP address ID
publicportThe public port
stateThe state of the rule
zoneidThe ID of the zone the rule belongs to
zonenameThe name of the zone the Load balancer rule belongs to
tags(*)The list of resource tags associated with Load balancer
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateGpuCard.html b/static/api/apidocs-4.23/apis/updateGpuCard.html new file mode 100644 index 0000000000..d3d2c7026e --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateGpuCard.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateGpuCard

+

Updates a GPU card definition in the system

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the GPU cardtrue
devicenamethe device name of the GPU cardfalse
namethe display name of the GPU cardfalse
vendornamethe vendor name of the GPU cardfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the GPU card
deviceidthe device ID of the GPU card
devicenamethe device name of the GPU card
namethe display name of the GPU card
vendoridthe vendor ID of the GPU card
vendornamethe vendor name of the GPU card
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateGpuDevice.html b/static/api/apidocs-4.23/apis/updateGpuDevice.html new file mode 100644 index 0000000000..d906037ed7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateGpuDevice.html @@ -0,0 +1,144 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateGpuDevice

+

Updates an existing GPU device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the GPU device to updatetrue
gpucardidNew GPU card IDfalse
numanodeNew NUMA node of the GPU devicefalse
parentgpudeviceidNew parent GPU device ID (for virtual GPU devices)false
typeNew type of GPU device (PCI, MDEV, VGPUOnly)false
vgpuprofileidNew vGPU profile IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the GPU device
busaddressbus address of the GPU device or MDEV UUID for vGPU devices
gpucardidthe GPU card ID associated with this GPU device
gpucardnamethe GPU card name associated with this GPU device
gpudevicetypebus address of the GPU device
hostidthe host ID where the GPU device is attached
hostnamethe host name where the GPU device is attached
managedstatethe managed state of the GPU device (Enabled/Disabled)
numanodethe NUMA node where the GPU device is located
parentgpudeviceidthe ID of the parent GPU device, if this is a vGPU
statethe vGPU profile name assigned to this GPU device
vgpuprofileidthe vGPU profile ID assigned to this GPU device
vgpuprofilenamethe vGPU profile name assigned to this GPU device
virtualmachineidthe vGPU profile ID assigned to this GPU device
virtualmachinenamethe vGPU profile name assigned to this GPU device
vmstatethe state of the virtual machine to which this GPU device is allocated
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateGuestOs.html b/static/api/apidocs-4.23/apis/updateGuestOs.html new file mode 100644 index 0000000000..590c08f309 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateGuestOs.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateGuestOs

+

Updates the information about Guest OS

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idUUID of the Guest OStrue
detailsMap of (key/value pairs)false
forDisplaywhether this guest OS is available for end usersfalse
oscategoryidthe ID of the OS categoryfalse
osdisplaynameUnique display name for Guest OSfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the OS type
descriptionThe name/description of the OS type
fordisplayIs the guest OS visible for the users
isuserdefinedIs the guest OS user defined
nameThe name of the OS type
oscategoryidThe ID of the OS category
oscategorynameThe name of the OS category
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateGuestOsMapping.html b/static/api/apidocs-4.23/apis/updateGuestOsMapping.html new file mode 100644 index 0000000000..9ebfa972c2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateGuestOsMapping.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateGuestOsMapping

+

Updates the information about Guest OS to Hypervisor specific name mapping

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idUUID of the Guest OS to hypervisor name Mappingtrue
osnameforhypervisorHypervisor specific name for this Guest OStrue
osmappingcheckenabledWhen 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Guest OS mapping
hypervisorThe hypervisor
hypervisorversionVersion of the hypervisor for mapping
isuserdefinedIs the mapping user defined
osdisplaynameStandard display name for the Guest OS
osnameforhypervisorHypervisor specific name for the Guest OS
ostypeidThe ID of the Guest OS type
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateGuiTheme.html b/static/api/apidocs-4.23/apis/updateGuiTheme.html new file mode 100644 index 0000000000..59a95cf99b --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateGuiTheme.html @@ -0,0 +1,150 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateGuiTheme

+

Updates an existing GUI theme.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the theme to be updated.true
accountidsA set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.false
commonnamesA set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.comfalse
cssThe CSS to be retrieved and imported into the GUI when matching the theme access configurations.false
descriptionA description for the theme.false
domainidsA set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.false
ispublicDefines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.false
jsonconfigurationThe JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.false
loginbasedomainThe ACS domain to be used as base for the login when accessing the GUI through the common name defined in the theme. If a common name is not defined, this parameter is ignored on the GUI.false
nameA name to identify the theme.false
recursivedomainsDefines whether the subdomains of the informed domains are considered. Default value is false.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the custom GUI theme.
accountidsA set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.
commonnamesA set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com
createdWhen the GUI theme was created.
cssThe CSS to be retrieved and imported into the GUI when matching the theme access configurations.
descriptionDescription of the GUI theme.
domainidsA set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.
ispublicDefines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.
jsonconfigurationThe JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.
loginbasedomainThe ACS domain to be used as base for the login when accessing the GUI through the common name defined in the theme. If a common name is not defined, this parameter is ignored on the GUI.
nameName of the GUI theme.
recursivedomainsWhether to consider the subdomains of the informed domain IDs.
removedWhen the GUI theme was removed.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateHSMProfile.html b/static/api/apidocs-4.23/apis/updateHSMProfile.html new file mode 100644 index 0000000000..000ecc2673 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateHSMProfile.html @@ -0,0 +1,141 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateHSMProfile

+

Updates an HSM profile

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the HSM profiletrue
enabledwhether the HSM profile is enabledfalse
namethe name of the HSM profilefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the HSM profile
accountthe account name of the HSM profile owner
accountidthe account ID of the HSM profile owner
createdthe date the HSM profile was created
detailsHSM configuration details (sensitive values are encrypted)
domainthe domain name of the HSM profile owner
domainidthe domain ID of the HSM profile owner
domainpaththe domain path of the HSM profile owner
enabledwhether the HSM profile is enabled
ispublicwhether this is a system HSM profile available to all users globally
namethe name of the HSM profile
projectthe project name of the HSM profile owner
projectidthe project ID of the HSM profile owner
protocolthe protocol of the HSM profile
statethe state of the HSM profile
vendorthe vendor name of the HSM profile
zoneidthe zone ID where the HSM profile is available
zonenamethe zone name where the HSM profile is available
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateHost.html b/static/api/apidocs-4.23/apis/updateHost.html new file mode 100644 index 0000000000..6d89d9be0f --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateHost.html @@ -0,0 +1,375 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateHost

+

Updates a host.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the host to updatetrue
allocationstateChange resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disablefalse
annotationAdd an annotation to this hostfalse
cleanupexternaldetailsOptional boolean field, which indicates if external details should be cleaned up or not (If set to true, external details removed for this host, externaldetails field ignored; if false or not set, no action)false
externaldetailsDetails in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvaluefalse
guestosrulethe guest OS rule written in JavaScript to match with the OS of the VM.It cannot be used alongside the 'oscategoryid' parameter.false
hosttagsList of tags to be added to the hostfalse
istagaruleWhether the informed tag is a JS interpretable rule or not.false
nameChange the name of hostfalse
oscategoryidthe ID of OS category used to prioritize VMs with matching OS category during the allocation process. It cannot be used alongside the 'guestosrule' parameter.false
urlThe new URI for the secondary storage: nfs://host/pathfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the host
annotationThe last annotation set on this host by an admin
archCPU Arch of the host
capabilitiesCapabilities of the host
clusteridThe cluster ID of the host
clusternameThe cluster name of the host
clusterstorageaccessgroupscomma-separated list of storage access groups on the cluster
clustertypeThe cluster type of the cluster that host belongs to
cpuallocatedThe amount of the host's CPU currently allocated
cpuallocatedpercentageThe amount of the host's CPU currently allocated in percentage
cpuallocatedvalueThe amount of the host's CPU currently allocated in MHz
cpuallocatedwithoverprovisioningThe amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor
cpuloadaverageThe average CPU load on the host
cpunumberThe CPU number of the host
cpusocketsThe number of CPU sockets on the host
cpuspeedThe CPU speed of the host
cpuusedThe amount of the host's CPU currently used
cpuwithoverprovisioningThe amount of the host's CPU after applying the cpu.overprovisioning.factor
createdThe date and time the host was created
detailsHost details in key/value pairs.
disconnectedTrue if the host is disconnected. False otherwise.
disksizeallocatedThe host's currently allocated disk size
disksizetotalThe total disk size of the host
encryptionsupportedTrue if the host supports encryption
eventsEvents available for the host
explicithosttagscomma-separated list of explicit host tags for the host
extensionidThe ID of extension for this cluster
extensionnameThe name of extension for this cluster
gputotalTotal GPUs on the Host
gpuusedUsed GPUs on the Host
guestosrulethe guest OS rule
hahostTrue if the host is Ha host (dedicated to Instances started by HA process; false otherwise
hasenoughcapacityTrue if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise
hosthaThe host HA information information
hosttagsComma-separated list of tags for the host
hypervisorThe host hypervisor
hypervisorversionThe hypervisor version
implicithosttagscomma-separated list of implicit host tags for the host
instanceconversionsupportedtrue if the host supports instance conversion (using virt-v2v)
ipaddressThe IP address of the host
islocalstorageactiveTrue if local storage is active, false otherwise
istagaruleWhether the informed tag is a JS interpretable rule or not.
lastannotatedThe last time this host was annotated
lastpingedThe date and time the host was last pinged
managementserveridThe management server ID of the host
managementservernamethe management server name of the host
memoryallocatedThe amount of the host's memory currently allocated
memoryallocatedbytesThe amount of the host's memory currently allocated in bytes
memoryallocatedpercentageThe amount of the host's memory currently allocated in percentage
memorytotalThe memory total of the host, this parameter is deprecated use memorywithoverprovisioning
memoryusedThe amount of the host's memory currently used
memorywithoverprovisioningThe amount of the host's memory after applying the mem.overprovisioning.factor
msid(only for details=core) the msid of the host's management server
nameThe name of the host
networkkbsreadThe incoming Network traffic on the host
networkkbswriteThe outgoing Network traffic on the host
oscategoryidThe OS category ID of the host
oscategorynameThe OS category name of the host
outofbandmanagementThe host out-of-band management information
podidThe Pod ID of the host
podnameThe Pod name of the host
podstorageaccessgroupscomma-separated list of storage access groups on the pod
removedThe date and time the host was removed
resourcestateThe resource state of the host
stateThe state of the host
storageaccessgroupscomma-separated list of storage access groups for the host
suitableformigrationTrue if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise
typeThe host type
ueficapabilityTrue if the host has capability to support UEFI boot
usernameThe admin that annotated this host
versionThe host version
virtualmachineidthe virtual machine id for host type ConsoleProxy and SecondaryStorageVM
zoneidThe Zone ID of the host
zonenameThe Zone name of the host
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
gpugroup(*)GPU cards present in the host
gpugroupnameGPU cards present in the host
vgpu(*)The list of enabled vGPUs
maxcapacityMaximum vGPU can be created with this vGPU type on the given GPU group
maxheadsMaximum displays per user
maxresolutionxMaximum X resolution per display
maxresolutionyMaximum Y resolution per display
maxvgpuperpgpuMaximum no. of vGPU per GPU card (pgpu)
remainingcapacityRemaining capacity in terms of no. of more Instances that can be deployed with this vGPU type
vgputypeModel Name of vGPU
videoramVideo RAM for this vGPU type
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateHostPassword.html b/static/api/apidocs-4.23/apis/updateHostPassword.html new file mode 100644 index 0000000000..98d136cf9a --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateHostPassword.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateHostPassword

+

Update password of a host/pool on management server.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
passwordThe new password for the host/clustertrue
usernameThe username for the host/clustertrue
clusteridThe cluster IDfalse
hostidThe host IDfalse
update_passwd_on_hostIf the password should also be updated on the hostsfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateHypervisorCapabilities.html b/static/api/apidocs-4.23/apis/updateHypervisorCapabilities.html new file mode 100644 index 0000000000..c54d7aa678 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateHypervisorCapabilities.html @@ -0,0 +1,132 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateHypervisorCapabilities

+

Updates a hypervisor capabilities.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hypervisorThe hypervisor for which the hypervisor capabilities are to be updatedfalse
hypervisorversionThe hypervisor version for which the hypervisor capabilities are to be updatedfalse
idID of the hypervisor capabilityfalse
maxdatavolumeslimitThe maximum number of Data Volumes that can be attached to an Instance for this hypervisor.false
maxguestslimitThe maximum number of Guest Instances per host for this hypervisor.false
maxhostsperclusterThe maximum number of the hypervisor hosts per cluster false
securitygroupenabledSet true to enable security group for this hypervisor.false
storagemotionenabledSet true to enable storage motion support for this hypervisorfalse
vmsnapshotenabledSet true to enable Instance Snapshots for this hypervisorfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe hypervisor capability ID
hypervisorThe hypervisor type
hypervisorversionThe hypervisor version
maxdatavolumeslimitThe maximum number of Data Volumes that can be attached for this hypervisor
maxguestslimitThe maximum number of guest Instances recommended for this hypervisor
maxhostsperclusterThe maximum number of Hosts per cluster for this hypervisor
securitygroupenabledTrue if security group is supported
storagemotionenabledTrue if storage motion is supported
vmsnapshotenabledTrue if Instance Snapshots are enabled for this hypervisor
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateImageStore.html b/static/api/apidocs-4.23/apis/updateImageStore.html new file mode 100644 index 0000000000..23128478d0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateImageStore.html @@ -0,0 +1,124 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateImageStore

+

Updates image store read-only status

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idImage Store UUIDtrue
capacitybytesThe 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
nameThe new name for the Image Store.false
readonlyIf set to true, it designates the corresponding image store to read-only, hence not considering them during storage migrationfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the image store
disksizetotalThe total disk size of the host
disksizeusedThe host's currently used disk size
nameThe name of the image store
protocolThe protocol of the image store
providernameThe provider name of the image store
readonlyDefines if store is read-only
scopeThe scope of the image store
urlThe URL of the image store
zoneidThe Zone ID of the image store
zonenameThe Zone name of the image store
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateInstanceGroup.html b/static/api/apidocs-4.23/apis/updateInstanceGroup.html new file mode 100644 index 0000000000..ea2effd165 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateInstanceGroup.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateInstanceGroup

+

Updates an Instance group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idInstance group IDtrue
nameNew Instance group namefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance group
accountThe Account owning the Instance group
createdTime and date the Instance group was created
domainThe domain name of the Instance group
domainidThe domain ID of the Instance group
domainpathpath of the Domain the instance group belongs to
nameThe name of the Instance group
projectThe project name of the Instance group
projectidThe project ID of the Instance group
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateIpAddress.html b/static/api/apidocs-4.23/apis/updateIpAddress.html new file mode 100644 index 0000000000..0ca1e6c36d --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateIpAddress.html @@ -0,0 +1,237 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateIpAddress

+

Updates an IP address

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the public IP address to updatetrue
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayAn optional field, whether to the display the IP to the end User or notfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idPublic IP address ID
accountThe Account the public IP address is associated with
allocatedDate the public IP address was acquired
associatednetworkidThe ID of the Network associated with the IP address
associatednetworknameThe name of the Network associated with the IP address
domainThe domain the public IP address is associated with
domainidThe domain ID the public IP address is associated with
domainpathpath of the domain to which the public IP address belongs
fordisplayIs public IP for display to the regular user
forprovidertrue if range is dedicated for external network providers
forsystemvmstrue if range is dedicated for System VMs
forvirtualnetworkThe virtual Network for the IP address
hasrulesWhether the IP address has Firewall/PortForwarding/LoadBalancing rules defined
ipaddressPublic IP address
isportableIs public IP portable across the zones
issourcenatTrue if the IP address is a source NAT address, false otherwise
isstaticnatTrue if this IP is for static NAT, false otherwise
issystemTrue if this IP is system IP (was allocated as a part of deployVm or createLbRule)
networkidThe ID of the Network where IP belongs to
networknameThe name of the Network where IP belongs to
physicalnetworkidThe physical Network this belongs to
projectThe project name of the address
projectidThe project id of the IP address
purposePurpose of the IP address. In Acton this value is not null for IPs with isSystem=true, and can have either StaticNat or LB value
stateState of the IP address. Can be: Allocating, Allocated, Releasing, Reserved and Free
virtualmachinedisplaynameInstance display name the IP address is assigned to (not null only for static NAT IP)
virtualmachineidInstance id the IP address is assigned to
virtualmachinenameInstance name the IP address is assigned to
virtualmachinetypeInstance type the IP address is assigned to
vlanidThe ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only
vlannameThe VLAN associated with the IP address
vmipaddressInstance (DNAT) IP address (not null only for static NAT IP)
vpcidVPC ID the IP belongs to
vpcnameVPC name the IP belongs to
zoneidThe ID of the zone the public IP address belongs to
zonenameThe name of the zone the public IP address belongs to
tags(*)The list of resource tags associated with IP address
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateIpv4SubnetForZone.html b/static/api/apidocs-4.23/apis/updateIpv4SubnetForZone.html new file mode 100644 index 0000000000..9b2e033ac1 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateIpv4SubnetForZone.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateIpv4SubnetForZone

+

Updates an existing IPv4 subnet for a zone.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idId of the guest network IPv4 subnettrue
subnetThe new CIDR of the IPv4 subnet.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idid of the guest IPv4 subnet
accountthe account of the IPv4 subnet
createddate when this IPv4 subnet was created.
domainthe domain name of the IPv4 subnet
domainidthe domain ID of the IPv4 subnet
projectthe project name of the IPv4 subnet
projectidthe project id of the IPv4 subnet
subnetguest IPv4 subnet
zoneidid of zone to which the IPv4 subnet belongs to.
zonenamename of zone to which the IPv4 subnet belongs to.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateIpv6FirewallRule.html b/static/api/apidocs-4.23/apis/updateIpv6FirewallRule.html new file mode 100644 index 0000000000..9f290577a8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateIpv6FirewallRule.html @@ -0,0 +1,195 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateIpv6FirewallRule

+

Updates Ipv6 firewall rule with specified ID

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the IPv6 firewall ruletrue
cidrlistThe cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).false
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
endportThe ending port of Ipv6 firewall rulefalse
fordisplayAn optional field, whether to the display the Ipv6 firewall rule to the end User or notfalse
icmpcodeError code for this ICMP messagefalse
icmptypeType of the ICMP message being sentfalse
protocolThe protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol numberfalse
startportThe starting port of Ipv6 firewall rulefalse
traffictypeThe traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specifiedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the port forwarding rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
fordisplayIs firewall for display to the regular user
ipaddressThe public IP address for the port forwarding rule
ipaddressidThe public IP address id for the port forwarding rule
networkidThe ID of the guest Network the port forwarding rule belongs to
networknameThe Name of the guest Network the port forwarding rule belongs to
privateendportThe ending port of port forwarding rule's private port range
privateportThe starting port of port forwarding rule's private port range
protocolThe protocol of the port forwarding rule
publicendportThe ending port of port forwarding rule's private port range
publicportThe starting port of port forwarding rule's public port range
stateThe state of the rule
virtualmachinedisplaynameThe Instance display name for the port forwarding rule
virtualmachineidThe Instance ID for the port forwarding rule
virtualmachinenameThe Instance name for the port forwarding rule
vmguestipThe Instance IP address for the port forwarding rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateIso.html b/static/api/apidocs-4.23/apis/updateIso.html new file mode 100644 index 0000000000..116329d96c --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateIso.html @@ -0,0 +1,297 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateIso

+

Updates an ISO file.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the image filetrue
archthe CPU arch of the template/ISO. Valid options are: x86_64, aarch64, s390xfalse
bootableTrue if image is bootable, false otherwise; available only for updateIso APIfalse
cleanupdetailsOptional 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
detailsDetails in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61false
displaytextThe display text of the imagefalse
forceupdateostypeForce OS type update. Warning: Updating OS type will update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.false
formatThe format for the imagefalse
isdynamicallyscalableTrue if Template/ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memoryfalse
isroutingTrue if the Template type is routing i.e., if Template is used to deploy routerfalse
nameThe name of the image filefalse
ostypeidThe ID of the OS type that best represents the OS of this image.false
passwordenabledTrue if the image supports the password reset feature; default is falsefalse
requireshvmTrue if the Template requires HVM, false otherwise; available only for updateTemplate APIfalse
sortkeySort key of the Template, integerfalse
sshkeyenabledTrue if the Template supports the SSHkey upload feature; default is falsefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe Account name to which the Template belongs
accountidThe Account id to which the Template belongs
archCPU Arch of the template
bitsThe processor bit size
bootableTrue if the ISO is bootable, false otherwise
checksumChecksum of the Template
childtemplatesIf root disk Template, then IDs of the datas disk Templates this Template owns
createdThe date this Template was created
crossZonesTrue if the Template is managed across all Zones, false otherwise
deployasisVMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is Template
detailsAdditional key/value details tied with Template
directdownloadKVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextThe Template display text
domainThe name of the domain to which the Template belongs
domainidThe ID of the domain to which the Template belongs
domainpathPath of the Domain the template belongs to
downloaddetailsLists the download progress of a Template across all secondary storages
extensionidThe ID of extension linked to this template
extensionnameThe name of extension linked to this template
forcksIf true it indicates that the template can be used for CKS cluster deployments
formatThe format of the Template.
hostidThe ID of the secondary storage host for the Template
hostnameThe name of the secondary storage host for the Template
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
isextractableTrue if the Template is extractable, false otherwise
isfeaturedTrue if this Template is a featured Template, false otherwise
ispublicTrue if this Template is a public Template, false otherwise
isreadyTrue if the Template is ready to be deployed from, false otherwise.
nameThe Template name
ostypeidThe ID of the OS type for this Template.
ostypenameThe name of the OS type for this Template.
parenttemplateidIf Datadisk Template, then id of the root disk Template this Template belongs to
passwordenabledTrue if the reset password feature is enabled, false otherwise
physicalsizeThe physical size of the Template
projectThe project name of the Template
projectidThe project ID of the Template
removedThe date this Template was removed
requireshvmTrue if Template requires HVM enabled, false otherwise
sizeThe size of the Template
sourcetemplateidThe Template ID of the parent Template if present
sshkeyenabledTrue if Template is sshkey enabled, false otherwise
statusThe status of the Template
templatetagThe tag of this Template
templatetypeThe type of the Template
urlThe URL which the Template/ISO is registered from
userdataidThe id of userdata linked to this Template
userdatanameThe name of userdata linked to this Template
userdataparamsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
zoneidThe ID of the zone for this Template
zonenameThe name of the zone for this Template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateIsoPermissions.html b/static/api/apidocs-4.23/apis/updateIsoPermissions.html new file mode 100644 index 0000000000..530017a616 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateIsoPermissions.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateIsoPermissions

+

Updates ISO permissions

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe Template IDtrue
accountsA comma delimited list of Accounts within caller's domain. If specified, "op" parameter has to be passed in.false
isextractableTrue if the Template/ISO is extractable, false otherwise. Can be set only by root adminfalse
isfeaturedTrue for featured Template/ISO, false otherwisefalse
ispublicTrue for public Template/ISO, false for private Templates/ISOsfalse
opPermission operator (add, remove, reset)false
projectidsA comma delimited list of projects. If specified, "op" parameter has to be passed in.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateKMSKey.html b/static/api/apidocs-4.23/apis/updateKMSKey.html new file mode 100644 index 0000000000..1b35e6936d --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateKMSKey.html @@ -0,0 +1,150 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateKMSKey

+

Updates KMS key name, description, or enabled status

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe UUID of the KMS key to updatetrue
descriptionNew description for the keyfalse
enabledwhether the key should be enabledfalse
nameNew name for the keyfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe UUID of the key
accountthe account owning the key
accountidthe account ID owning the key
algorithmthe encryption algorithm
createdthe creation timestamp
descriptionthe description of the key
domainthe domain name of the key
domainidthe domain ID of the key
domainpaththe domain path of the key
enabledwhether the key is enabled
hsmprofilethe zone name where the key is valid
hsmprofileidthe zone ID where the key is valid
keklabelthe provider-specific KEK label (admin only)
keybitsthe key size in bits
namethe name of the key
projectthe project name of the key
projectidthe project ID of the key
versionthe key size in bits
zoneidthe zone ID where the key is valid
zonenamethe zone name where the key is valid
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateKubernetesClusterAffinityGroups.html b/static/api/apidocs-4.23/apis/updateKubernetesClusterAffinityGroups.html new file mode 100644 index 0000000000..bdf3d17e63 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateKubernetesClusterAffinityGroups.html @@ -0,0 +1,243 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateKubernetesClusterAffinityGroups

+

Updates the affinity group mappings for a stopped Kubernetes cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Kubernetes clustertrue
nodeaffinitygroupsNode Type to Affinity Group ID mapping. VMs of each node type will be added to the specified affinity groupfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Kubernetes cluster
accountThe Account associated with the Kubernetes cluster
associatednetworknameThe name of the network of the Kubernetes cluster
autoscalingenabledWhether autoscaling is enabled for the cluster
clustertypeThe type of the cluster
cniconfignameName of CNI Configuration associated with the cluster
cniconfigurationidID of CNI Configuration associated with the cluster
consoleendpointURL end point for the Kubernetes cluster dashboard UI
controlaffinitygroupidsThe IDs of affinity groups associated with control nodes
controlaffinitygroupnamesThe names of affinity groups associated with control nodes
controlnodesThe control nodes count for the Kubernetes cluster
controlofferingidthe ID of the service offering of the control nodes on the Kubernetes cluster
controlofferingnamethe name of the service offering of the control nodes on the Kubernetes cluster
cpunumberThe cpu cores of the Kubernetes cluster
createdThe date when this Kubernetes cluster was created
csienabledIndicates if the CloudStack CSI driver has been setup in the cluster
descriptionThe description of the Kubernetes cluster
domainThe name of the domain in which the Kubernetes cluster exists
domainidThe ID of the domain in which the Kubernetes cluster exists
domainpathPath of the domain to which the Kubernetes cluster belongs
endpointURL end point for the Kubernetes cluster
etcdaffinitygroupidsThe IDs of affinity groups associated with etcd nodes
etcdaffinitygroupnamesThe names of affinity groups associated with etcd nodes
etcdipsPublic IP Addresses of the etcd nodes
etcdnodesthe number of the etcd nodes on the Kubernetes cluster
etcdofferingidthe ID of the service offering of the etcd nodes on the Kubernetes cluster
etcdofferingnamethe name of the service offering of the etcd nodes on the Kubernetes cluster
ipaddressPublic IP Address of the cluster
ipaddressidPublic IP Address ID of the cluster
keypairKeypair details
kubernetesversionidThe ID of the Kubernetes version for the Kubernetes cluster
kubernetesversionnameThe name of the Kubernetes version for the Kubernetes cluster
masternodesThe master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.
maxsizeMaximum size of the cluster
memoryThe memory the Kubernetes cluster
minsizeMinimum size of the cluster
nameThe name of the Kubernetes cluster
networkidThe ID of the network of the Kubernetes cluster
projectThe project name of the Kubernetes cluster
projectidThe project id of the Kubernetes cluster
serviceofferingidThe ID of the service offering of the Kubernetes cluster
serviceofferingnameThe name of the service offering of the Kubernetes cluster
sizeThe size (worker nodes count) of the Kubernetes cluster
stateThe state of the Kubernetes cluster
templateidThe ID of the Template of the Kubernetes cluster
templatenamethe name of the template of the Kubernetes cluster
virtualmachinesThe list of virtualmachines associated with this Kubernetes cluster
workeraffinitygroupidsThe IDs of affinity groups associated with worker nodes
workeraffinitygroupnamesThe names of affinity groups associated with worker nodes
workerofferingidthe ID of the service offering of the worker nodes on the Kubernetes cluster
workerofferingnamethe name of the service offering of the worker nodes on the Kubernetes cluster
zoneidThe name of the zone of the Kubernetes cluster
zonenameThe name of the zone of the Kubernetes cluster
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateKubernetesSupportedVersion.html b/static/api/apidocs-4.23/apis/updateKubernetesSupportedVersion.html new file mode 100644 index 0000000000..d528f4bd31 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateKubernetesSupportedVersion.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateKubernetesSupportedVersion

+

Update a supported Kubernetes version

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Kubernetes supported versiontrue
stateThe enabled or disabled state of the Kubernetes supported versiontrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Kubernetes supported version
archthe arch of the binaries ISO for Kubernetes supported version
createdThe date when this Kubernetes supported version was created
directdownloadKVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage
isoidThe ID of the binaries ISO for Kubernetes supported version
isonameThe name of the binaries ISO for Kubernetes supported version
isostateThe state of the binaries ISO for Kubernetes supported version
isourlthe URL of the binaries ISO for Kubernetes supported version
mincpunumberThe minimum number of CPUs needed for the Kubernetes supported version
minmemoryThe minimum RAM size in MB needed for the Kubernetes supported version
nameName of the Kubernetes supported version
semanticversionKubernetes semantic version
stateThe enabled or disabled state of the Kubernetes supported version
supportsautoscalingWhether Kubernetes supported version supports Autoscaling
supportshaWhether Kubernetes supported version supports HA, multi-control nodes
zoneidThe ID of the zone in which Kubernetes supported version is available
zonenameThe name of the zone in which Kubernetes supported version is available
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateLBHealthCheckPolicy.html b/static/api/apidocs-4.23/apis/updateLBHealthCheckPolicy.html new file mode 100644 index 0000000000..1285f4c356 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateLBHealthCheckPolicy.html @@ -0,0 +1,132 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateLBHealthCheckPolicy

+

Updates load balancer health check policy

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of load balancer health check policytrue
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayAn optional field, whether to the display the policy to the end user or notfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account of the HealthCheck policy
domainThe domain of the HealthCheck policy
domainidThe domain ID of the HealthCheck policy
lbruleidThe LB rule ID
zoneidThe ID of the zone the HealthCheck policy belongs to
healthcheckpolicy(*)The list of healthcheckpolicies
idThe LB HealthCheck policy ID
descriptionThe description of the healthcheck policy
fordisplayIs policy for display to the regular user
healthcheckintervalAmount of time between health checks
healthcheckthressholdNumber of consecutive health check success before declaring an Instance healthy
pingpathThe pingpath of the healthcheck policy
responsetimeTime to wait when receiving a response from the health check
stateThe state of the policy
unhealthcheckthressholdNumber of consecutive health check failures before declaring an Instance unhealthy.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateLBStickinessPolicy.html b/static/api/apidocs-4.23/apis/updateLBStickinessPolicy.html new file mode 100644 index 0000000000..5033c93da9 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateLBStickinessPolicy.html @@ -0,0 +1,135 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateLBStickinessPolicy

+

Updates load balancer stickiness policy

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of lb stickiness policytrue
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayAn optional field, whether to the display the policy to the end user or notfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account of the Stickiness policy
descriptionThe description of the Stickiness policy
domainThe domain of the Stickiness policy
domainidThe domain ID of the Stickiness policy
lbruleidThe LB rule ID
nameThe name of the Stickiness policy
stateThe state of the policy
zoneidThe ID of the zone the Stickiness policy belongs to
stickinesspolicy(*)The list of stickinesspolicies
idThe LB Stickiness policy ID
descriptionThe description of the Stickiness policy
fordisplayIs policy for display to the regular user
methodnameThe method name of the Stickiness policy
nameThe name of the Stickiness policy
paramsThe params of the policy
stateThe state of the policy
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateLoadBalancer.html b/static/api/apidocs-4.23/apis/updateLoadBalancer.html new file mode 100644 index 0000000000..fe39ffcd7c --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateLoadBalancer.html @@ -0,0 +1,192 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateLoadBalancer

+

Updates an internal load balancer

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the load balancertrue
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayAn optional field, whether to the display the rule to the end user or notfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Load Balancer ID
accountThe Account of the Load Balancer
algorithmThe Load balancer algorithm (source, roundrobin, leastconn)
descriptionThe description of the Load Balancer
domainThe domain of the Load Balancer
domainidThe domain ID of the Load Balancer
domainpathpath of the domain to which the Load Balancer belongs
fordisplayIs rule for display to the regular User
nameThe name of the Load Balancer
networkidLoad Balancer Network id
projectThe project name of the Load Balancer
projectidThe project id of the Load Balancer
sourceipaddressLoad Balancer source IP
sourceipaddressnetworkidLoad Balancer source IP Network id
loadbalancerinstance(*)The list of Instances associated with the Load Balancer
idThe Instance ID
ipaddressThe IP address of the Instance
nameThe name of the Instance
stateThe state of the Instance
loadbalancerrule(*)The list of rules associated with the Load Balancer
instanceportInstance port of the Load balancer rule
sourceportSource port of the Load balancer rule
stateThe state of the Load balancer rule
tags(*)The list of resource tags associated with the Load Balancer
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateLoadBalancerRule.html b/static/api/apidocs-4.23/apis/updateLoadBalancerRule.html new file mode 100644 index 0000000000..257db53623 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateLoadBalancerRule.html @@ -0,0 +1,201 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateLoadBalancerRule

+

Updates load balancer

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the load balancer rule to updatetrue
algorithmLoad balancer algorithm (source, roundrobin, leastconn)false
cidrlistthe cidr list to forward traffic fromfalse
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
descriptionThe description of the load balancer rulefalse
fordisplayAn optional field, whether to the display the rule to the end user or notfalse
nameThe name of the load balancer rulefalse
protocolThe protocol for the LBfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Load balancer rule ID
accountThe Account of the Load balancer rule
algorithmThe Load balancer algorithm (source, roundrobin, leastconn)
cidrlistThe CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).
descriptionThe description of the Load balancer
domainThe domain of the Load balancer rule
domainidThe domain ID of the Load balancer rule
domainpathpath of the domain to which the load balancer rule belongs
fordisplayIs rule for display to the regular user
nameThe name of the Load balancer
networkidThe ID of the guest Network the LB rule belongs to
privateportThe private port
projectThe project name of the Load balancer
projectidThe project ID of the Load balancer
protocolThe protocol of the Load Balancer rule
publicipThe public IP address
publicipidThe public IP address ID
publicportThe public port
stateThe state of the rule
zoneidThe ID of the zone the rule belongs to
zonenameThe name of the zone the Load balancer rule belongs to
tags(*)The list of resource tags associated with Load balancer
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateNetwork.html b/static/api/apidocs-4.23/apis/updateNetwork.html new file mode 100644 index 0000000000..be75efa943 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateNetwork.html @@ -0,0 +1,441 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateNetwork

+

Updates a network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the networktrue
changecidrForce update even if CIDR type is differentfalse
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
displaynetworkAn optional field, whether to the display the network to the end User or not.false
displaytextThe new display text for the networkfalse
dns1The first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zonefalse
dns2The second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zonefalse
forcedSetting this to true will cause a forced network update,false
guestvmcidrCIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDRfalse
hideipaddressusageWhen true IP address usage for the Network will not be exported by the listUsageRecords APIfalse
ip6dns1The first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zonefalse
ip6dns2The second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zonefalse
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.false
nameThe new name for the networkfalse
networkdomainNetwork domainfalse
networkofferingidNetwork offering IDfalse
privatemtuMTU to be configured on the network VR's public facing interfacesfalse
publicmtuMTU to be configured on the network VR's public facing interfacesfalse
sourcenatipaddressIPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this networkfalse
updateinsequenceIf true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as providerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Network
accountThe owner of the Network
aclidACL ID associated with the VPC Network
aclnameACL name associated with the VPC Network
acltypeACL type - access type to the Network
asnumberAS NUMBER
asnumberidUUID of AS NUMBER
bgppeersThe BGP peers for the network
broadcastdomaintypeBroadcast domain type of the Network
broadcasturiBroadcast URI of the Network. This parameter is visible to ROOT admins only
canusefordeployList Networks available for Instance deployment
cidrCloudStack managed address space, all CloudStack managed Instances get IP address from CIDR
createdThe date this Network was created
detailsThe details of the Network
displaynetworkAn optional field, whether to the display the Network to the end user or not.
displaytextThe displaytext of the Network
dns1The first IPv4 DNS for the Network
dns2The second IPv4 DNS for the Network
dnssubdomainDNS subdomain associated to the network
dnszoneDNS zone associated to the network
domainThe domain name of the Network owner
domainidThe domain ID of the Network owner
domainpathPath of the Domain the network belongs to
egressdefaultpolicyTrue if guest Network default egress policy is allow; false if default egress policy is deny
externalidThe external ID of the Network
gatewayThe Network's gateway
iconBase64 string representation of the resource icon
internetprotocolThe internet protocol of Network offering
ip4routesThe routes for the network to ease adding route in upstream router
ip4routingThe IPv4 routing type of network
ip6cidrThe CIDR of IPv6 Network
ip6dns1The first IPv6 DNS for the network
ip6dns2The second IPv6 DNS for the network
ip6gatewayThe gateway of IPv6 Network
ip6routesThe routes for the Network to ease adding route in upstream router
ip6routingThe IPv6 routing type of network offering
isdefaultTrue if Network is default, false otherwise
ispersistentList Networks that are persistent
issystemTrue if Network is system, false otherwise
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.
nameThe name of the Network
netmaskThe Network's netmask
networkcidrThe Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE
networkdomainThe Network domain
networkofferingavailabilityAvailability of the Network offering the Network is created from
networkofferingconservemodeTrue if Network offering is IP conserve mode enabled
networkofferingdisplaytextDisplay text of the Network offering the Network is created from
networkofferingidNetwork offering ID the Network is created from
networkofferingnameName of the Network offering the Network is created from
physicalnetworkidThe physical Network id
privatemtuMTU configured on the network VR's private interfaces
projectThe project name of the address
projectidThe project ID of the IP address
publicmtuMTU configured on the Network VR's public facing interfaces
receivedbytesThe total number of Network traffic bytes received
redundantrouterIf the Network has redundant routers enabled
relatedRelated to what other Network configuration
reservediprangeThe Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes
restartrequiredTrue if Network requires restart
sentbytesThe total number of Network traffic bytes sent
specifyiprangesTrue if Network supports specifying IP ranges, false otherwise
specifyvlanTrue if network supports specifying vlan, false otherwise
stateState of the Network
strechedl2subnetTrue if Network can span multiple zones
subdomainaccessTrue if users from subdomains can access the domain level Network
supportsvmautoscalingIf Network offering supports Instance autoscaling feature
traffictypeThe traffic type of the Network
tungstenvirtualrouteruuidTungsten-Fabric virtual router the Network belongs to
typeThe type of the Network
vlanThe VLAN of the Network. This parameter is visible to ROOT admins only
vpcidVPC the Network belongs to
vpcnameName of the VPC to which this Network belongs
zoneidZone ID of the Network
zonenameThe name of the zone the Network belongs to
zonesnetworkspansIf a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans
service(*)The list of services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
tags(*)The list of resource tags associated with Network
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateNetworkACLItem.html b/static/api/apidocs-4.23/apis/updateNetworkACLItem.html new file mode 100644 index 0000000000..788dbe25c7 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateNetworkACLItem.html @@ -0,0 +1,201 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateNetworkACLItem

+

Updates ACL item with specified ID

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the network ACL itemtrue
actionACL entry action, allow or denyfalse
cidrlistThe CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).false
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
endportThe ending port of ACLfalse
fordisplayAn optional field, whether to the display the rule to the end User or notfalse
icmpcodeError code for this ICMP messagefalse
icmptypeType of the ICMP message being sentfalse
numberThe Network of the Instance the ACL will be created forfalse
partialupgradeIndicates 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
protocolThe protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol numberfalse
reasonA description indicating why the ACL rule is required.false
startportThe starting port of ACLfalse
traffictypeThe traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specifiedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the ACL Item
aclidThe ID of the ACL this item belongs to
aclnameThe name of the ACL this item belongs to
actionAction of ACL Item. Allow/Deny
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
endportThe ending port of ACL's port range
fordisplayIs rule for display to the regular user
icmpcodeError code for this icmp message
icmptypeType of the icmp message being sent
numberNumber of the ACL Item
protocolThe protocol of the ACL
reasonAn explanation on why this ACL rule is being applied
startportThe starting port of ACL's port range
stateThe state of the rule
traffictypeThe traffic type for the ACL
tags(*)The list of resource tags associated with the Network ACLs
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateNetworkACLList.html b/static/api/apidocs-4.23/apis/updateNetworkACLList.html new file mode 100644 index 0000000000..5bc1d26125 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateNetworkACLList.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateNetworkACLList

+

Updates Network ACL list

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the network ACLtrue
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
descriptionDescription of the network ACL listfalse
fordisplayAn optional field, whether to the display the list to the end User or notfalse
nameName of the network ACL listfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateNetworkOffering.html b/static/api/apidocs-4.23/apis/updateNetworkOffering.html new file mode 100644 index 0000000000..0d96c68851 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateNetworkOffering.html @@ -0,0 +1,252 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateNetworkOffering

+

Updates a network offering.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
availabilityThe 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
displaytextThe display text of the network offeringfalse
domainidThe ID of the containing domain(s) as comma separated string, public for public offeringsfalse
idThe ID of the network offeringfalse
keepaliveenabledIf 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
maxconnectionsMaximum number of concurrent connections supported by the network offeringfalse
nameThe name of the network offeringfalse
sortkeySort key of the network offering, integerfalse
stateUpdate state for the network offeringfalse
tagsThe tags for the network offering.false
zoneidThe ID of the containing zone(s) as comma separated string, all for all zones offeringsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Network offering
availabilityAvailability of the Network offering
conservemodeTrue if Network offering is IP conserve mode enabled
createdThe date this Network offering was created
detailsAdditional key/value details tied with network offering
displaytextAn alternate display text of the Network offering.
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
egressdefaultpolicyTrue if guest network default egress policy is allow; false if default egress policy is deny
fornsxtrue if network offering can be used by NSX networks only
fortungstenTrue if Network offering can be used by Tungsten-Fabric Networks only
forvpcTrue if Network offering can be used by VPC Networks only
guestiptypeGuest type of the Network offering, can be Shared or Isolated
internetprotocolThe internet protocol of the network offering
isdefaultTrue if Network offering is default, false otherwise
ispersistentTrue if Network offering supports persistent networks, false otherwise
maxconnectionsMaximum number of concurrent connections to be handled by LB
nameThe name of the Network offering
networkmodeMode in which the network will operate. The valid values are NATTED and ROUTED
networkrateData transfer rate in megabits per second allowed.
routingmodethe routing mode for the network offering, supported types are Static or Dynamic.
serviceofferingidThe ID of the service offering used by virtual router provider
specifyasnumbertrue if network offering supports choosing AS numbers
specifyiprangesTrue if Network offering supports specifying IP ranges, false otherwise
specifyvlanTrue if Network offering supports VLANs, false otherwise
stateState of the Network offering. Can be Disabled/Enabled/Inactive
supportsinternallbtrue if network offering supports public access for guest networks
supportspublicaccessTrue if network offering supports public access for guest networks
supportsstrechedl2subnetTrue if network offering supports network that span multiple zones
tagsThe tags for the Network offering
traffictypeThe traffic type for the Network offering, supported types are Public, Management, Control, Guest, VLAN or Storage.
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
service(*)The list of supported services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateNetworkServiceProvider.html b/static/api/apidocs-4.23/apis/updateNetworkServiceProvider.html new file mode 100644 index 0000000000..b06b9fb06d --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateNetworkServiceProvider.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateNetworkServiceProvider

+

Updates a network serviceProvider of a physical network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idNetwork service provider IDtrue
servicelistThe list of services to be enabled for this physical network service providerfalse
stateEnabled/Disabled/Shutdown the physical network service providerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateOauthProvider.html b/static/api/apidocs-4.23/apis/updateOauthProvider.html new file mode 100644 index 0000000000..f1bff03a71 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateOauthProvider.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateOauthProvider

+

Updates the registered OAuth provider details

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idid of the OAuth provider to be updatedtrue
authorizeurlAuthorize URL pre-registered in the specific OAuth providerfalse
clientidClient ID pre-registered in the specific OAuth providerfalse
descriptionDescription of the OAuth Providerfalse
domainDomain path to reassign this OAuth provider to. Ignored when Domain ID is passed. If neither is provided, the current domain assignment is kept.false
domainidDomain ID to reassign this OAuth provider to. If not provided, the current domain assignment is kept.false
enabledOAuth provider will be enabled or disabled based on this valuefalse
redirecturiRedirect URI pre-registered in the specific OAuth providerfalse
secretkeySecret Key pre-registered in the specific OAuth providerfalse
tokenurlToken URL pre-registered in the specific OAuth providerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the provider
authorizeurlAuthorize URL registered in the OAuth provider
clientidClient ID registered in the OAuth provider
descriptionDescription of the provider registered
domainname of the domain the provider belongs to (empty for global)
domainidUUID of the domain the provider belongs to (empty for global)
domainpathpath of the domain the provider belongs to (empty for global)
enabledWhether the OAuth provider is enabled or not
nameName of the provider
providerName of the provider
redirecturiRedirect URI registered in the OAuth provider
secretkeySecret key registered in the OAuth provider
tokenurlToken URL registered in the OAuth provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateObjectStoragePool.html b/static/api/apidocs-4.23/apis/updateObjectStoragePool.html new file mode 100644 index 0000000000..25ffdf56f0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateObjectStoragePool.html @@ -0,0 +1,111 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateObjectStoragePool

+

Updates object storage pool

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idObject Store IDtrue
namethe name for the object storefalse
sizethe total size of the object store in GiB. Used for tracking capacity and sending alerts. Set to 0 to stop tracking.false
urlthe url for the object storefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the object store
namethe name of the object store
providernamethe provider name of the object store
storageallocatedthe allocated size of the object store
storagetotalthe total size of the object store
storageusedthe object store currently used size
urlthe url of the object store
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateOsCategory.html b/static/api/apidocs-4.23/apis/updateOsCategory.html new file mode 100644 index 0000000000..72e68553b2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateOsCategory.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateOsCategory

+

Updates an OS category

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the OS categorytrue
isfeaturedWhether the category is featured or notfalse
nameName for the OS categoryfalse
sortkeysort key of the OS category for listingfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the OS category
createdDate when the OS category was created.
iconBase64 string representation of the resource icon
isfeaturedWhether the OS category is featured
nameThe name of the OS category
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updatePhysicalNetwork.html b/static/api/apidocs-4.23/apis/updatePhysicalNetwork.html new file mode 100644 index 0000000000..11305dc780 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updatePhysicalNetwork.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updatePhysicalNetwork

+

Updates a physical network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idPhysical Network IDtrue
networkspeedThe speed for the physical Network[1G/10G]false
stateEnabled/Disabledfalse
tagsTag the physical Networkfalse
vlanThe VLAN for the physical Networkfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe UUID of the physical Network
broadcastdomainrangeBroadcast domain range of the physical Network
domainidThe domain ID of the physical Network owner
isolationmethodsIsolation methods
nameName of the physical Network
networkspeedThe speed of the physical Network
stateState of the physical Network
tagsComma separated tag
vlanThe VLAN of the physical Network
zoneidZone ID of the physical Network
zonenameZone name of the physical Network
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updatePod.html b/static/api/apidocs-4.23/apis/updatePod.html new file mode 100644 index 0000000000..cb8a7264dc --- /dev/null +++ b/static/api/apidocs-4.23/apis/updatePod.html @@ -0,0 +1,201 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updatePod

+

Updates a Pod.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Podtrue
allocationstateAllocation state of this cluster for allocation of new resourcesfalse
endipThe ending IP address for the Podfalse
gatewayThe gateway for the Podfalse
nameThe name of the Podfalse
netmaskThe netmask of the Podfalse
startipThe starting IP address for the Podfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Pod
allocationstateThe allocation state of the Pod
endipThe ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.
forsystemvmsIndicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.
gatewayThe gateway of the Pod
nameThe name of the Pod
netmaskThe netmask of the Pod
startipThe starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.
storageaccessgroupscomma-separated list of storage access groups for the pod
vlanidIndicates VLAN ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.
zoneidThe Zone ID of the Pod
zonenameThe Zone name of the Pod
zonestorageaccessgroupscomma-separated list of storage access groups on the zone
capacity(*)The capacity of the Pod
capacityallocatedThe capacity currently in allocated
capacitytotalThe total capacity available
capacityusedThe capacity currently in use
clusteridThe Cluster ID
clusternameThe Cluster name
nameThe capacity name
percentusedThe percentage of capacity currently in use
podidThe Pod ID
podnameThe Pod name
tagThe tag for the capacity type
typeThe capacity type
zoneidThe Zone ID
zonenameThe Zone name
ipranges(*)The IP ranges for the Pod
cidrThe CIDR for the range
endipThe ending IP for the range
forsystemvmsIndicates if range is dedicated for CPVM and SSVM
gatewayThe gateway for the range
startipThe starting IP for the range
vlanidIndicates VLAN ID for the range
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updatePodManagementNetworkIpRange.html b/static/api/apidocs-4.23/apis/updatePodManagementNetworkIpRange.html new file mode 100644 index 0000000000..d280b88581 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updatePodManagementNetworkIpRange.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updatePodManagementNetworkIpRange

+

Updates a management network IP range. Only allowed when no IPs are allocated.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
currentendipThe current ending IP address.true
currentstartipThe current starting IP address.true
podidUUID of POD, where the IP range belongs to.true
newendipThe new ending IP address.false
newstartipThe new starting IP address.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updatePortForwardingRule.html b/static/api/apidocs-4.23/apis/updatePortForwardingRule.html new file mode 100644 index 0000000000..d57bead565 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updatePortForwardingRule.html @@ -0,0 +1,189 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updatePortForwardingRule

+

Updates a port forwarding rule. Only the private port and the Instance can be updated.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the port forwarding ruletrue
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
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayAn optional field, whether to the display the rule to the end user or notfalse
privateendportThe private end port of the port forwarding rulefalse
privateportThe private start port of the port forwarding rulefalse
virtualmachineidThe ID of the Instance for the port forwarding rulefalse
vmguestipInstance guest NIC Secondary IP address for the port forwarding rulefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the port forwarding rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
fordisplayIs firewall for display to the regular user
ipaddressThe public IP address for the port forwarding rule
ipaddressidThe public IP address id for the port forwarding rule
networkidThe ID of the guest Network the port forwarding rule belongs to
networknameThe Name of the guest Network the port forwarding rule belongs to
privateendportThe ending port of port forwarding rule's private port range
privateportThe starting port of port forwarding rule's private port range
protocolThe protocol of the port forwarding rule
publicendportThe ending port of port forwarding rule's private port range
publicportThe starting port of port forwarding rule's public port range
stateThe state of the rule
virtualmachinedisplaynameThe Instance display name for the port forwarding rule
virtualmachineidThe Instance ID for the port forwarding rule
virtualmachinenameThe Instance name for the port forwarding rule
vmguestipThe Instance IP address for the port forwarding rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateProject.html b/static/api/apidocs-4.23/apis/updateProject.html new file mode 100644 index 0000000000..97db84b4b2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateProject.html @@ -0,0 +1,318 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateProject

+

Updates a project

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the project to be modifiedtrue
accountNew Admin Account for the projectfalse
displaytextDisplay text of the projectfalse
nameName of the projectfalse
roletypeAccount level role to be assigned to the User/Account : Admin/Regularfalse
swapownerWhen 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 truefalse
useridID of the User to be promoted/demotedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the project
backupavailablethe total number of backups available to this project
backuplimitthe total number of backups which can be stored by this project
backupstorageavailablethe total backup storage space (in GiB) available to the project
backupstoragelimitthe total backup storage space (in GiB) the project can own
backupstoragetotalthe total backup storage space (in GiB) owned by the project
backuptotalthe total number of backups stored by this project
bucketavailablethe total number of buckets available to this project
bucketlimitthe total number of buckets which can be stored by this project
buckettotalthe total number of buckets stored by this project
cpuavailableThe total number of CPU cores available to be created for this project
cpulimitThe total number of CPU cores the project can own
cputotalThe total number of CPU cores owned by project
createdThe date this project was created
displaytextThe displaytext of the project
domainThe domain name where the project belongs to
domainidThe domain ID the project belongs to
gpuavailablethe total number of gpus available to be created for this project
gpulimitthe total number of gpus the project can own
gputotalthe total number of gpus owned by project
iconBase64 string representation of the resource icon
ipavailableThe total number of public IP addresses available for this project to acquire
iplimitThe total number of public IP addresses this project can acquire
iptotalThe total number of public IP addresses allocated for this project
memoryavailableThe total memory (in MB) available to be created for this project
memorylimitThe total memory (in MB) the project can own
memorytotalThe total memory (in MB) owned by project
nameThe name of the project
networkavailableThe total number of Networks available to be created for this project
networklimitThe total number of Networks the project can own
networktotalThe total number of Networks owned by project
objectstorageavailablethe total object storage space (in GiB) available to the project
objectstoragelimitthe total object storage space (in GiB) the project can own
objectstoragetotalthe total object storage space (in GiB) owned by the project
ownerThe Account name of the project's owners
primarystorageavailableThe total primary storage space (in GiB) available to be used for this project
primarystoragelimitThe total primary storage space (in GiB) the project can own
primarystoragetotalThe total primary storage space (in GiB) owned by project
projectaccountnameThe project Account name of the project
secondarystorageavailableThe total secondary storage space (in GiB) available to be used for this project
secondarystoragelimitThe total secondary storage space (in GiB) the project can own
secondarystoragetotalThe total secondary storage space (in GiB) owned by project
snapshotavailableThe total number of Snapshots available for this project
snapshotlimitThe total number of Snapshots which can be stored by this project
snapshottotalThe total number of Snapshots stored by this project
stateThe state of the project
taggedresourcesThe tagged resource limit and count for the project
templateavailableThe total number of Templates available to be created by this project
templatelimitThe total number of Templates which can be created by this project
templatetotalThe total number of Templates which have been created by this project
vmavailableThe total number of Instances available for this project to acquire
vmlimitThe total number of Instances that can be deployed by this project
vmrunningThe total number of Instances running for this project
vmstoppedThe total number of Instances stopped for this project
vmtotalThe total number of Instances deployed by this project
volumeavailableThe total volume available for this project
volumelimitThe total volume which can be used by this project
volumetotalThe total volume being used by this project
vpcavailableThe total number of VPCs available to be created for this project
vpclimitThe total number of VPCs the project can own
vpctotalThe total number of VPCs owned by project
tags(*)The list of resource tags associated with Instance
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateProjectInvitation.html b/static/api/apidocs-4.23/apis/updateProjectInvitation.html new file mode 100644 index 0000000000..7bfe4325cd --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateProjectInvitation.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateProjectInvitation

+

Accepts or declines project invitation

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
projectidID of the project to jointrue
acceptIf true, accept the invitation, decline if false. True by defaultfalse
accountAccount that is joining the projectfalse
tokenList invitations for specified account; this parameter has to be specified with domainIdfalse
useridUser UUID, required for adding account from external provisioning systemfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateProjectRole.html b/static/api/apidocs-4.23/apis/updateProjectRole.html new file mode 100644 index 0000000000..4465156b4b --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateProjectRole.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateProjectRole

+

Creates a Project role

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the Project roletrue
projectidID of project where role is being createdtrue
descriptionThe description of the Project rolefalse
nameCreates a project role with this unique namefalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
projectidThe ID of the project
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateProjectRolePermission.html b/static/api/apidocs-4.23/apis/updateProjectRolePermission.html new file mode 100644 index 0000000000..9a1d8bbb91 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateProjectRolePermission.html @@ -0,0 +1,99 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateProjectRolePermission

+

Updates a project role permission and/or order

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
projectidID of project where project role permission is to be updatedtrue
projectroleidID of the project roletrue
permissionRule permission, can be: allow or denyfalse
projectrolepermissionidProject Role permission rule idfalse
ruleorderID of the parent role permission, use 0 to move this rule at the top of the listfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateQuarantinedIp.html b/static/api/apidocs-4.23/apis/updateQuarantinedIp.html new file mode 100644 index 0000000000..352a0e2216 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateQuarantinedIp.html @@ -0,0 +1,114 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateQuarantinedIp

+

Updates the quarantine end date for the given public IP address.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enddateThe date when the quarantine will no longer be active.true
idThe ID of the public IP address in active quarantine.false
ipaddressThe public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the quarantine process.
createdWhen the quarantine was created.
enddateEnd date for the quarantine.
ipaddressThe public IP address in quarantine.
previousowneridAccount ID of the previous public IP address owner.
previousownernameAccount name of the previous public IP address owner.
removalreasonThe reason for removing the IP from quarantine prematurely.
removedWhen the quarantine was removed.
removeraccountidID of the account that removed the IP from quarantine.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateRegion.html b/static/api/apidocs-4.23/apis/updateRegion.html new file mode 100644 index 0000000000..1c145e4b7a --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateRegion.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateRegion

+

Updates a region

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idId of region to updatetrue
endpointUpdates region with this end pointfalse
nameUpdates region with this namefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the region
endpointThe end point of the region
gslbserviceenabledTrue if GSLB service is enabled in the region, false otherwise
nameThe name of the region
portableipserviceenabledTrue if security groups support is enabled, false otherwise
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateRegisteredExtension.html b/static/api/apidocs-4.23/apis/updateRegisteredExtension.html new file mode 100644 index 0000000000..dd279f2eca --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateRegisteredExtension.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateRegisteredExtension

+

Update details for an extension registered with a resource

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
extensionidID of the extensiontrue
resourceidID of the resource where the extension is registeredtrue
resourcetypeType of the resourcetrue
cleanupdetailsOptional boolean field, which indicates if details should be cleaned up or not (If set to true, details removed for this registration, details field ignored; if false or not set, details can be updated through details map)false
detailsDetails in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvaluefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the extension
createdCreation timestamp of the extension
descriptionDescription of the extension
detailsThe details of the extension
isuserdefinedTrue if the extension is added by admin
nameName of the extension
pathThe path of the entry point fo the extension
pathreadyTrue if the extension path is in ready state across management servers
removedRemoval timestamp of the extension, if applicable
reservedresourcedetailsResource detail names as comma separated string that should be reserved and not visible to end users
stateThe state of the extension
typeType of the extension
resources(*)List of resources to which extension is registered to
idID of the resource associated with the extension
createdCreation timestamp of the mapping
detailsthe details of the resource map
nameName of the resource associated with this mapping
typeType of the resource
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateRemoteAccessVpn.html b/static/api/apidocs-4.23/apis/updateRemoteAccessVpn.html new file mode 100644 index 0000000000..857e370180 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateRemoteAccessVpn.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateRemoteAccessVpn

+

Updates remote access VPN

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the remote access VPNtrue
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayAn optional field, whether to the display the VPN to the end User or notfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the remote access VPN
accountThe Account of the remote access VPN
domainThe domain name of the Account of the remote access VPN
domainidThe domain ID of the Account of the remote access VPN
domainpathPath of the domain to which the remote access VPN belongs
fordisplayIs VPN for display to the regular user
iprangeThe range of IPs to allocate to the clients
presharedkeyThe IPSec preshared key
projectThe project name of the VPN
projectidThe project ID of the VPN
publicipThe public IP address of the VPN server
publicipidThe public IP address of the VPN server
stateThe state of the rule
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateResourceCount.html b/static/api/apidocs-4.23/apis/updateResourceCount.html new file mode 100644 index 0000000000..fd9c6909ad --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateResourceCount.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateResourceCount

+

Recalculate and update resource count for an account or domain. This also executes some cleanup tasks before calculating resource counts.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
domainidIf 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
accountUpdate resource count for a specified account. Must be used with the domainId parameter.false
projectidUpdate resource limits for projectfalse
resourcetypeType 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
tagTag for the resource typefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account for which resource count's are updated
domainThe domain name for which resource count's are updated
domainidThe domain ID for which resource count's are updated
domainpathPath of the domain to which the resource counts are updated
projectThe project name for which resource count's are updated
projectidThe project ID for which resource count's are updated
resourcecountThe resource count
resourcetypeResource 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.
resourcetypenameResource type name. Values include user_vm, public_ip, volume, Snapshot, Template, project, Network, VPC, CPU, memory, primary_storage, secondary_storage.
tagTag for the resource
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateResourceLimit.html b/static/api/apidocs-4.23/apis/updateResourceLimit.html new file mode 100644 index 0000000000..dcecf9fd6b --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateResourceLimit.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateResourceLimit

+

Updates resource limits for an account or domain.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
resourcetypeType 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
accountUpdate resource for a specified account. Must be used with the domainId parameter.false
domainidUpdate 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
max Maximum resource limit.false
projectidUpdate resource limits for projectfalse
tagTag for the resource typefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountThe Account of the resource limit
domainThe domain name of the resource limit
domainidThe domain ID of the resource limit
domainpathPath of the domain to which the resource limit belongs
maxThe maximum number of the resource. A -1 means the resource currently has no limit.
projectThe project name of the resource limit
projectidThe project ID of the resource limit
resourcetypeResource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.
resourcetypenameResource type name. Values include user_vm, public_ip, volume, Snapshot, Template, project, Network, VPC, CPU, memory, primary_storage, secondary_storage.
tagThe tag for the resource limit
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateResourceSchedule.html b/static/api/apidocs-4.23/apis/updateResourceSchedule.html new file mode 100644 index 0000000000..66250c2f20 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateResourceSchedule.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateResourceSchedule

+

Update Resource Schedule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the schedule to be updatedtrue
descriptionDescription of the schedulefalse
detailsMap of (key/value pairs) details for the schedule.false
enabledEnable or disable the schedule.false
enddateEnd date after which the schedule becomes inactive.false
scheduleSchedule for action on resource in cron format.false
startdateStart date from which the schedule becomes active.false
timezoneSpecifies a timezone for this command.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of resource schedule
actionAction
createdDate when the schedule was created
descriptionDescription of resource schedule
detailsSchedule details
enabledResource schedule is enabled
enddateDate after which the schedule becomes inactive
resourceidID of the resource
resourcetypeType of the resource
scheduleCron formatted resource schedule
startdateDate from which the schedule is active
timezoneTimezone of the schedule
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateRole.html b/static/api/apidocs-4.23/apis/updateRole.html new file mode 100644 index 0000000000..cb679ff797 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateRole.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateRole

+

Updates a role

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the roletrue
descriptionThe description of the rolefalse
descriptionThe description of the rolefalse
ispublicIndicates whether the role will be visible to all users (public) or only to root admins (private).false
nameCreates a role with this unique namefalse
typeThe type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, Userfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
isdefaultTrue if role is default, false otherwise
statethe state of the role
typeThe type of the role
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateRolePermission.html b/static/api/apidocs-4.23/apis/updateRolePermission.html new file mode 100644 index 0000000000..eaa345c1ab --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateRolePermission.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateRolePermission

+

Updates a role permission order

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
roleidID of the roletrue
permissionRule permission, can be: allow or denyfalse
ruleidRole permission rule idfalse
ruleorderThe parent role permission UUID, use 0 to move this rule at the top of the listfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateRoutingFirewallRule.html b/static/api/apidocs-4.23/apis/updateRoutingFirewallRule.html new file mode 100644 index 0000000000..18c7373f38 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateRoutingFirewallRule.html @@ -0,0 +1,174 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateRoutingFirewallRule

+

Updates Routing firewall rule with specified ID

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the Routing firewall ruletrue
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayan optional field, whether to the display the Routing firewall rule to the end user or notfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the port forwarding rule
cidrlistThe CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
fordisplayIs firewall for display to the regular user
ipaddressThe public IP address for the port forwarding rule
ipaddressidThe public IP address id for the port forwarding rule
networkidThe ID of the guest Network the port forwarding rule belongs to
networknameThe Name of the guest Network the port forwarding rule belongs to
privateendportThe ending port of port forwarding rule's private port range
privateportThe starting port of port forwarding rule's private port range
protocolThe protocol of the port forwarding rule
publicendportThe ending port of port forwarding rule's private port range
publicportThe starting port of port forwarding rule's public port range
stateThe state of the rule
virtualmachinedisplaynameThe Instance display name for the port forwarding rule
virtualmachineidThe Instance ID for the port forwarding rule
virtualmachinenameThe Instance name for the port forwarding rule
vmguestipThe Instance IP address for the port forwarding rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateSecondaryStorageSelector.html b/static/api/apidocs-4.23/apis/updateSecondaryStorageSelector.html new file mode 100644 index 0000000000..d9d8a9da11 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateSecondaryStorageSelector.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateSecondaryStorageSelector

+

Updates an existing secondary storage selector.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe unique identifier of the secondary storage selector.true
heuristicruleThe 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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the heuristic.
createdWhen the heuristic was created.
descriptionDescription of the heuristic.
heuristicruleThe heuristic rule, in JavaScript language, used to select a secondary storage to be directed.
nameName of the heuristic.
removedWhen the heuristic was removed.
typeThe resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, BACKUP, TEMPLATE and VOLUME.
zoneidThe zone which the heuristic is valid upon.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateSecurityGroup.html b/static/api/apidocs-4.23/apis/updateSecurityGroup.html new file mode 100644 index 0000000000..58dc6a3489 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateSecurityGroup.html @@ -0,0 +1,294 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateSecurityGroup

+

Updates a security group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the security group.true
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
nameThe new name of the security group.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateServiceOffering.html b/static/api/apidocs-4.23/apis/updateServiceOffering.html new file mode 100644 index 0000000000..dd3e6af6b8 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateServiceOffering.html @@ -0,0 +1,306 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateServiceOffering

+

Updates a service offering.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the service offering to be updatedtrue
cleanupexternaldetailsOptional boolean field, which indicates if external details should be cleaned up or not (If set to true, external details removed for this offering, externaldetails field ignored; if false or not set, no action)false
displaytextThe display text of the service offering to be updatedfalse
domainidThe ID of the containing domain(s) as comma separated string, public for public offeringsfalse
externaldetailsDetails in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvaluefalse
hosttagsThe host tag for this service offering.false
nameThe name of the service offering to be updatedfalse
purgeresourcesWhether to cleanup VM and its associated resource upon expungefalse
sortkeySort key of the service offering, integerfalse
statestate of the service offeringfalse
storagetagsComma-separated list of tags for the service offering, tags should match with existing storage pool tagsfalse
zoneidThe ID of the containing zone(s) as comma separated string, all for all zones offeringsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the service offering
cacheModeThe cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default
cpunumberThe number of CPU
cpuspeedThe clock rate CPU speed in Mhz
createdThe date this service offering was created
defaultuseIs this a default System VM offering
deploymentplannerDeployment strategy used to deploy Instance.
diskBytesReadRateBytes read rate of the service offering
diskBytesReadRateMaxBurst bytes read rate of the disk offering
diskBytesReadRateMaxLengthLength (in seconds) of the burst
diskBytesWriteRateBytes write rate of the service offering
diskBytesWriteRateMaxBurst bytes write rate of the disk offering
diskBytesWriteRateMaxLengthLength (in seconds) of the burst
diskIopsReadRateI/O requests read rate of the service offering
diskIopsReadRateMaxBurst io requests read rate of the disk offering
diskIopsReadRateMaxLengthLength (in second) of the burst
diskIopsWriteRateI/O requests write rate of the service offering
diskIopsWriteRateMaxBurst I/O requests write rate of the disk offering
diskIopsWriteRateMaxLengthLength (in seconds) of the burst
diskofferingdisplaytextThe display text of the disk offering
diskofferingidThe ID of the disk offering to which service offering is linked
diskofferingnameName of the disk offering
diskofferingstrictnessTrue/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 Instance is deployed and change disk offering is not allowed for the ROOT disk after the Instance is deployed
displaytextAn alternate display text of the service offering.
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
dynamicscalingenabledTrue if Instance needs to be dynamically scalable of CPU or memory
encryptrootTrue if Instance root disk will be encrypted on storage
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs to attach
gpudisplaywhether GPU device is used for display or not
hosttagsThe host tag for the service offering
hypervisorsnapshotreserveHypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
iscustomizedIs true if the offering is customized
iscustomizediopsTrue if disk offering uses custom IOPS, false otherwise
issystemIs this a System VM offering
isvolatileTrue if the Instance needs to be volatile, i.e., on every reboot of Instance from API root disk is discarded and creates a new root disk
leasedurationInstance lease duration (in days) for service offering
leaseexpiryactionAction to be taken once lease is over
limitcpuuseRestrict the CPU usage to committed service offering
maxheadsthe maximum number of display heads
maxiopsThe max IOPS of the disk offering
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory in MB
miniopsThe min IOPS of the disk offering
nameThe name of the service offering
networkrateData transfer rate in megabits per second allowed.
offerhaThe HA support in the service offering
provisioningtypeProvisioning type used to create volumes. Valid values are thin, sparse, fat.
purgeresourcesWhether to cleanup VM and its associated resource upon expunge
rootdisksizeRoot disk size in GB
serviceofferingdetailsAdditional key/value details tied with this service offering
stateState of the service offering
storagetagsThe tags for the service offering
storagetypeThe storage type for this service offering
systemvmtypeIs this a the System VM type for System VM offering
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vspherestoragepolicyThe vsphere storage policy tagged to the service offering in case of VMware
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateSharedFileSystem.html b/static/api/apidocs-4.23/apis/updateSharedFileSystem.html new file mode 100644 index 0000000000..1cc968f0ee --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateSharedFileSystem.html @@ -0,0 +1,306 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateSharedFileSystem

+

Update a Shared FileSystem

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the shared filesystemtrue
descriptionthe description for the shared filesystem.false
namethe name of the shared filesystem.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the shared filesystem
accountthe account associated with the shared filesystem
descriptiondescription of the shared filesystem
diskioreadthe read (IO) of disk on the shared filesystem
diskiowritethe write (IO) of disk on the shared filesystem
diskkbsreadthe shared filesystem's disk read in KiB
diskkbswritethe shared filesystem's disk write in KiB
diskofferingdisplaytextdisk offering display text for the shared filesystem
diskofferingiddisk offering ID for the shared filesystem
diskofferingnamedisk offering for the shared filesystem
domainthe domain associated with the shared filesystem
domainidthe ID of the domain associated with the shared filesystem
domainpathpath of the domain to which the shared filesystem
filesystemthe filesystem format
iscustomdiskofferingdisk offering for the shared filesystem has custom size
namename of the shared filesystem
networkidNetwork ID of the shared filesystem
networknameNetwork name of the shared filesystem
pathpath to mount the shared filesystem
physicalsizethe bytes actually consumed on disk
projectthe project name of the shared filesystem
projectidthe project ID of the shared filesystem
providerthe shared filesystem provider
provisioningtypeprovisioning type used in the shared filesystem
serviceofferingidservice offering ID for the shared filesystem
serviceofferingnameservice offering for the shared filesystem
sizesize of the shared filesystem
sizegbsize of the shared filesystem in GiB
statethe state of the shared filesystem
storagename of the storage pool hosting the data volume
storageidID of the storage pool hosting the data volume
utilizationthe disk utilization
virtualmachineidID of the storage fs vm
virtualsizethe bytes allocated
vmstateID of the storage fs vm
volumeidID of the storage fs data volume
volumenamename of the storage fs data volume
zoneidID of the availability zone
zonenameName of the availability zone
nic(*)the list of nics associated with the shared filesystem
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateSiocInfo.html b/static/api/apidocs-4.23/apis/updateSiocInfo.html new file mode 100644 index 0000000000..4b3c4f8c1f --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateSiocInfo.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateSiocInfo

+

Update SIOC info

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
iopsnotifythresholdNotify if IOPS above this valuetrue
limitiopspergbLimit IOPS per GBtrue
sharespergbShares per GBtrue
storageidStorage Pool IDtrue
zoneidZone IDtrue
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
msgThe return message from the operation ('Success' if successful)
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateSnapshotPolicy.html b/static/api/apidocs-4.23/apis/updateSnapshotPolicy.html new file mode 100644 index 0000000000..a79d893a6c --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateSnapshotPolicy.html @@ -0,0 +1,117 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateSnapshotPolicy

+

Updates the Snapshot policy.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayAn optional field, whether to the display the Snapshot policy to the end user or not.false
idThe ID of the Snapshot policyfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Snapshot policy
fordisplayIs this policy for display to the regular user
intervaltypeThe interval type of the Snapshot policy
maxsnapsMaximum number of Snapshots retained
scheduleTime the Snapshot is scheduled to be taken.
storageThe list of pools in which snapshot backup is scheduled
timezoneThe time zone of the Snapshot policy
volumeidThe ID of the disk volume
volumenamethe name of the disk volume
zoneThe list of zones in which snapshot backup is scheduled
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateStorageCapabilities.html b/static/api/apidocs-4.23/apis/updateStorageCapabilities.html new file mode 100644 index 0000000000..d93ffdffb0 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateStorageCapabilities.html @@ -0,0 +1,186 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateStorageCapabilities

+

Syncs capabilities of storage pools

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idStorage pool idtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the storage pool
allocatediopsTotal min IOPS currently in use by volumes
capacitybytesbytes CloudStack can provision from this storage pool
capacityiopsIOPS CloudStack can provision from this storage pool
clusteridThe ID of the cluster for the storage pool
clusternameThe name of the cluster for the storage pool
createdThe date and time the storage pool was created
detailsthe storage pool details
disksizeallocatedThe pool's currently allocated disk size
disksizetotalThe total disk size of the storage pool
disksizeusedThe pool's currently used disk size
hypervisorThe hypervisor type of the storage pool
ipaddressThe IP address of the storage pool
istagaruleWhether the informed tag is a JS interpretable rule or not.
managedwhether this pool is managed or not
nameThe name of the storage pool
nfsmountoptsthe nfs mount options for the storage pool
overprovisionfactorThe overprovisionfactor for the storage pool
pathThe storage pool path
podidThe Pod ID of the storage pool
podnameThe Pod name of the storage pool
providerStorage provider for this pool
scopeThe scope of the storage pool
stateThe state of the storage pool
storageaccessgroupsthe storage access groups for the storage pool
storagecapabilitiesThe storage pool capabilities
storagecustomstatsthe storage pool custom stats
suitableformigrationTrue if this pool is suitable to migrate a volume, false otherwise
tagsThe tags for the storage pool
typeThe storage pool type
usediopstotal IOPS currently in use
zoneidThe Zone ID of the storage pool
zonenameThe Zone name of the storage pool
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateStorageNetworkIpRange.html b/static/api/apidocs-4.23/apis/updateStorageNetworkIpRange.html new file mode 100644 index 0000000000..ff8d8042a2 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateStorageNetworkIpRange.html @@ -0,0 +1,120 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateStorageNetworkIpRange

+

Update a Storage network IP range, only allowed when no IPs in this range have been allocated.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idUUID of storage network ip rangetrue
endipThe ending IP addressfalse
netmaskThe netmask for storage networkfalse
startipThe beginning IP addressfalse
vlanOptional. the vlan the ip range sits onfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe UUID of storage Network IP range.
endipThe end IP of the storage Network IP range
gatewayThe gateway of the storage Network IP range
netmaskThe netmask of the storage Network IP range
networkidThe Network UUID of storage Network IP range
podidThe Pod UUID for the storage Network IP range
startipThe start IP of the storage Network IP range
vlanThe ID or VID of the VLAN.
zoneidThe Zone UUID of the storage Network IP range
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateStoragePool.html b/static/api/apidocs-4.23/apis/updateStoragePool.html new file mode 100644 index 0000000000..265c6f6078 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateStoragePool.html @@ -0,0 +1,210 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateStoragePool

+

Updates a storage pool.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe Id of the storage pooltrue
capacitybytesBytes CloudStack can provision from this storage poolfalse
capacityiopsIOPS CloudStack can provision from this storage poolfalse
detailsthe details for the storage poolfalse
enabledFalse to disable the pool for allocation of new volumes, true to enable it back.false
istagaruleWhether the informed tag is a JS interpretable rule or not.false
nameChange the name of the storage poolfalse
tagsComma-separated list of tags for the storage poolfalse
urlthe URL of the storage poolfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the storage pool
allocatediopsTotal min IOPS currently in use by volumes
capacitybytesbytes CloudStack can provision from this storage pool
capacityiopsIOPS CloudStack can provision from this storage pool
clusteridThe ID of the cluster for the storage pool
clusternameThe name of the cluster for the storage pool
createdThe date and time the storage pool was created
detailsthe storage pool details
disksizeallocatedThe pool's currently allocated disk size
disksizetotalThe total disk size of the storage pool
disksizeusedThe pool's currently used disk size
hypervisorThe hypervisor type of the storage pool
ipaddressThe IP address of the storage pool
istagaruleWhether the informed tag is a JS interpretable rule or not.
managedwhether this pool is managed or not
nameThe name of the storage pool
nfsmountoptsthe nfs mount options for the storage pool
overprovisionfactorThe overprovisionfactor for the storage pool
pathThe storage pool path
podidThe Pod ID of the storage pool
podnameThe Pod name of the storage pool
providerStorage provider for this pool
scopeThe scope of the storage pool
stateThe state of the storage pool
storageaccessgroupsthe storage access groups for the storage pool
storagecapabilitiesThe storage pool capabilities
storagecustomstatsthe storage pool custom stats
suitableformigrationTrue if this pool is suitable to migrate a volume, false otherwise
tagsThe tags for the storage pool
typeThe storage pool type
usediopstotal IOPS currently in use
zoneidThe Zone ID of the storage pool
zonenameThe Zone name of the storage pool
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateTemplate.html b/static/api/apidocs-4.23/apis/updateTemplate.html new file mode 100644 index 0000000000..e366541a6c --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateTemplate.html @@ -0,0 +1,306 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateTemplate

+

Updates attributes of a Template.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the image filetrue
archthe CPU arch of the template/ISO. Valid options are: x86_64, aarch64, s390xfalse
bootableTrue if image is bootable, false otherwise; available only for updateIso APIfalse
cleanupdetailsOptional 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
detailsDetails in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61false
displaytextThe display text of the imagefalse
forceupdateostypeForce OS type update. Warning: Updating OS type will update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.false
forcksindicates that the template can be used for deployment of CKS clustersfalse
formatThe format for the imagefalse
isdynamicallyscalableTrue if Template/ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memoryfalse
isroutingTrue if the Template type is routing i.e., if Template is used to deploy routerfalse
nameThe name of the image filefalse
ostypeidThe ID of the OS type that best represents the OS of this image.false
passwordenabledTrue if the image supports the password reset feature; default is falsefalse
requireshvmTrue if the Template requires HVM, false otherwise; available only for updateTemplate APIfalse
sortkeySort key of the Template, integerfalse
sshkeyenabledTrue if the Template supports the SSHkey upload feature; default is falsefalse
templatetagthe tag for this template.false
templatetypeThe type of the Template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe Account name to which the Template belongs
accountidThe Account id to which the Template belongs
archCPU Arch of the template
bitsThe processor bit size
bootableTrue if the ISO is bootable, false otherwise
checksumChecksum of the Template
childtemplatesIf root disk Template, then IDs of the datas disk Templates this Template owns
createdThe date this Template was created
crossZonesTrue if the Template is managed across all Zones, false otherwise
deployasisVMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is Template
detailsAdditional key/value details tied with Template
directdownloadKVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextThe Template display text
domainThe name of the domain to which the Template belongs
domainidThe ID of the domain to which the Template belongs
domainpathPath of the Domain the template belongs to
downloaddetailsLists the download progress of a Template across all secondary storages
extensionidThe ID of extension linked to this template
extensionnameThe name of extension linked to this template
forcksIf true it indicates that the template can be used for CKS cluster deployments
formatThe format of the Template.
hostidThe ID of the secondary storage host for the Template
hostnameThe name of the secondary storage host for the Template
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
isextractableTrue if the Template is extractable, false otherwise
isfeaturedTrue if this Template is a featured Template, false otherwise
ispublicTrue if this Template is a public Template, false otherwise
isreadyTrue if the Template is ready to be deployed from, false otherwise.
nameThe Template name
ostypeidThe ID of the OS type for this Template.
ostypenameThe name of the OS type for this Template.
parenttemplateidIf Datadisk Template, then id of the root disk Template this Template belongs to
passwordenabledTrue if the reset password feature is enabled, false otherwise
physicalsizeThe physical size of the Template
projectThe project name of the Template
projectidThe project ID of the Template
removedThe date this Template was removed
requireshvmTrue if Template requires HVM enabled, false otherwise
sizeThe size of the Template
sourcetemplateidThe Template ID of the parent Template if present
sshkeyenabledTrue if Template is sshkey enabled, false otherwise
statusThe status of the Template
templatetagThe tag of this Template
templatetypeThe type of the Template
urlThe URL which the Template/ISO is registered from
userdataidThe id of userdata linked to this Template
userdatanameThe name of userdata linked to this Template
userdataparamsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
zoneidThe ID of the zone for this Template
zonenameThe name of the zone for this Template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateTemplatePermissions.html b/static/api/apidocs-4.23/apis/updateTemplatePermissions.html new file mode 100644 index 0000000000..d55f12797f --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateTemplatePermissions.html @@ -0,0 +1,105 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

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.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe Template IDtrue
accountsA comma delimited list of Accounts within caller's domain. If specified, "op" parameter has to be passed in.false
isextractableTrue if the Template/ISO is extractable, false otherwise. Can be set only by root adminfalse
isfeaturedTrue for featured Template/ISO, false otherwisefalse
ispublicTrue for public Template/ISO, false for private Templates/ISOsfalse
opPermission operator (add, remove, reset)false
projectidsA comma delimited list of projects. If specified, "op" parameter has to be passed in.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateTrafficType.html b/static/api/apidocs-4.23/apis/updateTrafficType.html new file mode 100644 index 0000000000..8a59322adc --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateTrafficType.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateTrafficType

+

Updates traffic type of a physical network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idTraffic type IDtrue
hypervnetworklabelThe network name label of the physical device dedicated to this traffic on a Hyperv hostfalse
kvmnetworklabelThe network name label of the physical device dedicated to this traffic on a KVM hostfalse
ovm3networklabelThe network name of the physical device dedicated to this traffic on an OVM3 hostfalse
vmwarenetworklabelThe network name label of the physical device dedicated to this traffic on a VMware hostfalse
xennetworklabelThe network name label of the physical device dedicated to this traffic on a XenServer hostfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the Network provider
hypervnetworklabelThe Network name label of the physical device dedicated to this traffic on a HyperV host
isolationmethodsisolation methods for the physical network traffic
kvmnetworklabelThe Network name label of the physical device dedicated to this traffic on a KVM host
ovm3networklabelThe Network name of the physical device dedicated to this traffic on an OVM3 host
physicalnetworkidThe physical Network this belongs to
traffictypeThe trafficType to be added to the physical Network
vlanThe VLAN id to be used for Management traffic by VMware host
vmwarenetworklabelThe Network name label of the physical device dedicated to this traffic on a VMware host
xennetworklabelThe Network name label of the physical device dedicated to this traffic on a XenServer host
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateTungstenFabricLBHealthMonitor.html b/static/api/apidocs-4.23/apis/updateTungstenFabricLBHealthMonitor.html new file mode 100644 index 0000000000..3181b0aadc --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateTungstenFabricLBHealthMonitor.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateTungstenFabricLBHealthMonitor

+

Update Tungsten-Fabric loadbalancer health monitor

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
intervalLoadbalancer health monitor intervaltrue
lbruleidThe ID of LB ruletrue
retryLoadbalancer health monitor retrytrue
timeoutLoadbalancer health monitor timeouttrue
typeLoadbalancer health monitor typetrue
expectedcodeLoadbalancer health monitor expected codefalse
httpmethodtypeLoadbalancer health monitor HTTP methodfalse
urlpathLoadbalancer health monitor URL pathfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe health monitor ID
expectedcodeThe health monitor expected code
httpmethodThe health monitor HTTP method
intervalThe health monitor interval
lbruleidThe LB rule ID
retryThe health monitor retry
timeoutThe health monitor timeout
typeThe health monitor type
urlpathThe health monitor URL path
uuidThe health monitor UUID
zoneidTungsten-Fabric provider zone ID
zonenameTungsten-Fabric provider zone name
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateUser.html b/static/api/apidocs-4.23/apis/updateUser.html new file mode 100644 index 0000000000..9f2aea8fa4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateUser.html @@ -0,0 +1,192 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateUser

+

Updates a user account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idUser uuidtrue
apikeyaccessDetermines if Api key access for this user is enabled, disabled or inherits the value from its parent, the owning accountfalse
currentpasswordCurrent password that was being used by the user. You must inform the current password when updating the password.false
emailEmailfalse
firstnameFirst namefalse
lastnameLast namefalse
mandate2faProvide 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 2FAfalse
passwordClear 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.portfalse
passwordchangerequiredProvide true to mandate the User to reset password on next login.false
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.false
userapikeyUpdates the latest API key of the user. Must be specified with usersecretkeyfalse
usernameUnique usernamefalse
usersecretkeyUpdates the latest secret key of the user. Must be specified with userapikey.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe user ID
accountThe Account name of the user
accountidThe Account ID of the user
accounttypeThe Account type of the user
apikeyThe API key of the user
apikeyaccessWhether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
createdThe date and time the user Account was created
domainThe domain name of the user
domainidThe domain ID of the user
emailThe user email address
firstnameThe user firstname
iconBase64 string representation of the resource icon
is2faenabledTrue if user has two factor authentication enabled
is2famandatedTrue if user has two factor authentication is mandated
iscallerchilddomainThe boolean value representing if the updating target is in caller's child domain
isdefaultTrue if user is default, false otherwise
lastnameThe user lastname
roleidThe ID of the role
rolenameThe name of the role
roletypeThe type of the role
secretkeyThe secret key of the user
stateThe user state
timezoneThe timezone user was created in
usernameThe user name
usersourceThe source type of the user in lowercase, such as native, ldap, saml2
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateVMAffinityGroup.html b/static/api/apidocs-4.23/apis/updateVMAffinityGroup.html new file mode 100644 index 0000000000..37b454d86d --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateVMAffinityGroup.html @@ -0,0 +1,702 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateVMAffinityGroup

+

Updates the affinity/anti-affinity group associations of an Instance. The Instance has to be stopped and restarted for the new properties to take effect.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instancetrue
affinitygroupidsComma separated list of affinity groups id that are going to be applied to the Instance. Should be passed only when Instance is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameterfalse
affinitygroupnamesComma separated list of affinity groups names that are going to be applied to the Instance. Should be passed only when Instance is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameterfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateVMSchedule.html b/static/api/apidocs-4.23/apis/updateVMSchedule.html new file mode 100644 index 0000000000..d207e5b009 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateVMSchedule.html @@ -0,0 +1,129 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateVMSchedule

+

Update Instance Schedule.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of Instance scheduletrue
descriptionName of the schedulefalse
enabledEnable Instance schedulefalse
enddateEnd date after which the schedule becomes inactive(Format "yyyy-MM-dd hh:mm:ss")false
scheduleSchedule for action on Instance in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'false
startdateStart date from which the schedule becomes active(Format "yyyy-MM-dd hh:mm:ss")false
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of Instance schedule
actionAction
createdDate when the schedule was created
descriptionDescription of Instance schedule
enabledVM schedule is enabled
enddateDate after which the schedule becomes inactive
scheduleCron formatted Instance schedule
startdateDate from which the schedule is active
timezoneTimezone of the schedule
virtualmachineidID of Instance
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateVPC.html b/static/api/apidocs-4.23/apis/updateVPC.html new file mode 100644 index 0000000000..a2847089e3 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateVPC.html @@ -0,0 +1,291 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateVPC

+

Updates a VPC

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the VPCtrue
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
displaytextThe display text of the VPCfalse
fordisplayOptional field, should we display the VPC to the end User or notfalse
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.false
nameThe name of the VPCfalse
publicmtuMTU to be configured on the Network VR's public facing interfacesfalse
sourcenatipaddressIPV4 address to be assigned to the public interface of the Network router. This address must already be acquired for this VPCfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the VPC
accountThe owner of the VPC
asnumberAS NUMBER
asnumberidUUID of AS NUMBER
bgppeersThe BGP peers for the VPC
cidrThe CIDR the VPC
createdThe date this VPC was created
displaytextAn alternate display text of the VPC.
distributedvpcrouterDoes VPC use distributed router for one hop forwarding and host based Network ACL's
dns1The first IPv4 DNS for the VPC
dns2The second IPv4 DNS for the VPC
domainThe domain name of the owner
domainidThe domain ID of the VPC owner
domainpathThe domain path of the owner
fordisplayIs VPC for display to the regular user
iconBase64 string representation of the resource icon
ip4routesThe routes for the VPC to ease adding route in upstream router
ip4routingThe IPv4 routing mode of VPC
ip6dns1The first IPv6 DNS for the VPC
ip6dns2The second IPv6 DNS for the VPC
ip6routesThe routes for the Network to ease adding route in upstream router
keepmacaddressonpublicnicIndicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have a new MAC address.
nameThe name of the VPC
networkThe list of Networks belonging to the VPC
networkdomainThe Network domain of the VPC
projectThe project name of the VPC
projectidThe project ID of the VPC
publicmtuMTU configured on the public interfaces of the VPC VR
redundantvpcrouterIf this VPC has redundant router
regionlevelvpcTrue if VPC is region level
restartrequiredTrue VPC requires restart
stateState of the VPC. Can be Inactive/Enabled
vpcofferingconservemodetrue if VPC offering is ip conserve mode enabled
vpcofferingidVPC offering ID the VPC is created from
vpcofferingnameVPC offering name the VPC is created from
zoneidZone ID of the VPC
zonenameThe name of the zone the VPC belongs to
service(*)The list of supported services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
tags(*)The list of resource tags associated with the project
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateVPCOffering.html b/static/api/apidocs-4.23/apis/updateVPCOffering.html new file mode 100644 index 0000000000..286bde890a --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateVPCOffering.html @@ -0,0 +1,195 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateVPCOffering

+

Updates VPC offering

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the VPC offeringtrue
displaytextThe display text of the VPC offeringfalse
domainidThe ID of the containing domain(s) as comma separated string, public for public offeringsfalse
nameThe name of the VPC offeringfalse
sortkeySort key of the VPC offering, integerfalse
stateUpdate state for the VPC offering; supported states - Enabled/Disabledfalse
zoneidThe ID of the containing zone(s) as comma separated string, all for all zones offeringsfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the VPC offering
conservemodeTrue if the VPC offering is IP conserve mode enabled, allowing public IP services to be used across multiple VPC tiers.
createdThe date this VPC offering was created
displaytextAn alternate display text of the VPC offering.
distributedvpcrouterIndicates if the VPC offering supports distributed router for one-hop forwarding
domainThe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidThe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
fornsxTrue if VPC offering can be used by NSX networks only
internetprotocolThe internet protocol of the VPC offering
isdefaultTrue if VPC offering is default, false otherwise
nameThe name of the VPC offering
networkmodeMode in which the network will operate. The valid values are NATTED and ROUTED
routingmodeThe routing mode for the network offering, supported types are Static or Dynamic.
specifyasnumberTrue if network offering supports choosing AS numbers
stateState of the VPC offering. Can be Disabled/Enabled
supportsregionLevelvpcIndicated if the offering can support region level VPC
zoneThe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidThe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
service(*)The list of supported services
nameThe service name
capability(*)The list of capabilities
canchooseservicecapabilityCan this service capability value can be choosable while creatine Network offerings
nameThe capability name
valueThe capability value
provider(*)The service provider name
idUUID of the Network provider
canenableindividualserviceTrue if individual services can be enabled/disabled
destinationphysicalnetworkidThe destination physical Network
nameThe provider name
physicalnetworkidThe physical Network this belongs to
servicelistServices for this provider
stateState of the Network provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateVgpuProfile.html b/static/api/apidocs-4.23/apis/updateVgpuProfile.html new file mode 100644 index 0000000000..effa87dde4 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateVgpuProfile.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateVgpuProfile

+

Updates a vGPU profile in the system

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the vGPU profiletrue
descriptionthe description of the vGPU profilefalse
maxheadsthe maximum number of display headsfalse
maxresolutionxthe maximum X resolutionfalse
maxresolutionythe maximum Y resolutionfalse
maxvgpuperphysicalgputhe maximum number of vGPUs per physical GPUfalse
namethe name of the vGPU profilefalse
videoramthe video RAM size in MBfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
descriptionthe description of the vGPU profile
gpucardidthe ID of the GPU card associated with this vGPU profile
gpucardnamethe name of the vGPU profile
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
maxvgpuperphysicalgputhe maximum number of vGPUs per physical GPU
videoramthe video RAM size in MB
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateVirtualMachine.html b/static/api/apidocs-4.23/apis/updateVirtualMachine.html new file mode 100644 index 0000000000..5dd0199709 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateVirtualMachine.html @@ -0,0 +1,762 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateVirtualMachine

+

Updates properties of an Instance. The Instance has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the Instance is stopped. Therefore, stop the Instance manually before issuing this call.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Instancetrue
cleanupdetailsOptional 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
cleanupextraconfigOptional boolean field, which indicates if extraconfig for the instance should be cleaned up or not (If set to true, extraconfig removed for this instance, extraconfig field ignored; if false or not set, no action)false
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
deleteprotectionSet 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
detailsDetails in key/value pairs. 'extraconfig' is not allowed to be passed in details.false
dhcpoptionsnetworklistDHCP options which are passed to the Instance on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.comfalse
displaynameUser generated namefalse
displayvmAn optional field, whether to the display the Instance to the end User or not.false
extraconfigAn optional URL encoded string that can be passed to the Instance upon successful deploymentfalse
groupGroup of the Instancefalse
haenableTrue if high-availability is enabled for the Instance, false otherwisefalse
instancenameInstance name of the User Instancefalse
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance cpu/memory. This can be updated only when dynamic scaling is enabled on Template, service offering and the corresponding global settingfalse
leasedurationNumber of days to lease the instance from now onward. Use -1 to remove the existing leasefalse
leaseexpiryactionLease expiry action, valid values are STOP and DESTROYfalse
nameNew host name of the Instance. The Instance has to be stopped/started for this update to take affectfalse
ostypeidThe ID of the OS type that best represents this Instance.false
securitygroupidsList of security group ids to be applied on the Instance.false
securitygroupnamesComma separated list of security groups names that going to be applied to the Instance. Should be passed only when Instance is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameterfalse
userdataAn optional binary data that can be sent to the Instance 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 valuefalse
userdatadetailsUsed to specify the parameters values for the variables in userdata.false
userdataidThe ID of the userdatafalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateVlanIpRange.html b/static/api/apidocs-4.23/apis/updateVlanIpRange.html new file mode 100644 index 0000000000..f2fda855ce --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateVlanIpRange.html @@ -0,0 +1,186 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateVlanIpRange

+

Updates a VLAN IP range.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe UUID of the VLAN IP rangetrue
endipThe ending IP address in the VLAN IP rangefalse
endipv6The ending IPv6 address in the IPv6 Network rangefalse
forsystemvmsTrue if IP range is set to System VM, false if notfalse
gatewayThe gateway of the VLAN IP rangefalse
ip6cidrThe CIDR of IPv6 Network, must be at least /64false
ip6gatewayThe gateway of the IPv6 Networkfalse
netmaskThe netmask of the VLAN IP rangefalse
startipThe beginning IP address in the VLAN IP rangefalse
startipv6The beginning IPv6 address in the IPv6 Network rangefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the VLAN IP range
accountThe Account of the VLAN IP range
cidrThe CIDR of the VLAN IP range
descriptionThe description of the VLAN IP range
domainThe domain name of the VLAN IP range
domainidThe domain ID of the VLAN IP range
domainpathPath of the domain to which the VLAN IP range belongs
endipThe end IP of the VLAN IP range
endipv6The end IPv6 of the VLAN IP range
forsystemvmsIndicates whether VLAN IP range is dedicated to System VMs or not
forvirtualnetworkThe virtual Network for the VLAN IP range
gatewayThe gateway of the VLAN IP range
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
netmaskThe netmask of the VLAN IP range
networkidThe Network ID of VLAN range
physicalnetworkidThe physical Network this belongs to
podidThe Pod ID for the VLAN IP range
podnameThe Pod name for the VLAN IP range
projectThe project name of the VLAN range
projectidThe project ID of the VLAN range
providerindicates to which provider the IP range is dedicated to
startipThe start IP of the VLAN IP range
startipv6The start IPv6 of the VLAN IP range
vlanThe ID or VID of the VLAN.
zoneidThe Zone ID of the VLAN IP range
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateVmNic.html b/static/api/apidocs-4.23/apis/updateVmNic.html new file mode 100644 index 0000000000..4faf578983 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateVmNic.html @@ -0,0 +1,183 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateVmNic

+

Updates the specified VM NIC

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
nicidNIC IDtrue
enabledIf true, sets the NIC state to UP; otherwise, sets the NIC state to DOWNfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateVmNicIp.html b/static/api/apidocs-4.23/apis/updateVmNicIp.html new file mode 100644 index 0000000000..d679726124 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateVmNicIp.html @@ -0,0 +1,699 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateVmNicIp

+

Update the default IP of an Instance NIC

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
nicidThe ID of the NIC to which you want to assign private IPtrue
ipaddressSecondary IP Addressfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Instance
accountThe Account associated with the Instance
alloweddetailsList of allowed Vm details as comma separated string if VM instance settings are read from OVA.
archCPU arch of the VM
autoscalevmgroupidID of AutoScale Instance group
autoscalevmgroupnameName of AutoScale Instance group
backupofferingidThe ID of the backup offering of the Instance
backupofferingnameThe name of the backup offering of the Instance
backupproviderThe name of the backup provider of the offering attached to the Instance
bootmodeGuest Instance Boot Mode
boottypeGuest Instance Boot Type
cpunumberThe number of vCPUs this Instance is using
cpuspeedThe speed of each vCPU
cpuusedThe amount of the Instance's CPU currently used
createdThe date when this Instance was created
deleteprotectiontrue if vm has delete protection.
detailsInstance details in key/value pairs.
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingidThe ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
diskofferingnameThe name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
displayvmAn optional field whether to the display the Instance to the end user or not.
domainThe name of the domain in which the Instance exists
domainidThe ID of the domain in which the Instance exists
domainpathPath of the domain in which the virtual machine exists
forvirtualnetworkThe virtual Network for the service offering
gpucardidthe ID of the gpu card to which service offering is linked
gpucardnamethe name of the gpu card to which service offering is linked
gpucountthe count of GPUs on the virtual machine
groupThe group name of the Instance
groupidThe group ID of the Instance
guestosidOS type ID of the Instance
haenableTrue if high-availability is enabled, false otherwise
hostcontrolstateThe control state of the host for the Instance
hostidThe ID of the host for the Instance
hostnameThe name of the host for the Instance
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
instancenameInstance name of the user Instance; this parameter is returned to the ROOT admin only
ipaddressthe VM's primary IP address
isdynamicallyscalableTrue if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isomaxcountMaximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
isonameThe name of the ISO attached to the Instance
keypairsSSH key-pairs
lastupdatedThe date when this Instance was updated last time
leasedurationInstance lease duration in days
leaseexpiryactionInstance lease expiry action
leaseexpirydateInstance lease expiry date
maxheadsthe maximum number of display heads
maxresolutionxthe maximum X resolution
maxresolutionythe maximum Y resolution
memoryThe memory allocated for the Instance
memoryintfreekbsThe internal memory (KiB) that's free in Instance or zero if it can not be calculated
memorykbsThe memory used by the Instance in KiB
memorytargetkbsThe target memory in Instance (KiB)
nameThe name of the Instance
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
osdisplaynameOS name of the Instance
ostypeidOS type id of the Instance
passwordThe password (if exists) of the Instance
passwordenabledTrue if the password rest feature is enabled, false otherwise
pooltypeThe pool type of the Instance
projectThe project name of the Instance
projectidThe project ID of the Instance
publicipPublic IP address id associated with Instance via Static NAT rule
publicipidPublic IP address id associated with Instance via Static NAT rule
readonlydetailsList of read-only Instance details as comma separated string.
receivedbytesThe total number of Network traffic bytes received
rootdeviceidDevice ID of the root volume
rootdevicetypeDevice type of the root volume
sentbytesThe total number of Network traffic bytes sent
serviceofferingidThe ID of the service offering of the Instance
serviceofferingnameThe name of the service offering of the Instance
servicestateState of the Service from LB rule
stateThe state of the Instance
templatedisplaytextAn alternate display text of the Template for the Instance
templateformatThe format of the template for the virtual machine
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
templatetypeThe type of the template for the virtual machine
userdataBase64 string containing the user data
userdatadetailsList of variables and values for the variables declared in userdata
userdataidThe ID of userdata used for the Instance
userdatanameThe name of userdata used for the Instance
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
useridThe User's ID who deployed the Instance
usernameThe User's name who deployed the Instance
vgpuThe vGPU type used by the Instance
vgpuprofileidthe ID of the vgpu profile to which service offering is linked
vgpuprofilenamethe name of the vgpu profile to which service offering is linked
videoramthe video RAM size in MB
vmtypeUser VM type
vnfdetailsVNF details
vnfnicsNICs of the VNF appliance
zoneidThe ID of the availability zone for the Instance
zonenameThe name of the availability zone for the Instance
affinitygroup(*)List of Affinity groups associated with the Instance
idThe ID of the affinity group
accountThe account owning the affinity group
dedicatedresourcesdedicated resources associated with this affinity group
descriptionThe description of the affinity group
domainThe domain name of the affinity group
domainidThe domain ID of the affinity group
domainpathpath of the Domain the affinity group belongs to
nameThe name of the affinity group
projectThe project name of the affinity group
projectidThe project ID of the affinity group
typeThe type of the affinity group
virtualmachineIdsInstance IDs associated with this affinity group
isos(*)All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
idThe ID of the attached ISO
bootableWhether this is the bootable ISO for the VM
deviceseqThe cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
displaytextThe display text of the attached ISO
nameThe name of the attached ISO
nic(*)The list of NICs associated with Instance
idThe ID of the NIC
adaptertypeType of adapter if available
broadcasturiThe broadcast URI of the NIC
deviceidDevice ID for the Network when plugged into the Instance
enabledwhether the NIC is enabled or not
extradhcpoptionThe extra DHCP options on the NIC
gatewayThe gateway of the NIC
ip6addressThe IPv6 address of Network
ip6cidrThe CIDR of IPv6 Network
ip6gatewayThe gateway of IPv6 Network
ipaddressThe IP address of the NIC
ipaddressesIP addresses associated with NIC found for unmanaged Instance
isdefaultTrue if NIC is default, false otherwise
isolatedpvlanThe isolated private VLAN if available
isolatedpvlantypeThe isolated private VLAN type if available
isolationuriThe isolation URI of the NIC
macaddressTrue if NIC is default, false otherwise
mtuMTU configured on the NIC
netmaskThe netmask of the NIC
networkidThe ID of the corresponding Network
networknameThe name of the corresponding Network
nicdnsnameDNS name associated with this NIC's IP address
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
publicipPublic IP address associated with this NIC via Static NAT rule
publicipidPublic IP address ID associated with this NIC via Static NAT rule
secondaryipThe Secondary IPv4 addr of NIC
traffictypeThe traffic type of the NIC
typeThe type of the NIC
virtualmachineidId of the Instance to which the NIC belongs
vlanidID of the VLAN/VNI if available
vpcidID of the VPC to which the NIC belongs
vpcnameName of the VPC to which the NIC belongs
securitygroup(*)List of security groups associated with the Instance
idThe ID of the security group
accountThe Account owning the security group
descriptionThe description of the security group
domainThe domain name of the security group
domainidThe domain ID of the security group
domainpathpath of the Domain the security group belongs to
nameThe name of the security group
projectThe project name of the group
projectidThe project id of the group
virtualmachinecountThe number of Instances associated with this Security Group
virtualmachineidsThe list of Instance IDs associated with this Security Group
egressrule(*)The list of egress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
ingressrule(*)The list of ingress rules associated with the security group
accountAccount owning the security group rule
cidrThe CIDR notation for the base IP address of the security group rule
endportThe ending IP of the security group rule
icmpcodeThe code for the ICMP message response
icmptypeThe type of the ICMP message response
protocolThe protocol of the security group rule
ruleidThe ID of the security group rule
securitygroupnameSecurity group name
startportThe starting IP of the security group rule
tags(*)The list of resource tags associated with the rule
tags(*)The list of resource tags associated with the rule
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateVmwareDc.html b/static/api/apidocs-4.23/apis/updateVmwareDc.html new file mode 100644 index 0000000000..fdeb2fd079 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateVmwareDc.html @@ -0,0 +1,108 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateVmwareDc

+

Updates a VMware datacenter details for a zone

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
zoneidThe zone IDtrue
isrecursiveSpecify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.false
nameVMware datacenter name.false
passwordThe password for specified username.false
usernameThe username required to connect to resource.false
vcenterThe name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idThe VMware Datacenter ID
nameThe VMware Datacenter name
vcenterThe VMware vCenter name/ip
zoneidThe Zone ID associated with this VMware Datacenter
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateVnfTemplate.html b/static/api/apidocs-4.23/apis/updateVnfTemplate.html new file mode 100644 index 0000000000..9af55ee470 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateVnfTemplate.html @@ -0,0 +1,318 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateVnfTemplate

+

Updates a template to VNF template or attributes of a VNF template.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the image filetrue
archthe CPU arch of the template/ISO. Valid options are: x86_64, aarch64, s390xfalse
bootableTrue if image is bootable, false otherwise; available only for updateIso APIfalse
cleanupdetailsOptional 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
cleanupvnfdetailsoptional boolean field, which indicates if VNF details will be cleaned up or notfalse
cleanupvnfnicsoptional boolean field, which indicates if VNF nics will be cleaned up or notfalse
detailsDetails in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61false
displaytextThe display text of the imagefalse
forceupdateostypeForce OS type update. Warning: Updating OS type will update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.false
forcksindicates that the template can be used for deployment of CKS clustersfalse
formatThe format for the imagefalse
isdynamicallyscalableTrue if Template/ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memoryfalse
isroutingTrue if the Template type is routing i.e., if Template is used to deploy routerfalse
nameThe name of the image filefalse
ostypeidThe ID of the OS type that best represents the OS of this image.false
passwordenabledTrue if the image supports the password reset feature; default is falsefalse
requireshvmTrue if the Template requires HVM, false otherwise; available only for updateTemplate APIfalse
sortkeySort key of the Template, integerfalse
sshkeyenabledTrue if the Template supports the SSHkey upload feature; default is falsefalse
templatetagthe tag for this template.false
templatetypeThe type of the Template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).false
vnfdetailsVNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0false
vnfnicsVNF 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=SecondNICfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe Template ID
accountThe Account name to which the Template belongs
accountidThe Account id to which the Template belongs
archCPU Arch of the template
bitsThe processor bit size
bootableTrue if the ISO is bootable, false otherwise
checksumChecksum of the Template
childtemplatesIf root disk Template, then IDs of the datas disk Templates this Template owns
createdThe date this Template was created
crossZonesTrue if the Template is managed across all Zones, false otherwise
deployasisVMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is Template
detailsAdditional key/value details tied with Template
directdownloadKVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextThe Template display text
domainThe name of the domain to which the Template belongs
domainidThe ID of the domain to which the Template belongs
domainpathPath of the Domain the template belongs to
downloaddetailsLists the download progress of a Template across all secondary storages
extensionidThe ID of extension linked to this template
extensionnameThe name of extension linked to this template
forcksIf true it indicates that the template can be used for CKS cluster deployments
formatThe format of the Template.
hostidThe ID of the secondary storage host for the Template
hostnameThe name of the secondary storage host for the Template
hypervisorThe hypervisor on which the Template runs
iconBase64 string representation of the resource icon
isdynamicallyscalableTrue if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
isextractableTrue if the Template is extractable, false otherwise
isfeaturedTrue if this Template is a featured Template, false otherwise
ispublicTrue if this Template is a public Template, false otherwise
isreadyTrue if the Template is ready to be deployed from, false otherwise.
nameThe Template name
ostypeidThe ID of the OS type for this Template.
ostypenameThe name of the OS type for this Template.
parenttemplateidIf Datadisk Template, then id of the root disk Template this Template belongs to
passwordenabledTrue if the reset password feature is enabled, false otherwise
physicalsizeThe physical size of the Template
projectThe project name of the Template
projectidThe project ID of the Template
removedThe date this Template was removed
requireshvmTrue if Template requires HVM enabled, false otherwise
sizeThe size of the Template
sourcetemplateidThe Template ID of the parent Template if present
sshkeyenabledTrue if Template is sshkey enabled, false otherwise
statusThe status of the Template
templatetagThe tag of this Template
templatetypeThe type of the Template
urlThe URL which the Template/ISO is registered from
userdataidThe id of userdata linked to this Template
userdatanameThe name of userdata linked to this Template
userdataparamsList of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
userdatapolicyThe userdata override policy with the userdata provided while deploying Instance
zoneidThe ID of the zone for this Template
zonenameThe name of the zone for this Template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateVolume.html b/static/api/apidocs-4.23/apis/updateVolume.html new file mode 100644 index 0000000000..b0be933e89 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateVolume.html @@ -0,0 +1,327 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateVolume

+

Updates the volume.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
chaininfoThe chain info of the volumefalse
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
deleteprotectionSet 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
displayvolumeAn optional field, whether to the display the volume to the end User or not.false
idThe ID of the disk volumefalse
nameNew name of the volumefalse
pathThe path of the volumefalse
stateThe state of the volumefalse
storageidDestination storage pool UUID for the volumefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the disk volume
accountThe Account associated with the disk volume
attachedThe date the volume was attached to an Instance
chaininfoThe chain info of the volume
clusteridCluster id of the volume
clusternameCluster name where the volume is allocated
createdThe date the disk volume was created
deleteprotectiontrue if volume has delete protection.
destroyedThe boolean state of whether the volume is destroyed or not
deviceidThe ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
diskBytesReadRateBytes read rate of the disk volume
diskBytesWriteRateBytes write rate of the disk volume
diskIopsReadRateIO requests read rate of the disk volume per the disk offering
diskIopsWriteRateIO requests write rate of the disk volume per the disk offering
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingdisplaytextThe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnameName of the disk offering
displayvolumeAn optional field whether to the display the volume to the end User or not.
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathpath of the Domain the disk volume belongs to
encryptformatthe format of the disk encryption if applicable
externaluuidVolume UUID that is given by virtualisation provider (only for VMware)
hypervisorHypervisor the volume belongs to
isextractableTrue if the volume is extractable, false otherwise
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isonameThe name of the ISO attached to the Instance
kmskeyKMS key name of the volume
kmskeyidKMS key id of the volume
kmskeyversionVersion number of the KMS key used for disk encryption if applicable
maxiopsMax IOPS of the disk volume
miniopsMin IOPS of the disk volume
nameName of the disk volume
pathThe path of the volume
physicalsizeThe bytes actually consumed on disk
podidPod id of the volume
podnamePod name of the volume
projectThe project name of the VPN
projectidThe project id of the VPN
provisioningtypeProvisioning type used to create volumes.
quiescevmNeed quiesce Instance or not when taking Snapshot
serviceofferingdisplaytextThe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnameName of the service offering for root disk
sizeSize of the disk volume
snapshotidID of the Snapshot from which this volume was created
stateThe state of the disk volume
statusThe status of the volume
storageName of the primary storage hosting the disk volume
storageidID of the primary storage hosting the disk volume; returned to admin User only
storagetypeShared or local storage
supportsstoragesnapshotTrue if storage Snapshot is supported for the volume, false otherwise
templatedisplaytextAn alternate display text of the Template for the Instance
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
typeType of the disk volume (ROOT or DATADISK)
utilizationThe disk utilization
virtualmachineidID of the Instance
virtualsizeThe bytes allocated
vmdisplaynameDisplay name of the Instance
vmnameName of the Instance
vmstateState of the Instance
vmtypeType of the Instance
volumecheckresultdetails for the volume check result, they may vary for different hypervisors
volumerepairresultdetails for the volume repair result, they may vary for different hypervisors
zoneidID of the availability zone
zonenameName of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateVpnConnection.html b/static/api/apidocs-4.23/apis/updateVpnConnection.html new file mode 100644 index 0000000000..44992dd6d5 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateVpnConnection.html @@ -0,0 +1,165 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateVpnConnection

+

Updates site to site VPN connection

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of VPN connectiontrue
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayAn optional field, whether to the display the VPN to the end User or notfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe connection ID
accountThe owner
cidrlistGuest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).
createdThe date and time the host was created
domainThe domain name of the owner
domainidThe domain id of the owner
domainpaththe domain path of the owner
dpdIf DPD is enabled for customer gateway
esplifetimeLifetime of ESP SA of customer gateway
esppolicyESP policy of the customer gateway
forceencapIf Force NAT Encapsulation is enabled for customer gateway
fordisplayIs connection for display to the regular user
gatewayPublic IP address id of the customer gateway
ikelifetimeLifetime of IKE SA of customer gateway
ikepolicyIKE policy of the customer gateway
ikeversionWhich IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike
ipsecpskIPsec Preshared-Key of the customer gateway
passiveState of VPN connection
projectThe project name
projectidThe project id
publicipThe public IP address
removedThe date and time the host was removed
s2scustomergatewayidThe customer gateway ID
s2svpngatewayidThe VPN gateway ID
splitconnectionsSplit multiple remote Networks into multiple phase 2 SAs. Often used with Cisco some products.
stateState of VPN connection
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateVpnCustomerGateway.html b/static/api/apidocs-4.23/apis/updateVpnCustomerGateway.html new file mode 100644 index 0000000000..7612b254df --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateVpnCustomerGateway.html @@ -0,0 +1,192 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateVpnCustomerGateway

+

Update site to site VPN customer gateway

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of customer gatewaytrue
cidrlistGuest CIDR of the customer gateway. Multiple entries must be separated by a single comma character (,).true
esppolicyESP policy of the customer gatewaytrue
gatewayPublic IP address id of the customer gatewaytrue
ikepolicyIKE policy of the customer gatewaytrue
ipsecpskIPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.true
accountThe Account associated with the gateway. Must be used with the domainId parameter.false
domainidThe domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the Account for the specified domain.false
dpdIf DPD is enabled for VPN connectionfalse
esplifetimeLifetime of phase 2 VPN connection to the customer gateway, in secondsfalse
forceencapForce encapsulation for Nat Traversalfalse
ikelifetimeLifetime of phase 1 VPN connection to the customer gateway, in secondsfalse
ikeversionWhich 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 ikefalse
nameName of this customer gatewayfalse
splitconnectionsFor IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe VPN gateway ID
accountThe owner
cidrlistGuest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).
domainThe domain name of the owner
domainidThe domain ID of the owner
domainpathThe domain path of the owner
dpdIf DPD is enabled for customer gateway
esplifetimeLifetime of ESP SA of customer gateway
esppolicyIPsec policy of customer gateway
excludedparametersContains the list of excluded/not allowed cryptographic parameters that the vpn customer gateway is using.
forceencapIf Force NAT Encapsulation is enabled for customer gateway
gatewayPublic IP address ID of the customer gateway
ikelifetimeLifetime of IKE SA of customer gateway
ikepolicyIKE policy of customer gateway
ikeversionWhich IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike
ipaddressGuest IP of the customer gateway
ipsecpskIPsec preshared-key of customer gateway
nameName of the customer gateway
obsoleteparametersContains the list of obsolete/insecure cryptographic parameters that the vpn customer gateway is using.
projectThe project name
projectidThe project ID
removedThe date and time the host was removed
splitconnectionsFor IKEv2, whether to split multiple right subnet CIDRs into multiple connection statements.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateVpnGateway.html b/static/api/apidocs-4.23/apis/updateVpnGateway.html new file mode 100644 index 0000000000..56af823e41 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateVpnGateway.html @@ -0,0 +1,123 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateVpnGateway

+

Updates site to site VPN local gateway

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of customer gatewaytrue
customidAn optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayAn optional field, whether to the display the VPN to the end User or notfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe VPN gateway ID
accountThe owner
domainThe domain name of the owner
domainidThe domain id of the owner
domainpaththe domain path of the owner
fordisplayIs VPN gateway for display to the regular user
projectThe project name
projectidThe project id
publicipThe public IP address
removedThe date and time the host was removed
vpcidThe VPC id of this gateway
vpcnameThe VPC name of this gateway
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateWebhook.html b/static/api/apidocs-4.23/apis/updateWebhook.html new file mode 100644 index 0000000000..d9855cd324 --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateWebhook.html @@ -0,0 +1,147 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateWebhook

+

Updates a Webhook

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Webhooktrue
descriptionDescription for the Webhookfalse
nameName for the Webhookfalse
payloadurlPayload URL of the Webhookfalse
scopeScope of the Webhookfalse
secretkeySecret key of the Webhookfalse
sslverificationIf set to true then SSL verification will be done for the Webhook otherwise notfalse
stateState of the Webhookfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Webhook
accountThe account associated with the Webhook
createdThe date when this Webhook was created
descriptionThe description of the Webhook
domainThe name of the domain in which the Webhook exists
domainidThe ID of the domain in which the Webhook exists
domainpathpath of the domain to which the Webhook belongs
nameThe name of the Webhook
payloadurlThe payload URL end point for the Webhook
projectthe project name of the Kubernetes cluster
projectidthe project id of the Kubernetes cluster
scopeThe scope of the Webhook
secretkeyThe secret key for the Webhook
sslverificationWhether SSL verification is enabled for the Webhook
stateThe state of the Webhook
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/updateZone.html b/static/api/apidocs-4.23/apis/updateZone.html new file mode 100644 index 0000000000..e1a02e86be --- /dev/null +++ b/static/api/apidocs-4.23/apis/updateZone.html @@ -0,0 +1,309 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

updateZone

+

Updates a Zone.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Zonetrue
allocationstateAllocation state of this cluster for allocation of new resourcesfalse
detailsThe details for the Zonefalse
dhcpproviderThe DHCP Provider for the Zonefalse
dns1The first DNS for the Zonefalse
dns2The second DNS for the Zonefalse
dnssearchorderThe DNS search order listfalse
domainNetwork domain name for the networks in the zone; empty string will update domain with NULL valuefalse
guestcidraddressThe guest CIDR address for the Zonefalse
internaldns1The first internal DNS for the Zonefalse
internaldns2The second internal DNS for the Zonefalse
ip6dns1The first DNS for IPv6 network in the Zonefalse
ip6dns2The second DNS for IPv6 network in the Zonefalse
ispublicUpdates a private zone to public if set, but not vice-versafalse
localstorageenabledTrue if local storage offering enabled, false otherwisefalse
nameThe name of the Zonefalse
sortkeySort key of the zone, integerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idZone id
allocationstateThe allocation state of the cluster
allowuserspecifyvrmtuAllow end users to specify VR MTU
asnrangeAS Number Range
descriptionZone description
dhcpproviderThe DHCP Provider for the Zone
displaytextThe display text of the zone
dns1The first DNS for the Zone
dns2The second DNS for the Zone
domainNetwork domain name for the Networks in the zone
domainidThe UUID of the containing domain, null for public zones
domainnameThe name of the containing domain, null for public zones
gputotalTotal GPUs in the Zone
gpuusedUsed GPUs in the Zone
guestcidraddressThe guest CIDR address for the Zone
iconBase64 string representation of the resource icon
internaldns1The first internal DNS for the Zone
internaldns2The second internal DNS for the Zone
ip6dns1The first IPv6 DNS for the Zone
ip6dns2The second IPv6 DNS for the Zone
ismultiarchTrue, if zone contains clusters and hosts from different CPU architectures
isnsxenabledTrue, if zone is NSX enabled
localstorageenabledTrue if local storage offering enabled, false otherwise
nameZone name
networktypeThe Network type of the zone; can be Basic or Advanced
providerExternal network provider if any
resourcedetailsMeta data associated with the zone (key/value pairs)
routedmodeenabledTrue, if routed Network/VPC is enabled
routerprivateinterfacemaxmtuThe maximum value the MTU can have on the VR's private interfaces
routerpublicinterfacemaxmtuThe maximum value the MTU can have on the VR's public interfaces
securitygroupsenabledTrue if security groups support is enabled, false otherwise
storageaccessgroupscomma-separated list of storage access groups for the zone
typeThe type of the zone - core or edge
zonetokenZone Token
capacity(*)The capacity of the Zone
capacityallocatedThe capacity currently in allocated
capacitytotalThe total capacity available
capacityusedThe capacity currently in use
clusteridThe Cluster ID
clusternameThe Cluster name
nameThe capacity name
percentusedThe percentage of capacity currently in use
podidThe Pod ID
podnameThe Pod name
tagThe tag for the capacity type
typeThe capacity type
zoneidThe Zone ID
zonenameThe Zone name
tags(*)The list of resource tags associated with zone.
accountThe Account associated with the tag
customerCustomer associated with the tag
domainThe domain associated with the tag
domainidThe ID of the domain associated with the tag
domainpathPath of the Domain associated with the tag
keyTag key name
projectThe project name where tag belongs to
projectidThe project ID the tag belongs to
resourceidID of the resource
resourcetypeResource type
valueTag value
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/upgradeKubernetesCluster.html b/static/api/apidocs-4.23/apis/upgradeKubernetesCluster.html new file mode 100644 index 0000000000..6077d7e84d --- /dev/null +++ b/static/api/apidocs-4.23/apis/upgradeKubernetesCluster.html @@ -0,0 +1,243 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

upgradeKubernetesCluster

+

Upgrades a running CloudManaged Kubernetes cluster

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the Kubernetes clustertrue
kubernetesversionidThe ID of the Kubernetes version for upgradetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe ID of the Kubernetes cluster
accountThe Account associated with the Kubernetes cluster
associatednetworknameThe name of the network of the Kubernetes cluster
autoscalingenabledWhether autoscaling is enabled for the cluster
clustertypeThe type of the cluster
cniconfignameName of CNI Configuration associated with the cluster
cniconfigurationidID of CNI Configuration associated with the cluster
consoleendpointURL end point for the Kubernetes cluster dashboard UI
controlaffinitygroupidsThe IDs of affinity groups associated with control nodes
controlaffinitygroupnamesThe names of affinity groups associated with control nodes
controlnodesThe control nodes count for the Kubernetes cluster
controlofferingidthe ID of the service offering of the control nodes on the Kubernetes cluster
controlofferingnamethe name of the service offering of the control nodes on the Kubernetes cluster
cpunumberThe cpu cores of the Kubernetes cluster
createdThe date when this Kubernetes cluster was created
csienabledIndicates if the CloudStack CSI driver has been setup in the cluster
descriptionThe description of the Kubernetes cluster
domainThe name of the domain in which the Kubernetes cluster exists
domainidThe ID of the domain in which the Kubernetes cluster exists
domainpathPath of the domain to which the Kubernetes cluster belongs
endpointURL end point for the Kubernetes cluster
etcdaffinitygroupidsThe IDs of affinity groups associated with etcd nodes
etcdaffinitygroupnamesThe names of affinity groups associated with etcd nodes
etcdipsPublic IP Addresses of the etcd nodes
etcdnodesthe number of the etcd nodes on the Kubernetes cluster
etcdofferingidthe ID of the service offering of the etcd nodes on the Kubernetes cluster
etcdofferingnamethe name of the service offering of the etcd nodes on the Kubernetes cluster
ipaddressPublic IP Address of the cluster
ipaddressidPublic IP Address ID of the cluster
keypairKeypair details
kubernetesversionidThe ID of the Kubernetes version for the Kubernetes cluster
kubernetesversionnameThe name of the Kubernetes version for the Kubernetes cluster
masternodesThe master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.
maxsizeMaximum size of the cluster
memoryThe memory the Kubernetes cluster
minsizeMinimum size of the cluster
nameThe name of the Kubernetes cluster
networkidThe ID of the network of the Kubernetes cluster
projectThe project name of the Kubernetes cluster
projectidThe project id of the Kubernetes cluster
serviceofferingidThe ID of the service offering of the Kubernetes cluster
serviceofferingnameThe name of the service offering of the Kubernetes cluster
sizeThe size (worker nodes count) of the Kubernetes cluster
stateThe state of the Kubernetes cluster
templateidThe ID of the Template of the Kubernetes cluster
templatenamethe name of the template of the Kubernetes cluster
virtualmachinesThe list of virtualmachines associated with this Kubernetes cluster
workeraffinitygroupidsThe IDs of affinity groups associated with worker nodes
workeraffinitygroupnamesThe names of affinity groups associated with worker nodes
workerofferingidthe ID of the service offering of the worker nodes on the Kubernetes cluster
workerofferingnamethe name of the service offering of the worker nodes on the Kubernetes cluster
zoneidThe name of the zone of the Kubernetes cluster
zonenameThe name of the zone of the Kubernetes cluster
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/upgradeRouterTemplate.html b/static/api/apidocs-4.23/apis/upgradeRouterTemplate.html new file mode 100644 index 0000000000..75b1aad37d --- /dev/null +++ b/static/api/apidocs-4.23/apis/upgradeRouterTemplate.html @@ -0,0 +1,102 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

upgradeRouterTemplate

+

Upgrades router to use newer Template

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountUpgrades all routers owned by the specified accountfalse
clusteridUpgrades all routers within the specified clusterfalse
domainidUpgrades all routers owned by the specified domainfalse
idUpgrades router with the specified Idfalse
podidUpgrades all routers within the specified Podfalse
zoneidUpgrades all routers within the specified zonefalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
jobidThe UUID of the latest async job acting on this object
jobstatusThe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/uploadCustomCertificate.html b/static/api/apidocs-4.23/apis/uploadCustomCertificate.html new file mode 100644 index 0000000000..cc78e80e62 --- /dev/null +++ b/static/api/apidocs-4.23/apis/uploadCustomCertificate.html @@ -0,0 +1,96 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

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.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
certificateThe certificate to be uploaded.true
domainsuffixDNS domain suffix that the certificate is granted for.true
idAn 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 = 3false
nameA name / alias for the certificate.false
privatekeyThe private key for the attached certificate.false
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
messageMessage of the certificate upload operation
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/uploadResourceIcon.html b/static/api/apidocs-4.23/apis/uploadResourceIcon.html new file mode 100644 index 0000000000..af37b7bffc --- /dev/null +++ b/static/api/apidocs-4.23/apis/uploadResourceIcon.html @@ -0,0 +1,93 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

uploadResourceIcon

+

Uploads an icon for the specified resource(s)

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
base64imageBase64 string representation of the resource icon/imagetrue
resourceidsList of resources to upload the icon/image fortrue
resourcetypeType of the resourcetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/uploadSslCert.html b/static/api/apidocs-4.23/apis/uploadSslCert.html new file mode 100644 index 0000000000..5fb2935b68 --- /dev/null +++ b/static/api/apidocs-4.23/apis/uploadSslCert.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

uploadSslCert

+

Upload a certificate to CloudStack

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
certificateSSL certificatetrue
nameName for the uploaded certificatetrue
privatekeyPrivate keytrue
accountAccount that will own the SSL certificatefalse
certchainCertificate chain of trustfalse
domainidDomain ID of the account owning the SSL certificatefalse
enabledrevocationcheckEnables revocation checking for certificatesfalse
passwordPassword for the private keyfalse
projectidAn optional project for the SSL certificatefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idSSL certificate ID
accountAccount for the certificate
certchainCertificate chain
certificateCertificate
domainThe domain name of the Network owner
domainidThe domain id of the Network owner
fingerprintCertificate fingerprint
loadbalancerrulelistList of loabalancers this certificate is bound to
nameName
projectThe project name of the certificate
projectidThe project id of the certificate
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/uploadTemplateDirectDownloadCertificate.html b/static/api/apidocs-4.23/apis/uploadTemplateDirectDownloadCertificate.html new file mode 100644 index 0000000000..4f4a25b769 --- /dev/null +++ b/static/api/apidocs-4.23/apis/uploadTemplateDirectDownloadCertificate.html @@ -0,0 +1,126 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

uploadTemplateDirectDownloadCertificate

+

Upload a certificate for HTTPS direct Template download on KVM hosts

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
certificateSSL certificatetrue
hypervisorHypervisor typetrue
nameName for the uploaded certificatetrue
zoneidZone to upload certificatetrue
hostid(Optional) the host ID to upload certificatefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idThe direct download certificate ID
aliasThe direct download certificate alias
hostsmapThe hosts where the certificate is uploaded to
hypervisorThe hypervisor of the hosts where the certificate is uploaded
issuerThe direct download certificate issuer
serialnumThe direct download certificate serial num
subjectThe direct download certificate subject
validityThe direct download certificate issuer
versionThe direct download certificate version
zoneidThe zone ID where the certificate is uploaded
zonenameThe zone name where the certificate is uploaded
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/uploadVolume.html b/static/api/apidocs-4.23/apis/uploadVolume.html new file mode 100644 index 0000000000..ee11579263 --- /dev/null +++ b/static/api/apidocs-4.23/apis/uploadVolume.html @@ -0,0 +1,335 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

uploadVolume

+

Uploads a data disk.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
formatThe format for the volume. Possible values include QCOW2, OVA, and VHD.true
nameThe name of the volumetrue
urlThe URL of where the volume is hosted. Possible URL include http:// and https://true
zoneidThe ID of the zone the volume is to be hosted ontrue
accountAn optional accountName. Must be used with domainId.false
checksumThe 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
diskofferingidThe ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.false
domainidAn 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
imagestoreuuidImage store uuidfalse
projectidUpload volume for the projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the disk volume
accountThe Account associated with the disk volume
attachedThe date the volume was attached to an Instance
chaininfoThe chain info of the volume
clusteridCluster id of the volume
clusternameCluster name where the volume is allocated
createdThe date the disk volume was created
deleteprotectiontrue if volume has delete protection.
destroyedThe boolean state of whether the volume is destroyed or not
deviceidThe ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
diskBytesReadRateBytes read rate of the disk volume
diskBytesWriteRateBytes write rate of the disk volume
diskIopsReadRateIO requests read rate of the disk volume per the disk offering
diskIopsWriteRateIO requests write rate of the disk volume per the disk offering
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingdisplaytextThe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnameName of the disk offering
displayvolumeAn optional field whether to the display the volume to the end User or not.
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathpath of the Domain the disk volume belongs to
encryptformatthe format of the disk encryption if applicable
externaluuidVolume UUID that is given by virtualisation provider (only for VMware)
hypervisorHypervisor the volume belongs to
isextractableTrue if the volume is extractable, false otherwise
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isonameThe name of the ISO attached to the Instance
kmskeyKMS key name of the volume
kmskeyidKMS key id of the volume
kmskeyversionVersion number of the KMS key used for disk encryption if applicable
maxiopsMax IOPS of the disk volume
miniopsMin IOPS of the disk volume
nameName of the disk volume
pathThe path of the volume
physicalsizeThe bytes actually consumed on disk
podidPod id of the volume
podnamePod name of the volume
projectThe project name of the VPN
projectidThe project id of the VPN
provisioningtypeProvisioning type used to create volumes.
quiescevmNeed quiesce Instance or not when taking Snapshot
serviceofferingdisplaytextThe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnameName of the service offering for root disk
sizeSize of the disk volume
snapshotidID of the Snapshot from which this volume was created
stateThe state of the disk volume
statusThe status of the volume
storageName of the primary storage hosting the disk volume
storageidID of the primary storage hosting the disk volume; returned to admin User only
storagetypeShared or local storage
supportsstoragesnapshotTrue if storage Snapshot is supported for the volume, false otherwise
templatedisplaytextAn alternate display text of the Template for the Instance
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
typeType of the disk volume (ROOT or DATADISK)
utilizationThe disk utilization
virtualmachineidID of the Instance
virtualsizeThe bytes allocated
vmdisplaynameDisplay name of the Instance
vmnameName of the Instance
vmstateState of the Instance
vmtypeType of the Instance
volumecheckresultdetails for the volume check result, they may vary for different hypervisors
volumerepairresultdetails for the volume repair result, they may vary for different hypervisors
zoneidID of the availability zone
zonenameName of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/validateUserTwoFactorAuthenticationCode.html b/static/api/apidocs-4.23/apis/validateUserTwoFactorAuthenticationCode.html new file mode 100644 index 0000000000..8b7366c96a --- /dev/null +++ b/static/api/apidocs-4.23/apis/validateUserTwoFactorAuthenticationCode.html @@ -0,0 +1,87 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

validateUserTwoFactorAuthenticationCode

+

Checks the 2FA code for the user.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
codefor2faTwo factor authentication codetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextAny text associated with the success or failure
successTrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/apis/verifyOAuthCodeAndGetUser.html b/static/api/apidocs-4.23/apis/verifyOAuthCodeAndGetUser.html new file mode 100644 index 0000000000..59060231cb --- /dev/null +++ b/static/api/apidocs-4.23/apis/verifyOAuthCodeAndGetUser.html @@ -0,0 +1,138 @@ + + + + + + + + Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.23.0.0 Root Admin API Reference + +

+

verifyOAuthCodeAndGetUser

+

Verify the OAuth Code and fetch the corresponding user from provider

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
providerName of the providertrue
domainDomain path for domain-specific OAuth provider lookup. Ignored when Domain ID is passed.false
domainidDomain ID for domain-specific OAuth provider lookup. If not provided, uses global providerfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
secretcodeCode that is provided by OAuth provider (Eg. google, github) after successful loginfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the provider
authorizeurlAuthorize URL registered in the OAuth provider
clientidClient ID registered in the OAuth provider
descriptionDescription of the provider registered
domainname of the domain the provider belongs to (empty for global)
domainidUUID of the domain the provider belongs to (empty for global)
domainpathpath of the domain the provider belongs to (empty for global)
enabledWhether the OAuth provider is enabled or not
nameName of the provider
providerName of the provider
redirecturiRedirect URI registered in the OAuth provider
secretkeySecret key registered in the OAuth provider
tokenurlToken URL registered in the OAuth provider
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/apidocs-4.23/images/api_bullets.gif b/static/api/apidocs-4.23/images/api_bullets.gif new file mode 100644 index 0000000000..a7ea2f6b9b Binary files /dev/null and b/static/api/apidocs-4.23/images/api_bullets.gif differ diff --git a/static/api/apidocs-4.23/images/back_button.gif b/static/api/apidocs-4.23/images/back_button.gif new file mode 100644 index 0000000000..509f2565ae Binary files /dev/null and b/static/api/apidocs-4.23/images/back_button.gif differ diff --git a/static/api/apidocs-4.23/images/back_button_hover.gif b/static/api/apidocs-4.23/images/back_button_hover.gif new file mode 100644 index 0000000000..7316e8ec04 Binary files /dev/null and b/static/api/apidocs-4.23/images/back_button_hover.gif differ diff --git a/static/api/apidocs-4.23/images/cloudstack.png b/static/api/apidocs-4.23/images/cloudstack.png new file mode 100644 index 0000000000..ef28282955 Binary files /dev/null and b/static/api/apidocs-4.23/images/cloudstack.png differ diff --git a/static/api/apidocs-4.23/includes/main.css b/static/api/apidocs-4.23/includes/main.css new file mode 100644 index 0000000000..fc1cd71b8a --- /dev/null +++ b/static/api/apidocs-4.23/includes/main.css @@ -0,0 +1,1092 @@ +@charset "UTF-8"; +/* +* Licensed to the Apache Software Foundation (ASF) under one +* or more contributor license agreements. See the NOTICE file +* distributed with this work for additional information +* regarding copyright ownership. The ASF licenses this file +* to you under the Apache License, Version 2.0 (the +* "License"); you may not use this file except in compliance +* with the License. You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, +* software distributed under the License is distributed on an +* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +* KIND, either express or implied. See the License for the +* specific language governing permissions and limitations +* under the License. +*/ + +/* CSS Document */ + + +*{ + margin:0; + padding:0; +} + +body{ + font-family:Arial, Helvetica, sans-serif; + font-size:12px; + color:#333; + font-weight:normal; + background:#FFF repeat top left; + margin:0; + padding:0; +} + + +#inside_wrapper { + width:auto; + height:auto; + margin:0; + padding:0; + overflow:hidden; +} + +#insidetopbg { + width:100%; + height:auto; + margin:0; + padding:0; + overflow:hidden; +} + +.uppermenu_panel { + width:100%; + height:auto; + float:left; + margin:0; + padding:0; +} +.uppermenu_box { + width:auto; + height:29px; + float:right; + margin:0; + padding:0; + +} + +.uppermenu { + width:300px; + height:auto; + float:left; + color:#FFF; + font-size:13px; + font-weight:normal; + text-align:left; + padding:0; + margin:4px 10px 0 0; +} + +.uppermenu a:link { + width:auto; + height:auto; + color:#54bfd3; + font-weight:normal; + text-align:left; + text-decoration:none; + margin:0 5px 0 5px; + +} + +.uppermenu a:visited { + width:auto; + height:auto; + color:#54bfd3; + font-weight:normal; + text-align:left; + text-decoration:none; + margin:0 5px 0 5px; + +} + +.uppermenu a:hover { + width:auto; + height:auto; + color:#ccf004; + font-weight:normal; + text-align:left; + text-decoration:none; + margin:0 5px 0 5px; + +} + + +#main_controller { + width:960px; + height:auto; + margin:0 auto; + padding:0; +} + +#inside_header { + width:960px; + height:auto; + float:left; + margin:0 0 0 0; + padding:0; +} + +.header_top { + width:960px; + height:67px; + float:left; + margin:0; + padding:0; +} + +.header_bot { + width:960px; + height:352px; + float:left; + margin:0; + padding:0; +} + +.insideheader_bot { + width:960px; + height:91px; + float:left; + margin:0; + padding:0; +} + +.insideheader_botleft { + width:620px; + height:91px; + float:left; + margin:0; + padding:0; +} + +.insideheader_botleft h1 { + width:auto; + height:auto; + float:left; + color:#199cb4; + font-size:30px; + text-align:left; + font-weight:normal; + letter-spacing:1px; + margin:30px 0 0 0; + padding:0; +} + +.insideheader_botright { + width:340px; + height:91px; + float:left; + margin:0; + padding:0; +} + +.insideheader_button { + width:340px; + height:32px; + float:left; + margin:30px 0 0 0; + padding:0; +} + +a.insjoincomm_button { + width:169px; + height:32px; + float:left; + background:url(../images/insjoincomm_button.gif) no-repeat top left; + margin:0; + padding:0; +} + +a:hover.insjoincomm_button { + background:url(../images/insjoincomm_button_hover.gif) no-repeat top left; +} + +a.insdownload_button { + width:171px; + height:32px; + float:left; + background:url(../images/insdownload_button.gif) no-repeat top left; + margin:0; + padding:0; +} + +a:hover.insdownload_button { + background:url(../images/insdownload_button_hover.gif) no-repeat top left; +} + +.insheader_buttonshadow { + width:336px; + height:14px; + float:left; + background:url(../images/ins_buttonshadow.gif) no-repeat top left; + margin:0; + padding:0; +} +.header_botright { + width:550px; + height:352px; + float:left; + margin:0; + padding:0; +} + +.clear { + clear:both; +} + + +a.cloud_logo { + width:373px; + height:51px; + float:left; + background:url(../images/cloudstack.png) no-repeat top left; + margin:8px 0 0 0; + padding:0; +} + +.mainemenu_panel { + width: 801px; + height:51px; + float:left; + margin:0; + padding:0; +} + +.mainemenu_links { + width: auto; + height:auto; + float:right; + margin:30px 0 0 0; + padding:0; +} + +.mainemenu_links a:link { + width: auto; + height:auto; + font-size:18px; + text-align:left; + font-weight:normal; + text-decoration:none; + color:#FFF; + margin:0 25px 0 0; + padding:0; +} + +.mainemenu_links a:visited { + width: auto; + height:auto; + font-size:18px; + text-align:left; + font-weight:normal; + text-decoration:none; + margin:0 25px 0 0; + padding:0; + color:#FFF; +} + +.mainemenu_links a:hover { + width: auto; + height:auto; + font-size:18px; + text-align:left; + font-weight:normal; + text-decoration:none; + margin:0 25px 0 0; + padding:0; + color:#FFF; +} + +#main_content { + width:960px; + min-height:600px; + height:auto; + float:left; + margin:0; + padding:0; +} + +.main_homecontent_left { + width:600px; + height:auto; + float:left; + margin:0; + padding:0; +} + +.home_introbox { + width:600px; + height:auto; + float:left; + margin: 25px 0 0 0; + padding:0; +} + +.home_introbox h1 { + width:600px; + height:auto; + float:left; + color:#199cb4; + text-align:left; + font-weight:normal; + font-size:22px; + margin:0; + padding:0; +} + +.home_introbox p { + width:600px; + height:auto; + float:left; + text-align:justify; + font-weight:normal; + line-height:22px; + font-size:18px; + margin:10px 0 0 0; + padding:0; +} +.main_homecontent_right { + width:311px; + height:auto; + float:right; + margin:0; + padding:0; +} + +#news_panel { + width:600px; + height:auto; + float:left; + margin:30px 0 0 0; + padding:0; +} + +#news_panel h2 { + width:auto; + height:auto; + float:left; + color:#199cb4; + font-size:18px; + font-weight:normal; + text-align:left; +} + +.news_box { + width:600px; + height:auto; + float:left; + margin:15px 0 0 0; + padding:0; +} + +.news_box a:link { + width:600px; + height:auto; + float:left; + color:#105f8b; + text-align:left; + text-decoration:none; + font-weight:normal; + font-size:15px; +} + +.news_box a:visited { + width:600px; + height:auto; + float:left; + color:#105f8b; + text-align:left; + text-decoration:none; + font-weight:normal; + font-size:15px; +} + +.news_box a:hover { + width:600px; + height:auto; + float:left; + color:#666; + text-align:left; + text-decoration:none; + font-weight:normal; + font-size:15px; +} + +.news_box p { + width:600px; + height:auto; + float:left; + margin:8px 0 0 0; + text-align:left; + font-size:12px; + font-weight:normal; + padding:0; +} + +.news_box span { + width:auto; + height:auto; + float:left; + margin:0; + color:#999; + text-align:left; + font-size:11px; + font-weight:normal; + padding:0; +} + +#partners_panel { + width:311px; + height:auto; + float:left; + margin:30px 0 0 0; + padding:0; +} + +#partners_panel h2 { + width:300px; + height:auto; + float:left; + color:#199cb4; + font-size:18px; + font-weight:normal; + text-align:left; +} + +.partners_box { + width:310px; + height:auto; + float:left; + border-bottom:1px solid #CCC; + margin:15px 0 0 0; +} + +.partners_box_logo { + width:auto; + height:auto; + float:left; + display:block; + margin:0 0 10px 0; + padding:0; + border:0; +} + +.partners_box_small { + width:155px; + height:80px; + float:left; + margin:0; + padding:0; +} + +.readmore_box { + width:100%; + height:29px; + float:left; + margin:15px 0 0 0; + padding:0; +} + +.readmore_box a:link { + width:auto; + height:auto; + float:right; + color:#105f8b; + font-size:12px; + font-weight:normal; + text-decoration:none; + text-align:right; + margin:0 10px 0 0; + padding:0; +} + +.readmore_box a:visited { + width:auto; + height:auto; + float:right; + color:#105f8b; + font-size:12px; + font-weight:normal; + text-decoration:none; + text-align:right; + margin:0 10px 0 0; + padding:0; +} + +.readmore_box a:hover { + width:auto; + height:auto; + float:right; + color:#105f8b; + font-size:12px; + font-weight:normal; + text-decoration:underline; + text-align:right; + margin:0 10px 0 0; + padding:0; +} + +#footer { + width:100%; + height:auto; + background:#cdcdcd repeat top left; + margin:25px 0 0 0; + padding:0 0 10px 0; + float:left; +} + +#inside_footer { + width:100%; + height:auto; + background:#cdcdcd repeat top left; + margin:25px 0 0 0; + padding:0; + position:absolute; + bottom:0; +} + + +#footer_maincontroller { + width:960px; + height:auto; + margin:0 auto; + padding:0; +} + +#footer_maincontroller p{ + width:100%; + height:auto; + float:left; + margin:15px 0 0 0; + text-align:left; + font-size:11px; + font-weight:normal; + padding:0; +} + +.footer_linksbox { + width:180px; + height:auto; + float:left; + margin: 15px 20px 20px 0; + padding:0; +} + +.footer_linksbox li { + width:170px; + height:auto; + float:left; + margin: 0 0 5px 0; + border-bottom:1px solid #999; + list-style:none; + padding:0; +} + +.footer_linksbox a:link { + width:auto; + height:auto; + float:left; + font-size:11px; + font-weight:normal; + color:#666; + text-decoration:none; +} + +.footer_linksbox a:visited { + width:auto; + height:auto; + float:left; + font-size:11px; + font-weight:normal; + color:#666; + text-decoration:none; +} + +.footer_linksbox a:hover { + width:auto; + height:auto; + float:left; + font-size:11px; + font-weight:normal; + color:#333; + text-decoration:none; +} + +.inside_leftpanel { + width:212px; + height:auto; + float:left; + margin:0; + padding:0; +} + +.inside_rightpanel { + width:718px; + height:auto; + float:right; + margin:0; + padding:0; +} + +.inside_contentpanel { + width:700px; + height:auto; + float:left; + margin:0 0 0 0; + padding:0; +} + +.inside_contentpanel h1{ + width:700px; + height:auto; + float:left; + color:#199cb4; + font-size:20px; + font-weight:normal; + text-align:left; + margin:0; + padding:0; +} + +.inside_contentpanel h2{ + width:700px; + height:auto; + float:left; + color:#199cb4; + font-size:16px; + font-weight:normal; + text-align:left; + margin:15px 0 0 0; + padding:0; +} + + +.inside_contentpanel h3{ + width:700px; + height:auto; + float:left; + font-size:15px; + font-weight:bold; + text-align:left; + margin:15px 0 0 0; + padding:0; +} + +.inside_contentpanel h4{ + width:700px; + height:auto; + float:left; + font-size:14px; + font-weight:normal; + text-align:left; + margin:15px 0 10px 15px; + padding:0; +} + +.inside_contentpanel p { + width:100%; + height:auto; + float:left; + text-align:justify; + font-size:12px; + font-weight:normal; + margin:10px 0 0 0; + padding:0; +} + +.inside_contentpanel a:link { + width:auto; + height:auto; + color:#009fcd; + text-decoration:none; + text-align:left; + font-size:12px; + margin:0; + padding:0; +} + +.inside_contentpanel a:visited { + width:auto; + height:auto; + color:#009fcd; + text-decoration:none; + text-align:left; + font-size:12px; + margin:0; + padding:0; +} + +.inside_contentpanel a:hover { + width:auto; + height:auto; + color:#009fcd; + text-decoration:underline; + text-align:left; + font-size:12px; + margin:0; + padding:0; +} + +.download_text { + width:600px; + height:auto; + float:left; + color:#7418c2; + text-align:left; + font-weight:normal; + font-size:18px; + margin:20px 0 15px 0 +} + +.download_textbox { + width:720px; + height:auto; + float:left; + color:#333; + text-align:left; + font-weight:normal; + font-size:18px; + margin:20px 0 15px 0; + border-top:1px dashed #999; +} + +.screenshots_box { + width:454px; + height:455px; + float:left; + background:#000 repeat top left; + margin:20px 0 0 65px; + display:inline; +} + +.apiannouncement_box { + width:928px; + height:auto; + float:left; + background:#e0f4ff repeat top left; + margin:15px 0 0 0; + border:1px solid #9dd2eb; +} + +.apiannouncement_contentarea { + width:895px; + height:auto; + float:left; + margin:0 0 0 15px; + display:inline; + padding:0; +} + +.inside_apileftpanel { + width:930px; + height:left; + float:left; + margin:0; + padding:0; +} + +.api_leftsections { + width:928px; + height:auto; + float:left; + border-top:1px dashed #666; + margin:15px 0 0 0; + padding:0; +} + + + +.api_leftsections span { + width:700px; + height:auto; + float:left; + color:#666; + font-size:11px; + font-weight:normal; + text-align:left; + margin:7px 0 0 0; + padding:0; +} + +.api_legends{ + width:300px; + height:auto; + float:left; + background:#f9f9f9; + border:1px solid #e6e6e6; + margin:8px 0 0 0; + padding:0 3px 3px 0; +} + +.api_legends p{ + width:250px; + height:auto; + float:left; + color:#333; + text-align:left; + font-size:11px; + font-weight:normal; + margin:5px 0 0 5px; + padding:0; +} + +.api_legends_async{ + width:auto !important; + height:auto; + color:#2c8bbc !important; + font-size:11px; + font-weight:normal; + text-align:left; + margin:0 3px 0 0 !important; + padding:0; +} + +.api_legends_premium{ + width:auto !important; + height:auto; + color:#013150 !important;; + font-size:11px; + font-weight:normal; + text-align:left; + margin:0 3px 0 0 !important;; + padding:0; +} + +.apismallsections { + width:925px; + height:auto; + float:left; + margin:15px 0 0 0; + list-style:none; + padding:0; +} + +.apismallbullet_box { + width:231px; + height:auto; + float:left; + margin:10px 0 0 0; + list-style:none; + padding:0; +} + +.apismallbullet_box h5 { + width:120px; + height:auto; + float:left; + color:#666; + font-size:12px; + text-align:left; + font-weight:bold; + margin:0; + padding:0 0 10px 0; +} + +.apismallbullet_box h6 { + width:120px; + height:auto; + float:left; + color:#6214ab; + font-size:12px; + text-align:left; + font-weight:bold; + margin:0; + padding:0 0 10px 0; +} + +.apismallbullet_box li { + width:188px; + height:auto; + float:left; + margin:4px 0 0 0; + background:url(../images/api_bullets.gif) no-repeat top left; + padding:0 0 3px 15px; + background-position: 2px 2px; + text-align: left; + list-style:none; + border-bottom:1px dotted #999; +} + +.apismallbullet_box a{ + width:auto; + height:auto; + float:left; + color:#2c8bbc; + font-size:11px !important; + font-weight:normal; + text-align:left; + margin:0; + padding:0; + text-decoration:none; +} + +.apismallbullet_box a:link, .apismallbullet_box a:visited { + text-decoration:none; +} + +.apismallbullet_box a:hover { + text-decoration:underline; +} + +.api_tablepanel { + width:920px; + height:auto; + float:left; + margin:15px 0 0 0; + padding:0; +} + +.api_tablepanel h2{ + width:800px; + height:auto; + float:left; + color:#666; + font-size:14px; + font-weight:bold; + text-align:left; + margin:15px 0 0 0; + padding:0; +} + +.apitable { + width:100%; + height:auto; + float:left; + border:none; + border-collapse:collapse; + margin:10px 0 0 0; + padding:0; +} + +.api_usagebox { + width:700px; + height:auto; + float:left; + background:#f4f5f5; + border:1px solid #CCC; + margin:10px 0 0 30px; + padding:10px; + color:#333; + font-size:11px; + font-weight:normal; + text-align:left; +} + +.api_samplebox { + width:700px; + height:auto; + float:left; + background:#E0F4FF; + border:1px solid #9DD2EB; + margin:10px 0 0 30px; + padding:10px; + color:#333; + font-size:11px; + font-weight:normal; + text-align:left; +} + +.apitable tr { + width:100%; + height:auto; + float:left; + border-collapse:collapse; + border-bottom:1px solid #d5e8f1; + margin:0; + padding:0; +} + +.apitable tr.hed { + width:100%; + height:22px; + float:left; + background:#e7e7e7; + border-collapse:collapse; + border-top:1px solid #999; + border-bottom:1px solid #999; + margin:15px 0 0 0; + padding:0; + border-left:none; + border-right:none; +} + +.apitable td { + height:auto; + float:left; + border:none; + color:#333; + font-size:12px; + font-weight:normal; + border-collapse:collapse; + text-align:left; + padding:5px; + margin:0; +} + + +.apitable td.p{ + height:auto; + float:left; + border:none; + color:#333; + font-size:12px; + font-weight:normal; + text-align:left; + padding:5px; + margin:0; +} + + + +.api_titlebox { + width:100%; + height:auto; + float:left; + margin:0; + padding:0; +} + +.api_titlebox_left { + width:700px; + height:auto; + float:left; + margin:0; + padding:0; +} + +.api_titlebox span{ + width:600px; + height:auto; + float:left; + color:#666; + font-size:11px; + font-weight:normal; + font-style:italic; + text-align:left; + margin:10px 0 0 0; + padding:0; +} + +.api_titlebox_right { + width:200px; + height:20px; + float:right; + margin:0; + padding:0; +} + +a.api_backbutton { + width:60px !important; + height:19px !important; + float:right; + background:#F00 url(../images/back_button.gif) no-repeat top left; + margin:10px 0 0 0 !important; + padding:0; + text-decoration:none; +} + +a:hover.api_backbutton { + background:url(../images/back_button_hover.gif) no-repeat top left; +} diff --git a/static/api/apidocs-4.23/index.html b/static/api/apidocs-4.23/index.html new file mode 100644 index 0000000000..91af26982b --- /dev/null +++ b/static/api/apidocs-4.23/index.html @@ -0,0 +1,3565 @@ + + + + + + + + CloudStack API Reference + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+

Apache CloudStack API Documentation (4.23.0.0)

+ +
+
+

Using the CloudStack API

+

+ For information about how the APIs work, and tips on how to use them, see the + Developer's Guide. +

+
+
+
+

All APIs

+ Commands available through the developer API URL and the integration API URL. +
+

+ (A) implies that the command is asynchronous. +

+

+ (D) implies that the command is deprecated. +

+

(*) implies element has a child.

+
+
+
+
Network
+ +
+
+
Tungsten
+ +
+
+
Virtual Machine
+ +
+
+
Load Balancer
+ +
+
+
+
+
Backup and Recovery
+ +
+
+
Volume
+ +
+
+
Zone
+ +
+
+
Project
+ +
+
+
+
+
AutoScale
+ +
+
+
VPN
+ +
+
+
User
+ +
+
+
Image Store
+ +
+
+
+
+
Firewall
+ +
+
+
Kubernetes Service
+ +
+
+
Configuration
+ +
+
+
Host
+ +
+
+
+
+
Snapshot
+ +
+
+
Quota
+ +
+
+
GPU
+ +
+
+
Template
+ +
+
+
+
+
Storage Pool
+ +
+
+
Guest OS
+ +
+
+
Cluster
+ +
+
+
VPC
+ +
+
+
+
+
Shared FileSystem
+ +
+
+
Extension
+ +
+
+
Account
+ +
+
+
Role
+ +
+
+
+
+
Network ACL
+ +
+
+
ISO
+ +
+
+
Authentication
+ +
+
+
Webhook
+ +
+
+
+
+
System VM
+ +
+
+
Router
+ +
+
+
Pod
+ +
+
+
Certificate
+ +
+
+
+
+
Baremetal
+ +
+
+
Out-of-band Management
+ +
+
+
Netscaler
+ +
+
+
Maintenance
+ +
+
+
+
+
Key Management System
+ +
+
+
VLAN
+ +
+
+
Security Group
+ +
+
+
Object Store
+ +
+
+
+
+
Domain
+ +
+
+
DNS
+ +
+
+
Address
+ +
+
+
BGP Peer
+ +
+
+
+
+
Virtual Network Functions
+ +
+
+
UCS
+ +
+
+
Metrics
+ +
+
+
Internal LB
+ +
+
+
+
+
External Device
+ +
+
+
VPC Offering
+ +
+
+
Service Offering
+ +
+
+
Palo Alto
+ +
+
+
+
+
Nic
+ +
+
+
Network Offering
+ +
+
+
NAT
+ +
+
+
Disk Offering
+ +
+
+
+
+
Alert
+ +
+
+
Affinity Group
+ +
+
+
VM Group
+ +
+
+
User Data
+ +
+
+
+
+
Usage
+ +
+
+
SSH
+ +
+
+
Resource tags
+ +
+
+
Resource metadata
+ +
+
+
+
+
Resource Schedule
+ +
+
+
Region
+ +
+
+
Oauth
+ +
+
+
Nicira NVP
+ +
+
+
+
+
GUI Theme
+ +
+
+
Event
+ +
+
+
Brocade VCS
+ +
+
+
Annotations
+ +
+
+
+
+
SolidFire
+ +
+
+
SSL Certificates
+ +
+
+
Resource Icon
+ +
+
+
Portable IP
+ +
+
+
+
+
Network Device
+ +
+
+
Netris
+ +
+
+
NSX
+ +
+
+
Management
+ +
+
+
+
+
LDAP
+ +
+
+
IP Quarantine
+ +
+
+
BigSwitch BCF
+ +
+
+
AS Number Range
+ +
+
+
+
+
vSphere storage policies
+ +
+
+
Storage Access Groups
+ +
+
+
Resource Limit
+ +
+
+
Pool
+ +
+
+
+
+
Ovs Element
+ +
+
+
Misc Network Service Providers
+ +
+
+
Diagnostics
+ +
+
+
Dedicate Resources
+ +
+
+
+
+
Console Session
+ +
+
+
Cloudian
+ +
+
+
Async job
+ +
+
+
AS Number
+ +
+
+
+
+
System Capacity
+ +
+
+
Sioc
+ +
+
+
Resource
+ +
+
+
Misc
+ +
+
+
+
+
Limit
+ +
+
+
Import VM Task
+ +
+
+
Cloud Identifier
+ +
+
+
API Discovery
+ +
+
+
+
+
+
+
+ +
+
+ +