f5networks.f5_modules.bigip_message_routing_transport_config – Manages configuration for an outgoing connection

Note

This plugin is part of the f5networks.f5_modules collection (version 1.12.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_transport_config.

New in version 1.0.0: of f5networks.f5_modules

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Manages configuration for an outgoing connection in BIG-IP message routing.

Parameters

Parameter		Choices/Defaults	Comments
description string			The user-defined description of the transport config.
name string / required			Specifies the name of the transport config to manage.
partition string		Default: "Common"	Device partition to create transport-config object on.
profiles list / elements=string			Specifies a list of profiles for the outgoing connection to use to direct and manage traffic.
provider dictionary added in 1.0.0 of f5networks.f5_modules			A dict object containing connection details.
	auth_provider string		Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices.
	no_f5_teem boolean	Choices: no ← yes	If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing.
	password string / required		The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd
	server string / required		The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
	server_port integer	Default: 443	The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
	timeout integer		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.
	transport string	Choices: rest ←	Configures the transport connection to use when connecting to the remote device.
	user string / required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`.
	validate_certs boolean	Choices: no yes ←	If `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 `F5_VALIDATE_CERTS`.
rules list / elements=string			The iRules you want run on this transport config. iRules help automate the intercepting, processing, and routing of application traffic.
src_addr_translation dictionary			Specifies the type of source address translation enabled for the transport config and the pool the source address translation will use.
	pool string		Specifies the name of a LSN or SNAT pool used by the specified transport config. Name can also be specified in `fullPath` format: `/Common/foobar`. When `type` is `none` or `automap`, the pool parameter will be replaced by `none` keyword, thus any defined `pool` parameter will be ignored.
	type string	Choices: snat none automap	Specifies the type of source address translation associated with the specified transport config. When set to `snat`, the `pool` parameter needs to contain a name for a valid LSN or SNAT pool.
src_port integer			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.
state string		Choices: present ← absent	When `present`, ensures the transport-config object exists. When `absent`, ensures the transport-config object is removed.
type string		Choices: generic ←	Parameter used to specify the type of transport-config object to manage. Default setting is `generic` with more options coming.

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		Returned	Description
description string		changed	The user-defined description of the router profile. Sample: My description
profiles list / elements=string		changed	The profiles for the outgoing connection . Sample: ['/Common/profile1', '/Common/profile2']
rules list / elements=string		changed	The iRules running on transport config. Sample: ['/Common/rule1', '/Common/rule2']
source_port integer		changed	The source port for the connection being created. Sample: 10041
src_addr_translation complex		changed	The type of source address translation enabled for the transport config. Sample: hash/dictionary of values
	pool string	changed	The name of a LSN or SNAT pool used by the specified transport config. Sample: /Common/pool1
	type string	changed	the type of source address translation associated with the specified transport config. Sample: automap

Authors

Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_message_routing_transport_config_module.html