zfs resource

[edit on GitHub]

Use the zfs Chef InSpec audit resource to test the named ZFS Pool file system and its respective properties.

Availability

Installation

Chef Inspec distributes this resource.

Syntax

A zfs Chef InSpec audit resource allows you to test if the ZFS Pool is present and has specific properties.

    describe zfs(zfs_pool_name) do
      it { should exist }
      it { should have_property({ "key1" => "VALUE1", "key2" => "VALUE2" }) }
    end

where

• 'zfs_pool_name' is the name of a ZFS Pool,
• exist and have_property are matchers of this resource,
• { "key1" => "value1", "key2" => "value2" } are properties of the ZFS Pool to test.

Matchers

For a full list of available matchers, please visit our matchers page.

The specific matchers of this resource are: exist and have_property.

exist

The exist matcher tests if the ZFS Pool exists on the system.

    it { should exist }

have_property

The have_property matcher accepts properties in hash format and tests if the specified properties are valid ZFS Pool properties.

    it { should have_property({ "key1" => "VALUE1", "key2" => "VALUE2" }) }

Examples

The following examples show how to use this Chef InSpec audit resource.

Test if the ZFS Pool exists on the system

exist matcher allows to test if the ZFS Pool exists on the system.

    describe zfs("POOL") do
      it { should exist }
    end

Test if the specified properties are valid ZFS Pool properties

have_property matcher allows you to test if the specified properties are valid ZFS Pool properties.

    describe zfs("POOL") do
      it { should have_property({ "failmode" => "WAIT", "capacity" => "0" }) }
    end