Get Guest Filesystem Files
Returns information about a file or directory in the guest.
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/filesystem/files/{path}?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
path
Required
The complete path to the file.
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
VmGuestFilesystemFilesGetRequestBody 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
VmGuestFilesystemFilesInfo
of type application/json
Files.Info object containing information for the file.
{
"attributes": {
"filesystem_family": "WINDOWS",
"last_accessed": "string",
"last_modified": "string",
"posix_attributes": {
"group": 0,
"owner": 0,
"permissions": "string"
},
"symlink_target": "string",
"win_attributes": {
"created": "string",
"hidden": false,
"read_only": false
}
},
"size": 0,
"type": "FILE"
}
integer
size
Required
The file size in bytes.
type
Required
The Files.Type enumerated type defines the valid types of files.
FILE : normal file
DIRECTORY : directory
SYMLINK : symbolic link
Possible values are: FILE , DIRECTORY , SYMLINK
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if path is too long. The value of com.vmware.vapi.std.errors.Error#data will contain all the fields defined in the FileErrorDetails providing additional information about the failure. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is not running. | com.vmware.vapi.std.errors.unsupported : if the operation is not supported by the VMware Tools in the guest operating system. if the operation is disabled by the VMware Tools in the guest operating system.
403
com.vmware.vapi.std.errors.unauthorized : if path cannot be accessed. if path cannot be listed because the guest authentication will not allow the operation.
404
com.vmware.vapi.std.errors.not_found : if the virtual machine is not found. if path is not found. The value of com.vmware.vapi.std.errors.Error#data will contain all the fields defined in the FileErrorDetails providing additional information about the failure.
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"
$VmGuestFilesystemFilesGetRequestBody = Initialize-VmGuestFilesystemFilesGetRequestBody -Credentials $VmGuestCredentials
Invoke-GetVmPathFiles -Vm "MyVm" -Path "MyPath" -VmGuestFilesystemFilesGetRequestBody $VmGuestFilesystemFilesGetRequestBody
PowerCLI Client SDK All Parameters Example
$VmGuestCredentials = Initialize-VmGuestCredentials -InteractiveSession $false -Type "USERNAME_PASSWORD" -UserName "MyUserName" -Password "MyPassword" -SamlToken "MySamlToken"
$VmGuestFilesystemFilesGetRequestBody = Initialize-VmGuestFilesystemFilesGetRequestBody -Credentials $VmGuestCredentials
Invoke-GetVmPathFiles -Vm "MyVm" -Path "MyPath" -VmGuestFilesystemFilesGetRequestBody $VmGuestFilesystemFilesGetRequestBody
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/filesystem/files/{path}?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
