vcenter vm guest local filesystem: get
Returns details of the local file systems in the guest operating system. This operation was added in vSphere API 6.7.
Request:
HTTP request
GET https://{server}/rest/vcenter/vm/{vm}/guest/local-filesystem
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| vm | string | Identifier of the virtual machine. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : [
{
"value" : {
"mappings" : [
{
"disk" : "obj-103"
},
{
"disk" : "obj-103"
}
],
"free_space" : 1,
"filesystem" : "string",
"capacity" : 1
},
"key" : "string"
}
]
}
"value" : [
{
"value" : {
"mappings" : [
{
"disk" : "obj-103"
},
{
"disk" : "obj-103"
}
],
"free_space" : 1,
"filesystem" : "string",
"capacity" : 1
},
"key" : "string"
}
]
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | list | Information about the local file systems configured in the guest operating system.List of {"key": string, "value": info} |
| value[].key | string | |
| value[].value | info | |
| value[].value.capacity | long | Total capacity of the file system, in bytes. This attribute was added in vSphere API 6.7. |
| value[].value.free_space | long | Free space on the file system, in bytes. This attribute was added in vSphere API 6.7. |
| value[].value.filesystem | string | Filesystem type, if known. For example, ext3 or NTFS. This attribute was added in vSphere API 7.0.0.0. Optional. set if VMware Tools reports a value. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | if the system reports an error while responding to the request. |
| 404 | not_found | if the virtual machine is not found. |
| 503 | service_unavailable | if VMware Tools is not running. |