In-Reply-To: <1d6b7f4149b145f39313a6a6c9d7bb76@git.apache.org> References: <1d6b7f4149b145f39313a6a6c9d7bb76@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [48/51] [abbrv] [partial] cloudstack-www git commit: 4.8.0, close #24 http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/domain_admin/assignToLoadBalancerRule.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/assignToLoadBalancerRule.html b/content/api/apidocs-4.8/domain_admin/assignToLoadBalancerRule.html new file mode 100644 index 0000000..fc918b4 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/assignToLoadBalancerRule.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

assignToLoadBalancerRule

Assigns virtual machine or a list of virtual machines to a load balancer rule.

+ +

Request parameters

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

Parameter Name	Description	Required
id	the ID of the load balancer rule	true
virtualmachineids	the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)	false
vmidipmap	VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75	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/79d7c49c/content/api/apidocs-4.8/domain_admin/assignVirtualMachine.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/assignVirtualMachine.html b/content/api/apidocs-4.8/domain_admin/assignVirtualMachine.html new file mode 100644 index 0000000..f585623 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/assignVirtualMachine.html @@ -0,0 +1,526 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

assignVirtualMachine

Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.

+ +

Request parameters

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

Parameter Name	Description	Required
account	account name of the new VM owner.	true
domainid	domain id of the new VM owner.	true
virtualmachineid	id of the VM to be moved	true
networkids	list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.	false
securitygroupids	list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group.	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
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/79d7c49c/content/api/apidocs-4.8/domain_admin/associateIpAddress.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/associateIpAddress.html b/content/api/apidocs-4.8/domain_admin/associateIpAddress.html new file mode 100644 index 0000000..2468180 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/associateIpAddress.html @@ -0,0 +1,223 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

associateIpAddress

Acquires and associates a public IP to an account.

+ +

Request parameters

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

Parameter Name	Description	Required
account	the account to associate with this IP address	false
domainid	the ID of the domain to associate with this IP address	false
fordisplay	an optional field, whether to the display the IP to the end user or not	false
isportable	should be set to true if public IP is required to be transferable across zones, if not specified defaults to false	false
networkid	The network this IP address should be associated to.	false
projectid	Deploy VM for the project	false
regionid	region ID from where portable IP is to be associated.	false
vpcid	the VPC you want the IP address to be associated with	false
zoneid	the ID of the availability zone you want to acquire an public IP address from	false

Response Tags

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

Response Name	Description
id	public IP address id
account	the account the public IP address is associated with
allocated	date the public IP address was acquired
associatednetworkid	the ID of the Network associated with the IP address
associatednetworkname	the name of the Network associated with the IP address
domain	the domain the public IP address is associated with
domainid	the domain ID the public IP address is associated with
fordisplay	is public ip for display to the regular user
forvirtualnetwork	the virtual network for the IP address
ipaddress	public IP address
isportable	is public IP portable across the zones
issourcenat	true if the IP address is a source nat address, false otherwise
isstaticnat	true if this ip is for static nat, false otherwise
issystem	true if this ip is system ip (was allocated as a part of deployVm or createLbRule)
networkid	the ID of the Network where ip belongs to
physicalnetworkid	the physical network this belongs to
project	the project name of the address
projectid	the project id of the ipaddress
purpose	purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value
state	State of the ip address. Can be: Allocatin, Allocated and Releasing
virtualmachinedisplayname	virutal machine display name the ip address is assigned to (not null only for static nat Ip)
virtualmachineid	virutal machine id the ip address is assigned to (not null only for static nat Ip)
virtualmachinename	virutal machine name the ip address is assigned to (not null only for static nat Ip)
vlanid	the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only
vlanname	the VLAN associated with the IP address
vmipaddress	virutal machine (dnat) ip address (not null only for static nat Ip)
vpcid	VPC the ip belongs to
zoneid	the ID of the zone the public IP address belongs to
zonename	the name of the zone the public IP address belongs to
*tags()**	the list of resource tags associated with ip address
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/79d7c49c/content/api/apidocs-4.8/domain_admin/associateLun.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/associateLun.html b/content/api/apidocs-4.8/domain_admin/associateLun.html new file mode 100644 index 0000000..d8a6e4e --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/associateLun.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

associateLun

Associate a LUN with a guest IQN

+ +

Request parameters

+ + + + + + + + + + +

Parameter Name	Description	Required
iqn	Guest IQN to which the LUN associate.	true
name	LUN name.	true

Response Tags

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

Response Name	Description
id	the LUN id
ipaddress	the IP address of
targetiqn	the target IQN

+ +

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

+ +

+ + Apache CloudStack v4.8.0 Domain 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/79d7c49c/content/api/apidocs-4.8/domain_admin/attachVolume.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/attachVolume.html b/content/api/apidocs-4.8/domain_admin/attachVolume.html new file mode 100644 index 0000000..9e0c8ff --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/attachVolume.html @@ -0,0 +1,268 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Domain 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/79d7c49c/content/api/apidocs-4.8/domain_admin/authorizeSamlSso.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/authorizeSamlSso.html b/content/api/apidocs-4.8/domain_admin/authorizeSamlSso.html new file mode 100644 index 0000000..b2dfbf4 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/authorizeSamlSso.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Domain 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

+ +