Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 9532 invoked by uid 99); 12 May 2015 07:20:28 -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; Tue, 12 May 2015 07:20:28 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 3E657E17F2; Tue, 12 May 2015 07:20:28 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: sebgoa@apache.org To: commits@cloudstack.apache.org Date: Tue, 12 May 2015 07:20:55 -0000 Message-Id: <58bcd0055ee74717be8f2595013ebc5f@git.apache.org> In-Reply-To: <2584744b3895405fa98bef3e158d33b5@git.apache.org> References: <2584744b3895405fa98bef3e158d33b5@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [29/51] [partial] cloudstack-www git commit: Adding API html pages http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/createTemplate.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/createTemplate.html b/source/api/apidocs-4.0.0/root_admin/createTemplate.html new file mode 100644 index 0000000..56248bf --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/createTemplate.html @@ -0,0 +1,169 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

createTemplate

Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it.

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
displaytext	the display text of the template. This is usually used for display purposes.	true
name	the name of the template	true
ostypeid	the ID of the OS Type that best represents the OS of this template.	true
bits	32 or 64 bit	false
details	Template details in key/value pairs.	false
isfeatured	true if this template is a featured template, false otherwise	false
ispublic	true if this template is a public template, false otherwise	false
passwordenabled	true if the template supports the password reset feature; default is false	false
requireshvm	true if the template requres HVM, false otherwise	false
snapshotid	the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in	false
templatetag	the tag for this template.	false
url	Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server	false
virtualmachineid	Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal	false
volumeid	the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the ID of the storage pool
clusterid	the ID of the cluster for the storage pool
clustername	the name of the cluster for the storage pool
created	the date and time the storage pool was created
disksizeallocated	the host's currently allocated disk size
disksizetotal	the total disk size of the storage pool
disksizeused	the host's currently used disk size
ipaddress	the IP address of the storage pool
name	the name of the storage pool
path	the storage pool path
podid	the Pod ID of the storage pool
podname	the Pod name of the storage pool
state	the state of the storage pool
tags	the tags for the storage pool
type	the storage pool type
zoneid	the Zone ID of the storage pool
zonename	the Zone name of the storage pool
jobid	the ID of the latest async job acting on this object
jobstatus	the current status of the latest async job acting on this object

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/createUser.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/createUser.html b/source/api/apidocs-4.0.0/root_admin/createUser.html new file mode 100644 index 0000000..f2eac0f --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/createUser.html @@ -0,0 +1,139 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

createUser

Creates a user for an account that already exists

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
account	Creates the user under the specified account. If no account is specified, the username will be used as the account name.	true
email	email	true
firstname	firstname	true
lastname	lastname	true
password	Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.	true
username	Unique username.	true
domainid	Creates the user under the specified domain. Has to be accompanied with the account parameter	false
timezone	Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the user ID
account	the account name of the user
accountid	the account ID of the user
accounttype	the account type of the user
apikey	the api key of the user
created	the date and time the user account was created
domain	the domain name of the user
domainid	the domain ID of the user
email	the user email address
firstname	the user firstname
lastname	the user lastname
secretkey	the secret key of the user
state	the user state
timezone	the timezone user was created in
username	the user name

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/createVPC.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/createVPC.html b/source/api/apidocs-4.0.0/root_admin/createVPC.html new file mode 100644 index 0000000..0d252e1 --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/createVPC.html @@ -0,0 +1,355 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

createVPC

