Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 5405C200BEF for ; Wed, 4 Jan 2017 11:33:45 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 52614160B47; Wed, 4 Jan 2017 10:33:45 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 4C661160B44 for ; Wed, 4 Jan 2017 11:33:43 +0100 (CET) Received: (qmail 24878 invoked by uid 500); 4 Jan 2017 10:32:55 -0000 Mailing-List: contact commits-help@cloudstack.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 23176 invoked by uid 99); 4 Jan 2017 10:32:52 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 04 Jan 2017 10:32:52 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id B3E06DFB3D; Wed, 4 Jan 2017 10:32:52 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: bhaisaab@apache.org To: commits@cloudstack.apache.org Date: Wed, 04 Jan 2017 10:33:28 -0000 Message-Id: <0df3ef2d9b6f4b7295fc8d635cea41f1@git.apache.org> In-Reply-To: <2e2e449f8d914851bfd07cc89927b47c@git.apache.org> References: <2e2e449f8d914851bfd07cc89927b47c@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [38/49] cloudstack-www git commit: content: update freshly built website archived-at: Wed, 04 Jan 2017 10:33:45 -0000 http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/createVolume.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/createVolume.html b/content/api/apidocs-4.9/apis/createVolume.html new file mode 100644 index 0000000..425770a --- /dev/null +++ b/content/api/apidocs-4.9/apis/createVolume.html @@ -0,0 +1,271 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

createVolume

+

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

+
+
+ +
+
+
+

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.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
virtualmachineidthe ID of the virtual machine; to be used with snapshot Id, VM 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 a VM instance
chaininfothe chain info of the volume
createdthe date the disk volume was created
destroyedthe boolean state of whether the volume is destroyed or not
deviceidthe ID of the device on user vm the volume is attahed 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
diskIopsWriteRateio requests write rate of the disk volume
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
hypervisorHypervisor the volume belongs to
isextractabletrue if the volume is extractable, false otherwise
isodisplaytextan alternate display text of the ISO attached to the virtual machine
isoidthe ID of the ISO attached to the virtual machine
isonamethe name of the ISO attached to the virtual machine
maxiopsmax iops of the disk volume
miniopsmin iops of the disk volume
namename of the disk volume
paththe path of the volume
projectthe project name of the vpn
projectidthe project id of the vpn
provisioningtypeprovisioning type used to create volumes.
quiescevmneed quiesce vm 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
templatedisplaytext an alternate display text of the template for the virtual machine
templateidthe ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.
templatenamethe name of the template for the virtual machine
typetype of the disk volume (ROOT or DATADISK)
virtualmachineidid of the virtual machine
vmdisplaynamedisplay name of the virtual machine
vmnamename of the virtual machine
vmstatestate of the virtual machine
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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/createVolumeOnFiler.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/createVolumeOnFiler.html b/content/api/apidocs-4.9/apis/createVolumeOnFiler.html new file mode 100644 index 0000000..b0f57f5 --- /dev/null +++ b/content/api/apidocs-4.9/apis/createVolumeOnFiler.html @@ -0,0 +1,103 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

createVolumeOnFiler

+

Create a volume

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
aggregatenameaggregate name.true
ipaddressip address.true
passwordpassword.true
poolnamepool name.true
sizevolume size.true
usernameuser name.true
volumenamevolume name.true
snapshotpolicysnapshot policy.false
snapshotreservationsnapshot reservation.false
+
+
+

Response Tags

+ + + + +
Response NameDescription
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/createVpnConnection.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/createVpnConnection.html b/content/api/apidocs-4.9/apis/createVpnConnection.html new file mode 100644 index 0000000..16fff18 --- /dev/null +++ b/content/api/apidocs-4.9/apis/createVpnConnection.html @@ -0,0 +1,157 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.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
createdthe date and time the host was created
domainthe domain name of the owner
domainidthe domain id 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
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
stateState of vpn connection
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/createVpnCustomerGateway.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/createVpnCustomerGateway.html b/content/api/apidocs-4.9/apis/createVpnCustomerGateway.html new file mode 100644 index 0000000..69e79cf --- /dev/null +++ b/content/api/apidocs-4.9/apis/createVpnCustomerGateway.html @@ -0,0 +1,169 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

createVpnCustomerGateway

+

