Steampunk Ansible Documentation - f5networks.f5_modules.bigip_message_routing_route (1.28.0) - module - Manages static routes for routing message protocol messages

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 static routes for routing message protocol messages.

Usage examples

Scanned by Steampunk Spotter

- name: Create a simple generic route
  bigip_message_routing_route:
    name: foobar
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Scanned by Steampunk Spotter

- name: Modify a generic route
  bigip_message_routing_route:
    name: foobar
    peers:
      - peer1
      - peer2
    peer_selection_mode: ratio
    src_address: annoying_user
    dst_address: blackhole
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Scanned by Steampunk Spotter

- name: Remove a generic
  bigip_message_routing_route:
    name: foobar
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Inputs

name:
description:
- Specifies the name of the static route.
required: true
type: str

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

peers:
description:
- Specifies a list of ltm messagerouting-peer objects.
- The specified peer must be on the same partition as the route.
elements: str
type: list

state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the route exists.
- When C(absent), ensures the route 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

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

description:
description:
- The user-defined description of the static route.
type: str

dst_address:
description:
- Specifies the destination address of the route.
- Setting the attribute to an empty string will create a wildcard matching all message
destination-addresses, which is the default when creating a new route.
type: str

src_address:
description:
- Specifies the source address of the route.
- Setting the attribute to an empty string will create a wildcard matching all message
source-addresses, which is the default when creating a new route.
type: str

peer_selection_mode:
choices:
- ratio
- sequential
description:
- Specifies the method to use when selecting a peer from the provided list of C(peers).
type: str

Outputs

description:
  description: The user-defined description of the route.
  returned: changed
  sample: Some description
  type: str
dst_address:
  description: The destination address of the route.
  returned: changed
  sample: blackhole
  type: str
peer_selection_mode:
  description: The method to use when selecting a peer.
  returned: changed
  sample: ratio
  type: str
peers:
  description: The list of ltm messagerouting-peer object.
  returned: changed
  sample:
  - /Common/peer1
  - /Common/peer2
  type: list
src_address:
  description: The source address of the route.
  returned: changed
  sample: annyoing_user
  type: str