inspec 1.51.6 → 1.51.15

data/docs/resources/bash.md.erb

@@ -1,74 +1,74 @@
----
-title: About the bash Resource
----
-
-# bash
-
-Use the `bash` InSpec audit resource to test an arbitrary command that is run on the system using a Bash script.
-
-<br>
-
-## Syntax
-
-A `command` resource block declares a command to be run, one (or more) expected outputs, and the location to which that output is sent:
-
-    describe bash('command') do
-      it { should exist }
-      its('property') { should eq 'expected value' }
-    end
-
-where
-
-* `'command'` must specify a command to be run
-* `'property'` is one of `exit_status`, `stderr`, or `stdout`
-* `'expected value'` tests the output of the command run on the system versus the expected output stated in the test
-
-For example:
-
-    describe bash('ls -al /') do
-      its('stdout') { should match /bin/ }
-      its('stderr') { should eq '' }
-      its('exit_status') { should eq 0 }
-    end
-
-<br>
-
-## Supported Properties
-
-* `exit_status`, `stderr`, `stdout`
-
-<br>
-
-## Property Examples
-
-### exit_status
-
-The `exit_status` property tests the exit status for the command:
-
-    its('exit_status') { should eq 0 }
-
-### stderr
-
-The `stderr` property tests results of the command as returned in standard error (stderr):
-
-    its('stderr') { should eq '' }
-
-### stdout
-
-The `stdout` property tests results of the command as returned in standard output (stdout).
-
-    its('stdout') { should match /bin/ }
-
-<br>
-
-## Matchers
-
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### exist
-
-If an absolute path is provided, the `exist` matcher tests if the command exists on the filesystem at the specified location. Otherwise, the `exist` matcher tests if the command is found in the PATH.
-
-    it { should exist }
-
-
+---
+title: About the bash Resource
+---
+
+# bash
+
+Use the `bash` InSpec audit resource to test an arbitrary command that is run on the system using a Bash script.
+
+<br>
+
+## Syntax
+
+A `command` resource block declares a command to be run, one (or more) expected outputs, and the location to which that output is sent:
+
+    describe bash('command') do
+      it { should exist }
+      its('property') { should eq 'expected value' }
+    end
+
+where
+
+* `'command'` must specify a command to be run
+* `'property'` is one of `exit_status`, `stderr`, or `stdout`
+* `'expected value'` tests the output of the command run on the system versus the expected output stated in the test
+
+For example:
+
+    describe bash('ls -al /') do
+      its('stdout') { should match /bin/ }
+      its('stderr') { should eq '' }
+      its('exit_status') { should eq 0 }
+    end
+
+<br>
+
+## Supported Properties
+
+* `exit_status`, `stderr`, `stdout`
+
+<br>
+
+## Property Examples
+
+### exit_status
+
+The `exit_status` property tests the exit status for the command:
+
+    its('exit_status') { should eq 0 }
+
+### stderr
+
+The `stderr` property tests results of the command as returned in standard error (stderr):
+
+    its('stderr') { should eq '' }
+
+### stdout
+
+The `stdout` property tests results of the command as returned in standard output (stdout).
+
+    its('stdout') { should match /bin/ }
+
+<br>
+
+## Matchers
+
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### exist
+
+If an absolute path is provided, the `exist` matcher tests if the command exists on the filesystem at the specified location. Otherwise, the `exist` matcher tests if the command is found in the PATH.
+
+    it { should exist }
+
+

data/docs/resources/bond.md.erb

