This API has a deprecated equivalent from v7.0U1.
Get Guest Local Filesystem
Returns details of the local file systems in the guest operating system.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/guest/local-filesystem
Path Parameters
Path Parameters
string
vm
Required
Identifier of the virtual machine. 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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
map of
VmGuestLocalFilesystemInfo
of type application/json
Information about the local file systems configured in the guest operating system.
{
"capacity": 0,
"filesystem": "string",
"free_space": 0,
"mappings": [
{
"disk": "string"
}
]
}
integer
capacity
Required
Total capacity of the file system, in bytes.
integer
free_space
Required
Free space on the file system, in bytes.
string
filesystem
Optional
Filesystem type, if known. For example, ext3 or NTFS. set if VMware Tools reports a value.
mappings
Optional
VirtualDisks backing the guest partition, if known. This field is optional because it was added in a newer version than its parent node.
Errors
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
503
com.vmware.vapi.std.errors.service_unavailable : if VMware Tools is not running. if VMware Tools has not provided any data.
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
Invoke-GetVmGuestLocalFilesystem -Vm "MyVm"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/guest/local-filesystem
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/guest/local-filesystem
x-vmw-doc-operation: get
Availability
Added in 7.0U2
