Try SpotterManage Cisco NXOS configuration sections
| "added in version" 1.0.0 of cisco.nxos"
Authors: Peter Sprygada (@privateip)
Install with ansible-galaxy collection install cisco.nxos:==7.0.0
collections:
- name: cisco.nxos
version: 7.0.0Cisco 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.
- name: configure top level configuration and save it
cisco.nxos.nxos_config:
lines: hostname {{ inventory_hostname }}
save_when: modified
- name: diff the running-config against a provided config
cisco.nxos.nxos_config:
diff_against: intended
intended_config: "{{ lookup('file', 'master.cfg') }}"
- cisco.nxos.nxos_config:
lines:
- 10 permit ip 192.0.2.1/32 any log
- 20 permit ip 192.0.2.2/32 any log
- 30 permit ip 192.0.2.3/32 any log
- 40 permit ip 192.0.2.4/32 any log
- 50 permit ip 192.0.2.5/32 any log
parents: ip access-list test
before: no ip access-list test
match: exact
- cisco.nxos.nxos_config:
lines:
- 10 permit ip 192.0.2.1/32 any log
- 20 permit ip 192.0.2.2/32 any log
- 30 permit ip 192.0.2.3/32 any log
- 40 permit ip 192.0.2.4/32 any log
parents: ip access-list test
before: no ip access-list test
replace: block
- name: replace config with flat file
cisco.nxos.nxos_config:
replace_src: config.txt
replace: config
- name: for idempotency, use full-form commands
cisco.nxos.nxos_config:
lines:
# - shut
- shutdown
# parents: int eth1/1
parents: interface Ethernet1/1
- name: configurable backup path
cisco.nxos.nxos_config:
backup: true
backup_options:
filename: backup.cfg
dir_path: /home/user
src:
description:
- The I(src) argument provides a path to the configuration file to load into the remote
system. The path can either be a full system path to the configuration file if
the value starts with / or relative to the root of the implemented role or playbook.
This argument is mutually exclusive with the I(lines) and I(parents) arguments.
The configuration lines in the source file should be similar to how it will appear
if present in the running-configuration of the device including indentation to ensure
idempotency and correct diff.
type: path
after:
description:
- The ordered set of commands to append to the end of the command stack if a change
needs to be made. Just like with I(before) this allows the playbook designer to
append a set of commands to be executed after the command set.
elements: str
type: list
lines:
aliases:
- commands
description:
- The ordered set of commands that should be configured in the section. The commands
must be the exact same commands as found in the device running-config to ensure
idempotency and correct diff. Be sure to note the configuration command syntax as
some commands are automatically modified by the device config parser.
elements: str
type: list
match:
choices:
- line
- strict
- exact
- none
default: line
description:
- Instructs the module on the way to perform the matching of the set of commands against
the current device config. If match is set to I(line), commands are matched line
by line. If match is set to I(strict), command lines are matched with respect to
position. If match is set to I(exact), command lines must be an equal match. Finally,
if match is set to I(none), the module will not attempt to compare the source configuration
with the running configuration on the remote device.
type: str
backup:
default: false
description:
- 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. If the C(backup_options) value
is not given, the backup file is written to the C(backup) folder in the playbook
root directory or role root directory, if playbook is part of an ansible role. If
the directory does not exist, it is created.
type: bool
before:
description:
- The ordered set of commands to push on to the command stack if a change needs to
be made. This allows the playbook designer the opportunity to perform configuration
commands prior to pushing any changes without affecting how the set of commands
are matched against the system.
elements: str
type: list
parents:
description:
- The ordered set of parents that uniquely identify the section or hierarchy the commands
should be checked against. If the parents argument is omitted, the commands are
checked against the set of top level or global commands.
elements: str
type: list
replace:
choices:
- line
- block
- config
default: line
description:
- Instructs the module on the way to perform the configuration on the device. If
the replace argument is set to I(line) then the modified lines are pushed to the
device in configuration mode. If the replace argument is set to I(block) then the
entire command block is pushed to the device in configuration mode if any line is
not correct. replace I(config) will only work for NX-OS versions that support `config
replace`.
type: str
defaults:
default: false
description:
- The I(defaults) argument will influence how the running-config is collected from
the device. When the value is set to true, the command used to collect the running-config
is append with the all keyword. When the value is set to false, the command is
issued without the all keyword
type: bool
save_when:
choices:
- always
- never
- modified
- changed
default: never
description:
- When changes are made to the device running-configuration, the changes are not copied
to non-volatile storage by default. Using this argument will change that before. If
the argument is set to I(always), then the running-config will always be copied
to the startup-config and the I(modified) flag will always be set to True. If the
argument is set to I(modified), then the running-config will only be copied to the
startup-config if it has changed since the last save to startup-config. If the
argument is set to I(never), the running-config will never be copied to the startup-config. If
the argument is set to I(changed), then the running-config will only be copied to
the startup-config if the task has made a change. I(changed) was added in Ansible
2.6.
type: str
replace_src:
description:
- The I(replace_src) argument provides path to the configuration file to load into
the remote system. This argument is used to replace the entire config with a flat-file.
This is used with argument I(replace) with value I(config). This is mutually exclusive
with the I(lines) and I(src) arguments. This argument will only work for NX-OS versions
that support `config replace`. Use I(nxos_file_copy) module to copy the flat file
to remote device and then use the path with this argument. The configuration lines
in the file should be similar to how it will appear if present in the running-configuration
of the device including the indentation to ensure idempotency and correct diff.
type: str
diff_against:
choices:
- startup
- intended
- running
description:
- 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.
type: str
backup_options:
description:
- This is a dict object containing configurable options related to backup file path.
The value of this option is read only when C(backup) is set to I(True), if C(backup)
is set to I(false) this option will be silently ignored.
suboptions:
dir_path:
description:
- This option provides the path ending with directory name in which the backup
configuration file will be stored. If the directory does not exist it will be
created and the filename is either the value of C(filename) or default filename
as described in C(filename) options description. If the path value is not given
in that case a I(backup) directory will be created in the current working directory
and backup configuration will be copied in C(filename) within I(backup) directory.
type: path
filename:
description:
- The filename to be used to store the backup configuration. If the filename is
not given it will be generated based on the hostname, current time and date
in format defined by <hostname>_config.<current-date>@<current-time>
type: str
type: dict
running_config:
aliases:
- config
description:
- 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(running_config) argument allows the implementer
to pass in the configuration to use as the base config for comparison. The configuration
lines for this option should be similar to how it will appear if present in the
running-configuration of the device including the indentation to ensure idempotency
and correct diff.
type: str
intended_config:
description:
- The C(intended_config) provides the master configuration that the node should conform
to and is used to check the final running-config against. This argument will not
modify any settings on the remote device and is strictly used to check the compliance
of the current device's configuration against. When specifying this argument, the
task should also modify the C(diff_against) value and set it to I(intended). The
configuration lines for this value should be similar to how it will appear if present
in the running-configuration of the device including the indentation to ensure correct
diff.
type: str
diff_ignore_lines:
description:
- Use this argument to specify one or more lines that should be ignored during the
diff. This is used for lines in the configuration that are automatically updated
by the system. This argument takes a list of regular expressions or exact line
matches.
elements: str
type: list
backup_path: description: The full path to the backup file returned: when backup is yes sample: /playbooks/ansible/backup/nxos_config.2016-07-16@22:28:34 type: str commands: description: The set of commands that will be pushed to the remote device returned: always sample: - hostname foo - vlan 1 - name default type: list date: description: The date extracted from the backup file name returned: when backup is yes sample: '2016-07-16' type: str filename: description: The name of the backup file returned: when backup is yes and filename is not specified in backup options sample: nxos_config.2016-07-16@22:28:34 type: str shortname: description: The full path to the backup file excluding the timestamp returned: when backup is yes and filename is not specified in backup options sample: /playbooks/ansible/backup/nxos_config type: str time: description: The time extracted from the backup file name returned: when backup is yes sample: '22:28:34' type: str updates: description: The set of commands that will be pushed to the remote device returned: always sample: - hostname foo - vlan 1 - name default type: list