@@ -1,89 +1,89 @@
----
-title: About the bond Resource
----
-
-# bond
-
-Use the `bond` InSpec audit resource to test a logical, bonded network interface (i.e. "two or more network interfaces aggregated into a single, logical network interface"). On Linux platforms, any value in the `/proc/net/bonding` directory may be tested.
-
-<br>
-
-## Syntax
-
-A `bond` resource block declares a bonded network interface, and then specifies the properties of that bonded network interface to be tested:
-
-    describe bond('name') do
-      it { should exist }
-    end
-
-where
-
-* `'name'` is the name of the bonded network interface
-* `{ should exist }` is a valid matcher for this resource
-
-<br>
-
-## Property Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### content
-
-The `content` matcher tests if contents in the file that defines the bonded network interface match the value specified in the test. The values of the `content` matcher are arbitrary.
-
-    its('content') { should match('value') }
-
-### interfaces
-
-The `interfaces` matcher tests if the named secondary interfaces are available.
-
-    its('interfaces') { should eq ['eth0', 'eth1', ...] }
-
-### mode
-
-The `mode` matcher tests the Bonding Mode.
-
-    its('mode') { should eq 'IEEE 802.3ad Dynamic link aggregation' }
-
-### params
-
-The `params` matcher tests arbitrary parameters for the bonded network interface.
-
-    its('params') { should eq 'value' }
-
-### Test if eth0 is a secondary interface for bond0
-
-    describe bond('bond0') do
-      it { should exist }
-      it { should have_interface 'eth0' }
-    end
-
-### Test parameters for bond0
-
-    describe bond('bond0') do
-      its('mode') { should eq 'IEEE 802.3ad Dynamic link aggregation' }
-      its('Transmit Hash Policy') { should eq 'layer3+4 (1)' }
-      its('MII Status') { should eq 'up' }
-      its('MII Polling Interval (ms)') { should eq '100' }
-      its('Up Delay (ms)') { should eq '0' }
-      its('Down Delay (ms)') { should eq '0' }
-    end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
-
-### exist
-
-The `exist` matcher tests if the bonded network interface is available:
-
-    it { should exist }
-
-### have_interface
-
-The `have_interface` matcher tests if the bonded network interface has one (or more) secondary interfaces:
-
-    it { should have_interface }
-
+---
+title: About the bond Resource
+---
+
+# bond
+
+Use the `bond` InSpec audit resource to test a logical, bonded network interface (i.e. "two or more network interfaces aggregated into a single, logical network interface"). On Linux platforms, any value in the `/proc/net/bonding` directory may be tested.
+
+<br>
+
+## Syntax
+
+A `bond` resource block declares a bonded network interface, and then specifies the properties of that bonded network interface to be tested:
+
+    describe bond('name') do
+      it { should exist }
+    end
+
+where
+
+* `'name'` is the name of the bonded network interface
+* `{ should exist }` is a valid matcher for this resource
+
+<br>
+
+## Property Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### content
+
+The `content` matcher tests if contents in the file that defines the bonded network interface match the value specified in the test. The values of the `content` matcher are arbitrary.
+
+    its('content') { should match('value') }
+
+### interfaces
+
+The `interfaces` matcher tests if the named secondary interfaces are available.
+
+    its('interfaces') { should eq ['eth0', 'eth1', ...] }
+
+### mode
+
+The `mode` matcher tests the Bonding Mode.
+
+    its('mode') { should eq 'IEEE 802.3ad Dynamic link aggregation' }
+
+### params
+
+The `params` matcher tests arbitrary parameters for the bonded network interface.
+
+    its('params') { should eq 'value' }
+
+### Test if eth0 is a secondary interface for bond0
+
+    describe bond('bond0') do
+      it { should exist }
+      it { should have_interface 'eth0' }
+    end
+
+### Test parameters for bond0
+
+    describe bond('bond0') do
+      its('mode') { should eq 'IEEE 802.3ad Dynamic link aggregation' }
+      its('Transmit Hash Policy') { should eq 'layer3+4 (1)' }
+      its('MII Status') { should eq 'up' }
+      its('MII Polling Interval (ms)') { should eq '100' }
+      its('Up Delay (ms)') { should eq '0' }
+      its('Down Delay (ms)') { should eq '0' }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
+
+### exist
+
+The `exist` matcher tests if the bonded network interface is available:
+
+    it { should exist }
+
+### have_interface
+
+The `have_interface` matcher tests if the bonded network interface has one (or more) secondary interfaces:
+
+    it { should have_interface }
+

data/docs/resources/bridge.md.erb

