f5networks.f5_modules.bigip_message_routing_transport_config module – Manages configuration for an outgoing connection
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_transport_config
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages configuration for an outgoing connection in BIG-IP message routing.
Parameters
Parameter |
Comments |
---|---|
The user-defined description of the transport config. |
|
Specifies the name of the transport config to manage. |
|
Device partition to create transport-config object on. Default: |
|
Specifies a list of profiles for the outgoing connection to use to direct and manage traffic. |
|
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:
|
|
The iRules you want run on this transport config. iRules help automate the intercepting, processing, and routing of application traffic. |
|
Specifies the type of source address translation enabled for the transport config and the pool the source address translation will use. |
|
Specifies the name of a LSN or SNAT pool used by the specified transport config. Name can also be specified in When |
|
Specifies the type of source address translation associated with the specified transport config. When set to Choices:
|
|
Specifies the source port for the connection being created. If no value is specified an ephemeral port is chosen for the connection being created. The acceptable range is between 0 and 65535 inclusive. |
|
When When Choices:
|
|
Parameter used to specify the type of transport-config object 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 generic transport config
bigip_message_routing_transport_config:
name: foo
profiles:
transport: genericmsg
tcp: tcp-lan-optimized
description: new_transport
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Modify generic transport config
bigip_message_routing_transport_config:
name: foo
rules:
- rule_1
- rule_2
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove generic transport config
bigip_message_routing_transport_config:
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: |
|
The profiles for the outgoing connection . Returned: changed Sample: |
|
The iRules running on transport config. Returned: changed Sample: |
|
The source port for the connection being created. Returned: changed Sample: |
|
The type of source address translation enabled for the transport config. Returned: changed Sample: |
|
The name of a LSN or SNAT pool used by the specified transport config. Returned: changed Sample: |
|
the type of source address translation associated with the specified transport config. Returned: changed Sample: |