Return-Path: X-Original-To: apmail-cloudstack-commits-archive@www.apache.org Delivered-To: apmail-cloudstack-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 24C0A18263 for ; Wed, 17 Feb 2016 02:22:47 +0000 (UTC) Received: (qmail 91277 invoked by uid 500); 17 Feb 2016 02:22:34 -0000 Delivered-To: apmail-cloudstack-commits-archive@cloudstack.apache.org Received: (qmail 91204 invoked by uid 500); 17 Feb 2016 02:22:34 -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 89224 invoked by uid 99); 17 Feb 2016 02:22:32 -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, 17 Feb 2016 02:22:32 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 4D69FE057C; Wed, 17 Feb 2016 02:22:32 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: pdion891@apache.org To: commits@cloudstack.apache.org Date: Wed, 17 Feb 2016 02:23:13 -0000 Message-Id: <187ea492d746436eb8bfb63b573eeb0c@git.apache.org> In-Reply-To: <1d6b7f4149b145f39313a6a6c9d7bb76@git.apache.org> References: <1d6b7f4149b145f39313a6a6c9d7bb76@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [43/51] [abbrv] [partial] cloudstack-www git commit: 4.8.0, close #24 http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/domain_admin/createUser.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/createUser.html b/content/api/apidocs-4.8/domain_admin/createUser.html new file mode 100644 index 0000000..bbcd6b5 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/createUser.html @@ -0,0 +1,148 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain 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
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
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
iscallerchilddomainthe boolean value representing if the updating target is in caller's child domain
isdefaulttrue if user is default, false otherwise
lastnamethe user lastname
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/domain_admin/createVMSnapshot.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/createVMSnapshot.html b/content/api/apidocs-4.8/domain_admin/createVMSnapshot.html new file mode 100644 index 0000000..3f19296 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/createVMSnapshot.html @@ -0,0 +1,136 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

createVMSnapshot

+

Creates snapshot for a vm.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidThe ID of the vmtrue
descriptionThe description of the snapshotfalse
nameThe display name of the snapshotfalse
quiescevmquiesce vm if truefalse
snapshotmemorysnapshot memory if truefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the vm snapshot
accountthe account associated with the disk volume
createdthe create date of the vm snapshot
currentindiates if this is current snapshot
descriptionthe description of the vm snapshot
displaynamethe display name of the vm snapshot
domainthe domain associated with the disk volume
domainidthe ID of the domain associated with the disk volume
namethe name of the vm snapshot
parentthe parent ID of the vm snapshot
parentNamethe parent displayName of the vm snapshot
projectthe project name of the vpn
projectidthe project id of the vpn
statethe state of the vm snapshot
typeVM Snapshot type
virtualmachineidthe vm ID of the vm snapshot
zoneidthe Zone ID of the vm snapshot
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/domain_admin/createVPC.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/createVPC.html b/content/api/apidocs-4.8/domain_admin/createVPC.html new file mode 100644 index 0000000..b4c9e37 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/createVPC.html @@ -0,0 +1,424 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

createVPC

+

