Class: Ansible::Ruby::Modules::Nxos_snapshot

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/nxos/nxos_snapshot.rb

Overview

Create snapshots of the running states of selected features, add new show commands for snapshot creation, delete and compare existing 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, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#action ⇒ :add, ...

Returns Define what snapshot action the module would perform.

Returns:

  • (:add, :compare, :create, :delete, :delete_all) —

    Define what snapshot action the module would perform.



12
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snapshot.rb', line 12

attribute :action

#compare_option ⇒ :summary, ...

Returns Snapshot options to be used when C(action=compare).

Returns:

  • (:summary, :ipv4routes, :ipv6routes, nil) —

    Snapshot options to be used when C(action=compare).



36
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snapshot.rb', line 36

attribute :compare_option

#comparison_results_file ⇒ String?

Returns Name of the file where snapshots comparison will be stored when C(action=compare).

Returns:

  • (String, nil) —

    Name of the file where snapshots comparison will be stored when C(action=compare).



32
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snapshot.rb', line 32

attribute :comparison_results_file

#description ⇒ String?

Returns Snapshot description to be used when C(action=create).

Returns:

  • (String, nil) —

    Snapshot description to be used when C(action=create).



20
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snapshot.rb', line 20

attribute :description

#element_key1 ⇒ String?

Returns Specify the tags used to distinguish among row entries, to be used when C(action=add).

Returns:

  • (String, nil) —

    Specify the tags used to distinguish among row entries, to be used when C(action=add).



52
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snapshot.rb', line 52

attribute :element_key1

#element_key2 ⇒ Object?

Returns Specify the tags used to distinguish among row entries, to be used when C(action=add).

Returns:

  • (Object, nil) —

    Specify the tags used to distinguish among row entries, to be used when C(action=add).



56
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snapshot.rb', line 56

attribute :element_key2

#path ⇒ String?

Returns Specify the path of the file where new created snapshot or snapshots comparison will be stored, to be used when C(action=create) and C(save_snapshot_locally=true) or C(action=compare).

Returns:

  • (String, nil) —

    Specify the path of the file where new created snapshot or snapshots comparison will be stored, to be used when C(action=create) and C(save_snapshot_locally=true) or C(action=compare).



63
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snapshot.rb', line 63

attribute :path

#row_id ⇒ String?

Returns Specifies the tag of each row entry of the show command’s XML output, to be used when C(action=add).

Returns:

  • (String, nil) —

    Specifies the tag of each row entry of the show command’s XML output, to be used when C(action=add).



48
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snapshot.rb', line 48

attribute :row_id

#save_snapshot_locally ⇒ :yes, ...

Returns Specify to locally store a new created snapshot, to be used when C(action=create).

Returns:

  • (:yes, :no, nil) —

    Specify to locally store a new created snapshot, to be used when C(action=create).



59
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snapshot.rb', line 59

attribute :save_snapshot_locally

#section ⇒ String?

Returns Used to name the show command output, to be used when C(action=add).

Returns:

  • (String, nil) —

    Used to name the show command output, to be used when C(action=add).



40
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snapshot.rb', line 40

attribute :section

#show_command ⇒ String?

Returns Specify a new show command, to be used when C(action=add).

Returns:

  • (String, nil) —

    Specify a new show command, to be used when C(action=add).



44
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snapshot.rb', line 44

attribute :show_command

#snapshot1 ⇒ String?

Returns First snapshot to be used when C(action=compare).

Returns:

  • (String, nil) —

    First snapshot to be used when C(action=compare).



24
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snapshot.rb', line 24

attribute :snapshot1

#snapshot2 ⇒ String?

Returns Second snapshot to be used when C(action=compare).

Returns:

  • (String, nil) —

    Second snapshot to be used when C(action=compare).



28
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snapshot.rb', line 28

attribute :snapshot2

#snapshot_name ⇒ String?

Returns Snapshot name, to be used when C(action=create) or C(action=delete).

Returns:

  • (String, nil) —

    Snapshot name, to be used when C(action=create) or C(action=delete).



16
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snapshot.rb', line 16

attribute :snapshot_name