2016-09-22 12:43:57 +00:00
---
title: About the sys_info Resource
2018-02-16 00:28:15 +00:00
platform: os
2016-09-22 12:43:57 +00:00
---
# sys_info
2019-04-26 18:24:29 +00:00
Use the `sys_info` Chef InSpec audit resource to test for operating system properties for the named host, and then returns that info as standard output.
2016-09-22 12:43:57 +00:00
2017-10-03 21:35:10 +00:00
<br>
2018-08-09 12:34:49 +00:00
## Availability
### Installation
2019-04-26 18:24:29 +00:00
This resource is distributed along with Chef InSpec itself. You can use it automatically.
2018-08-09 12:34:49 +00:00
### Version
This resource first became available in v1.0.0 of InSpec.
2016-09-27 19:03:23 +00:00
## Syntax
2016-09-22 12:43:57 +00:00
An `sys_info` resource block declares the hostname to be tested:
describe sys_info do
its('hostname') { should eq 'value' }
end
2017-10-03 21:35:10 +00:00
<br>
2016-09-22 12:43:57 +00:00
2017-10-03 21:35:10 +00:00
## Examples
2016-09-22 12:43:57 +00:00
2019-04-26 18:24:29 +00:00
The following examples show how to use this Chef InSpec audit resource.
2016-09-22 12:43:57 +00:00
2017-10-03 21:35:10 +00:00
### Get system information for example.com
2016-09-22 12:43:57 +00:00
2017-10-03 21:35:10 +00:00
describe sys_info do
its('hostname') { should eq 'example.com' }
end
2016-09-22 12:43:57 +00:00
2017-10-03 21:35:10 +00:00
<br>
2016-09-22 12:43:57 +00:00
2017-10-03 21:35:10 +00:00
## Matchers
2016-09-22 12:43:57 +00:00
2018-02-16 03:07:18 +00:00
For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
2016-09-22 12:43:57 +00:00
2016-09-27 19:03:23 +00:00
### hostname
2016-09-22 12:43:57 +00:00
The `hostname` matcher tests the host for which standard output is returned:
2019-07-02 21:25:33 +00:00
its('hostname') { should eq 'value' }
2019-06-21 14:23:09 +00:00
2019-08-19 18:40:14 +00:00
### fqdn
The `fqdn` property tests the 'fully qualified domain name' of the system:
its('fqdn') { should eq 'value' }
### domain
The `domain` property tests the name of the DNS domain:
its('domain') { should eq 'value' }
### ip-address
The `ip-address` property tests all network addresses of the host:
its('ip-address') { should eq 'value' }
### short
The `short` property tests the host name cut at the first dot:
its('short') { should eq 'value' }
2019-06-21 14:23:09 +00:00
### manufacturer
The `manufacturer` matcher tests the host for which standard output is returned:
2019-07-12 12:01:25 +00:00
its('manufacturer') { should eq 'ACME Corp.' }
2019-06-21 14:23:09 +00:00
### model
The `model` matcher tests the host for which standard output is returned:
2019-07-12 12:01:25 +00:00
its('model') { should eq 'Flux Capacitor' }