dellos9_config – Manage Dell EMC Networking OS9 configuration sections — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# dellos9_config – Manage Dell EMC Networking OS9 configuration sections

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- OS9 configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with OS9 configuration sections in a deterministic way.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
after - |  | The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with before this allows the playbook designer to append a set of commands to be executed after the command set.
backup boolean | Choices: no ← yes | This argument will cause the module to create a full backup of the current `running-config` from the remote device before any changes are made. If the `backup_options` value is not given, the backup file is written to the `backup` folder in the playbook root directory. If the directory does not exist, it is created.
backup_options dictionary added in 2.8 |  | This is a dict object containing configurable options related to backup file path. The value of this option is read only when `backup` is set to yes, if `backup` is set to no this option will be silently ignored.
| dir_path path |  | 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 `filename` or default filename as described in `filename` options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in `filename` within backup directory.
| filename - |  | 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>
before - |  | 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 - |  | 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 config argument allows the implementer to pass in the configuration to use as the base config for comparison.
lines - |  | 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 src. aliases: commands
match - | Choices: 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 match is set to line, commands are matched line by line. If match is set to strict, command lines are matched with respect to position. If match is set to exact, command lines must be an equal match. Finally, if match is set to none, the module will not attempt to compare the source configuration with the running configuration on the remote device.
parents - |  | 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.
provider dictionary |  | A dict object containing connection details.
| host string / required |  | 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.
| password string |  | 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 integer | Default: 22 | Specifies the port to use when building the connection to the remote device.
| ssh_keyfile path |  | 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 integer | Default: 10 | Specifies idle timeout (in seconds) for the connection. Useful if the console freezes before continuing. For example when saving configurations.
| username string |  | 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.
replace - | Choices: line ← block | Instructs the module on the way to perform the configuration on the device. If the replace argument is set to line then the modified lines are pushed to the device in configuration mode. If the replace argument is set to block then the entire command block is pushed to the device in configuration mode if any line is not correct.
save boolean | Choices: no ← yes | The `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.
src - |  | 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 - | Choices: 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.

## Notes

Note

- This module requires Dell OS9 version 9.10.0.1P13 or above.
- This module requires to increase the ssh connection rate limit. Use the following command ip ssh connection-rate-limit 60 to configure the same. This can also be done with the dellos9_config module.
- For more information on using Ansible to manage Dell EMC Network devices see https://www.ansible.com/ansible-dell-networking.

## Examples

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

    - dellos9_config:
        lines:
          - 10 permit ip host 1.1.1.1 any log
          - 20 permit ip host 2.2.2.2 any log
          - 30 permit ip host 3.3.3.3 any log
          - 40 permit ip host 4.4.4.4 any log
          - 50 permit ip host 5.5.5.5 any log
        parents: ['ip access-list extended test']
        before: ['no ip access-list extended test']
        match: exact

    - dellos9_config:
        lines:
          - 10 permit ip host 1.1.1.1 any log
          - 20 permit ip host 2.2.2.2 any log
          - 30 permit ip host 3.3.3.3 any log
          - 40 permit ip host 4.4.4.4 any log
        parents: ['ip access-list extended test']
        before: ['no ip access-list extended test']
        replace: block

    - dellos9_config:
        lines: ['hostname {{ inventory_hostname }}']
        provider: "{{ cli }}"
        backup: yes
        backup_options:
          filename: backup.cfg
          dir_path: /home/user

## Return Values

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

Key | Returned | Description
--- | --- | ---
backup_path string | when backup is yes | The full path to the backup file Sample: /playbooks/ansible/backup/dellos9_config.2016-07-16@22:28:34
commands list | always | The set of commands that will be pushed to the remote device Sample: ['hostname foo', 'router bgp 1', 'bgp router-id 1.1.1.1']
saved boolean | When not check_mode. | Returns whether the configuration is saved to the startup configuration or not. Sample: True
updates list | always | The set of commands that will be pushed to the remote device. Sample: ['hostname foo', 'router bgp 1', 'bgp router-id 1.1.1.1']

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Dhivya P (@dhivyap)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.