X-Mailer: ASF-Git Admin Mailer Subject: [35/50] [abbrv] cloudstack-www git commit: site build for 4.9.0 archived-at: Fri, 12 Aug 2016 00:38:11 -0000 http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/97caa4e4/content/api/apidocs-4.9/apis/deleteVlanIpRange.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/deleteVlanIpRange.html b/content/api/apidocs-4.9/apis/deleteVlanIpRange.html new file mode 100644 index 0000000..5d10ec1 --- /dev/null +++ b/content/api/apidocs-4.9/apis/deleteVlanIpRange.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

deleteVlanIpRange

Creates a VLAN IP range.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	the id of the VLAN IP range	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/97caa4e4/content/api/apidocs-4.9/apis/deleteVolume.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/deleteVolume.html b/content/api/apidocs-4.9/apis/deleteVolume.html new file mode 100644 index 0000000..8996a59 --- /dev/null +++ b/content/api/apidocs-4.9/apis/deleteVolume.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

deleteVolume

Deletes a detached disk volume.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	The ID of the disk volume	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/97caa4e4/content/api/apidocs-4.9/apis/deleteVpnConnection.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/deleteVpnConnection.html b/content/api/apidocs-4.9/apis/deleteVpnConnection.html new file mode 100644 index 0000000..7b119ce --- /dev/null +++ b/content/api/apidocs-4.9/apis/deleteVpnConnection.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

deleteVpnConnection

Delete site to site vpn connection

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	id of vpn connection	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/97caa4e4/content/api/apidocs-4.9/apis/deleteVpnCustomerGateway.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/deleteVpnCustomerGateway.html b/content/api/apidocs-4.9/apis/deleteVpnCustomerGateway.html new file mode 100644 index 0000000..2c6f5d3 --- /dev/null +++ b/content/api/apidocs-4.9/apis/deleteVpnCustomerGateway.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

deleteVpnCustomerGateway

Delete site to site vpn customer gateway

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	id of customer gateway	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/97caa4e4/content/api/apidocs-4.9/apis/deleteVpnGateway.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/deleteVpnGateway.html b/content/api/apidocs-4.9/apis/deleteVpnGateway.html new file mode 100644 index 0000000..23d201f --- /dev/null +++ b/content/api/apidocs-4.9/apis/deleteVpnGateway.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

deleteVpnGateway

Delete site to site vpn gateway

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	id of customer gateway	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/97caa4e4/content/api/apidocs-4.9/apis/deleteZone.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/deleteZone.html b/content/api/apidocs-4.9/apis/deleteZone.html new file mode 100644 index 0000000..522a81d --- /dev/null +++ b/content/api/apidocs-4.9/apis/deleteZone.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

deleteZone

Deletes a Zone.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	the ID of the Zone	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/97caa4e4/content/api/apidocs-4.9/apis/deployVirtualMachine.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/deployVirtualMachine.html b/content/api/apidocs-4.9/apis/deployVirtualMachine.html new file mode 100644 index 0000000..f318d98 --- /dev/null +++ b/content/api/apidocs-4.9/apis/deployVirtualMachine.html @@ -0,0 +1,583 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

deployVirtualMachine

Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.

+ +

Request parameters

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

Parameter Name	Description	Required
serviceofferingid	the ID of the service offering for the virtual machine	true
templateid	the ID of the template for the virtual machine	true
zoneid	availability zone for the virtual machine	true
account	an optional account for the virtual machine. Must be used with domainId.	false
affinitygroupids	comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter	false
affinitygroupnames	comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter	false
customid	an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only	false
deploymentplanner	Deployment planner to use for vm allocation. Available to ROOT admin only	false
details	used to specify the custom parameters.	false
diskofferingid	the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.	false
displayname	an optional user generated name for the virtual machine	false
displayvm	an optional field, whether to the display the vm to the end user or not.	false
domainid	an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.	false
group	an optional group for the virtual machine	false
hostid	destination Host ID to deploy the VM to - parameter available for root admin only	false
hypervisor	the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call	false
ip6address	the ipv6 address for default vm's network	false
ipaddress	the ip address for default vm's network	false
iptonetworklist	ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid - requests to use ip 10.10.10.11 in network id=uuid	false
keyboard	an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us	false
keypair	name of the ssh key pair used to login to the virtual machine	false
name	host name for the virtual machine	false
networkids	list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter	false
projectid	Deploy vm for the project	false
rootdisksize	Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided	false
securitygroupids	comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter	false
securitygroupnames	comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter	false
size	the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId	false
startvm	true if start vm after creating; defaulted to true if not specified	false
userdata	an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 2KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 32K of data after base64 encoding.	false

Response Tags

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

