Class: Ansible::Ruby::Modules::Nxos_config

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Nxos_config

Defined in:

lib/ansible/ruby/modules/generated/network/nxos/nxos_config.rb

Overview

Cisco NXOS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with NXOS configuration sections in a deterministic way. This module works with either CLI or NXAPI transports.

Instance Method Summary

• #after ⇒ Object^?

  The ordered set of commands to append to the end of the command stack if a change needs to be made.

• #backup ⇒ :yes, ...

  This argument will cause the module to create a full backup of the current C(running-config) from the remote device before any changes are made.

• #before ⇒ String^?

  The ordered set of commands to push on to the command stack if a change needs to be made.

• #defaults ⇒ :yes, ...

  The I(defaults) argument will influence how the running-config is collected from the device.

• #diff_against ⇒ :startup, ...

  When using the C(ansible-playbook –diff) command line argument the module can generate diffs against different sources.,When this option is configure as I(startup), the module will return the diff of the running-config against the startup-config.,When this option is configured as I(intended), the module will return the diff of the running-config against the configuration provided in the C(intended_config) argument.,When this option is configured as I(running), the module will return the before and after diff of the running-config with respect to any changes made to the device configuration.

• #diff_ignore_lines ⇒ Object^?

  Use this argument to specify one or more lines that should be ignored during the diff.

• #force ⇒ :yes, ...

  The force argument instructs the module to not consider the current devices running-config.

• #intended_config ⇒ String^?

  The C(intended_config) provides the master configuration that the node should conform to and is used to check the final running-config against.

• #lines ⇒ Array<String>, ...

  The ordered set of commands that should be configured in the section.

• #match ⇒ :line, ...

  Instructs the module on the way to perform the matching of the set of commands against the current device config.

• #parents ⇒ String^?

  The ordered set of parents that uniquely identify the section or hierarchy the commands should be checked against.

• #replace ⇒ :line, ...

  Instructs the module on the way to perform the configuration on the device.

• #replace_src ⇒ String^?

  The I(replace_src) argument provides path to the configuration file to load into the remote system.

• #running_config ⇒ Object^?

  The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source.

• #save ⇒ :yes, ...

  The C(save) argument instructs the module to save the running-config to startup-config.

• #save_when ⇒ :always, ...

  When changes are made to the device running-configuration, the changes are not copied to non-volatile storage by default.

• #src ⇒ Object^?

  The I(src) argument provides a path to the configuration file to load into the remote system.

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

#after ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_config.rb', line 31

attribute :after

#backup ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_config.rb', line 46

attribute :backup

#before ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_config.rb', line 27

attribute :before

#defaults ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_config.rb', line 53

attribute :defaults

#diff_against ⇒ :startup, ...

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_config.rb', line 65

attribute :diff_against

#diff_ignore_lines ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_config.rb', line 69

attribute :diff_ignore_lines

#force ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_config.rb', line 42

attribute :force

#intended_config ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_config.rb', line 72

attribute :intended_config

#lines ⇒ Array<String>, ...

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

attribute :lines

#match ⇒ :line, ...

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_config.rb', line 34

attribute :match

#parents ⇒ String^?

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

attribute :parents

#replace ⇒ :line, ...

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_config.rb', line 38

attribute :replace

#replace_src ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_config.rb', line 23

attribute :replace_src

#running_config ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_config.rb', line 50

attribute :running_config

#save ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_config.rb', line 57

attribute :save

#save_when ⇒ :always, ...

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_config.rb', line 61

attribute :save_when

#src ⇒ Object^?

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

attribute :src