X-Mailer: ASF-Git Admin Mailer Subject: [16/51] [partial] cloudstack-www git commit: 4.8.0 with APIs, change copyright date to 2016 http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/attachIso.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/attachIso.html b/source/api/apidocs-4.8/root_admin/attachIso.html new file mode 100644 index 0000000..f9acc9c --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/attachIso.html @@ -0,0 +1,523 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

attachIso

Attaches an ISO to a virtual machine.

+ +

Request parameters

+ + + + + + + + + + +

Parameter Name	Description	Required
id	the ID of the ISO file	true
virtualmachineid	the ID of the virtual machine	true

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
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
*tags()**	the list of resource tags associated with vm
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/51c4e97e/source/api/apidocs-4.8/root_admin/attachVolume.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/attachVolume.html b/source/api/apidocs-4.8/root_admin/attachVolume.html new file mode 100644 index 0000000..7e444c1 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/attachVolume.html @@ -0,0 +1,274 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

attachVolume

Attaches a disk volume to a virtual machine.

+ +

Request parameters

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

Parameter Name	Description	Required
id	the ID of the disk volume	true
virtualmachineid	the ID of the virtual machine	true
deviceid	the ID of the device to map the volume to within the guest OS. If no deviceId is passed in, the next available deviceId will be chosen. Possible values for a Linux OS are:* 0 - /dev/xvda* 1 - /dev/xvdb* 2 - /dev/xvdc* 4 - /dev/xvde* 5 - /dev/xvdf* 6 - /dev/xvdg* 7 - /dev/xvdh* 8 - /dev/xvdi* 9 - /dev/xvdj	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
chaininfo	the chain info of the volume
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.
diskBytesReadRate	bytes read rate of the disk volume
diskBytesWriteRate	bytes write rate of the disk volume
diskIopsReadRate	io requests read rate of the disk volume
diskIopsWriteRate	io requests write rate of the disk volume
diskofferingdisplaytext	the display text of the disk offering
diskofferingid	ID of the disk offering
diskofferingname	name of the disk offering
displayvolume	an optional field whether to the display the volume to the end user or not.
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
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
maxiops	max iops of the disk volume
miniops	min iops of the disk volume
name	name of the disk volume
path	the path of the volume
project	the project name of the vpn
projectid	the project id of the vpn
provisioningtype	provisioning type used to create volumes.
quiescevm	need quiesce vm or not when taking snapshot
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
storageid	id of the primary storage hosting the disk volume; returned to admin user only
storagetype	shared or local storage
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
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/51c4e97e/source/api/apidocs-4.8/root_admin/authorizeSamlSso.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/authorizeSamlSso.html b/source/api/apidocs-4.8/root_admin/authorizeSamlSso.html new file mode 100644 index 0000000..43fa44c --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/authorizeSamlSso.html @@ -0,0 +1,91 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

authorizeSamlSso

Allow or disallow a user to use SAML SSO

+ +

Request parameters

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

Parameter Name	Description	Required
enable	If true, authorizes user to be able to use SAML for Single Sign. If False, disable user to user SAML SSO.	true
userid	User uuid	true
entityid	The Identity Provider ID the user is allowed to get single signed on from	false

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/51c4e97e/source/api/apidocs-4.8/root_admin/authorizeSecurityGroupEgress.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/authorizeSecurityGroupEgress.html b/source/api/apidocs-4.8/root_admin/authorizeSecurityGroupEgress.html new file mode 100644 index 0000000..dda05fc --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/authorizeSecurityGroupEgress.html @@ -0,0 +1,172 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

authorizeSecurityGroupEgress

Authorizes a particular egress rule for this security group

+ +

Request parameters

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

Parameter Name	Description	Required
account	an optional account for the security group. Must be used with domainId.	false
cidrlist	the cidr list associated	false
domainid	an optional domainId for the security group. If the account parameter is used, domainId must also be used.	false
endport	end port for this egress rule	false
icmpcode	error code for this icmp message	false
icmptype	type of the icmp message being sent	false
projectid	an optional project of the security group	false
protocol	TCP is default. UDP is the other supported protocol	false
securitygroupid	The ID of the security group. Mutually exclusive with securityGroupName parameter	false
securitygroupname	The name of the security group. Mutually exclusive with securityGroupId parameter	false
startport	start port for this egress rule	false
usersecuritygrouplist	user to security group mapping	false

Response Tags

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

Response Name	Description
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
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/51c4e97e/source/api/apidocs-4.8/root_admin/authorizeSecurityGroupIngress.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/authorizeSecurityGroupIngress.html b/source/api/apidocs-4.8/root_admin/authorizeSecurityGroupIngress.html new file mode 100644 index 0000000..40301b8 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/authorizeSecurityGroupIngress.html @@ -0,0 +1,172 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

authorizeSecurityGroupIngress

Authorizes a particular ingress rule for this security group

+ +

Request parameters

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

Parameter Name	Description	Required
account	an optional account for the security group. Must be used with domainId.	false
cidrlist	the cidr list associated	false
domainid	an optional domainId for the security group. If the account parameter is used, domainId must also be used.	false
endport	end port for this ingress rule	false
icmpcode	error code for this icmp message	false
icmptype	type of the icmp message being sent	false
projectid	an optional project of the security group	false
protocol	TCP is default. UDP is the other supported protocol	false
securitygroupid	The ID of the security group. Mutually exclusive with securityGroupName parameter	false
securitygroupname	The name of the security group. Mutually exclusive with securityGroupId parameter	false
startport	start port for this ingress rule	false
usersecuritygrouplist	user to security group mapping	false

Response Tags

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

Response Name	Description
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
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/51c4e97e/source/api/apidocs-4.8/root_admin/cancelHostMaintenance.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/cancelHostMaintenance.html b/source/api/apidocs-4.8/root_admin/cancelHostMaintenance.html new file mode 100644 index 0000000..f060a49 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/cancelHostMaintenance.html @@ -0,0 +1,253 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

cancelHostMaintenance

Cancels host maintenance.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	the host ID	true

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/51c4e97e/source/api/apidocs-4.8/root_admin/cancelStorageMaintenance.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/cancelStorageMaintenance.html b/source/api/apidocs-4.8/root_admin/cancelStorageMaintenance.html new file mode 100644 index 0000000..c16ae1e --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/cancelStorageMaintenance.html @@ -0,0 +1,154 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

cancelStorageMaintenance

Cancels maintenance for primary storage

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	the primary storage ID	true

Response Tags

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

Response Name	Description
id	the ID of the storage pool
capacityiops	IOPS CloudStack can provision from this 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
hypervisor	the hypervisor type of the storage pool
ipaddress	the IP address of the storage pool
name	the name of the storage pool
overprovisionfactor	the overprovisionfactor for the storage pool
path	the storage pool path
podid	the Pod ID of the storage pool
podname	the Pod name of the storage pool
scope	the scope of the storage pool
state	the state of the storage pool
storagecapabilities	the storage pool capabilities
suitableformigration	true if this pool is suitable to migrate a volume, false otherwise
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/51c4e97e/source/api/apidocs-4.8/root_admin/changeServiceForRouter.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/changeServiceForRouter.html b/source/api/apidocs-4.8/root_admin/changeServiceForRouter.html new file mode 100644 index 0000000..4f9da2b --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/changeServiceForRouter.html @@ -0,0 +1,280 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

changeServiceForRouter

Upgrades domain router to a new service offering

+ +

Request parameters

+ + + + + + + + + + +

Parameter Name	Description	Required
id	The ID of the router	true
serviceofferingid	the service offering ID to apply to the domain 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

+ +