Response Name	Description
id	the ID of the virtual machine
account	the account associated with the virtual machine
cpunumber	the number of cpu this virtual machine is running with
cpuspeed	the speed of each cpu
cpuused	the amount of the vm's CPU currently used
created	the date when this virtual machine was created
details	Vm details in key/value pairs.
diskioread	the read (io) of disk on the vm
diskiowrite	the write (io) of disk on the vm
diskkbsread	the read (bytes) of disk on the vm
diskkbswrite	the write (bytes) of disk on the vm
diskofferingid	the ID of the disk offering of the virtual machine
diskofferingname	the name of the disk offering of the virtual machine
displayname	user generated name. The name of the virtual machine is returned if no displayname exists.
displayvm	an optional field whether to the display the vm to the end user or not.
domain	the name of the domain in which the virtual machine exists
domainid	the ID of the domain in which the virtual machine exists
forvirtualnetwork	the virtual network for the service offering
group	the group name of the virtual machine
groupid	the group ID of the virtual machine
guestosid	Os type ID of the virtual machine
haenable	true if high-availability is enabled, false otherwise
hostid	the ID of the host for the virtual machine
hostname	the name of the host for the virtual machine
hypervisor	the hypervisor on which the template runs
instancename	instance name of the user vm; this parameter is returned to the ROOT admin only
isdynamicallyscalable	true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.
isodisplaytext	an alternate display text of the ISO attached to the virtual machine
isoid	the ID of the ISO attached to the virtual machine
isoname	the name of the ISO attached to the virtual machine
keypair	ssh key-pair
memory	the memory allocated for the virtual machine
memoryintfreekbs	the internal memory thats free in vm
memorykbs	the memory used by the vm
memorytargetkbs	the target memory in vm
name	the name of the virtual machine
networkkbsread	the incoming network traffic on the vm
networkkbswrite	the outgoing network traffic on the host
ostypeid	OS type id of the vm
password	the password (if exists) of the virtual machine
passwordenabled	true if the password rest feature is enabled, false otherwise
project	the project name of the vm
projectid	the project id of the vm
publicip	public IP address id associated with vm via Static nat rule
publicipid	public IP address id associated with vm via Static nat rule
rootdeviceid	device ID of the root volume
rootdevicetype	device type of the root volume
serviceofferingid	the ID of the service offering of the virtual machine
serviceofferingname	the name of the service offering of the virtual machine
servicestate	State of the Service from LB rule
state	the state of the virtual machine
templatedisplaytext	an alternate display text of the template for the virtual machine
templateid	the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.
templatename	the name of the template for the virtual machine
userid	the user's ID who deployed the virtual machine
username	the user's name who deployed the virtual machine
vgpu	the vgpu type used by the virtual machine
zoneid	the ID of the availablility zone for the virtual machine
zonename	the name of the availability zone for the virtual machine
*affinitygroup()**	list of affinity groups associated with the virtual machine
id	the ID of the affinity group
account	the account owning the affinity group
description	the description of the affinity group
domain	the domain name of the affinity group
domainid	the domain ID of the affinity group
name	the name of the affinity group
project	the project name of the affinity group
projectid	the project ID of the affinity group
type	the type of the affinity group
virtualmachineIds	virtual machine IDs associated with this affinity group
*nic()**	the list of nics associated with vm
id	the ID of the nic
broadcasturi	the broadcast uri of the nic
deviceid	device id for the network when plugged into the virtual machine
gateway	the gateway of the nic
ip6address	the IPv6 address of network
ip6cidr	the cidr of IPv6 network
ip6gateway	the gateway of IPv6 network
ipaddress	the ip address of the nic
isdefault	true if nic is default, false otherwise
isolationuri	the isolation uri of the nic
macaddress	true if nic is default, false otherwise
netmask	the netmask of the nic
networkid	the ID of the corresponding network
networkname	the name of the corresponding network
nsxlogicalswitch	Id of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchport	Id of the NSX Logical Switch Port (if NSX based), null otherwise
secondaryip	the Secondary ipv4 addr of nic
traffictype	the traffic type of the nic
type	the type of the nic
virtualmachineid	Id of the vm to which the nic belongs
*securitygroup()**	list of security groups associated with the virtual machine
id	the ID of the security group
account	the account owning the security group
description	the description of the security group
domain	the domain name of the security group
domainid	the domain ID of the security group
name	the name of the security group
project	the project name of the group
projectid	the project id of the group
virtualmachinecount	the number of virtualmachines associated with this securitygroup
virtualmachineids	the list of virtualmachine ids associated with this securitygroup
*egressrule()**	the list of egress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group rule
tags(*)	the list of resource tags associated with the rule
*ingressrule()**	the list of ingress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group rule
tags(*)	the list of resource tags associated with the rule
*tags()**	the list of resource tags associated with the rule
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
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/97caa4e4/content/api/apidocs-4.9/apis/destroyLunOnFiler.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/destroyLunOnFiler.html b/content/api/apidocs-4.9/apis/destroyLunOnFiler.html new file mode 100644 index 0000000..7a82909 --- /dev/null +++ b/content/api/apidocs-4.9/apis/destroyLunOnFiler.html @@ -0,0 +1,79 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