Creates a VPC

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
cidr	the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR	true
displaytext	the display text of the VPC	true
name	the name of the VPC	true
vpcofferingid	the ID of the VPC offering	true
zoneid	the ID of the availability zone	true
account	the account associated with the VPC. Must be used with the domainId parameter.	false
domainid	the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.	false
networkdomain	VPC network domain. All networks inside the VPC will belong to this domain	false
projectid	create VPC for the project	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the id of the VPC
account	the owner of the VPC
cidr	the cidr the VPC
created	the date this VPC was created
displaytext	an alternate display text of the VPC.
domain	the domain name of the owner
domainid	the domain id of the VPC owner
name	the name of the VPC
networkdomain	the network domain of the VPC
project	the project name of the VPC
projectid	the project id of the VPC
restartrequired	true VPC requires restart
state	state of the VPC. Can be Inactive/Enabled
vpcofferingid	vpc offering id the VPC is created from
zoneid	zone id of the vpc
zonename	the name of the zone the VPC belongs to
*network()**	the list of networks belongign to the VPC
id	the id of the network
account	the owner of the network
acltype	acl type - access type to the network
broadcastdomaintype	Broadcast domain type of the network
broadcasturi	broadcast uri of the network
canusefordeploy	list networks available for vm deployment
cidr	the cidr the network
displaytext	the displaytext of the network
dns1	the first DNS for the network
dns2	the second DNS for the network
domain	the domain name of the network owner
domainid	the domain id of the network owner
gateway	the network's gateway
isdefault	true if network is default, false otherwise
issystem	true if network is system, false otherwise
name	the name of the network
netmask	the network's netmask
networkdomain	the network domain
networkofferingavailability	availability of the network offering the network is created from
networkofferingdisplaytext	display text of the network offering the network is created from
networkofferingid	network offering id the network is created from
networkofferingname	name of the network offering the network is created from
physicalnetworkid	the physical network id
project	the project name of the address
projectid	the project id of the ipaddress
related	related to what other network configuration
restartrequired	true network requires restart
specifyipranges	true if network supports specifying ip ranges, false otherwise
state	state of the network
subdomainaccess	true if users from subdomains can access the domain level network
traffictype	the traffic type of the network
type	the type of the network
vlan	the vlan of the network
vpcid	VPC the network belongs to
zoneid	zone id of the network
zonename	the name of the zone the network belongs to
*service()**	the list of services
name	the service name
provider	the service provider name
capability(*)	the list of capabilities
*tags()**	the list of resource tags associated with network
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value
*service()**	the list of supported services
name	the service name
provider	the service provider name
*capability()**	the list of capabilities
canchooseservicecapability	can this service capability value can be choosable while creatine network offerings
name	the capability name
value	the capability value
*tags()**	the list of resource tags associated with the project
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/createVPCOffering.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/createVPCOffering.html b/source/api/apidocs-4.0.0/root_admin/createVPCOffering.html new file mode 100644 index 0000000..1e5e570 --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/createVPCOffering.html @@ -0,0 +1,118 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

createVPCOffering

Creates VPC offering

+ +

Request parameters

+ + + + + + + + + + + + + +

Parameter Name	Description	Required
displaytext	the display text of the vpc offering	true
name	the name of the vpc offering	true
supportedservices	services supported by the vpc offering	true

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the id of the vpc offering
created	the date this vpc offering was created
displaytext	an alternate display text of the vpc offering.
isdefault	true if vpc offering is default, false otherwise
name	the name of the vpc offering
state	state of the vpc offering. Can be Disabled/Enabled
*service()**	the list of supported services
name	the service name
provider	the service provider name
*capability()**	the list of capabilities
canchooseservicecapability	can this service capability value can be choosable while creatine network offerings
name	the capability name
value	the capability value

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/createVirtualRouterElement.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/createVirtualRouterElement.html b/source/api/apidocs-4.0.0/root_admin/createVirtualRouterElement.html new file mode 100644 index 0000000..3610818 --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/createVirtualRouterElement.html @@ -0,0 +1,97 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

createVirtualRouterElement

Create a virtual router element.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
nspid	the network service provider ID of the virtual router element	true

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the id of the router
account	the account associated with the provider
domain	the domain associated with the provider
domainid	the domain ID associated with the provider
enabled	Enabled/Disabled the service provider
nspid	the physical network service provider id of the provider
project	the project name of the address
projectid	the project id of the ipaddress

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/createVlanIpRange.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/createVlanIpRange.html b/source/api/apidocs-4.0.0/root_admin/createVlanIpRange.html new file mode 100644 index 0000000..ca1af34 --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/createVlanIpRange.html @@ -0,0 +1,163 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

createVlanIpRange

