aireos_config – Manage Cisco WLC configurations

From Get docs
Ansible/docs/2.8/modules/aireos config module


aireos_config – Manage Cisco WLC configurations

New in version 2.4.


Synopsis

  • AireOS does not use a block indent file syntax, so there are no sections or parents. This module provides an implementation for working with AireOS configurations 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

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

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.

diff_against

-

  • intended
  • running

When using the ansible-playbook --diff command line argument the module can generate diffs against different sources.

When this option is configured as intended, the module will return the diff of the running-config against the configuration provided in the intended_config argument.

When this option is configured as running, the module will return the before and after diff of the running-config with respect to any changes made to the device configuration.

diff_ignore_lines

-

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.

intended_config

-

The intended_config 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 diff_against value and set it to intended.

lines

-

The ordered set of commands that should be configured. The commands must be the exact same commands as found in the device run-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.


aliases: commands

match

-

  • line

  • 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 none, the module will not attempt to compare the source configuration with the running configuration on the remote device.

provider

-

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

Specifies the password to use to authenticate the connection to the remote device.

This value is used to authenticate the SSH session.

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

Specifies the SSH key to use to authenticate the connection to the remote device.

This value is the path to the key used to authenticate the SSH session.

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 the timeout in seconds for communicating with the network device for either connecting or sending commands.

If the timeout is exceeded before the operation is completed, the module will error.

username

string

Configures the username to use to authenticate the connection to the remote device.

This value is used to authenticate the SSH session.

If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

running_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 running_config argument allows the implementer to pass in the configuration to use as the base config for comparison.


aliases: config

save

boolean

  • no

  • yes

The save argument instructs the module to save the running-config to startup-config. This operation is performed after any changes are made to the current running config. If no changes are made, the configuration is still saved to the startup config. This option will always cause the module to return changed. This argument is mutually exclusive with save_when.

This option is deprecated as of Ansible 2.7, use save_when

save_when

-

added in 2.7

  • always
  • never

  • changed

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. If the argument is set to always, then the running-config will always be copied to the startup-config and the module will always return as changed. If the argument is set to never, the running-config will never be copied to the startup-config. If the argument is set to changed, then the running-config will only be copied to the startup-config if the task has made a change.

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.



Examples

- name: configure configuration
  aireos_config:
    lines: sysname testDevice

- name: diff the running-config against a provided config
  aireos_config:
    diff_against: intended
    intended: "{{ lookup('file', 'master.cfg') }}"

- name: load new acl into device
  aireos_config:
    lines:
      - acl create testACL
      - acl rule protocol testACL 1 any
      - acl rule direction testACL 3 in
    before: acl delete testACL

- name: configurable backup path
  aireos_config:
    backup: yes
    lines: sysname testDevice
    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/aireos_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', 'vlan 1', 'name default']

updates

list

always

The set of commands that will be pushed to the remote device


Sample:

['hostname foo', 'vlan 1', 'name default']




Status

Authors

  • James Mighion (@jmighion)

Hint

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


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