Try SpotterManage peers for routing generic message protocol messages
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Wojciech Wypior (@wojtek0806)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Manage peers for routing generic message protocol messages.
- 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
name:
description:
- Specifies the name of the peer to manage.
required: true
type: str
pool:
description:
- Specifies the name of the pool that messages are routed towards.
- The specified pool must be on the same partition as the peer.
type: str
type:
choices:
- generic
default: generic
description:
- Parameter used to specify the type of the peer to manage.
- Default setting is C(generic) with more options coming.
type: str
ratio:
description:
- 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.
type: int
state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the peer exists.
- When C(absent), ensures the peer is removed.
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
auto_init:
description:
- If C(true), the BIG-IP automatically creates outbound connections to the active
pool members in the specified C(pool) using the configuration of the specified C(transport_config).
- 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 C(auto_init) logic verifies at C(auto_init_interval) if the a connection exists
between the BIG-IP and the pool members of the pool. If a connection does not exist,
it attempts to reestablish one.
type: bool
partition:
default: Common
description:
- Device partition to create peer object on.
type: str
description:
description:
- The user-defined description of the peer.
type: str
connection_mode:
choices:
- per-blade
- per-client
- per-peer
- per-tmm
description:
- Specifies how the number of connections per host are to be limited.
type: str
transport_config:
description:
- 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.
type: str
auto_init_interval:
description:
- 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 C(5000)
milliseconds.
- The accepted range is between 0 and 4294967295 inclusive.
type: int
number_of_connections:
description:
- Specifies the distribution of connections between the BIG-IP and a remote host.
- The accepted range is between 0 and 65535 inclusive.
type: int
auto_init:
description: Enables creation of outbound connections to the active pool members.
returned: changed
sample: true
type: bool
auto_init_interval:
description: The interval at which attempts to initiate a connection occur.
returned: changed
sample: 2000
type: int
connection_mode:
description: Specifies how the number of connections per host are to be limited.
returned: changed
sample: per-peer
type: str
description:
description: The user defined description of the peer.
returned: changed
sample: Some description
type: str
number_of_connections:
description: The distribution of connections between the BIG-IP and a remote host.
returned: changed
sample: 2000
type: int
pool:
description: The name of the pool that messages are routed towards.
returned: changed
sample: /Bazbar/foobar
type: str
ratio:
description: The ratio to be used for selection of a peer within a list of peers
in a LTM route.
returned: changed
sample: 500
type: int
transport_config:
description: The LTM virtual or LTM transport-config to use for creating an outgoing
connection.
returned: changed
sample: /Common/foobar
type: str