In-Reply-To: <433cd090942a470db80c89b475c90ec4@git.apache.org> References: <433cd090942a470db80c89b475c90ec4@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [05/49] cloudstack-www git commit: content: update freshly built website archived-at: Wed, 04 Jan 2017 10:32:50 -0000 http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/updateResourceLimit.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/updateResourceLimit.html b/content/api/apidocs-4.9/apis/updateResourceLimit.html new file mode 100644 index 0000000..8e43d43 --- /dev/null +++ b/content/api/apidocs-4.9/apis/updateResourceLimit.html @@ -0,0 +1,112 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

updateResourceLimit

Updates resource limits for an account or domain.

+ +

Request parameters

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

Parameter Name	Description	Required
resourcetype	Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use.	true
account	Update resource for a specified account. Must be used with the domainId parameter.	false
domainid	Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.	false
max	Maximum resource limit.	false
projectid	Update resource limits for project	false

Response Tags

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

Response Name	Description
account	the account of the resource limit
domain	the domain name of the resource limit
domainid	the domain ID of the resource limit
max	the maximum number of the resource. A -1 means the resource currently has no limit.
project	the project name of the resource limit
projectid	the project id of the resource limit
resourcetype	resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.

+ +

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

+ +

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

updateRole

Updates a role

+ +

Request parameters

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

Parameter Name	Description	Required
id	ID of the role	true
description	The description of the role	false
name	creates a role with this unique name	false
type	The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User	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/071d0632/content/api/apidocs-4.9/apis/updateRolePermission.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/updateRolePermission.html b/content/api/apidocs-4.9/apis/updateRolePermission.html new file mode 100644 index 0000000..f101f61 --- /dev/null +++ b/content/api/apidocs-4.9/apis/updateRolePermission.html @@ -0,0 +1,88 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

updateRolePermission

Updates a role permission order

+ +

Request parameters

+ + + + + + + + + + +

Parameter Name	Description	Required
roleid	ID of the role	true
ruleorder	The parent role permission uuid, use 0 to move this rule at the top of the list	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/071d0632/content/api/apidocs-4.9/apis/updateServiceOffering.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/updateServiceOffering.html b/content/api/apidocs-4.9/apis/updateServiceOffering.html new file mode 100644 index 0000000..5c79456 --- /dev/null +++ b/content/api/apidocs-4.9/apis/updateServiceOffering.html @@ -0,0 +1,181 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

updateServiceOffering

Updates a service offering.

+ +

Request parameters

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

Parameter Name	Description	Required
id	the ID of the service offering to be updated	true
displaytext	the display text of the service offering to be updated	false
name	the name of the service offering to be updated	false
sortkey	sort key of the service offering, integer	false

Response Tags

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

Response Name	Description
id	the id of the service offering
cpunumber	the number of CPU
cpuspeed	the clock rate CPU speed in Mhz
created	the date this service offering was created
defaultuse	is this a default system vm offering
deploymentplanner	deployment strategy used to deploy VM.
diskBytesReadRate	bytes read rate of the service offering
diskBytesWriteRate	bytes write rate of the service offering
diskIopsReadRate	io requests read rate of the service offering
diskIopsWriteRate	io requests write rate of the service offering
displaytext	an alternate display text of the service offering.
domain	Domain name for the offering
domainid	the domain id of the service offering
hosttags	the host tag for the service offering
hypervisorsnapshotreserve	Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
iscustomized	is true if the offering is customized
iscustomizediops	true if disk offering uses custom iops, false otherwise
issystem	is this a system vm offering
isvolatile	true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk
limitcpuuse	restrict the CPU usage to committed service offering
maxiops	the max iops of the disk offering
memory	the memory in MB
miniops	the min iops of the disk offering
name	the name of the service offering
networkrate	data transfer rate in megabits per second allowed.
offerha	the ha support in the service offering
provisioningtype	provisioning type used to create volumes. Valid values are thin, sparse, fat.
serviceofferingdetails	additional key/value details tied with this service offering
storagetype	the storage type for this service offering
systemvmtype	is this a the systemvm type for system vm offering
tags	the tags for the service offering

