f5networks.f5_modules.bigip_message_routing_router (1.28.0) — module

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 router profiles for message-routing protocols.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create a generic router profile
  bigip_message_routing_router:
    name: foo
    max_retries: 10
    ignore_client_port: true
    routes:
      - /Common/route1
      - /Common/route2
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Modify a generic router profile
  bigip_message_routing_router:
    name: foo
    ignore_client_port: false
    mirror: true
    mirrored_msg_sweeper_interval: 4000
    traffic_group: /Common/traffic-group-2
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove a generic router profile
  bigip_message_routing_router:
    name: foo
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Inputs

    
name:
    description:
    - Specifies the name of the router profile.
    required: true
    type: str

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

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

mirror:
    description:
    - Enables or disables state mirroring. State mirroring can be used to maintain the
      same state information in the standby unit that is in the active unit.
    type: bool

parent:
    description:
    - The parent template of this router profile. Once this value has been set, it cannot
      be changed.
    - The default values are set by the system if not specified and they correspond to
      the router type created, for example, C(/Common/messagerouter) for C(generic) C(type)
      and so on.
    type: str

routes:
    description:
    - Specifies a list of static routes for the router instance to use.
    - The route must be on the same partition as router profile.
    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

partition:
    default: Common
    description:
    - Device partition to create router profile on.
    type: str

description:
    description:
    - The user-defined description of the router profile.
    type: str

max_retries:
    description:
    - Sets the maximum number of time a message may be resubmitted for rerouting by the
      C(MR::retry) iRule command.
    - The accepted range is between 0 and 4294967295 inclusive.
    type: int

traffic_group:
    description:
    - Specifies the traffic-group of the router profile.
    - Setting the C(traffic_group) to an empty string value C("") will cause the device
      to inherit from containing folder, which means the value of C(inherited_traffic_group)
      on device will be C(true).
    type: str

max_pending_bytes:
    description:
    - The maximum number of bytes worth of pending messages that will be held while waiting
      for a connection to a peer to be created. Once reached, any additional messages
      to the peer will be flagged as undeliverable and returned to the originator.
    - The accepted range is between 0 and 4294967295 inclusive.
    type: int

ignore_client_port:
    description:
    - When C(true), the remote port on clientside connections (connections where the peer
      connected to the BIG-IP) is ignored when searching for an existing connection.
    type: bool

max_pending_messages:
    description:
    - The maximum number of pending messages that will be held while waiting for a connection
      to a peer to be created. Once reached, any additional messages to the peer will
      be flagged as undeliverable and returned to the originator.
    - The accepted range is between 0 and 65535 inclusive.
    type: int

use_local_connection:
    description:
    - If C(true), the router will route a message to an existing connection on the same
      TMM as the message was received.
    type: bool

inherited_traffic_group:
    description:
    - When set to C(true), the C(traffic_group) is inherited from the containing folder.
      When not specified, the system sets this to C(false) when creating new router profile.
    type: bool

mirrored_msg_sweeper_interval:
    description:
    - Specifies the maximum time in milliseconds that a message will be held on the standby
      device as it waits for the active device to route the message.
    - Messages on the standby device held for longer than the configurable sweeper interval,
      will be dropped.
    - The acceptable range is between 0 and 4294967295 inclusive.
    type: int

Outputs

description:
  description: The user-defined description of the router profile.
  returned: changed
  sample: My description
  type: str
ignore_client_port:
  description: Enables ignoring of the remote port on clientside connections when
    searching for an existing connection.
  returned: changed
  sample: false
  type: bool
inherited_traffic_group:
  description: Specifies if a traffic-group should be inherited from containing folder.
  returned: changed
  sample: true
  type: bool
max_pending_bytes:
  description: The maximum number of bytes worth of pending messages that will be
    held.
  returned: changed
  sample: 10000
  type: int
max_pending_messages:
  description: The maximum number of pending messages that will be held.
  returned: changed
  sample: 64
  type: int
max_retries:
  description: The maximum number of time a message may be resubmitted for rerouting.
  returned: changed
  sample: 10
  type: int
mirror:
  description: Enables or disables state mirroring.
  returned: changed
  sample: true
  type: bool
mirrored_msg_sweeper_interval:
  description: The maximum time in milliseconds that a message will be held on the
    standby device.
  returned: changed
  sample: 2000
  type: int
parent:
  description: The parent template of this router profile.
  returned: changed
  sample: /Common/messagerouter
  type: str
routes:
  description: The list of static routes for the router instance to use.
  returned: changed
  sample:
  - /Common/route1
  - /Common/route2
  type: list
traffic_group:
  description: The traffic-group of the router profile.
  returned: changed
  sample: /Common/traffic-group-1
  type: str
use_local_connection:
  description: Enables routing of messages to an existing connection on the same TMM
    as the message was received.
  returned: changed
  sample: true
  type: bool