inspec/docs/resources/filesystem.md.erb
Kimberly Garmoe b0bcc35fda Add one comma in all docs & deletes two repeated sentences. (#2658)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-15 22:07:18 -05:00

41 lines
841 B
Text

---
title: About the filesystem Resource
platform: linux
---
# filesystem
Use the `filesystem` InSpec resource to audit filesystem disk space usage.
<br>
## Syntax
A `filesystem` resource block declares tests for disk space in a partion:
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 megabytes (MB).
<br>
## Resource Property Examples
The following examples show how to use this InSpec audit resource.
### Test if the root partition is greater thank 32000 MB
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/).