Class: Ansible::Ruby::Modules::Nxos_template

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/core/network/nxos/nxos_template.rb

Overview

Manages network device configurations over SSH or NXAPI. This module allows implementors to work with the device running-config. It provides a way to push a set of commands onto a network device by evaluting the current running-config and only pushing configuration commands that are not already configured. The config source can be a set of commands or a template.

Instance Method Summary

• #backup ⇒ Boolean^?

  When this argument is configured true, the module will backup the running-config from the node prior to making any changes.

• #config ⇒ String^?

  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.

• #force ⇒ Boolean^?

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

• #include_defaults ⇒ Boolean^?

  The module, by default, will collect the current device running-config to use as a base for comparision to the commands in I(src).

• #src ⇒ String^?

  The path to the config source.

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

#backup ⇒ Boolean^?

Returns When this argument is configured true, the module will backup the running-config from the node prior to making any changes. The backup file will be written to backup_hostname } in the root of the playbook directory.

Returns:

• (Boolean, nil) —

  When this argument is configured true, the module will backup the running-config from the node prior to making any changes. The backup file will be written to backup_hostname } in the root of the playbook directory.

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

attribute :backup

#config ⇒ String^?

Returns 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. There are times when it is not desirable to have the task get the current running-config for every task in a playbook. The I(config) argument allows the implementer to pass in the configuruation to use as the base config for comparision.

Returns:

• (String, nil) —

  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. There are times when it is not desirable to have the task get the current running-config for every task in a playbook. The I(config) argument allows the implementer to pass in the configuruation to use as the base config for comparision.

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

attribute :config

#force ⇒ Boolean^?

Returns The force argument instructs the module to not consider the current devices running-config. When set to true, this will cause the module to push the contents of I(src) into the device without first checking if already configured.

Returns:

• (Boolean, nil) —

  The force argument instructs the module to not consider the current devices running-config. When set to true, this will cause the module to push the contents of I(src) into the device without first checking if already configured.

# File 'lib/ansible/ruby/modules/generated/core/network/nxos/nxos_template.rb', line 15

attribute :force

#include_defaults ⇒ Boolean^?

Returns The module, by default, will collect the current device running-config to use as a base for comparision to the commands in I(src). Setting this value to true will cause the module to issue the command ‘show running-config all` to include all device settings.

Returns:

• (Boolean, nil) —

  The module, by default, will collect the current device running-config to use as a base for comparision to the commands in I(src). Setting this value to true will cause the module to issue the command ‘show running-config all` to include all device settings.

# File 'lib/ansible/ruby/modules/generated/core/network/nxos/nxos_template.rb', line 19

attribute :include_defaults

#src ⇒ String^?

Returns The path to the config source. The source can be either a file with config or a template that will be merged during runtime. By default the task will search for the source file in role or playbook root folder in templates directory.

Returns:

• (String, nil) —

  The path to the config source. The source can be either a file with config or a template that will be merged during runtime. By default the task will search for the source file in role or playbook root folder in templates directory.

# File 'lib/ansible/ruby/modules/generated/core/network/nxos/nxos_template.rb', line 11

attribute :src