Class: Ansible::Ruby::Modules::Netapp_e_volume_copy

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

Overview

Create and delete snapshots images on volume groups for NetApp E-series storage arrays.

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

#api_password ⇒ Object

Returns The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.

Returns:

  • (Object) —

    The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.



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

attribute :api_password

#api_url ⇒ Object

Returns The url to the SANtricity WebServices Proxy or embedded REST API, for example C(prod-1.wahoo.acme.com/devmgr/v2).

Returns:



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

attribute :api_url

#api_username ⇒ Object

Returns The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.

Returns:

  • (Object) —

    The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.



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

attribute :api_username

#create_copy_pair_if_does_not_exist ⇒ Boolean?

Returns Defines if a copy pair will be created if it does not exist.,If set to True destination_volume_id and source_volume_id are required.

Returns:

  • (Boolean, nil) —

    Defines if a copy pair will be created if it does not exist.,If set to True destination_volume_id and source_volume_id are required.



41
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_volume_copy.rb', line 41

attribute :create_copy_pair_if_does_not_exist

#destination_volume_id ⇒ Object?

Returns The id of the volume copy destination.,If used, must be paired with source_volume_id,Mutually exclusive with volume_copy_pair_id, and search_volume_id.

Returns:

  • (Object, nil) —

    The id of the volume copy destination.,If used, must be paired with source_volume_id,Mutually exclusive with volume_copy_pair_id, and search_volume_id



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

attribute :destination_volume_id

#search_volume_id ⇒ Object?

Returns Searches for all valid potential target and source volumes that could be used in a copy_pair,Mutually exclusive with volume_copy_pair_id, destination_volume_id and source_volume_id.

Returns:

  • (Object, nil) —

    Searches for all valid potential target and source volumes that could be used in a copy_pair,Mutually exclusive with volume_copy_pair_id, destination_volume_id and source_volume_id



48
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_volume_copy.rb', line 48

attribute :search_volume_id

#source_volume_id ⇒ Object?

Returns The id of the volume copy source.,If used, must be paired with destination_volume_id,Mutually exclusive with volume_copy_pair_id, and search_volume_id.

Returns:

  • (Object, nil) —

    The id of the volume copy source.,If used, must be paired with destination_volume_id,Mutually exclusive with volume_copy_pair_id, and search_volume_id



28
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_volume_copy.rb', line 28

attribute :source_volume_id

#start_stop_copy ⇒ Object?

Returns starts a re-copy or stops a copy in progress,Note: If you stop the initial file copy before it it done the copy pair will be destroyed,Requires volume_copy_pair_id.

Returns:

  • (Object, nil) —

    starts a re-copy or stops a copy in progress,Note: If you stop the initial file copy before it it done the copy pair will be destroyed,Requires volume_copy_pair_id



45
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_volume_copy.rb', line 45

attribute :start_stop_copy

#state ⇒ :present, :absent

Returns Whether the specified volume copy pair should exist or not.

Returns:

  • (:present, :absent) —

    Whether the specified volume copy pair should exist or not.



37
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_volume_copy.rb', line 37

attribute :state

#validate_certs ⇒ Boolean?

Returns Should https certificates be validated?.

Returns:

  • (Boolean, nil) —

    Should https certificates be validated?



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

attribute :validate_certs

#volume_copy_pair_id ⇒ Object?

Returns The id of a given volume copy pair,Mutually exclusive with destination_volume_id, source_volume_id, and search_volume_id,Can use to delete or check presence of volume pairs,Must specify this or (destination_volume_id and source_volume_id).

Returns:

  • (Object, nil) —

    The id of a given volume copy pair,Mutually exclusive with destination_volume_id, source_volume_id, and search_volume_id,Can use to delete or check presence of volume pairs,Must specify this or (destination_volume_id and source_volume_id)



34
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_volume_copy.rb', line 34

attribute :volume_copy_pair_id