f5networks.f5_modules.bigip_message_routing_transport_config (1.28.0) — module

Manages configuration for an outgoing connection

| "added in version" 1.0.0 of f5networks.f5_modules"

Authors: Wojciech Wypior (@wojtek0806)

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0


Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.0

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
name:
    description:
    - Specifies the name of the transport config to manage.
    required: true
    type: str

type:
    choices:
    - generic
    default: generic
    description:
    - Parameter used to specify the type of transport-config object to manage.
    - Default setting is C(generic) with more options coming.
    type: str

rules:
    description:
    - The iRules you want run on this transport config. iRules help automate the intercepting,
      processing, and routing of application traffic.
    elements: str
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description:
    - When C(present), ensures the transport-config object exists.
    - When C(absent), ensures the transport-config object is removed.
    type: str

profiles:
    description:
    - Specifies a list of profiles for the outgoing connection to use to direct and manage
      traffic.
    elements: str
    type: list

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

src_port:
    description:
    - 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.
    type: int

partition:
    default: Common
    description:
    - Device partition to create transport-config object on.
    type: str

description:
    description:
    - The user-defined description of the transport config.
    type: str

src_addr_translation:
    description:
    - Specifies the type of source address translation enabled for the transport config
      and the pool the source address translation will use.
    suboptions:
      pool:
        description:
        - Specifies the name of a LSN or SNAT pool used by the specified transport config.
        - 'Name can also be specified in C(fullPath) format: C(/Common/foobar).'
        - When C(type) is C(none) or C(automap), the pool parameter will be replaced by
          C(none) keyword, thus any defined C(pool) parameter will be ignored.
        type: str
      type:
        choices:
        - snat
        - none
        - automap
        description:
        - Specifies the type of source address translation associated with the specified
          transport config.
        - When set to C(snat), the C(pool) parameter needs to contain a name for a valid
          LSN or SNAT pool.
        type: str
    type: dict

Outputs

description:
  description: The user-defined description of the router profile.
  returned: changed
  sample: My description
  type: str
profiles:
  description: The profiles for the outgoing connection .
  returned: changed
  sample:
  - /Common/profile1
  - /Common/profile2
  type: list
rules:
  description: The iRules running on transport config.
  returned: changed
  sample:
  - /Common/rule1
  - /Common/rule2
  type: list
source_port:
  description: The source port for the connection being created.
  returned: changed
  sample: 10041
  type: int
src_addr_translation:
  contains:
    pool:
      description: The name of a LSN or SNAT pool used by the specified transport
        config.
      returned: changed
      sample: /Common/pool1
      type: str
    type:
      description: the type of source address translation associated with the specified
        transport config.
      returned: changed
      sample: automap
      type: str
  description: The type of source address translation enabled for the transport config.
  returned: changed
  sample: hash/dictionary of values
  type: complex