+ +

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

+ +

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

updateSnapshotPolicy

Updates the snapshot policy.

+ +

Request parameters

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

Parameter Name	Description	Required
customid	an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only	false
fordisplay	an optional field, whether to the display the snapshot policy to the end user or not.	false
id	the ID of the snapshot policy	false

Response Tags

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

Response Name	Description
id	the ID of the snapshot policy
fordisplay	is this policy for display to the regular user
intervaltype	the interval type of the snapshot policy
maxsnaps	maximum number of snapshots retained
schedule	time the snapshot is scheduled to be taken.
timezone	the time zone of the snapshot policy
volumeid	the ID of the disk volume

+ +

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

+ +

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

updateStorageNetworkIpRange

Update a Storage network IP range, only allowed when no IPs in this range have been allocated.

+ +

Request parameters

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

Parameter Name	Description	Required
id	UUID of storage network ip range	true
endip	the ending IP address	false
netmask	the netmask for storage network	false
startip	the beginning IP address	false
vlan	Optional. the vlan the ip range sits on	false

Response Tags

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

Response Name	Description
id	the uuid of storage network IP range.
endip	the end ip of the storage network IP range
gateway	the gateway of the storage network IP range
netmask	the netmask of the storage network IP range
networkid	the network uuid of storage network IP range
podid	the Pod uuid for the storage network IP range
startip	the start ip of the storage network IP range
vlan	the ID or VID of the VLAN.
zoneid	the Zone uuid of the storage network IP range

+ +

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

+ +

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

updateStoragePool

Updates a storage pool.

+ +

Request parameters

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

Parameter Name	Description	Required
id	the Id of the storage pool	true
capacitybytes	bytes CloudStack can provision from this storage pool	false
capacityiops	IOPS CloudStack can provision from this storage pool	false
enabled	false to disable the pool for allocation of new volumes, true to enable it back.	false
tags	comma-separated list of tags for the storage pool	false

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/071d0632/content/api/apidocs-4.9/apis/updateTemplate.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/updateTemplate.html b/content/api/apidocs-4.9/apis/updateTemplate.html new file mode 100644 index 0000000..a12d0a6 --- /dev/null +++ b/content/api/apidocs-4.9/apis/updateTemplate.html @@ -0,0 +1,223 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

updateTemplate

Updates attributes of a template.

+ +

Request parameters

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

Parameter Name	Description	Required
id	the ID of the image file	true
bootable	true if image is bootable, false otherwise; available only for updateIso API	false
details	Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61	false
displaytext	the display text of the image	false
format	the format for the image	false
isdynamicallyscalable	true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory	false
isrouting	true if the template type is routing i.e., if template is used to deploy router	false
name	the name of the image file	false
ostypeid	the ID of the OS type that best represents the OS of this image.	false
passwordenabled	true if the image supports the password reset feature; default is false	false
requireshvm	true if the template requres HVM, false otherwise; available only for updateTemplate API	false
sortkey	sort key of the template, integer	false

Response Tags

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

Response Name	Description
id	the template ID
account	the account name to which the template belongs
accountid	the account id to which the template belongs
bootable	true if the ISO is bootable, false otherwise
checksum	checksum of the template
created	the date this template was created
crossZones	true if the template is managed across all Zones, false otherwise
details	additional key/value details tied with template
displaytext	the template display text
domain	the name of the domain to which the template belongs
domainid	the ID of the domain to which the template belongs
format	the format of the template.
hostid	the ID of the secondary storage host for the template
hostname	the name of the secondary storage host for the template
hypervisor	the hypervisor on which the template runs
isdynamicallyscalable	true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory
isextractable	true if the template is extractable, false otherwise
isfeatured	true if this template is a featured template, false otherwise
ispublic	true if this template is a public template, false otherwise
isready	true if the template is ready to be deployed from, false otherwise.
name	the template name
ostypeid	the ID of the OS type for this template.
ostypename	the name of the OS type for this template.
passwordenabled	true if the reset password feature is enabled, false otherwise
project	the project name of the template
projectid	the project id of the template
removed	the date this template was removed
size	the size of the template
sourcetemplateid	the template ID of the parent template if present
sshkeyenabled	true if template is sshkey enabled, false otherwise
status	the status of the template
templatetag	the tag of this template
templatetype	the type of the template
zoneid	the ID of the zone for this template
zonename	the name of the zone for this template
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/071d0632/content/api/apidocs-4.9/apis/updateTemplatePermissions.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/updateTemplatePermissions.html b/content/api/apidocs-4.9/apis/updateTemplatePermissions.html new file mode 100644 index 0000000..1d2d213 --- /dev/null +++ b/content/api/apidocs-4.9/apis/updateTemplatePermissions.html @@ -0,0 +1,103 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

