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

52 lines
1 KiB
Text

---
title: About the sys_info Resource
platform: os
---
# sys_info
Use the `sys_info` InSpec audit resource to test for operating system properties for the named host, and then returns that info as standard output.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
An `sys_info` resource block declares the hostname to be tested:
describe sys_info do
its('hostname') { should eq 'value' }
end
<br>
## Examples
The following examples show how to use this InSpec audit resource.
### Get system information for example.com
describe sys_info do
its('hostname') { should eq 'example.com' }
end
<br>
## Matchers
For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
### hostname
The `hostname` matcher tests the host for which standard output is returned:
its('hostname') { should eq 'value' }