Class: Ansible::Ruby::Modules::Zfs

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/storage/zfs/zfs.rb

Overview

Manages ZFS file systems, volumes, clones and snapshots

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#extra_zfs_properties ⇒ Hash?

Returns A dictionary of zfs properties to be set.,See the zfs(8) man page for more information.

Returns:

  • (Hash, nil) —

    A dictionary of zfs properties to be set.,See the zfs(8) man page for more information.



27
 
# File 'lib/ansible/ruby/modules/generated/storage/zfs/zfs.rb', line 27

attribute :extra_zfs_properties

#key_value ⇒ Object?

Returns (DEPRECATED) This will be removed in Ansible-2.9. Set these values in the,C(extra_zfs_properties) option instead.,The C(zfs) module takes key=value pairs for zfs properties to be set.,See the zfs(8) man page for more information.

Returns:

  • (Object, nil) —

    (DEPRECATED) This will be removed in Ansible-2.9. Set these values in the,C(extra_zfs_properties) option instead.,The C(zfs) module takes key=value pairs for zfs properties to be set.,See the zfs(8) man page for more information.



24
 
# File 'lib/ansible/ruby/modules/generated/storage/zfs/zfs.rb', line 24

attribute :key_value

#name ⇒ String

Returns File system, snapshot or volume name e.g. C(rpool/myfs).

Returns:

  • (String) —

    File system, snapshot or volume name e.g. C(rpool/myfs).



12
 
# File 'lib/ansible/ruby/modules/generated/storage/zfs/zfs.rb', line 12

attribute :name

#origin ⇒ String?

Returns Snapshot from which to create a clone.

Returns:

  • (String, nil) —

    Snapshot from which to create a clone.



20
 
# File 'lib/ansible/ruby/modules/generated/storage/zfs/zfs.rb', line 20

attribute :origin

#state ⇒ :absent, :present

Returns Whether to create (C(present)), or remove (C(absent)) a file system, snapshot or volume. All parents/children will be created/destroyed as needed to reach the desired state.

Returns:

  • (:absent, :present) —

    Whether to create (C(present)), or remove (C(absent)) a file system, snapshot or volume. All parents/children will be created/destroyed as needed to reach the desired state.



16
 
# File 'lib/ansible/ruby/modules/generated/storage/zfs/zfs.rb', line 16

attribute :state