updateTemplatePermissions

Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A priviledged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them.

+ +

Request parameters

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

Parameter Name	Description	Required
id	the template ID	true
accounts	a comma delimited list of accounts. If specified, "op" parameter has to be passed in.	false
isextractable	true if the template/iso is extractable, false other wise. Can be set only by root admin	false
isfeatured	true for featured template/iso, false otherwise	false
ispublic	true for public template/iso, false for private templates/isos	false
op	permission operator (add, remove, reset)	false
projectids	a comma delimited list of projects. If specified, "op" parameter has to be passed in.	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/071d0632/content/api/apidocs-4.9/apis/updateTrafficType.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/updateTrafficType.html b/content/api/apidocs-4.9/apis/updateTrafficType.html new file mode 100644 index 0000000..dfda0a4 --- /dev/null +++ b/content/api/apidocs-4.9/apis/updateTrafficType.html @@ -0,0 +1,118 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

updateTrafficType

Updates traffic type of a physical network

+ +

Request parameters

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

Parameter Name	Description	Required
id	traffic type id	true
hypervnetworklabel	The network name label of the physical device dedicated to this traffic on a Hyperv host	false
kvmnetworklabel	The network name label of the physical device dedicated to this traffic on a KVM host	false
ovm3networklabel	The network name of the physical device dedicated to this traffic on an OVM3 host	false
vmwarenetworklabel	The network name label of the physical device dedicated to this traffic on a VMware host	false
xennetworklabel	The network name label of the physical device dedicated to this traffic on a XenServer host	false

Response Tags

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

Response Name	Description
id	id of the network provider
hypervnetworklabel	The network name label of the physical device dedicated to this traffic on a HyperV host
kvmnetworklabel	The network name label of the physical device dedicated to this traffic on a KVM host
ovm3networklabel	The network name of the physical device dedicated to this traffic on an OVM3 host
physicalnetworkid	the physical network this belongs to
traffictype	the trafficType to be added to the physical network
vmwarenetworklabel	The network name label of the physical device dedicated to this traffic on a VMware host
xennetworklabel	The network name label of the physical device dedicated to this traffic on a XenServer host

+ +

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

+ +

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

updateUser

Updates a user account

+ +

Request parameters

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

Parameter Name	Description	Required
id	User uuid	true
email	email	false
firstname	first name	false
lastname	last name	false
password	Clear text password (default hashed to SHA256SALT). If you wish to use any other hasing algorithm, you would need to write a custom authentication adapter	false
timezone	Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.	false
userapikey	The API key for the user. Must be specified with userSecretKey	false
username	Unique username	false
usersecretkey	The secret key for the user. Must be specified with userSecretKey	false

Response Tags

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

Response Name	Description
id	the user ID
account	the account name of the user
accountid	the account ID of the user
accounttype	the account type of the user
apikey	the api key of the user
created	the date and time the user account was created
domain	the domain name of the user
domainid	the domain ID of the user
email	the user email address
firstname	the user firstname
iscallerchilddomain	the boolean value representing if the updating target is in caller's child domain
isdefault	true if user is default, false otherwise
lastname	the user lastname
roleid	the ID of the role
rolename	the name of the role
roletype	the type of the role
secretkey	the secret key of the user
state	the user state
timezone	the timezone user was created in
username	the user name

+ +