Try SpotterManage AlliedWare Plus configuration sections
| "added in version" 2.9 of alliedtelesis.awplus"
Authors: Cheng Yi Kok (@cyk19)
Install with ansible-galaxy collection install alliedtelesis.awplus:==1.2.2
collections:
- name: alliedtelesis.awplus
version: 1.2.2AlliedWare Plus configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with AlliedWare Plus configuration sections in a deterministic way.
- name: Change hostname
alliedtelesis.awplus.awplus_config:
lines:
- hostname aw1
- name: configure interface settings
alliedtelesis.awplus.awplus_config:
lines:
- description test interface
parents: interface port1.0.2
- name: configure ip helpers on multiple interfaces
alliedtelesis.awplus.awplus_config:
lines:
- ip helper-address 172.26.1.10
- ip helper-address 172.26.3.8
parents: "{{ item }}"
with_items:
- interface eth1
- interface vlan1
- name: check startup-config against master config
alliedtelesis.awplus.awplus_config:
diff_against: intended
intended_config: "{{ lookup('file', 'master.cfg') }}"
- name: check the startup-config against the running-config
alliedtelesis.awplus.awplus_config:
diff_against: startup
- name: for idempotency, use full-form commands
alliedtelesis.awplus.awplus_config:
lines:
- shutdown
parents: interface port1.0.2
- name: save running to startup when modified
alliedtelesis.awplus.awplus_config:
save_when: modified
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: str
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. 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 C(line), commands are matched line
by line. If match is set to C(strict), command lines are matched with respect to
position. If match is set to C(exact), command lines must be an equal match. Finally,
if match is set to C(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 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
default: line
description:
- Instructs the module on the way to perform the configuration on the device. If the
replace argument is set to C(line) then the modified lines are pushed to the device
in configuration mode. If the replace argument is set to C(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
- 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 C(always), then the running-config will always be copied
to the startup-config and the C(modified) flag will always be set to True. If the
argument is set to C(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 C(never), the running-config will never be copied to the startup-config. If
the argument is set to C(changed), then the running-config will only be copied to
the startup-config if the task has made a change.
type: str
diff_against:
choices:
- running
- startup
- intended
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 C(startup), the module will return the diff of
the running-config against the startup-config.
- When this option is configured as C(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 C(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 I(backup=yes), if I(backup=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 I(filename) or default
filename as described in I(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 I(filename) within
I(backup) directory.
type: path
filename:
description:
- The filename to be used to store the backup configuration in the format <filename>.<current-date>@<current-time>.
If the filename is not given it will be replaced with `awplus`.
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. This argument allows the implementer to pass in the
configuration to use as the base config for comparison.
type: str
intended_config:
description:
- This 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 C(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
multiline_delimiter:
default: '@'
description:
- This argument is used when pushing a multiline configuration element to the AlliedWare
Plus device. It specifies the character to use as the delimiting character. This
only applies to the configuration action.
type: str
backup_path: description: The path to the backup file returned: when backup is yes sample: ./backup type: str commands: description: The set of commands that will be pushed to the remote device returned: always sample: - hostname foo - router ospf 1 - router-id 192.0.2.1 type: list filename: description: The name of the backup file returned: when backup is yes sample: awplus.2020-12-22@16:36:59.795714 type: str