Creates a VLAN IP range.

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
startip	the beginning IP address in the VLAN IP range	true
account	account who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited	false
domainid	domain ID of the account owning a VLAN	false
endip	the ending IP address in the VLAN IP range	false
forvirtualnetwork	true if VLAN is of Virtual type, false if Direct	false
gateway	the gateway of the VLAN IP range	false
netmask	the netmask of the VLAN IP range	false
networkid	the network id	false
physicalnetworkid	the physical network id	false
podid	optional parameter. Have to be specified for Direct Untagged vlan only.	false
projectid	project who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited	false
vlan	the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged	false
zoneid	the Zone ID of the VLAN IP range	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the ID of the VLAN IP range
account	the account of the VLAN IP range
description	the description of the VLAN IP range
domain	the domain name of the VLAN IP range
domainid	the domain ID of the VLAN IP range
endip	the end ip of the VLAN IP range
forvirtualnetwork	the virtual network for the VLAN IP range
gateway	the gateway of the VLAN IP range
netmask	the netmask of the VLAN IP range
networkid	the network id of vlan range
physicalnetworkid	the physical network this belongs to
podid	the Pod ID for the VLAN IP range
podname	the Pod name for the VLAN IP range
project	the project name of the vlan range
projectid	the project id of the vlan range
startip	the start ip of the VLAN IP range
vlan	the ID or VID of the VLAN.
zoneid	the Zone ID of the VLAN IP range

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/createVolume.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/createVolume.html b/source/api/apidocs-4.0.0/root_admin/createVolume.html new file mode 100644 index 0000000..2a186b7 --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/createVolume.html @@ -0,0 +1,229 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating 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 Name	Description	Required
name	the name of the disk volume	true
account	the account associated with the disk volume. Must be used with the domainId parameter.	false
diskofferingid	the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.	false
domainid	the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.	false
projectid	the project associated with the volume. Mutually exclusive with account parameter	false
size	Arbitrary volume size	false
snapshotid	the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.	false
zoneid	the ID of the availability zone	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	ID of the disk volume
account	the account associated with the disk volume
attached	the date the volume was attached to a VM instance
created	the date the disk volume was created
destroyed	the boolean state of whether the volume is destroyed or not
deviceid	the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.
diskofferingdisplaytext	the display text of the disk offering
diskofferingid	ID of the disk offering
diskofferingname	name of the disk offering
domain	the domain associated with the disk volume
domainid	the ID of the domain associated with the disk volume
hypervisor	Hypervisor the volume belongs to
isextractable	true if the volume is extractable, false otherwise
name	name of the disk volume
project	the project name of the vpn
projectid	the project id of the vpn
serviceofferingdisplaytext	the display text of the service offering for root disk
serviceofferingid	ID of the service offering for root disk
serviceofferingname	name of the service offering for root disk
size	size of the disk volume
snapshotid	ID of the snapshot from which this volume was created
state	the state of the disk volume
status	the status of the volume
storage	name of the primary storage hosting the disk volume
storagetype	shared or local storage
type	type of the disk volume (ROOT or DATADISK)
virtualmachineid	id of the virtual machine
vmdisplayname	display name of the virtual machine
vmname	name of the virtual machine
vmstate	state of the virtual machine
zoneid	ID of the availability zone
zonename	name of the availability zone
*tags()**	the list of resource tags associated with volume
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value
jobid	the ID of the latest async job acting on this object
jobstatus	the current status of the latest async job acting on this object

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/createVpnConnection.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/createVpnConnection.html b/source/api/apidocs-4.0.0/root_admin/createVpnConnection.html new file mode 100644 index 0000000..c5783ad --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/createVpnConnection.html @@ -0,0 +1,136 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

createVpnConnection

Create site to site vpn connection

+ +

Request parameters

+ + + + + + + + + + +

Parameter Name	Description	Required
s2scustomergatewayid	id of the customer gateway	true
s2svpngatewayid	id of the vpn gateway	true

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the vpn gateway ID
account	the owner
cidrlist	guest cidr list of the customer gateway
created	the date and time the host was created
domain	the domain name of the owner
domainid	the domain id of the owner
dpd	if DPD is enabled for customer gateway
esplifetime	Lifetime of ESP SA of customer gateway
esppolicy	ESP policy of the customer gateway
gateway	public ip address id of the customer gateway
ikelifetime	Lifetime of IKE SA of customer gateway
ikepolicy	IKE policy of the customer gateway
ipsecpsk	IPsec Preshared-Key of the customer gateway
project	the project name
projectid	the project id
publicip	the public IP address
removed	the date and time the host was removed
s2scustomergatewayid	the customer gateway ID
s2svpngatewayid	the vpn gateway ID
state	State of vpn connection

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/createVpnCustomerGateway.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/createVpnCustomerGateway.html b/source/api/apidocs-4.0.0/root_admin/createVpnCustomerGateway.html new file mode 100644 index 0000000..f716229 --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/createVpnCustomerGateway.html @@ -0,0 +1,154 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

createVpnCustomerGateway

