inspec/docs/resources/filesystem.md.erb
Clinton Wolfe 2de06bdeb5 Clean injection of Availability section (#3206)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-08-09 08:34:49 -04:00

51 lines
1 KiB
Text

---
title: About the filesystem Resource
platform: linux
---
# filesystem
Use the `filesystem` InSpec resource to audit filesystem disk space usage.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.51.0 of InSpec.
## Syntax
A `filesystem` resource block declares tests for disk space in a partition:
describe filesystem('/') do
its('size') { should be >= 32000 }
end
where
* `filesystem('/')` states that the resource will look at the root (/) partition.
* `size` is measured in kilobytes (KB).
<br>
## Resource Property Examples
The following examples show how to use this InSpec audit resource.
### Test if the root partition is greater than 32000 KB
describe filesystem('/') do
its('size') { should be >= 32000 }
end
<br>
## Matchers
For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).