f5networks.f5_modules.bigip_message_routing_route module – Manages static routes for routing message protocol messages
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_message_routing_route
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages static routes for routing message protocol messages.
Parameters
Parameter |
Comments |
---|---|
The user-defined description of the static route. |
|
Specifies the destination address of the route. Setting the attribute to an empty string will create a wildcard matching all message destination-addresses, which is the default when creating a new route. |
|
Specifies the name of the static route. |
|
Device partition to create route object on. Default: |
|
Specifies the method to use when selecting a peer from the provided list of Choices:
|
|
Specifies a list of ltm messagerouting-peer objects. The specified peer must be on the same partition as the route. |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
Specifies the source address of the route. Setting the attribute to an empty string will create a wildcard matching all message source-addresses, which is the default when creating a new route. |
|
When When Choices:
|
|
Parameter used to specify the type of the route to manage. Default setting is Choices:
|
Notes
Note
Requires BIG-IP >= 14.0.0
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- name: Create a simple generic route
bigip_message_routing_route:
name: foobar
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Modify a generic route
bigip_message_routing_route:
name: foobar
peers:
- peer1
- peer2
peer_selection_mode: ratio
src_address: annoying_user
dst_address: blackhole
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove a generic
bigip_message_routing_route:
name: foobar
state: absent
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The user-defined description of the route. Returned: changed Sample: |
|
The destination address of the route. Returned: changed Sample: |
|
The method to use when selecting a peer. Returned: changed Sample: |
|
The list of ltm messagerouting-peer object. Returned: changed Sample: |
|
The source address of the route. Returned: changed Sample: |