inspec/docs/resources/mount.md.erb
hannah-radish 9cfc86d2ab Resource documentation update (#2207)
Light formatting changes, change order of example and matchers, slight
color changes

Signed-off-by: hannah-radish <hmaddy@chef.io>
2017-10-03 17:35:10 -04:00

68 lines
1.5 KiB
Text

---
title: About the mount Resource
---
# mount
Use the `mount` InSpec audit resource to test the mount points on FreeBSD and Linux systems.
<br>
## Syntax
An `mount` resource block declares the synchronization settings that should be tested:
describe mount('path') do
it { should MATCHER 'value' }
end
where
* `('path')` is the path to the mounted directory
* `MATCHER` is a valid matcher for this resource
* `'value'` is the value to be tested
<br>
## Examples
The following examples show how to use this InSpec audit resource.
### Test a the mount point on '/'
describe mount('/') do
it { should be_mounted }
its('device') { should eq '/dev/mapper/VolGroup-lv_root' }
its('type') { should eq 'ext4' }
its('options') { should eq ['rw', 'mode=620'] }
end
<br>
## Matchers
This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
### be_mounted
The `be_mounted` matcher tests if the file is accessible from the file system:
it { should be_mounted }
### device
The `device` matcher tests the device from the `fstab` table:
its('device') { should eq '/dev/mapper/VolGroup-lv_root' }
### options
The `options` matcher tests the mount options for the file system from the `fstab` table:
its('options') { should eq ['rw', 'mode=620'] }
### type
The `type` matcher tests the file system type:
its('type') { should eq 'ext4' }