Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-23 05:03:07 +00:00
Code Issues Projects Releases Packages Wiki Activity

doc review changes

Browse source 
Signed-off-by: Deepa Kumaraswamy <dkumaras@progress.com>
This commit is contained in:
Deepa Kumaraswamy 2022-04-06 18:49:17 +05:30 committed by Sonu Saha
parent c64d92f470
commit eb9bb1fdd2
1 changed files with 19 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docs-chef-io/content/inspec/resources/routing_table.md
View file

@ -11,8 +11,7 @@ platform = "linux"
parent = "inspec/resources/os"
+++
Use the `routing_table` Chef InSpec audit resource to test the routing information parameters (viz. destination, gateway and interface) present in the routing table. The rule match is done against the output information of `netstat -rn`.
Use the `routing_table` Chef InSpec audit resource to test the routing information parameters, destination, gateway, and interface present in the routing table. The rule matches with the output information of `netstat -rn`.
## Availability
@ -22,41 +21,48 @@ This resource is distributed with Chef InSpec.
## Syntax
A `routing_table` Chef InSpec audit resource test if an entry of destination, gateway and interface is present as part of the routing table information. All three keys and its value must be passed when testing.
A `routing_table` Chef InSpec audit resource tests if an entry of destination, gateway, and interface is present as part of the routing table information. All three keys and their values must be passed when testing.
```ruby
describe routing_table do
it { should have_entry(destination: '0.0.0.0', interface: 'eth0', gateway: '172.31.80.1') }
end
where
```
- `'destination', 'interface' and 'gateway'` are parameters of the routing table
- `have_entry` is a matcher of this resource
> where
>
> - `destination`, `interface`, and `gateway` are parameters of the routing table.
> - `have_entry` is a matcher of this resource.
## Matchers
For a full list of available matchers, please visit our [matchers page](https://docs.chef.io/inspec/matchers/).
The specific matchers of this resource is: `have_entry`
### have_entry
The `have_entry` matcher tests the if the given destination, interface and gateway exists as an entry in the routing table
The `have_entry` matcher tests the if the given destination, interface, and gateway exist as an entry in the routing table.
```ruby
it { should have_entry(destination: '0.0.0.0', interface: 'eth0', gateway: '172.31.80.1') }
```
## Examples
The following examples show how to use this Chef InSpec audit resource.
### Check if an entry with destination as '10.123.137.0', gateway as '0.0.0.0' and interface as 'eth0' exists in the routing table
### Ensures an entry with the destination as '10.123.137.0', gateway as '0.0.0.0', and interface as 'eth0' exists in the routing table
`have_entry` returns true if the given combination of destination, gateway and interface is a valid entry in the routing table
`have_entry` returns *true* if the given combination of destination, gateway, and interface is a valid entry in the routing table.
```ruby
describe routing_table do
it { should have_entry(destination: '10.123.137.0', interface: 'eth0', gateway: '0.0.0.0') }
end
```
### Check if an entry with destination as '192.168.43.1/32', gateway as '172.31.80.1' and interface as 'lxdbr0' exists in the routing table
### Ensures an entry with the destination as '192.168.43.1/32', gateway as '172.31.80.1', and interface as 'lxdbr0' exists in the routing table
```ruby
describe routing_table do
it do
should have_entry(
@ -66,4 +72,4 @@ The following examples show how to use this Chef InSpec audit resource.
)
end
end
```