f5networks.f5_modules.bigip_message_routing_router module – Manages router profiles for message-routing protocols
Note
This module is part of the f5networks.f5_modules collection (version 1.30.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_router
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages router profiles for message-routing protocols.
Parameters
Parameter |
Comments |
---|---|
The user-defined description of the router profile. |
|
When Choices:
|
|
When set to Choices:
|
|
The maximum number of bytes worth of pending messages that will be held while waiting for a connection to a peer to be created. Once reached, any additional messages to the peer will be flagged as undeliverable and returned to the originator. The accepted range is between 0 and 4294967295 inclusive. |
|
The maximum number of pending messages that will be held while waiting for a connection to a peer to be created. Once reached, any additional messages to the peer will be flagged as undeliverable and returned to the originator. The accepted range is between 0 and 65535 inclusive. |
|
Sets the maximum number of time a message may be resubmitted for rerouting by the The accepted range is between 0 and 4294967295 inclusive. |
|
Enables or disables state mirroring. State mirroring can be used to maintain the same state information in the standby unit that is in the active unit. Choices:
|
|
Specifies the maximum time in milliseconds that a message will be held on the standby device as it waits for the active device to route the message. Messages on the standby device held for longer than the configurable sweeper interval, will be dropped. The acceptable range is between 0 and 4294967295 inclusive. |
|
Specifies the name of the router profile. |
|
The parent template of this router profile. Once this value has been set, it cannot be changed. The default values are set by the system if not specified and they correspond to the router type created, for example, |
|
Device partition to create router profile on. Default: |
|
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 a list of static routes for the router instance to use. The route must be on the same partition as router profile. |
|
When When Choices:
|
|
Specifies the traffic-group of the router profile. Setting the |
|
Parameter used to specify the type of the router profile to manage. Default setting is Choices:
|
|
If 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 generic router profile
bigip_message_routing_router:
name: foo
max_retries: 10
ignore_client_port: true
routes:
- /Common/route1
- /Common/route2
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Modify a generic router profile
bigip_message_routing_router:
name: foo
ignore_client_port: false
mirror: true
mirrored_msg_sweeper_interval: 4000
traffic_group: /Common/traffic-group-2
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove a generic router profile
bigip_message_routing_router:
name: foo
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 router profile. Returned: changed Sample: |
|
Enables ignoring of the remote port on clientside connections when searching for an existing connection. Returned: changed Sample: |
|
Specifies if a traffic-group should be inherited from containing folder. Returned: changed Sample: |
|
The maximum number of bytes worth of pending messages that will be held. Returned: changed Sample: |
|
The maximum number of pending messages that will be held. Returned: changed Sample: |
|
The maximum number of time a message may be resubmitted for rerouting. Returned: changed Sample: |
|
Enables or disables state mirroring. Returned: changed Sample: |
|
The maximum time in milliseconds that a message will be held on the standby device. Returned: changed Sample: |
|
The parent template of this router profile. Returned: changed Sample: |
|
The list of static routes for the router instance to use. Returned: changed Sample: |
|
The traffic-group of the router profile. Returned: changed Sample: |
|
Enables routing of messages to an existing connection on the same TMM as the message was received. Returned: changed Sample: |