Class: Ansible::Ruby::Modules::Beadm

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/system/beadm.rb

Overview

Create, delete or activate ZFS boot environments. Mount and unmount ZFS boot environments.

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

#description ⇒ Boolean?

Returns Associate a description with a new boot environment. This option is available only on Solarish platforms.

Returns:

  • (Boolean, nil) —

    Associate a description with a new boot environment. This option is available only on Solarish platforms.



21
 
# File 'lib/ansible/ruby/modules/generated/system/beadm.rb', line 21

attribute :description

#force ⇒ Symbol?

Returns Specifies if the unmount should be forced.

Returns:

  • (Symbol, nil) —

    Specifies if the unmount should be forced.



37
 
# File 'lib/ansible/ruby/modules/generated/system/beadm.rb', line 37

attribute :force

#mountpoint ⇒ Boolean?

Returns Path where to mount the ZFS boot environment.

Returns:

  • (Boolean, nil) —

    Path where to mount the ZFS boot environment



29
 
# File 'lib/ansible/ruby/modules/generated/system/beadm.rb', line 29

attribute :mountpoint

#name ⇒ String

Returns ZFS boot environment name.

Returns:

  • (String) —

    ZFS boot environment name.



13
 
# File 'lib/ansible/ruby/modules/generated/system/beadm.rb', line 13

attribute :name

#options ⇒ Boolean?

Returns Create the datasets for new BE with specific ZFS properties. Multiple options can be specified. This option is available only on Solarish platforms.

Returns:

  • (Boolean, nil) —

    Create the datasets for new BE with specific ZFS properties. Multiple options can be specified. This option is available only on Solarish platforms.



25
 
# File 'lib/ansible/ruby/modules/generated/system/beadm.rb', line 25

attribute :options

#snapshot ⇒ Boolean?

Returns If specified, the new boot environment will be cloned from the given snapshot or inactive boot environment.

Returns:

  • (Boolean, nil) —

    If specified, the new boot environment will be cloned from the given snapshot or inactive boot environment.



17
 
# File 'lib/ansible/ruby/modules/generated/system/beadm.rb', line 17

attribute :snapshot

#state ⇒ :present, ...

Returns Create or delete ZFS boot environment.

Returns:

  • (:present, :absent, :activated, :mounted, :unmounted, nil) —

    Create or delete ZFS boot environment.



33
 
# File 'lib/ansible/ruby/modules/generated/system/beadm.rb', line 33

attribute :state