Creates site to site vpn customer gateway

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
cidrlistguest cidr list of the customer gatewaytrue
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
namename of this customer gatewayfalse
projectidcreate site-to-site VPN customer gateway for the projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe vpn gateway ID
accountthe owner
cidrlistguest cidr list of the customer gateway
domainthe domain name of the owner
domainidthe domain id of the owner
dpdif DPD is enabled for customer gateway
esplifetimeLifetime of ESP SA of customer gateway
esppolicyIPsec policy of customer gateway
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
ipaddressguest ip of the customer gateway
ipsecpskIPsec preshared-key of customer gateway
namename of the customer gateway
projectthe project name
projectidthe project id
removedthe date and time the host was removed
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/createVpnGateway.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/createVpnGateway.html b/content/api/apidocs-4.9/apis/createVpnGateway.html new file mode 100644 index 0000000..ebcdddf --- /dev/null +++ b/content/api/apidocs-4.9/apis/createVpnGateway.html @@ -0,0 +1,112 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe vpn gateway ID
accountthe owner
domainthe domain name of the owner
domainidthe domain id 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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/createZone.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/createZone.html b/content/api/apidocs-4.9/apis/createZone.html new file mode 100644 index 0000000..ae46b91 --- /dev/null +++ b/content/api/apidocs-4.9/apis/createZone.html @@ -0,0 +1,247 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.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
localstorageenabledtrue if local storage offering enabled, false otherwisefalse
securitygroupenabledtrue if network is security group enabled, false otherwisefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idZone id
allocationstatethe allocation state of the cluster
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
guestcidraddressthe guest CIDR address for the Zone
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
localstorageenabledtrue if local storage offering enabled, false otherwise
nameZone name
networktypethe network type of the zone; can be Basic or Advanced
resourcedetailsMeta data associated with the zone (key/value pairs)
securitygroupsenabledtrue if security groups support is enabled, false otherwise
zonetokenZone Token
capacity(*)the capacity of the Zone
capacitytotalthe total capacity available
capacityusedthe capacity currently in use
clusteridthe Cluster ID
clusternamethe Cluster name
percentusedthe percentage of capacity currently in use
podidthe Pod ID
podnamethe Pod name
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
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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/dedicateCluster.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/dedicateCluster.html b/content/api/apidocs-4.9/apis/dedicateCluster.html new file mode 100644 index 0000000..bb393e4 --- /dev/null +++ b/content/api/apidocs-4.9/apis/dedicateCluster.html @@ -0,0 +1,103 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/dedicateGuestVlanRange.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/dedicateGuestVlanRange.html b/content/api/apidocs-4.9/apis/dedicateGuestVlanRange.html new file mode 100644 index 0000000..203db66 --- /dev/null +++ b/content/api/apidocs-4.9/apis/dedicateGuestVlanRange.html @@ -0,0 +1,118 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

dedicateGuestVlanRange

+

Dedicates a guest vlan range to an account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountaccount who will own the VLANtrue
domainiddomain ID of the account owning a VLANtrue
physicalnetworkidphysical network ID of the vlantrue
vlanrangeguest vlan range to be dedicatedtrue
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
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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/dedicateHost.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/dedicateHost.html b/content/api/apidocs-4.9/apis/dedicateHost.html new file mode 100644 index 0000000..d8275c1 --- /dev/null +++ b/content/api/apidocs-4.9/apis/dedicateHost.html @@ -0,0 +1,103 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/dedicatePod.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/dedicatePod.html b/content/api/apidocs-4.9/apis/dedicatePod.html new file mode 100644 index 0000000..6e026bf --- /dev/null +++ b/content/api/apidocs-4.9/apis/dedicatePod.html @@ -0,0 +1,103 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/dedicatePublicIpRange.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/dedicatePublicIpRange.html b/content/api/apidocs-4.9/apis/dedicatePublicIpRange.html new file mode 100644 index 0000000..93714c4 --- /dev/null +++ b/content/api/apidocs-4.9/apis/dedicatePublicIpRange.html @@ -0,0 +1,154 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.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
descriptionthe description of the VLAN IP range
domainthe domain name of the VLAN IP range
domainidthe domain ID of the VLAN IP range
endipthe end ip of the VLAN IP range
endipv6the end ipv6 of the VLAN IP range
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
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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/dedicateZone.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/dedicateZone.html b/content/api/apidocs-4.9/apis/dedicateZone.html new file mode 100644 index 0000000..5c491e9 --- /dev/null +++ b/content/api/apidocs-4.9/apis/dedicateZone.html @@ -0,0 +1,103 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/deleteAccount.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/deleteAccount.html b/content/api/apidocs-4.9/apis/deleteAccount.html new file mode 100644 index 0000000..639a2bf --- /dev/null +++ b/content/api/apidocs-4.9/apis/deleteAccount.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

deleteAccount

+

Deletes a 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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/deleteAccountFromProject.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/deleteAccountFromProject.html b/content/api/apidocs-4.9/apis/deleteAccountFromProject.html new file mode 100644 index 0000000..9aa84c4 --- /dev/null +++ b/content/api/apidocs-4.9/apis/deleteAccountFromProject.html @@ -0,0 +1,88 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/deleteAffinityGroup.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/deleteAffinityGroup.html b/content/api/apidocs-4.9/apis/deleteAffinityGroup.html new file mode 100644 index 0000000..62cd2fd --- /dev/null +++ b/content/api/apidocs-4.9/apis/deleteAffinityGroup.html @@ -0,0 +1,97 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.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
+
+
+
+
+
+ +
+
+ +