Return-Path: X-Original-To: apmail-cloudstack-commits-archive@www.apache.org Delivered-To: apmail-cloudstack-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 6733518C9A for ; Tue, 19 Apr 2016 14:41:43 +0000 (UTC) Received: (qmail 57169 invoked by uid 500); 19 Apr 2016 14:41:43 -0000 Delivered-To: apmail-cloudstack-commits-archive@cloudstack.apache.org Received: (qmail 57127 invoked by uid 500); 19 Apr 2016 14:41:43 -0000 Mailing-List: contact commits-help@cloudstack.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 57065 invoked by uid 99); 19 Apr 2016 14:41:43 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 19 Apr 2016 14:41:43 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id DC7EADFE65; Tue, 19 Apr 2016 14:41:42 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: pdion891@apache.org To: commits@cloudstack.apache.org Date: Tue, 19 Apr 2016 14:41:43 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [02/53] [partial] cloudstack-www git commit: update event section for 2016 events http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/findHostsForMigration.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/findHostsForMigration.html b/content/api/apidocs-4.8/root_admin/findHostsForMigration.html new file mode 100644 index 0000000..f5f5dc3 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/findHostsForMigration.html @@ -0,0 +1,220 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

findHostsForMigration

+

Find hosts suitable for migrating a virtual machine.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidfind hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VMtrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the host
averageloadthe cpu average load on the host
capabilitiescapabilities of the host
clusteridthe cluster ID of the host
clusternamethe cluster name of the host
clustertypethe cluster type of the cluster that host belongs to
cpuallocatedthe amount of the host's CPU currently allocated
cpunumberthe CPU number of the host
cpuspeedthe CPU speed of the host
cpuusedthe amount of the host's CPU currently used
cpuwithoverprovisioningthe amount of the host's CPU after applying the cpu.overprovisioning.factor
createdthe date and time the host was created
disconnectedtrue if the host is disconnected. False otherwise.
disksizeallocatedthe host's currently allocated disk size
disksizetotalthe total disk size of the host
eventsevents available for the host
hahosttrue if the host is Ha host (dedicated to vms started by HA process; false otherwise
hasenoughcapacitytrue if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise
hosttagscomma-separated list of tags for the host
hypervisorthe host hypervisor
hypervisorversionthe hypervisor version
ipaddressthe IP address of the host
islocalstorageactivetrue if local storage is active, false otherwise
lastpingedthe date and time the host was last pinged
managementserveridthe management server ID of the host
memoryallocatedthe amount of the host's memory currently allocated
memorytotalthe memory total of the host
memoryusedthe amount of the host's memory currently used
namethe name of the host
networkkbsreadthe incoming network traffic on the host
networkkbswritethe outgoing network traffic on the host
oscategoryidthe OS category ID of the host
oscategorynamethe OS category name of the host
podidthe Pod ID of the host
podnamethe Pod name of the host
removedthe date and time the host was removed
requiresStorageMotiontrue if migrating a vm to this host requires storage motion, false otherwise
resourcestatethe resource state of the host
statethe state of the host
suitableformigrationtrue 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
typethe host type
versionthe host version
zoneidthe Zone ID of the host
zonenamethe Zone name of the host
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/findStoragePoolsForMigration.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/findStoragePoolsForMigration.html b/content/api/apidocs-4.8/root_admin/findStoragePoolsForMigration.html new file mode 100644 index 0000000..41285fc --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/findStoragePoolsForMigration.html @@ -0,0 +1,163 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

findStoragePoolsForMigration

+

Lists storage pools available for migration of a volume.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the volumetrue
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the storage pool
capacityiopsIOPS CloudStack can provision from this storage pool
clusteridthe ID of the cluster for the storage pool
clusternamethe name of the cluster for the storage pool
createdthe date and time the storage pool was created
disksizeallocatedthe host's currently allocated disk size
disksizetotalthe total disk size of the storage pool
disksizeusedthe host's currently used disk size
hypervisorthe hypervisor type of the storage pool
ipaddressthe IP address of the storage pool
namethe name of the storage pool
overprovisionfactorthe overprovisionfactor for the storage pool
paththe storage pool path
podidthe Pod ID of the storage pool
podnamethe Pod name of the storage pool
scopethe scope of the storage pool
statethe state of the storage pool
storagecapabilitiesthe storage pool capabilities
suitableformigrationtrue if this pool is suitable to migrate a volume, false otherwise
tagsthe tags for the storage pool
typethe storage pool type
zoneidthe Zone ID of the storage pool
zonenamethe Zone name of the storage pool
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/generateAlert.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/generateAlert.html b/content/api/apidocs-4.8/root_admin/generateAlert.html new file mode 100644 index 0000000..b536f7a --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/generateAlert.html @@ -0,0 +1,97 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

generateAlert

+

Generates an alert

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
descriptionAlert descriptiontrue
nameName of the alerttrue
typeType of the alerttrue
podidPod id for which alert is generatedfalse
zoneidZone id for which alert is generatedfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextany text associated with the success or failure
successtrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/generateUsageRecords.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/generateUsageRecords.html b/content/api/apidocs-4.8/root_admin/generateUsageRecords.html new file mode 100644 index 0000000..fa16368 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/generateUsageRecords.html @@ -0,0 +1,91 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

generateUsageRecords

+

Generates usage records. This will generate records only if there any records to be generated, i.e if the scheduled usage job was not run or failed

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enddateEnd date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.true
startdateStart date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.true
domainidList events for the specified domain.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextany text associated with the success or failure
successtrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/getApiLimit.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/getApiLimit.html b/content/api/apidocs-4.8/root_admin/getApiLimit.html new file mode 100644 index 0000000..3251266 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/getApiLimit.html @@ -0,0 +1,91 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

getApiLimit

+

Get API limit count for the caller

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountthe account name of the api remaining count
accountidthe account uuid of the api remaining count
apiAllowedcurrently allowed number of apis
apiIssuednumber of api already issued
expireAfterseconds left to reset counters
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/getCloudIdentifier.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/getCloudIdentifier.html b/content/api/apidocs-4.8/root_admin/getCloudIdentifier.html new file mode 100644 index 0000000..ddc347c --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/getCloudIdentifier.html @@ -0,0 +1,88 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

getCloudIdentifier

+

Retrieves a cloud identifier.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
useridthe user ID for the cloud identifiertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
cloudidentifierthe cloud identifier
signaturethe signed response for the cloud identifier
useridthe user ID for the cloud identifier
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/getSPMetadata.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/getSPMetadata.html b/content/api/apidocs-4.8/root_admin/getSPMetadata.html new file mode 100644 index 0000000..2ccf829 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/getSPMetadata.html @@ -0,0 +1,79 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

getSPMetadata

+

Returns SAML2 CloudStack Service Provider MetaData

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
metadataThe Metadata XML
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/getSolidFireAccountId.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/getSolidFireAccountId.html b/content/api/apidocs-4.8/root_admin/getSolidFireAccountId.html new file mode 100644 index 0000000..99cde33 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/getSolidFireAccountId.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

getSolidFireAccountId

+

Get SolidFire Account ID

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
accountidCloudStack Account UUIDtrue
storageidStorage Pool UUIDtrue
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
solidFireAccountIdSolidFire Account ID
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/getSolidFireVolumeAccessGroupId.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/getSolidFireVolumeAccessGroupId.html b/content/api/apidocs-4.8/root_admin/getSolidFireVolumeAccessGroupId.html new file mode 100644 index 0000000..d979eac --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/getSolidFireVolumeAccessGroupId.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

getSolidFireVolumeAccessGroupId

+

Get the SF Volume Access Group ID

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
clusteridCluster UUIDtrue
storageidStorage Pool UUIDtrue
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
solidFireVolumeAccessGroupIdSolidFire Volume Access Group Id
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/getSolidFireVolumeIscsiName.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/getSolidFireVolumeIscsiName.html b/content/api/apidocs-4.8/root_admin/getSolidFireVolumeIscsiName.html new file mode 100644 index 0000000..e3ec27c --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/getSolidFireVolumeIscsiName.html @@ -0,0 +1,82 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

getSolidFireVolumeIscsiName

+

Get SolidFire Volume's Iscsi Name

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
volumeidCloudStack Volume UUIDtrue
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
solidFireVolumeIscsiNameSolidFire Volume Iscsi Name
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/getSolidFireVolumeSize.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/getSolidFireVolumeSize.html b/content/api/apidocs-4.8/root_admin/getSolidFireVolumeSize.html new file mode 100644 index 0000000..1c9b8c0 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/getSolidFireVolumeSize.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

getSolidFireVolumeSize

+

Get the SF volume size including Hypervisor Snapshot Reserve

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
storageidStorage Pool UUIDtrue
volumeidVolume UUIDtrue
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
solidFireVolumeSizeSolidFire Volume Size Including Hypervisor Snapshot Reserve
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/getUploadParamsForTemplate.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/getUploadParamsForTemplate.html b/content/api/apidocs-4.8/root_admin/getUploadParamsForTemplate.html new file mode 100644 index 0000000..2b4368e --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/getUploadParamsForTemplate.html @@ -0,0 +1,154 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

getUploadParamsForTemplate

+

upload an existing template into the CloudStack cloud.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
displaytextthe display text of the template. This is usually used for display purposes.true
formatthe format for the volume/template. Possible values include QCOW2, OVA, and VHD.true
hypervisorthe target hypervisor for the templatetrue
namethe name of the volume/templatetrue
ostypeidthe ID of the OS Type that best represents the OS of this template.true
zoneidthe ID of the zone the volume/template is to be hosted ontrue
accountan optional accountName. Must be used with domainId.false
bits32 or 64 bits support. 64 by defaultfalse
checksumthe MD5 checksum value of this volume/templatefalse
detailsTemplate details in key/value pairs.false
domainidan optional domainId. If the account parameter is used, domainId must also be used.false
isdynamicallyscalabletrue if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memoryfalse
isextractabletrue if the template or its derivatives are extractable; default is falsefalse
isfeaturedtrue if this template is a featured template, false otherwisefalse
ispublictrue if the template is available to all accounts; default is truefalse
isroutingtrue if the template type is routing i.e., if template is used to deploy routerfalse
passwordenabledtrue if the template supports the password reset feature; default is falsefalse
projectidUpload volume/template for the projectfalse
requireshvmtrue if this template requires HVMfalse
sshkeyenabledtrue if the template supports the sshkey upload feature; default is falsefalse
templatetagthe tag for this template.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe template/volume ID
expiresthe timestamp after which the signature expires
metadataencrypted data to be sent in the POST request.
postURLPOST url to upload the file to
signaturesignature to be sent in the POST request.
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/getUploadParamsForVolume.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/getUploadParamsForVolume.html b/content/api/apidocs-4.8/root_admin/getUploadParamsForVolume.html new file mode 100644 index 0000000..2360fdc --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/getUploadParamsForVolume.html @@ -0,0 +1,118 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

getUploadParamsForVolume

+

Upload a data disk to the cloudstack cloud.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
formatthe format for the volume/template. Possible values include QCOW2, OVA, and VHD.true
namethe name of the volume/templatetrue
zoneidthe ID of the zone the volume/template is to be hosted ontrue
accountan optional accountName. Must be used with domainId.false
checksumthe MD5 checksum value of this volume/templatefalse
diskofferingidthe ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.false
domainidan optional domainId. If the account parameter is used, domainId must also be used.false
imagestoreuuidImage store uuidfalse
projectidUpload volume/template for the projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe template/volume ID
expiresthe timestamp after which the signature expires
metadataencrypted data to be sent in the POST request.
postURLPOST url to upload the file to
signaturesignature to be sent in the POST request.
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/getUser.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/getUser.html b/content/api/apidocs-4.8/root_admin/getUser.html new file mode 100644 index 0000000..e5b5660 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/getUser.html @@ -0,0 +1,130 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

getUser

+

Find user account by API key

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
userapikeyAPI key of the usertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe user ID
accountthe account name of the user
accountidthe account ID of the user
accounttypethe account type of the user
apikeythe api key of the user
createdthe date and time the user account was created
domainthe domain name of the user
domainidthe domain ID of the user
emailthe user email address
firstnamethe user firstname
iscallerchilddomainthe boolean value representing if the updating target is in caller's child domain
isdefaulttrue if user is default, false otherwise
lastnamethe user lastname
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/getVMPassword.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/getVMPassword.html b/content/api/apidocs-4.8/root_admin/getVMPassword.html new file mode 100644 index 0000000..8d90095 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/getVMPassword.html @@ -0,0 +1,82 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

getVMPassword

+

Returns an encrypted password for the VM

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the virtual machinetrue
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
encryptedpasswordThe base64 encoded encrypted password of the VM
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/getVirtualMachineUserData.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/getVirtualMachineUserData.html b/content/api/apidocs-4.8/root_admin/getVirtualMachineUserData.html new file mode 100644 index 0000000..6f245e4 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/getVirtualMachineUserData.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

getVirtualMachineUserData

+

Returns user data associated with the VM

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidThe ID of the virtual machinetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
userdataBase 64 encoded VM user data
virtualmachineidthe ID of the virtual machine
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/importLdapUsers.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/importLdapUsers.html b/content/api/apidocs-4.8/root_admin/importLdapUsers.html new file mode 100644 index 0000000..f1c00d7 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/importLdapUsers.html @@ -0,0 +1,121 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

importLdapUsers

+

Import LDAP users

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accounttypeType of the account. Specify 0 for user, 1 for root admin, and 2 for domain admintrue
accountCreates the user under the specified account. If no account is specified, the username will be used as the account name.false
accountdetailsdetails for account used to store specific parametersfalse
domainidSpecifies the domain to which the ldap users are to be imported. If no domain is specified, a domain will created using group parameter. If the group is also not specified, a domain name based on the OU information will be created. If no OU hierarchy exists, will be defaulted to ROOT domainfalse
groupSpecifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.false
keywordList by keywordfalse
pagefalse
pagesizefalse
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
domainThe user's domain
emailThe user's email
firstnameThe user's firstname
lastnameThe user's lastname
principalThe user's principle
usernameThe user's username
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/issueNuageVspResourceRequest.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/issueNuageVspResourceRequest.html b/content/api/apidocs-4.8/root_admin/issueNuageVspResourceRequest.html new file mode 100644 index 0000000..2a8d536 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/issueNuageVspResourceRequest.html @@ -0,0 +1,103 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

issueNuageVspResourceRequest

+

Issues a Nuage VSP REST API resource request

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
methodthe Nuage VSP REST API method typetrue
networkofferingidthe network offering idtrue
resourcethe resource in Nuage VSPtrue
zoneidthe Zone ID for the networktrue
childresourcethe child resource in Nuage VSPfalse
physicalnetworkidthe ID of the physical network in to which Nuage VSP Controller is addedfalse
resourcefilterthe resource filter in Nuage VSPfalse
resourceidthe ID of the resource in Nuage VSPfalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
resourceinfothe details of the Nuage VSP resource
+
+
+
+
+
+ +
+
+ +