VirtualGuest create request (Provider API)
Description
This API creates a VirtualGuest object. The input to the request specifies a VirtualCluster to target. If a VirtualHost is specified, the VirtualGuest is placed on that host within the cluster. If a VirtualResourcePool is specified, the VirtualGuest is placed in that pool. If neither is specified, the software assumes that the cluster can place the VirtualGuest by itself.
API stability classification
API overview
HTTP | URI | Return | Return type |
|---|---|---|---|
POST | csm/VirtualGuest/create | 1 |
HTTP request message
Query string parameters
This API does not use query string parameters.
Request message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Request message body
This API uses the following objects in the request message body JSON.
Top-level objects
Name | Type | Multi- | Description |
|---|---|---|---|
callbackURL | String | 0..1 | URL to call when the operation finishes |
postCallout | String | 0..1 | Identifier of a callout to run after the operation executes |
preCallout | String | 0..1 | Identifier of a callout to run before the operation executes |
timeout | Integer | 0..1 | Timeout setting. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values:
|
operationParams | 1 | Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing-input-parameters-with-an-API-request. |
Input parameters to include in operationParams
Name | Type | Multi- | Description |
|---|---|---|---|
deploymentParameterValue | 0..* | List of deployment parameter values | |
InstallableResource | 1 | Installable resource | |
password | String | 0..1 | Password |
username | String | 0..1 | User name |
VGName | String | 0..1 | Virtual guest name |
VirtualDatastore | 1 | Virtual data store | |
VirtualGuest | 1 | Virtual guest | |
VirtualGuestDestination | 1 | VirtualCluster, VirtualHost, or VirtualResourcePool provisioning target |
HTTP response message
Response message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Response message body
The response message body contains a Task object.
Unknown macro: confluence_bmc-report-replacer-error. Click on this message for details.