Try SpotterManage BIG-IP advanced routing configuration sections
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Tim Rupp (@caphrim007), Wojciech Wypior (@wojtek0806)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0This module provides an implementation for working with advanced routing configuration sections in a deterministic way.
- name: configure top level configuration and save it
bigip_imish_config:
lines: bfd slow-timer 2000
save_when: modified
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: diff the running-config against a provided config
bigip_imish_config:
diff_against: intended
intended_config: "{{ lookup('file', 'master.cfg') }}"
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- 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
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- 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
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- 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
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: configurable backup path
bigip_imish_config:
lines: bfd slow-timer 2000
backup: true
provider:
user: admin
password: secret
server: lb.mydomain.com
backup_options:
filename: backup.cfg
dir_path: /home/user
delegate_to: localhost
src:
description:
- The I(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 I(lines) and I(parents) arguments.
type: path
mode:
description:
- The permissions the resulting filesystem object should have.
- For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers.
You must give Ansible enough information to parse them correctly. For consistent
results, quote octal numbers (for example, V('644') or V('1777')) so Ansible receives
a string and can do its own conversion from string into number. Adding a leading
zero (for example, V(0755)) works sometimes, but can fail in loops and some other
circumstances.
- Giving Ansible a number without following either of these rules will end up with
a decimal number which will have unexpected results.
- As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, V(u+rwx)
or V(u=rw,g=r,o=r)).
- If O(mode) is not specified and the destination filesystem object B(does not) exist,
the default C(umask) on the system will be used when setting the mode for the newly
created filesystem object.
- If O(mode) is not specified and the destination filesystem object B(does) exist,
the mode of the existing filesystem object will be used.
- Specifying O(mode) is the best way to ensure filesystem objects are created with
the correct permissions. See CVE-2020-1736 for further details.
type: raw
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.
elements: str
type: list
group:
description:
- Name of the group that should own the filesystem object, as would be fed to I(chown).
- When left unspecified, it uses the current group of the current user unless you
are root, in which case it can preserve the previous ownership.
type: str
lines:
aliases:
- commands
description:
- 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.
elements: str
type: list
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.
type: str
owner:
description:
- Name of the user that should own the filesystem object, as would be fed to I(chown).
- When left unspecified, it uses the current user unless you are root, in which case
it can preserve the previous ownership.
- Specifying a numeric username will be assumed to be a user ID and not a username.
Avoid numeric usernames to avoid this confusion.
type: str
backup:
default: false
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.
- The backup file is written to the C(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.
type: bool
before:
description:
- 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.
elements: str
type: list
serole:
description:
- The role part of the SELinux filesystem object context.
- When set to V(_default), it will use the C(role) portion of the policy if available.
type: str
setype:
description:
- The type part of the SELinux filesystem object context.
- When set to V(_default), it will use the C(type) portion of the policy if available.
type: str
seuser:
description:
- The user part of the SELinux filesystem object context.
- By default it uses the V(system) policy, where applicable.
- When set to V(_default), it will use the C(user) portion of the policy if available.
type: str
parents:
description:
- The ordered set of parents that uniquely identify the section or hierarchy the commands
should be checked against.
- If the C(parents) argument is omitted, the commands are checked against the set
of top level or global commands.
elements: str
type: list
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), the modified lines are pushed to the
device in configuration mode.
- If the replace argument is set to I(block), the entire command block is pushed to
the device in configuration mode if any line is not correct.
type: str
selevel:
description:
- The level part of the SELinux filesystem object context.
- This is the MLS/MCS attribute, sometimes known as the C(range).
- When set to V(_default), it will use the C(level) portion of the policy if available.
type: str
provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- The password for the user account used to connect to the BIG-IP or the BIG-IQ.
- You may omit this option by setting the environment variable C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- 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.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative
privileges on the device.
- You may omit this option by setting the environment variable C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(no), SSL certificates are not validated. Use this only on personally controlled
sites using self-signed certificates.
- You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules
save_when:
choices:
- always
- never
- modified
- changed
default: never
description:
- 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 I(always), the running-config will always be copied to
the startup-config and the I(modified) flag will always be set to C(True).
- If the argument is set to I(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 I(never), the running-config will never be copied to the
startup-config.
- If the argument is set to I(changed), the running-config will only be copied to
the startup-config if the task has made a change.
type: str
attributes:
aliases:
- attr
description:
- The attributes the resulting filesystem object should have.
- To get supported flags look at the man page for I(chattr) on the target system.
- This string should contain the attributes in the same order as the one displayed
by I(lsattr).
- The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to
be included in the string.
type: str
version_added: '2.3'
version_added_collection: ansible.builtin
diff_against:
choices:
- startup
- intended
- running
default: startup
description:
- When using the C(ansible-playbook --diff) command line argument, the module can
generate diffs against different sources.
- When this option is configured as I(startup), the module will return the diff of
the running-config against the startup-config.
- When this option is configured as I(intended), the module will return the diff of
the running-config against the configuration provided in the C(intended_config)
argument.
- When this option is configured as I(running), the module will return the before
and after diff of the running-config with respect to any changes made to the device
configuration.
type: str
route_domain:
default: '0'
description:
- Route domain on which to manage the BGP configuration.
type: str
unsafe_writes:
default: false
description:
- Influence when to use atomic operation to prevent data corruption or inconsistent
reads from the target filesystem object.
- By default this module uses atomic operations to prevent data corruption or inconsistent
reads from the target filesystem objects, but sometimes systems are configured or
just broken in ways that prevent this. One example is docker mounted filesystem
objects, which cannot be updated atomically from inside the container and can only
be written in an unsafe manner.
- This option allows Ansible to fall back to unsafe methods of updating filesystem
objects when atomic operations fail (however, it doesn't force Ansible to perform
unsafe writes).
- IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption.
type: bool
version_added: '2.2'
version_added_collection: ansible.builtin
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, a I(backup) directory will be created in the current working directory
and backup configuration will be copied in C(filename) within the I(backup)
directory.
type: path
filename:
description:
- 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>
type: str
type: dict
running_config:
aliases:
- config
description:
- 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 I(running_config) argument allows the implementer to pass in the configuration
to use as the base config for comparison.
type: str
intended_config:
description:
- The C(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 C(diff_against) value
and set it to I(intended).
type: str
allow_duplicates:
default: false
description:
- Allows duplicate commands to be sent to the device. This is to accommodate scenarios
where address families are configured.
- Only used with the C(lines) parameter.
type: bool
version_added: 1.2.0
version_added_collection: f5networks.f5_modules
diff_ignore_lines:
description:
- 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.
elements: str
type: list
backup_path: description: The full path to the backup file. returned: when backup is yes sample: /playbooks/ansible/backup/bigip_imish_config.2016-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 ANYCAST-P2P-2 - neighbor 20.20.20.21 remote-as 65000 - neighbor 20.20.20.21 fall-over bfd type: list updates: description: The set of commands that will be pushed to the remote device. returned: always sample: - interface ANYCAST-P2P-2 - neighbor 20.20.20.21 remote-as 65000 - neighbor 20.20.20.21 fall-over bfd type: list