Creates site to site vpn customer gateway

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
cidrlist	guest cidr list of the customer gateway	true
esppolicy	ESP policy of the customer gateway	true
gateway	public ip address id of the customer gateway	true
ikepolicy	IKE policy of the customer gateway	true
ipsecpsk	IPsec Preshared-Key of the customer gateway	true
account	the account associated with the gateway. Must be used with the domainId parameter.	false
domainid	the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.	false
dpd	If DPD is enabled for VPN connection	false
esplifetime	Lifetime of phase 2 VPN connection to the customer gateway, in seconds	false
ikelifetime	Lifetime of phase 1 VPN connection to the customer gateway, in seconds	false
name	name of this customer gateway	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the vpn gateway ID
account	the owner
cidrlist	guest cidr list of the customer gateway
domain	the domain name of the owner
domainid	the domain id of the owner
dpd	if DPD is enabled for customer gateway
esplifetime	Lifetime of ESP SA of customer gateway
esppolicy	IPsec policy of customer gateway
gateway	public ip address id of the customer gateway
ikelifetime	Lifetime of IKE SA of customer gateway
ikepolicy	IKE policy of customer gateway
ipaddress	guest ip of the customer gateway
ipsecpsk	IPsec preshared-key of customer gateway
name	name of the customer gateway
project	the project name
projectid	the project id
removed	the date and time the host was removed

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/createVpnGateway.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/createVpnGateway.html b/source/api/apidocs-4.0.0/root_admin/createVpnGateway.html new file mode 100644 index 0000000..a845fac --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/createVpnGateway.html @@ -0,0 +1,100 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

createVpnGateway

Creates site to site vpn local gateway

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
vpcid	public ip address id of the vpn gateway	true

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the vpn gateway ID
account	the owner
domain	the domain name of the owner
domainid	the domain id of the owner
project	the project name
projectid	the project id
publicip	the public IP address
removed	the date and time the host was removed
vpcid	the vpc id of this gateway

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/createZone.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/createZone.html b/source/api/apidocs-4.0.0/root_admin/createZone.html new file mode 100644 index 0000000..2e1c768 --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/createZone.html @@ -0,0 +1,196 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

createZone

Creates a Zone.

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
dns1	the first DNS for the Zone	true
internaldns1	the first internal DNS for the Zone	true
name	the name of the Zone	true
networktype	network type of the zone, can be Basic or Advanced	true
allocationstate	Allocation state of this Zone for allocation of new resources	false
dns2	the second DNS for the Zone	false
domain	Network domain name for the networks in the zone	false
domainid	the ID of the containing domain, null for public zones	false
guestcidraddress	the guest CIDR address for the Zone	false
internaldns2	the second internal DNS for the Zone	false
localstorageenabled	true if local storage offering enabled, false otherwise	false
securitygroupenabled	true if network is security group enabled, false otherwise	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	Zone id
allocationstate	the allocation state of the cluster
description	Zone description
dhcpprovider	the dhcp Provider for the Zone
displaytext	the display text of the zone
dns1	the first DNS for the Zone
dns2	the second DNS for the Zone
domain	Network domain name for the networks in the zone
domainid	the ID of the containing domain, null for public zones
domainname	the name of the containing domain, null for public zones
guestcidraddress	the guest CIDR address for the Zone
internaldns1	the first internal DNS for the Zone
internaldns2	the second internal DNS for the Zone
localstorageenabled	true if local storage offering enabled, false otherwise
name	Zone name
networktype	the network type of the zone; can be Basic or Advanced
securitygroupsenabled	true if security groups support is enabled, false otherwise
vlan	the vlan range of the zone
zonetoken	Zone Token
*capacity()**	the capacity of the Zone
capacitytotal	the total capacity available
capacityused	the capacity currently in use
clusterid	the Cluster ID
clustername	the Cluster name
percentused	the percentage of capacity currently in use
podid	the Pod ID
podname	the Pod name
type	the capacity type
zoneid	the Zone ID
zonename	the Zone name

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/deleteAccount.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/deleteAccount.html b/source/api/apidocs-4.0.0/root_admin/deleteAccount.html new file mode 100644 index 0000000..4b77dee --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/deleteAccount.html @@ -0,0 +1,79 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

deleteAccount

Deletes a account, and all users associated with this account

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	Account id	true

Response Tags

+ + + + + + + + + + +

Response Name	Description
displaytext	any text associated with the success or failure
success	true if operation is executed successfully

+ +