Get Guest Environment
Reads a single environment variable from the guest operating system. If the authentication uses Credentials.interactive-session, then the environment being read will be that of the user logged into the desktop. Otherwise it’s the environment of the system user.
if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/guest/environment/{name}?action=get
Path Parameters
Path Parameters
string
vm
Required
Virtual machine to perform the operation on. The parameter must be an identifier for the resource type: VirtualMachine.
string
name
Required
The name of the environment variable to be read.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
VmGuestEnvironmentGetRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"credentials": {
"interactive_session": false,
"type": "USERNAME_PASSWORD"
}
}
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
string
of type application/json
The value of the name environment variable.
Errors
400
com.vmware.vapi.std.errors.unsupported : if the operation is not supported by the VMware tools in the guest OS. if the operation is disabled by the VMware tools in the guest OS. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine vm is not running.
404
com.vmware.vapi.std.errors.not_found : if the virtual machine vm is not found. if the environment variable name is not not set in the guest operating system.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$VmGuestCredentials = Initialize-VmGuestCredentials -InteractiveSession $false -Type "USERNAME_PASSWORD"
$VmGuestEnvironmentGetRequestBody = Initialize-VmGuestEnvironmentGetRequestBody -Credentials $VmGuestCredentials
Invoke-GetVmNameEnvironment -Vm "MyVm" -Name "MyName" -VmGuestEnvironmentGetRequestBody $VmGuestEnvironmentGetRequestBody
PowerCLI Client SDK All Parameters Example
$VmGuestCredentials = Initialize-VmGuestCredentials -InteractiveSession $false -Type "USERNAME_PASSWORD" -UserName "MyUserName" -Password "MyPassword" -SamlToken "MySamlToken"
$VmGuestEnvironmentGetRequestBody = Initialize-VmGuestEnvironmentGetRequestBody -Credentials $VmGuestCredentials
Invoke-GetVmNameEnvironment -Vm "MyVm" -Name "MyName" -VmGuestEnvironmentGetRequestBody $VmGuestEnvironmentGetRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"credentials":{"interactive_session":false,"password":"string","saml_token":"string","type":"USERNAME_PASSWORD","user_name":"string"}}' https://{api_host}/api/vcenter/vm/{vm}/guest/environment/{name}?action=get
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.2.0
