Class: Ansible::Ruby::Modules::Na_ontap_volume

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

Overview

Create or destroy or modify volumes on NetApp ONTAP.

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

#aggregate_name ⇒ String?

Returns The name of the aggregate the flexvol should exist on.,Required when C(state=present).

Returns:

  • (String, nil) —

    The name of the aggregate the flexvol should exist on.,Required when C(state=present).



35
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_ontap_volume.rb', line 35

attribute :aggregate_name

#efficiency_policy ⇒ Object?

Returns Allows a storage efficiency policy to be set on volume creation.

Returns:

  • (Object, nil) —

    Allows a storage efficiency policy to be set on volume creation.



72
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_ontap_volume.rb', line 72

attribute :efficiency_policy

#encrypt ⇒ Symbol?

Returns Whether or not to enable Volume Encryption.

Returns:

  • (Symbol, nil) —

    Whether or not to enable Volume Encryption.



68
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_ontap_volume.rb', line 68

attribute :encrypt

#from_name ⇒ Object?

Returns Name of the existing volume to be renamed to name.

Returns:

  • (Object, nil) —

    Name of the existing volume to be renamed to name.



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

attribute :from_name

#is_infinite ⇒ Symbol?

Returns Set True if the volume is an Infinite Volume. Deleting an infinite volume is asynchronous.

Returns:

  • (Symbol, nil) —

    Set True if the volume is an Infinite Volume. Deleting an infinite volume is asynchronous.



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

attribute :is_infinite

#is_online ⇒ Boolean?

Returns Whether the specified volume is online, or not.

Returns:

  • (Boolean, nil) —

    Whether the specified volume is online, or not.



31
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_ontap_volume.rb', line 31

attribute :is_online

#junction_path ⇒ String?

Returns Junction path of the volume.

Returns:

  • (String, nil) —

    Junction path of the volume.



53
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_ontap_volume.rb', line 53

attribute :junction_path

#name ⇒ String

Returns The name of the volume to manage.

Returns:

  • (String) —

    The name of the volume to manage.



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

attribute :name

#percent_snapshot_space ⇒ Object?

Returns Amount of space reserved for snapshot copies of the volume.

Returns:

  • (Object, nil) —

    Amount of space reserved for snapshot copies of the volume.



61
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_ontap_volume.rb', line 61

attribute :percent_snapshot_space

#policy ⇒ Object?

Returns Name of the export policy.

Returns:

  • (Object, nil) —

    Name of the export policy.



50
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_ontap_volume.rb', line 50

attribute :policy

#size ⇒ Integer?

Returns The size of the volume in (size_unit). Required when C(state=present).

Returns:

  • (Integer, nil) —

    The size of the volume in (size_unit). Required when C(state=present).



39
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_ontap_volume.rb', line 39

attribute :size

#size_unit ⇒ :bytes, ...

Returns The unit used to interpret the size parameter.

Returns:

  • (:bytes, :b, :kb, :mb, :gb, :tb, :pb, :eb, :zb, :yb, nil) —

    The unit used to interpret the size parameter.



43
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_ontap_volume.rb', line 43

attribute :size_unit

#space_guarantee ⇒ :none, ...

Returns Space guarantee style for the volume.

Returns:

  • (:none, :volume, nil) —

    Space guarantee style for the volume.



57
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_ontap_volume.rb', line 57

attribute :space_guarantee

#state ⇒ :present, ...

Returns Whether the specified volume should exist or not.

Returns:

  • (:present, :absent, nil) —

    Whether the specified volume should exist or not.



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

attribute :state

#type ⇒ Object?

Returns The volume type, either read-write (RW) or data-protection (DP).

Returns:

  • (Object, nil) —

    The volume type, either read-write (RW) or data-protection (DP).



47
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_ontap_volume.rb', line 47

attribute :type

#volume_security_style ⇒ :mixed, ...

Returns The security style associated with this volume.

Returns:

  • (:mixed, :ntfs, :unified, :unix, nil) —

    The security style associated with this volume.



64
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_ontap_volume.rb', line 64

attribute :volume_security_style

#vserver ⇒ String

Returns Name of the vserver to use.

Returns:

  • (String) —

    Name of the vserver to use.



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

attribute :vserver