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.
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}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"vm": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"auth": {
"_typeName": "string",
"interactiveSession": false
},
"names": [
"string"
]
}
GuestAuthentication is an abstract base class for authentication in the guest.
The names of the variables to be read. If not set, then all the environment variables are returned.
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.
[
{}
]
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.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}