Create Runspace
DescriptionRunspace creation and preparation time depends on the requested runspace details. If a connection to the vCenter Servers is requested, the operation creates a PowerShell instance, loads PowerCLI modules, and connects PowerCLI to the vCenter Servers.
Request
URLURL
Request Body
{
"creation_time": "string",
"error_details": {
"code": 0,
"details": "string",
"error_message": "string"
},
"id": "string",
"name": "string",
"run_vc_connection_script": false,
"state": "ready",
"vc_connection_script_id": "string"
}
The time at which the object was created. String representing time in format ISO 8601.
Unique identifier for the object.
Name of the runspace. It is optional to give a name of the runspace on create request. If name was not specified on runspace creation the field has null value.
Boolean that indicates whether PowerCLI connection has to be initialized when a Runspace creation is requested.
It is optional to request VCenter Servers connection to be initialized on create request. If true is specified PowerCLI Connect-VIServer cmdlet will be called in the create PowerShell instance. Connect-VIServer uses the authorized user’s SSO SAML token to connect to the vCenter Servers. Connection to all linked vCetner Servers will be established. When requested the runspace creation will be slower with the time needed for PowerCLI modules loading and Connect-VIServer execution time. _vc_connection_script_state field will hold state of the script completion. In case errors have occured during connect script execution _vc_connection_script_error_records will be populated.
Default value is false.
RunspaceState defines possible runspace states.
Possible values are: ready , active , creating , error
Id of the vc connection script if it was requested on the runspace create request. You can use this id to retrieve all the details of the script execution. The script could fail and the details about the script failure would be available in the scriptexecutions API.
Authentication
Response
Response BodyResponse Body
202 Accepted
The request is accepted. The Location header is returned in the response that leads you to the runspace resource. The runspace resource is in creation state initially.
{
"creation_time": "string",
"error_details": {
"code": 0,
"details": "string",
"error_message": "string"
},
"id": "string",
"name": "string",
"run_vc_connection_script": false,
"state": "ready",
"vc_connection_script_id": "string"
}
The time at which the object was created. String representing time in format ISO 8601.
Unique identifier for the object.
Name of the runspace. It is optional to give a name of the runspace on create request. If name was not specified on runspace creation the field has null value.
Boolean that indicates whether PowerCLI connection has to be initialized when a Runspace creation is requested.
It is optional to request VCenter Servers connection to be initialized on create request. If true is specified PowerCLI Connect-VIServer cmdlet will be called in the create PowerShell instance. Connect-VIServer uses the authorized user’s SSO SAML token to connect to the vCenter Servers. Connection to all linked vCetner Servers will be established. When requested the runspace creation will be slower with the time needed for PowerCLI modules loading and Connect-VIServer execution time. _vc_connection_script_state field will hold state of the script completion. In case errors have occured during connect script execution _vc_connection_script_error_records will be populated.
Default value is false.
RunspaceState defines possible runspace states.
Possible values are: ready , active , creating , error
Id of the vc connection script if it was requested on the runspace create request. You can use this id to retrieve all the details of the script execution. The script could fail and the details about the script failure would be available in the scriptexecutions API.
Errors
Unauthorized
Server Error
Code Samples
cURL Command
Vendor Extensions
x-vmw-vapi-methodname: create
x-vmw-vapi-servicename: runspaces
