Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 88259 invoked by uid 99); 17 Feb 2016 02:22:31 -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:31 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 95038E0C68; Wed, 17 Feb 2016 02:22:31 +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:22:49 -0000 Message-Id: <4333cdf88d9047bd88117d2f84184e41@git.apache.org> In-Reply-To: <1d6b7f4149b145f39313a6a6c9d7bb76@git.apache.org> References: <1d6b7f4149b145f39313a6a6c9d7bb76@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [19/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/root_admin/addF5LoadBalancer.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/addF5LoadBalancer.html b/content/api/apidocs-4.8/root_admin/addF5LoadBalancer.html new file mode 100644 index 0000000..8029a9e --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/addF5LoadBalancer.html @@ -0,0 +1,121 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

addF5LoadBalancer

Adds a F5 BigIP load balancer device

+ +

Request parameters

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

Parameter Name	Description	Required
networkdevicetype	supports only F5BigIpLoadBalancer	true
password	Credentials to reach F5 BigIP load balancer device	true
physicalnetworkid	the Physical Network ID	true
url	URL of the F5 load balancer appliance.	true
username	Credentials to reach F5 BigIP load balancer device	true

Response Tags

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

Response Name	Description
ipaddress	the management IP address of the external load balancer
lbdevicecapacity	device capacity
lbdevicededicated	true if device is dedicated for an account
lbdeviceid	device id of the F5 load balancer
lbdevicename	device name
lbdevicestate	device state
physicalnetworkid	the physical network to which this F5 device belongs to
privateinterface	the private interface of the load balancer
provider	name of the provider
publicinterface	the public interface of the load balancer

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/addGloboDnsHost.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/addGloboDnsHost.html b/content/api/apidocs-4.8/root_admin/addGloboDnsHost.html new file mode 100644 index 0000000..93bffa0 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/addGloboDnsHost.html @@ -0,0 +1,94 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

addGloboDnsHost

Adds the GloboDNS external host

+ +

Request parameters

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

Parameter Name	Description	Required
password	Password for GloboDNS	true
physicalnetworkid	the Physical Network ID	true
url	GloboDNS url	true
username	Username for GloboDNS	true

Response Tags

+ + + + + + + + + + +

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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/addGuestOs.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/addGuestOs.html b/content/api/apidocs-4.8/root_admin/addGuestOs.html new file mode 100644 index 0000000..d28208b --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/addGuestOs.html @@ -0,0 +1,97 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

addGuestOs

Add a new guest OS type

+ +

Request parameters

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

Parameter Name	Description	Required
oscategoryid	ID of Guest OS category	true
osdisplayname	Unique display name for Guest OS	true
name	Optional name for Guest OS	false

Response Tags

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

Response Name	Description
id	the ID of the OS type
description	the name/description of the OS type
isuserdefined	is the guest OS user defined
oscategoryid	the ID of the OS category

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/addGuestOsMapping.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/addGuestOsMapping.html b/content/api/apidocs-4.8/root_admin/addGuestOsMapping.html new file mode 100644 index 0000000..8c9fe0e --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/addGuestOsMapping.html @@ -0,0 +1,112 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

addGuestOsMapping

Adds a guest OS name to hypervisor OS name mapping

+ +

Request parameters

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

Parameter Name	Description	Required
hypervisor	Hypervisor type. One of : XenServer, KVM, VMWare	true
hypervisorversion	Hypervisor version to create the mapping for. Use 'default' for default versions	true
osnameforhypervisor	OS name specific to the hypervisor	true
osdisplayname	Display Name of Guest OS standard type. Either Display Name or UUID must be passed	false
ostypeid	UUID of Guest OS type. Either the UUID or Display Name must be passed	false

Response Tags

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

Response Name	Description
id	the ID of the Guest OS mapping
hypervisor	the hypervisor
hypervisorversion	version of the hypervisor for mapping
isuserdefined	is the mapping user defined
osdisplayname	standard display name for the Guest OS
osnameforhypervisor	hypervisor specific name for the Guest OS
ostypeid	the ID of the Guest OS type

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/addHost.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/addHost.html b/content/api/apidocs-4.8/root_admin/addHost.html new file mode 100644 index 0000000..3d3b10d --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/addHost.html @@ -0,0 +1,280 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

addHost

Adds a new host.

+ +

Request parameters

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

Parameter Name	Description	Required
hypervisor	hypervisor type of the host	true
password	the password for the host	true
podid	the Pod ID for the host	true
url	the host URL	true
username	the username for the host	true
zoneid	the Zone ID for the host	true
allocationstate	Allocation state of this Host for allocation of new resources	false
clusterid	the cluster ID for the host	false
clustername	the cluster name for the host	false
hosttags	list of tags to be added to the host	false

Response Tags

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

Response Name	Description
id	the ID of the host
averageload	the cpu average load on the host
capabilities	capabilities of the host
clusterid	the cluster ID of the host
clustername	the cluster name of the host
clustertype	the cluster type of the cluster that host belongs to
cpuallocated	the amount of the host's CPU currently allocated
cpunumber	the CPU number of the host
cpusockets	the number of CPU sockets on the host
cpuspeed	the CPU speed of the host
cpuused	the amount of the host's CPU currently used
cpuwithoverprovisioning	the amount of the host's CPU after applying the cpu.overprovisioning.factor
created	the date and time the host was created
details	Host details in key/value pairs.
disconnected	true if the host is disconnected. False otherwise.
disksizeallocated	the host's currently allocated disk size
disksizetotal	the total disk size of the host
events	events available for the host
hahost	true if the host is Ha host (dedicated to vms started by HA process; false otherwise
hasenoughcapacity	true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise
hosttags	comma-separated list of tags for the host
hypervisor	the host hypervisor
hypervisorversion	the hypervisor version
ipaddress	the IP address of the host
islocalstorageactive	true if local storage is active, false otherwise
lastpinged	the date and time the host was last pinged
managementserverid	the management server ID of the host
memoryallocated	the amount of the host's memory currently allocated
memorytotal	the memory total of the host
memoryused	the amount of the host's memory currently used
name	the name of the host
networkkbsread	the incoming network traffic on the host
networkkbswrite	the outgoing network traffic on the host
oscategoryid	the OS category ID of the host
oscategoryname	the OS category name of the host
podid	the Pod ID of the host
podname	the Pod name of the host
removed	the date and time the host was removed
resourcestate	the resource state of the host
state	the state of the host
suitableformigration	true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise
type	the host type
version	the host version
zoneid	the Zone ID of the host
zonename	the Zone name of the host
*gpugroup()**	GPU cards present in the host
gpugroupname	GPU cards present in the host
*vgpu()**	the list of enabled vGPUs
maxcapacity	Maximum vgpu can be created with this vgpu type on the given gpu group
maxheads	Maximum displays per user
maxresolutionx	Maximum X resolution per display
maxresolutiony	Maximum Y resolution per display
maxvgpuperpgpu	Maximum no. of vgpu per gpu card (pgpu)
remainingcapacity	Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type
vgputype	Model Name of vGPU
videoram	Video RAM for this vGPU type
jobid	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/79d7c49c/content/api/apidocs-4.8/root_admin/addImageStore.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/addImageStore.html b/content/api/apidocs-4.8/root_admin/addImageStore.html new file mode 100644 index 0000000..63c0a87 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/addImageStore.html @@ -0,0 +1,118 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

addImageStore

Adds backup image store.

+ +

Request parameters

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

Parameter Name	Description	Required
provider	the image store provider name	true
details	the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss	false
name	the name for the image store	false
url	the URL for the image store	false
zoneid	the Zone ID for the image store	false

Response Tags

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

Response Name	Description
id	the ID of the image store
details	the details of the image store
name	the name of the image store
protocol	the protocol of the image store
providername	the provider name of the image store
scope	the scope of the image store
url	the url of the image store
zoneid	the Zone ID of the image store
zonename	the Zone name of the image store

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/addImageStoreS3.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/addImageStoreS3.html b/content/api/apidocs-4.8/root_admin/addImageStoreS3.html new file mode 100644 index 0000000..3536551 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/addImageStoreS3.html @@ -0,0 +1,136 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

addImageStoreS3

Adds S3 Image Store

+ +

Request parameters

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

Parameter Name	Description	Required
accesskey	S3 access key	true
bucket	Name of the storage bucket	true
endpoint	S3 endpoint	true
secretkey	S3 secret key	true
connectiontimeout	Connection timeout (milliseconds)	false
connectionttl	Connection TTL (milliseconds)	false
maxerrorretry	Maximum number of times to retry on error	false
s3signer	Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType	false
sockettimeout	Socket timeout (milliseconds)	false
usehttps	Use HTTPS instead of HTTP	false
usetcpkeepalive	Whether TCP keep-alive is used	false

Response Tags

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

Response Name	Description
id	the ID of the image store
details	the details of the image store
name	the name of the image store
protocol	the protocol of the image store
providername	the provider name of the image store
scope	the scope of the image store
url	the url of the image store
zoneid	the Zone ID of the image store
zonename	the Zone name of the image store

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/addIpToNic.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/addIpToNic.html b/content/api/apidocs-4.8/root_admin/addIpToNic.html new file mode 100644 index 0000000..01d4533 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/addIpToNic.html @@ -0,0 +1,97 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

addIpToNic

Assigns secondary IP to NIC

+ +

Request parameters

+ + + + + + + + + + +

Parameter Name	Description	Required
nicid	the ID of the nic to which you want to assign private IP	true
ipaddress	Secondary IP Address	false

Response Tags

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

Response Name	Description
id	the ID of the secondary private IP addr
ipaddress	Secondary IP address
networkid	the ID of the network
nicid	the ID of the nic
virtualmachineid	the ID of the vm

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/addLdapConfiguration.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/addLdapConfiguration.html b/content/api/apidocs-4.8/root_admin/addLdapConfiguration.html new file mode 100644 index 0000000..484512f --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/addLdapConfiguration.html @@ -0,0 +1,88 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

addLdapConfiguration

Add a new Ldap Configuration

+ +

Request parameters

+ + + + + + + + + + +

Parameter Name	Description	Required
hostname	Hostname	true
port	Port	true

Response Tags

+ + + + + + + + + + +

Response Name	Description
hostname	hostname
port	port

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/addNetscalerLoadBalancer.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/addNetscalerLoadBalancer.html b/content/api/apidocs-4.8/root_admin/addNetscalerLoadBalancer.html new file mode 100644 index 0000000..2125723 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/addNetscalerLoadBalancer.html @@ -0,0 +1,148 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

addNetscalerLoadBalancer

Adds a netscaler load balancer device

+ +

Request parameters

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

Parameter Name	Description	Required
networkdevicetype	Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer	true
password	Credentials to reach netscaler load balancer device	true
physicalnetworkid	the Physical Network ID	true
url	URL of the netscaler load balancer appliance.	true
username	Credentials to reach netscaler load balancer device	true
gslbprovider	true if NetScaler device being added is for providing GSLB service	false
gslbproviderprivateip	public IP of the site	false
gslbproviderpublicip	public IP of the site	false
isexclusivegslbprovider	true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB	false

Response Tags

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

Response Name	Description
gslbprovider	true if NetScaler device is provisioned to be a GSLB service provider
gslbproviderprivateip	private IP of the NetScaler representing GSLB site
gslbproviderpublicip	public IP of the NetScaler representing GSLB site
ipaddress	the management IP address of the external load balancer
isexclusivegslbprovider	true if NetScaler device is provisioned exclusively to be a GSLB service provider
lbdevicecapacity	device capacity
lbdevicededicated	true if device is dedicated for an account
lbdeviceid	device id of the netscaler load balancer
lbdevicename	device name
lbdevicestate	device state
physicalnetworkid	the physical network to which this netscaler device belongs to
podids	Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.
privateinterface	the private interface of the load balancer
provider	name of the provider
publicinterface	the public interface of the load balancer

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/addNetworkDevice.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/addNetworkDevice.html b/content/api/apidocs-4.8/root_admin/addNetworkDevice.html new file mode 100644 index 0000000..e0045e8 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/addNetworkDevice.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

addNetworkDevice

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

+ +

Request parameters

+ + + + + + + + + + +

Parameter Name	Description	Required
networkdeviceparameterlist	parameters for network device	false
networkdevicetype	Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall	false

Response Tags

+ + + + + + + +

Response Name	Description
id	the ID of the network device

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/addNetworkServiceProvider.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/addNetworkServiceProvider.html b/content/api/apidocs-4.8/root_admin/addNetworkServiceProvider.html new file mode 100644 index 0000000..7664629 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/addNetworkServiceProvider.html @@ -0,0 +1,109 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

addNetworkServiceProvider

Adds a network serviceProvider to a physical network

+ +

Request parameters

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

Parameter Name	Description	Required
name	the name for the physical network service provider	true
physicalnetworkid	the Physical Network ID to add the provider to	true
destinationphysicalnetworkid	the destination Physical Network ID to bridge to	false
servicelist	the list of services to be enabled for this physical network service provider	false

Response Tags

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

Response Name	Description
id	uuid of the network provider
canenableindividualservice	true if individual services can be enabled/disabled
destinationphysicalnetworkid	the destination physical network
name	the provider name
physicalnetworkid	the physical network this belongs to
servicelist	services for this provider
state	state of the network provider

+ +