Creates a VPC

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
cidrthe cidr of the VPC. All VPC guest networks' cidrs should be within this CIDRtrue
displaytextthe display text of the VPCtrue
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
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
networkdomainVPC network domain. All networks inside the VPC will belong to this domainfalse
projectidcreate VPC for the projectfalse
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
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the VPC
accountthe owner of the VPC
cidrthe cidr the VPC
createdthe date this VPC was created
displaytextan alternate display text of the VPC.
distributedvpcrouteris VPC uses distributed router for one hop forwarding and host based network ACL's
domainthe domain name of the owner
domainidthe domain id of the VPC owner
fordisplayis vpc for display to the regular user
namethe name of the VPC
networkdomainthe network domain of the VPC
projectthe project name of the VPC
projectidthe project id of the VPC
redundantvpcrouterif this VPC has redundant router
regionlevelvpctrue if VPC is region level
restartrequiredtrue VPC requires restart
statestate of the VPC. Can be Inactive/Enabled
vpcofferingidvpc offering id the VPC is created from
zoneidzone id of the vpc
zonenamethe name of the zone the VPC belongs to
network(*)the list of networks belongign to the VPC
idthe id of the network
accountthe owner of the network
aclidACL Id associated with the VPC network
acltypeacl type - access type to 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 vm deployment
cidrCloudstack managed address space, all CloudStack managed VMs get IP address from CIDR
displaynetworkan optional field, whether to the display the network to the end user or not.
displaytextthe displaytext of the network
dns1the first DNS for the network
dns2the second DNS for the network
domainthe domain name of the network owner
domainidthe domain id of the network owner
gatewaythe network's gateway
ip6cidrthe cidr of IPv6 network
ip6gatewaythe gateway of IPv6 network
isdefaulttrue if network is default, false otherwise
ispersistentlist networks that are persistent
issystemtrue if network is system, false otherwise
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
projectthe project name of the address
projectidthe project id of the ipaddress
relatedrelated to what other network configuration
reservediprangethe network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes
restartrequiredtrue network requires restart
specifyiprangestrue if network supports specifying ip ranges, false otherwise
statestate of the network
strechedl2subnettrue if network can span multiple zones
subdomainaccesstrue if users from subdomains can access the domain level network
traffictypethe traffic type of the network
typethe type of the network
vlanThe vlan of the network. This parameter is visible to ROOT admins only
vpcidVPC the network belongs to
zoneidzone id of the network
zonenamethe name of the zone the network belongs to
zonesnetworkspansIf a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans
service(*)the list of services
namethe service name
capability(*)the list of capabilities
provider(*)the service provider name
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
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
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
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/79d7c49c/content/api/apidocs-4.8/domain_admin/createVirtualRouterElement.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/createVirtualRouterElement.html b/content/api/apidocs-4.8/domain_admin/createVirtualRouterElement.html new file mode 100644 index 0000000..2514a6d --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/createVirtualRouterElement.html @@ -0,0 +1,100 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain 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
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 ipaddress
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/domain_admin/createVolume.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/createVolume.html b/content/api/apidocs-4.8/domain_admin/createVolume.html new file mode 100644 index 0000000..5462006 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/createVolume.html @@ -0,0 +1,298 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain 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
tags(*)the list of resource tags associated with volume
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
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/79d7c49c/content/api/apidocs-4.8/domain_admin/createVolumeOnFiler.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/createVolumeOnFiler.html b/content/api/apidocs-4.8/domain_admin/createVolumeOnFiler.html new file mode 100644 index 0000000..0ee899b --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/createVolumeOnFiler.html @@ -0,0 +1,97 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain 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/79d7c49c/content/api/apidocs-4.8/domain_admin/createVpnConnection.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/createVpnConnection.html b/content/api/apidocs-4.8/domain_admin/createVpnConnection.html new file mode 100644 index 0000000..7ebf325 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/createVpnConnection.html @@ -0,0 +1,151 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain 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/79d7c49c/content/api/apidocs-4.8/domain_admin/createVpnCustomerGateway.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/createVpnCustomerGateway.html b/content/api/apidocs-4.8/domain_admin/createVpnCustomerGateway.html new file mode 100644 index 0000000..e67bfea --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/createVpnCustomerGateway.html @@ -0,0 +1,163 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain 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 gatewaytrue
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/79d7c49c/content/api/apidocs-4.8/domain_admin/createVpnGateway.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/createVpnGateway.html b/content/api/apidocs-4.8/domain_admin/createVpnGateway.html new file mode 100644 index 0000000..beb44f3 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/createVpnGateway.html @@ -0,0 +1,106 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain 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/79d7c49c/content/api/apidocs-4.8/domain_admin/deleteAccount.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/deleteAccount.html b/content/api/apidocs-4.8/domain_admin/deleteAccount.html new file mode 100644 index 0000000..1567bff --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/deleteAccount.html @@ -0,0 +1,79 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain 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/79d7c49c/content/api/apidocs-4.8/domain_admin/deleteAccountFromProject.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/deleteAccountFromProject.html b/content/api/apidocs-4.8/domain_admin/deleteAccountFromProject.html new file mode 100644 index 0000000..e929f07 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/deleteAccountFromProject.html @@ -0,0 +1,82 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain 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/79d7c49c/content/api/apidocs-4.8/domain_admin/deleteAffinityGroup.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/deleteAffinityGroup.html b/content/api/apidocs-4.8/domain_admin/deleteAffinityGroup.html new file mode 100644 index 0000000..a3e3ed6 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/deleteAffinityGroup.html @@ -0,0 +1,91 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain 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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/domain_admin/deleteAutoScalePolicy.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/deleteAutoScalePolicy.html b/content/api/apidocs-4.8/domain_admin/deleteAutoScalePolicy.html new file mode 100644 index 0000000..7b51439 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/deleteAutoScalePolicy.html @@ -0,0 +1,79 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain 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
+
+
+
+
+
+ +
+
+ +