Try SpotterManage Dell EMC Networking OS6 configuration sections
| "added in version" 2.2 of ansible.builtin"
Authors: Abirami N (@abirami-n)
preview | supported by community
pipInstall with pip install ansible==2.9.3
OS6 configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with OS6 configuration sections in a deterministic way.
- dellos6_config:
lines: ['hostname {{ inventory_hostname }}']
- dellos6_config:
lines:
- 10 permit ip 1.1.1.1 any log
- 20 permit ip 2.2.2.2 any log
- 30 permit ip 3.3.3.3 any log
- 40 permit ip 4.4.4.4 any log
- 50 permit ip 5.5.5.5 any log
parents: ['ip access-list test']
before: ['no ip access-list test']
match: exact
- dellos6_config:
lines:
- 10 permit ip 1.1.1.1 any log
- 20 permit ip 2.2.2.2 any log
- 30 permit ip 3.3.3.3 any log
- 40 permit ip 4.4.4.4 any log
parents: ['ip access-list test']
before: ['no ip access-list test']
replace: block
- dellos6_config:
lines: ['hostname {{ inventory_hostname }}']
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).
save:
default: 'no'
description:
- The C(save) argument instructs the module to save the running- config to the startup-config
at the conclusion of the module running. If check mode is specified, this argument
is ignored.
type: bool
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.
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. This argument is mutually exclusive with I(src).
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.
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. 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.
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(config) argument allows the implementer to
pass in the configuration to use as the base config for comparison.
update:
choices:
- merge
- check
default: merge
description:
- The I(update) argument controls how the configuration statements are processed on
the remote device. Valid choices for the I(update) argument are I(merge) and I(check). When
you set this argument to I(merge), the configuration changes merge with the current
device running configuration. When you set this argument to I(check) the configuration
updates are determined but not actually configured on the remote device.
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.
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.
provider:
description:
- A dict object containing connection details.
suboptions:
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode on the remote
device. If I(authorize) is false, then this argument does nothing. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS)
will be used instead.
type: str
authorize:
description:
- Instructs the module to enter privileged mode on the remote device before sending
any commands. If not specified, the device will attempt to execute all commands
in non-privileged mode. If the value is not specified in the task, the value
of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool
host:
description:
- Specifies the DNS host name or address for connecting to the remote device over
the specified transport. The value of host is used as the destination address
for the transport.
type: str
password:
description:
- Password to authenticate the SSH session to the remote device. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD)
will be used instead.
type: str
port:
description:
- Specifies the port to use when building the connection to the remote device.
type: int
ssh_keyfile:
description:
- Path to an ssh key used to authenticate the SSH session to the remote device. If
the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead.
type: path
timeout:
description:
- Specifies idle timeout (in seconds) for the connection. Useful if the console
freezes before continuing. For example when saving configurations.
type: int
username:
description:
- User to authenticate the SSH session to the remote device. If the value is not
specified in the task, the value of environment variable C(ANSIBLE_NET_USERNAME)
will be used instead.
type: str
type: dict
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: dict
version_added: '2.8'
version_added_collection: ansible.builtin
backup_path:
description: The full path to the backup file
returned: when backup is yes
sample: /playbooks/ansible/backup/dellos6_config.2017-07-16@22:28:34
type: str
commands:
description: The set of commands that will be pushed to the remote device
returned: always
sample:
- interface Te1/0/1
- no shutdown
- exit
type: list
saved:
description: Returns whether the configuration is saved to the startup configuration
or not.
returned: When not check_mode.
sample: true
type: bool
updates:
description: The set of commands that will be pushed to the remote device.
returned: always
sample:
- interface Te1/0/1
- no shutdown
- exit
type: list