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

46 lines
1.1 KiB
Text

---
title: About the interface Resource
---
# interface
Use the `interface` InSpec audit resource to test basic network adapter properties, such as name, status, and link speed (in MB/sec).
* On Linux platforms, `/sys/class/net/#{iface}` is used as source
* On the Windows platform, the `Get-NetAdapter` cmdlet is used as source
<br>
## Syntax
An `interface` resource block declares network interface properties to be tested:
describe interface('eth0') do
it { should be_up }
its('speed') { should eq 1000 }
its('name') { should eq eth0 }
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_up
The `be_up` matcher tests if the network interface is available:
it { should be_up }
### name
The `name` matcher tests if the named network interface exists:
its('name') { should eq eth0 }
### speed
The `speed` matcher tests the speed of the network interface, in MB/sec:
its('speed') { should eq 1000 }