REST API - get

vcenter vm guest processes: get

Gets the status of a process running in the guest operating system, including those started by create that may have recently completed.

. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/rest/vcenter/vm/{vm}/guest/processes/{pid}?action=get

Path Parameters

Name	Type	Description
Required
vm	string	Virtual machine to perform the operation on.
pid	long	Specifies the process to query.

Request Body Structure:

{
    "credentials" : {
        "password" : "secret string",
        "user_name" : "string",
        "saml_token" : "secret string",
        "type" : "USERNAME_PASSWORD",
        "interactive_session" : true
    }
}

Request Body Parameters:

Name	Type	Description
bold = required
credentials	credentials	The guest authentication data. See vcenter.vm.guest.credentials.
credentials.interactive_session	boolean	If set, the operation will interact with the logged-in desktop session in the guest. This requires that the logged-on user matches the user specified by the vcenter.vm.guest.credentials. This is currently only supported for USERNAME_PASSWORD. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
credentials.type	string	The guest credentials type. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Types of guest credentials. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: USERNAME_PASSWORD: USERNAME_PASSWORD credentials contains the information necessary to authenticate within a guest using a username and password. This method of authentication is stateless. To use USERNAME_PASSWORD, populate userName and password with the appropriate login information. Once populated, you can use USERNAME_PASSWORD in any guest operations function call. . Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. SAML_BEARER_TOKEN: SAML_BEARER_TOKEN contains the information necessary to authenticate within a guest using a SAML token. SAML Bearer token credentials relies on a guest alias that associates a guest account with the subject and certificate encoded in a SAML Bearer token obtained from the VMware SSO Server. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
credentials.user_name	string	For SAML_BEARER_TOKEN, this is the guest user to be associated with the credentials. For USERNAME_PASSWORD this is the guest username. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. It is only relevant when type has value [USERNAME_PASSWORD, SAML_BEARER_TOKEN]. If no user is specified for SAML_BEARER_TOKEN, a guest dependent mapping will decide what guest user account is applied.
credentials.password	secret	password. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. It is only relevant when type has value USERNAME_PASSWORD. This field is optional and it is only relevant when the value of `type` is USERNAME_PASSWORD.
credentials.saml_token	secret	SAML Bearer Token. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. It is only relevant when type has value SAML_BEARER_TOKEN. This field is optional and it is only relevant when the value of `type` is SAML_BEARER_TOKEN.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "owner" : "string",
        "name" : "string",
        "exit_code" : 1,
        "started" : "2015-01-01T22:13:05.651Z",
        "finished" : "2015-01-01T22:13:05.651Z",
        "command" : "string"
    }
}

Response Type:

Name	Type	Description
bold = required
value	info	The vcenter.vm.guest.processes.info for the process with id `pid`.
value.name	string	The process name. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value.owner	string	The process owner. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value.command	string	The full command line of the process. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value.started	date_time	The start time of the process. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value.finished	date_time	If the process was started using create then the process completion time will be available if queried within 5 minutes after it completes. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. Set if the process was started with create and has recently exited.
value.exit_code	long	If the process was started using create then the process exit code will be available if queried within 5 minutes after it completes. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. Set if the process was started with create and has recently exited.

Errors:

HTTP Status Code	Type	Description
400	not_allowed_in_current_state	if the virtual machine `vm` is not running.
404	not_found	if the virtual machine `vm` is not found.
500	resource_busy	if the virtual machine is busy.
503	service_unavailable	if the VMware tools are not running.
401	unauthenticated	if the `credentials` is not valid.
400	unsupported	if the operation is not supported by the VMware tools in the guest OS.