Guest Process Manager Read Environment Variable In Guest

Reads an environment variable from the guest OS

If the authentication uses interactiveSession, then the environment being read will be that of the user logged into the desktop. Otherwise it's the environment of the user specified by the auth.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/GuestProcessManager/{moId}/ReadEnvironmentVariableInGuest

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case GuestProcessManager/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Request Body

ReadEnvironmentVariableInGuestRequestType of type(s) application/json

Required

Show optional properties

{
    "vm": {},
    "auth": {
        "interactiveSession": false
    }
}

{
    "vm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "auth": {
        "_typeName": "string",
        "interactiveSession": false
    },
    "names": [
        "string"
    ]
}

MoRefVirtualMachine

Required

Reference to an instance of the VirtualMachine managed object.

GuestAuthentication

auth

Required

GuestAuthentication is an abstract base class for authentication in the guest.

array of string

names

Optional

The names of the variables to be read. If not set, then all the environment variables are returned.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

A string array containing the value of the variables, or all environment variables if nothing is specified. The format of each string is "name=value". If any specified environment variable isn't set, then nothing is returned for that variable.

Returns Array of string of type(s) application/json

[
    {}
]

500

GuestOperationsFault: if there is an error processing a guest operation.

GuestOperationsUnavailable: if the VM agent for guest operations is not running.

InvalidPowerState: if the VM is not powered on.

InvalidState: if the operation cannot be performed because of the virtual machine's current state.

TaskInProgress: if the virtual machine is busy. accepted by the guest OS.

GuestPermissionDenied: if there are insufficient permissions in the guest OS.

InvalidGuestLogin: if the the guest authentication information was not accepted.

GuestComponentsOutOfDate: if the guest agent is too old to support the operation.

OperationNotSupportedByGuest: if the operation is not supported by the guest OS.

OperationDisabledByGuest: if the operation is not enabled due to guest agent configuration.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations

POST

Guest Process Manager List Processes In Guest