List Guest Environment
Reads a list of environment variables 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?action=list
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.
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
VmGuestEnvironmentListRequestBody 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"
},
"names": [
"string"
]
}
array of
string
names
Required
The names of the variables to be read. If the set is empty, then all the environment variables are returned.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
map of
string
of type application/json
Mapping from environment variable names to environment variable values, or all environment variables if nothing is specified. If any specified environment variable contained in names is not set, then nothing is returned for that 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.
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"
$VmGuestEnvironmentListRequestBody = Initialize-VmGuestEnvironmentListRequestBody -Credentials $VmGuestCredentials -Names "MyNames"
Invoke-ListVmGuestEnvironment -Vm "MyVm" -VmGuestEnvironmentListRequestBody $VmGuestEnvironmentListRequestBody
PowerCLI Client SDK All Parameters Example
$VmGuestCredentials = Initialize-VmGuestCredentials -InteractiveSession $false -Type "USERNAME_PASSWORD" -UserName "MyUserName" -Password "MyPassword" -SamlToken "MySamlToken"
$VmGuestEnvironmentListRequestBody = Initialize-VmGuestEnvironmentListRequestBody -Credentials $VmGuestCredentials -Names "MyNames"
Invoke-ListVmGuestEnvironment -Vm "MyVm" -VmGuestEnvironmentListRequestBody $VmGuestEnvironmentListRequestBody
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"},"names":["string"]}' https://{api_host}/api/vcenter/vm/{vm}/guest/environment?action=list
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 7.0.2.0
