dellos6_config - Manage Dell EMC Networking OS6 configuration sections

New in version 2.2.

Synopsis

  • 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.

Options

parameter required default choices comments
after
 no
The ordered set of commands to append to the end of the command stack if a change needs to be made. As with before, the playbook designer can use this to append a set of commands to be executed after the command set.
backup
 no
  • yes
  • no
This argument causes the module to create a full backup of the current running-config from the remote device before any changes are made. The backup file is written to the backup folder in the playbook root directory. If the directory does not exist, it is created.
before
 no
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
 no
The playbook designer can use the config argument to supply the base configuration to be used to validate necessary configuration changes. If you specify this argument, the module does not download the running-config from the remote node.
lines
 no
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. Note the configuration command syntax as the device config parser automatically modifies some commands. This argument is mutually exclusive with src.
aliases: commands
match
 no line
  • line
  • strict
  • exact
  • none
Instructs the module on the way to perform the matching of the set of commands against the current device config. If you set match to line, commands match line by line. If you set match to strict, command lines matched by respect to position. If you set match to exact, command lines must be an equal match. Finally, if you set match to none, the module does not attempt to compare the source configuration with the running configuration on the remote device.
parents
 no
The ordered set of parents that uniquely identify the section the commands should be checked against. If you omit the parents argument, the commands are checked against the set of top level or global commands.
provider
 no
A dict object containing connection details.
Dictionary object provider
parameter required default choices comments
username
 no
User to authenticate the SSH session to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
host
 yes
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.
ssh_keyfile
 no
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 ANSIBLE_NET_SSH_KEYFILE will be used instead.
timeout
 no 10
Specifies idle timeout (in seconds) for the connection. Useful if the console freezes before continuing. For example when saving configurations.
password
 no
Password to authenticate the SSH session to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port
 no 22
Specifies the port to use when building the connection to the remote device.
replace
 no line
  • line
  • block
Instructs the module on the way to perform the configuration on the device. If you set the replace argument to line, then the modified lines are pushed to the device in configuration mode. If you set the replace argument to block then the entire command block is pushed to the device in configuration mode if any line is not correct.
save
 no
  • yes
  • no
The save argument instructs the module to save the running- config to the startup-config at the conclusion of the module running. If you specify check mode, this argument is ignored.
src
 no
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 lines.
update
 no merge
  • merge
  • check
The update argument controls how the configuration statements are processed on the remote device. Valid choices for the update argument are merge and check. When you set this argument to merge, the configuration changes merge with the current device running configuration. When you set this argument to check the configuration updates are determined but not actually configured on the remote device.

Examples

- dellos6_config:
    lines: ['hostname {{ inventory_hostname }}']
    provider: "{{ cli }}"

- 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
    provider: "{{ cli }}"

- 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
    provider: "{{ cli }}"

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
backup_path
The full path to the backup file
 when backup is yes string /playbooks/ansible/backup/dellos6_config.2016-07-16@22:28:34
responses
The set of responses from issuing the commands on the device.
 When not check_mode. list ['...', '...']
saved
Returns whether the configuration is saved to the startup configuration or not.
 When not check_mode. bool True
updates
The set of commands pushed to the remote device.
 Always. list ['...', '...']

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/dellos6_config_module.html