Try SpotterManage the configuration of Yamaha RTX/NVR/FWX/vRX devices.
| "added in version" 2.10 of yamaha_network.rtx"
Authors: Yamaha Corporation
preview | supported by community
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install yamaha_network.rtx:==1.0.1
collections:
- name: yamaha_network.rtx
version: 1.0.1This module provides an implementation for manage the configuration of Yamaha RTX/NVR/FWX/vRX devices in a deterministic way.
- name: configure hostname
rtx_config:
lines: console prompt {{ inventory_hostname }}
- name: configure lan1 interface settings
rtx_config:
lines:
- description lan1 test
- ip lan1 address 192.168.100.1/24
- name: configure description for pp
rtx_config:
lines:
- description pp test
parents:
- pp select anonymous
- name: check the running config against master config
rtx_config:
diff_against: intended
diff_ignore_lines:
- administrator password
- login
intended_config: "{{ lookup('file', 'master.cfg') }}"
- name: configurable backup path
rtx_config:
src: rtx_template.j2
backup: yes
backup_options:
filename: backup.cfg
dir_path: /home/user
src:
description:
- Specifies the source path to the file that contains the configuration or configuration
template to load. The path to the source file can either be the full path on the
Ansible control host or a relative path from the playbook or role root directory. This
argument is mutually exclusive with I(lines), I(parents).
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 config. 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: 'no'
description:
- This argument will cause the module to create a full backup of the running C(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 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.
elements: str
type: list
replace:
choices:
- line
- block
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.
type: str
save_when:
choices:
- always
- never
- changed
default: never
description:
- When changes are made to the device running config, 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 default config. If the argument is set to I(never), the running config will
never be copied to the default config. If the argument is set to I(changed), then
the running config will only be copied to the default config if the task has made
a change.
type: str
diff_against:
choices:
- running
- intended
description:
- When using the C(ansible-playbook --diff) command line argument the module can generate
diffs against different sources.
- 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 th is option is configured as I(running), the module will return the before
and after diff of the running configuration 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(yes), if C(backup)
is set to I(no) 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
first 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 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 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 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.
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 configuration 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).
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/rtx_config.2020-02-04@12:24:48 type: str commands: description: The set of commands that will be pushed to the remote device returned: always sample: - console prompt foo - ip lan2 address dhcp type: list date: description: The date extracted from the backup file name returned: when backup is yes sample: '2020-02-04' type: str filename: description: The name of the backup file returned: when backup is yes and filename is not specified in backup options sample: rtx_config.2020-02-04@12:24:48 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/rtx_config type: str time: description: The time extracted from the backup file name returned: when backup is yes sample: '12:24:48' type: str updates: description: The set of commands that will be pushed to the remote device returned: always sample: - console prompt foo - ip lan2 address dhcp type: list