destroyLunOnFiler

Destroy a LUN

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
path	LUN path.	true

Response Tags

+ + + + +

Response Name

Description

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/97caa4e4/content/api/apidocs-4.9/apis/destroyRouter.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/destroyRouter.html b/content/api/apidocs-4.9/apis/destroyRouter.html new file mode 100644 index 0000000..b92d3fb --- /dev/null +++ b/content/api/apidocs-4.9/apis/destroyRouter.html @@ -0,0 +1,277 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

destroyRouter

Destroys a router.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	the ID of the router	true

Response Tags

Response Name	Description
id	the id of the router
account	the account associated with the router
created	the date and time the router was created
dns1	the first DNS for the router
dns2	the second DNS for the router
domain	the domain associated with the router
domainid	the domain ID associated with the router
gateway	the gateway for the router
guestipaddress	the guest IP address for the router
guestmacaddress	the guest MAC address for the router
guestnetmask	the guest netmask for the router
guestnetworkid	the ID of the corresponding guest network
guestnetworkname	the name of the corresponding guest network
hostid	the host ID for the router
hostname	the hostname for the router
hypervisor	the hypervisor on which the template runs
ip6dns1	the first IPv6 DNS for the router
ip6dns2	the second IPv6 DNS for the router
isredundantrouter	if this router is an redundant virtual router
linklocalip	the link local IP address for the router
linklocalmacaddress	the link local MAC address for the router
linklocalnetmask	the link local netmask for the router
linklocalnetworkid	the ID of the corresponding link local network
name	the name of the router
networkdomain	the network domain for the router
podid	the Pod ID for the router
project	the project name of the address
projectid	the project id of the ipaddress
publicip	the public IP address for the router
publicmacaddress	the public MAC address for the router
publicnetmask	the public netmask for the router
publicnetworkid	the ID of the corresponding public network
redundantstate	the state of redundant virtual router
requiresupgrade	true if the router template requires upgrader
role	role of the domain router
scriptsversion	the version of scripts
serviceofferingid	the ID of the service offering of the virtual machine
serviceofferingname	the name of the service offering of the virtual machine
state	the state of the router
templateid	the template ID for the router
version	the version of template
vpcid	VPC the router belongs to
vpcname	the name of VPC the router belongs to
zoneid	the Zone ID for the router
zonename	the Zone name for the router
*nic()**	the list of nics associated with the router
id	the ID of the nic
broadcasturi	the broadcast uri of the nic
deviceid	device id for the network when plugged into the virtual machine
gateway	the gateway of the nic
ip6address	the IPv6 address of network
ip6cidr	the cidr of IPv6 network
ip6gateway	the gateway of IPv6 network
ipaddress	the ip address of the nic
isdefault	true if nic is default, false otherwise
isolationuri	the isolation uri of the nic
macaddress	true if nic is default, false otherwise
netmask	the netmask of the nic
networkid	the ID of the corresponding network
networkname	the name of the corresponding network
nsxlogicalswitch	Id of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchport	Id of the NSX Logical Switch Port (if NSX based), null otherwise
secondaryip	the Secondary ipv4 addr of nic
traffictype	the traffic type of the nic
type	the type of the nic
virtualmachineid	Id of the vm to which the nic belongs

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/97caa4e4/content/api/apidocs-4.9/apis/destroySystemVm.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/destroySystemVm.html b/content/api/apidocs-4.9/apis/destroySystemVm.html new file mode 100644 index 0000000..0940520 --- /dev/null +++ b/content/api/apidocs-4.9/apis/destroySystemVm.html @@ -0,0 +1,163 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

destroySystemVm

Destroyes a system virtual machine.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	The ID of the system virtual machine	true

Response Tags

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

Response Name	Description
id	the ID of the system VM
activeviewersessions	the number of active console sessions for the console proxy system vm
created	the date and time the system VM was created
dns1	the first DNS for the system VM
dns2	the second DNS for the system VM
gateway	the gateway for the system VM
hostid	the host ID for the system VM
hostname	the hostname for the system VM
hypervisor	the hypervisor on which the template runs
jobid	the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.
jobstatus	the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.
linklocalip	the link local IP address for the system vm
linklocalmacaddress	the link local MAC address for the system vm
linklocalnetmask	the link local netmask for the system vm
name	the name of the system VM
networkdomain	the network domain for the system VM
podid	the Pod ID for the system VM
privateip	the private IP address for the system VM
privatemacaddress	the private MAC address for the system VM
privatenetmask	the private netmask for the system VM
publicip	the public IP address for the system VM
publicmacaddress	the public MAC address for the system VM
publicnetmask	the public netmask for the system VM
state	the state of the system VM
systemvmtype	the system VM type
templateid	the template ID for the system VM
zoneid	the Zone ID for the system VM
zonename	the Zone name for the system VM

+ +