bigip_imish_config – Manage BIG-IP advanced routing configuration sections

New in version 1.0.0.

Synopsis

  • This module provides an implementation for working with advanced routing configuration sections in a deterministic way.

Parameters

Parameter Choices/Defaults Configuration Comments
after
list / elements=string
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.
allow_duplicates
boolean
added in 1.2.0
    Choices:
  • no ←
  • yes
Allows duplicate commands to be sent to the device. This is to accommodate scenarios where address families are configured.
Only used with the lines parameter.
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.
The backup file is written to the 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.
backup_options
dictionary
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, a backup directory will be created in the current working directory and backup configuration will be copied in filename within the backup directory.
filename
string
The filename to be used to store the backup configuration. If the filename is not given, it will be generated based on the hostname, current time and date in the format defined by <hostname>_config.<current-date>@<current-time>
before
list / elements=string
The ordered set of commands to push onto 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
string
    Choices:
  • startup ←
  • 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 startup, the module will return the diff of the running-config against the startup-config.
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
list / elements=string
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
string
The intended_config provides the master configuration 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
list / elements=string
The ordered set of commands that should be configured in the section.
The commands must be the exact same as those 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.

aliases: commands
match
string
    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
list / elements=string
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
string
    Choices:
  • line ←
  • block
Instructs the module on the way to perform the configuration on the device.
If the replace argument is set to line, the modified lines are pushed to the device in configuration mode.
If the replace argument is set to block, the entire command block is pushed to the device in configuration mode if any line is not correct.
route_domain
string
Default:
0
Route domain on which to manage the BGP configuration.
running_config
string
By default, the module 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 you do not want 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_when
string
    Choices:
  • always
  • never ←
  • modified
  • changed
When changes are made to the device running-configuration, the changes are not copied to non-volatile storage by default.
If the argument is set to always, the running-config will always be copied to the startup-config and the modified flag will always be set to True.
If the argument is set to modified, 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 never, the running-config will never be copied to the startup-config.
If the argument is set to changed, the running-config will only be copied to the startup-config if the task has made a change.
src
path
The src argument provides a path to the configuration file to load into the remote system.
The path can either be a full system path to the configuration file if the value starts with /, or relative to the root of the implemented role or playbook.
This argument is mutually exclusive with the lines and parents arguments.

Notes

Note

  • Abbreviated commands are NOT idempotent

Examples

- hosts: all
  collections:
    - f5networks.f5_bigip
  connection: httpapi

  vars:
    ansible_host: "lb.mydomain.com"
    ansible_user: "admin"
    ansible_httpapi_password: "secret"
    ansible_network_os: f5networks.f5_bigip.bigip
    ansible_httpapi_use_ssl: yes

  tasks:
    - name: Configure top level configuration and save it
      bigip_imish_config:
        lines: bfd slow-timer 2000
        save_when: modified

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

    - name: Add config to a parent block
      bigip_imish_config:
        lines:
          - bgp graceful-restart restart-time 120
          - redistribute kernel route-map rhi
          - neighbor 10.10.10.11 remote-as 65000
          - neighbor 10.10.10.11 fall-over bfd
          - neighbor 10.10.10.11 remote-as 65000
          - neighbor 10.10.10.11 fall-over bfd
        parents: router bgp 64664
        match: exact

    - name: Remove an existing acl before writing it
      bigip_imish_config:
        lines:
          - access-list 10 permit 20.20.20.20
          - access-list 10 permit 20.20.20.21
          - access-list 10 deny any
        before: no access-list 10

    - name: For idempotency, use full-form commands
      bigip_imish_config:
        lines:
          # - desc My interface
          - description My Interface
        # parents: int ANYCAST-P2P-2
        parents: interface ANYCAST-P2P-2

    - name: Configurable backup path
      bigip_imish_config:
        lines: bfd slow-timer 2000
        backup: yes
        backup_options:
          filename: backup.cfg
          dir_path: /home/user

Return Values

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/bigip_imish_config.2016-07-16@22:28:34
commands
list
always
The set of commands that will be pushed to the remote device.

Sample:
['interface ANYCAST-P2P-2', 'neighbor 20.20.20.21 remote-as 65000', 'neighbor 20.20.20.21 fall-over bfd']
updates
list
always
The set of commands that will be pushed to the remote device.

Sample:
['interface ANYCAST-P2P-2', 'neighbor 20.20.20.21 remote-as 65000', 'neighbor 20.20.20.21 fall-over bfd']


Status

Authors

  • Wojciech Wypior (@wojtek0806)