f5networks.f5_modules.bigip_message_routing_peer module – Manage peers for routing generic message protocol messages
Note
This module is part of the f5networks.f5_modules collection (version 1.33.0).
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_peer.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage peers for routing generic message protocol messages.
Parameters
Parameter |
Comments |
|---|---|
If For auto-initialization to attempt to create a connection, the peer must be included in a route that is attached to a router instance. For each router instance the peer is contained in, a connection is initiated. The Choices:
|
|
Specifies the interval at which attempts to initiate a connection occur. The default value upon peer object creation, that is supplied by the system is The accepted range is between 0 and 4294967295 inclusive. |
|
Specifies how the number of connections per host are to be limited. Choices:
|
|
The user-defined description of the peer. |
|
Specifies the name of the peer to manage. |
|
Specifies the distribution of connections between the BIG-IP and a remote host. The accepted range is between 0 and 65535 inclusive. |
|
Device partition to create peer object on. Default: |
|
Specifies the name of the pool that messages are routed towards. The specified pool must be on the same partition as the peer. |
|
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 ratio to be used for selection of a peer within a list of peers in a LTM route. The accepted range is between 0 and 4294967295 inclusive. |
|
When When Choices:
|
|
The name of the LTM virtual or LTM transport-config to use for creating an outgoing connection. The resource must exist on the same partition as the peer object. |
|
Parameter used to specify the type of the peer 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 peer
bigip_message_routing_peer:
name: foobar
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create message routing peer with additional settings
bigip_message_routing_peer:
name: foobar
connection_mode: per-blade
pool: /baz/bar
partition: baz
transport_config: foovirtual
ratio: 10
auto_init: true
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Modify message routing peer settings
bigip_message_routing_peer:
name: foobar
partition: baz
ratio: 20
auto_init_interval: 2000
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove message routing peer
bigip_message_routing_peer:
name: foobar
partition: baz
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 |
|---|---|
Enables creation of outbound connections to the active pool members. Returned: changed Sample: |
|
The interval at which attempts to initiate a connection occur. Returned: changed Sample: |
|
Specifies how the number of connections per host are to be limited. Returned: changed Sample: |
|
The user defined description of the peer. Returned: changed Sample: |
|
The distribution of connections between the BIG-IP and a remote host. Returned: changed Sample: |
|
The name of the pool that messages are routed towards. Returned: changed Sample: |
|
The ratio to be used for selection of a peer within a list of peers in a LTM route. Returned: changed Sample: |
|
The LTM virtual or LTM transport-config to use for creating an outgoing connection. Returned: changed Sample: |