inspec/docs/resources/virtualization.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

67 lines
1.4 KiB
Text

---
title: About the virtualization Resource
platform: linux
---
# virtualization
Use the `virtualization` InSpec audit resource to test the virtualization platform on which the system is running.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.28.0 of InSpec.
## Syntax
An `virtualization` resource block declares the virtualization platform that should be tested:
describe virtualization do
its('system') { should MATCHER 'value' }
end
where
* `('system')` is the name of the system information of the virtualization platform (e.g. docker, lxc, vbox, kvm, etc)
* `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 for Docker
describe virtualization do
its('system') { should eq 'docker' }
end
### Test for VirtualBox
describe virtualization do
its('system') { should eq 'vbox' }
its('role') { should eq 'guest' }
end
### Detect the virtualization platform
if virtualization.system == 'vbox'
describe package('name') do
it { should be_installed }
end
end
<br>
## Matchers
For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).