@@ -1,54 +1,54 @@
----
-title: About the bridge Resource
----
-
-# bridge
-
-Use the `bridge` InSpec audit resource to test basic network bridge properties, such as name, if an interface is defined, and the associations for any defined interface.
-
-<br>
-
-## Syntax
-
-A `bridge` resource block declares the bridge to be tested and what interface it should be associated with:
-
-    describe bridge('br0') do
-      it { should exist }
-      it { should have_interface 'eth0' }
-    end
-
-<br>
-
-## Supported Properties 
-
-* On Linux platforms, any value in the `/sys/class/net/{interface}/bridge` directory may be tested
-* On the Windows platform, the `Get-NetAdapter` cmdlet is associated with the `Get-NetAdapterBinding` cmdlet and returns the `ComponentID ms_bridge` value as a JSON object
-
-<br>
-
-## Property Examples
-
-### interfaces
-
-The `interfaces` property tests if the named interface is present:
-
-    its('interfaces') { should eq 'foo' }
-    its('interfaces') { should eq 'bar' }
-    its('interfaces') { should include('foo') }
-
-## Matchers
-
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
-
-### exist
-
-The `exist` matcher tests if the network bridge is available:
-
-    it { should exist }
-
-### have_interface
-
-The `have_interface` matcher tests if the named interface is defined for the network bridge:
-
-    it { should have_interface 'eth0' }
-
+---
+title: About the bridge Resource
+---
+
+# bridge
+
+Use the `bridge` InSpec audit resource to test basic network bridge properties, such as name, if an interface is defined, and the associations for any defined interface.
+
+<br>
+
+## Syntax
+
+A `bridge` resource block declares the bridge to be tested and what interface it should be associated with:
+
+    describe bridge('br0') do
+      it { should exist }
+      it { should have_interface 'eth0' }
+    end
+
+<br>
+
+## Supported Properties 
+
+* On Linux platforms, any value in the `/sys/class/net/{interface}/bridge` directory may be tested
+* On the Windows platform, the `Get-NetAdapter` cmdlet is associated with the `Get-NetAdapterBinding` cmdlet and returns the `ComponentID ms_bridge` value as a JSON object
+
+<br>
+
+## Property Examples
+
+### interfaces
+
+The `interfaces` property tests if the named interface is present:
+
+    its('interfaces') { should eq 'foo' }
+    its('interfaces') { should eq 'bar' }
+    its('interfaces') { should include('foo') }
+
+## Matchers
+
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
+
+### exist
+
+The `exist` matcher tests if the network bridge is available:
+
+    it { should exist }
+
+### have_interface
+
+The `have_interface` matcher tests if the named interface is defined for the network bridge:
+
+    it { should have_interface 'eth0' }
+

data/docs/resources/bsd_service.md.erb

@@ -1,65 +1,65 @@
----
-title: About the bsd_service Resource
----
-
-# bsd_service
-
-Use the `bsd_service` InSpec audit resource to test a service using a Berkeley OS-style `init` on the FreeBSD platform.
-
-<br>
-
-## Syntax
-
-A `bsd_service` resource block declares the name of a service and then one (or more) matchers to test the state of the service:
-
-    describe bsd_service('service_name') do
-      it { should be_installed }
-      it { should be_enabled }
-      it { should be_running }
-    end
-
-where
-
-* `('service_name')` must specify a service name
-* `be_installed`, `be_enabled`, and `be_running` are valid matchers for this resource.
-
-### Using `bsd_service` resource parameters
-
-#### Path
-
-The path to the service manager's control may be specified for situations where the path isn't available in the current `PATH`. For example:
-
-    describe bsd_service('service_name', '/path/to/control') do
-      it { should be_enabled }
-      it { should be_installed }
-      it { should be_running }
-    end
-
-<br>
-
-## Supported Properties
-
-All properties available to the `service` resource may be used.
-<br>
-
-## Matchers
-
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
-
-### be_enabled
-
-The `be_enabled` matcher tests if the named service is enabled:
-
-    it { should be_enabled }
-
-### be_installed
-
-The `be_installed` matcher tests if the named service is installed:
-
-    it { should be_installed }
-
-### be_running
-
-The `be_running` matcher tests if the named service is running:
-
-    it { should be_running }
+---
+title: About the bsd_service Resource
+---
+
+# bsd_service
+
+Use the `bsd_service` InSpec audit resource to test a service using a Berkeley OS-style `init` on the FreeBSD platform.
+
+<br>
+
+## Syntax
+
+A `bsd_service` resource block declares the name of a service and then one (or more) matchers to test the state of the service:
+
+    describe bsd_service('service_name') do
+      it { should be_installed }
+      it { should be_enabled }
+      it { should be_running }
+    end
+
+where
+
+* `('service_name')` must specify a service name
+* `be_installed`, `be_enabled`, and `be_running` are valid matchers for this resource.
+
+### Using `bsd_service` resource parameters
+
+#### Path
+
+The path to the service manager's control may be specified for situations where the path isn't available in the current `PATH`. For example:
+
+    describe bsd_service('service_name', '/path/to/control') do
+      it { should be_enabled }
+      it { should be_installed }
+      it { should be_running }
+    end
+
+<br>
+
+## Supported Properties
+
+All properties available to the `service` resource may be used.
+<br>
+
+## Matchers
+
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
+
+### be_enabled
+
+The `be_enabled` matcher tests if the named service is enabled:
+
+    it { should be_enabled }
+
+### be_installed
+
+The `be_installed` matcher tests if the named service is installed:
+
+    it { should be_installed }
+
+### be_running
+
+The `be_running` matcher tests if the named service is running:
+
+    it { should be_running }