bigip_message_routing_protocol – Manage generic message parser profile — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# bigip_message_routing_protocol – Manage generic message parser profile

New in version 2.9.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Manages generic message parser profile for use with the message routing framework.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
description string |  | The user defined description of the generic parser profile.
disable_parser boolean | Choices: no yes | When `yes`, the generic message parser will be disabled ignoring all incoming packets and not directly send message data. This mode supports iRule script protocol implementations that will generate messages from the incoming transport stream and send outgoing messages on the outgoing transport stream.
max_egress_buffer integer |  | Specifies the maximum size of the send buffer in bytes. If the number of bytes in the send buffer for a connection exceeds this value, the generic message protocol will stop receiving outgoing messages from the router until the size of the size of the buffer drops below this setting. The accepted range is between 0 and 4294967295 inclusive.
max_msg_size integer |  | Specifies the maximum size of a received message. If a message exceeds this size, the connection will be reset. The accepted range is between 0 and 4294967295 inclusive.
msg_terminator string |  | The string of characters used to terminate a message. If the message-terminator is not specified, the generic message parser will not separate the input stream into messages.
name string / required |  | Specifies the name of the generic parser profile.
no_response boolean | Choices: no yes | When set, matching of responses to requests is disabled.
parent string |  | The parent template of this parser profile. Once this value has been set, it cannot be changed. When creating a new profile, if this parameter is not specified, the default is the system-supplied `genericmsg` profile.
partition string | Default: "Common" | Device partition to create route object on.
provider dictionary added in 2.5 |  | 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.
| 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`.
| ssh_keyfile path |  | Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable `ANSIBLE_NET_SSH_KEYFILE`.
| 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: cli 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`.
state string | Choices: present ← absent | When `present`, ensures that the route exists. When `absent`, ensures the route is removed.

## 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 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 a generic parser
      bigip_message_routing_protocol:
        name: foo
        description: 'This is parser'
        no_response: yes
        provider:
          password: secret
          server: lb.mydomain.com
          user: admin
      delegate_to: localhost

    - name: Modify a generic parser
      bigip_message_routing_protocol:
        name: foo
        no_response: no
        max_egress_buffer: 10000
        max_msg_size: 2000
        provider:
          password: secret
          server: lb.mydomain.com
          user: admin
      delegate_to: localhost

    - name: Remove generic parser
      bigip_message_routing_protocol:
        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 parser profile. Sample: My description
disable_parser boolean | changed | Disables generic message parser. Sample: True
max_egress_buffer integer | changed | The maximum size of the send buffer in bytes. Sample: 10000
max_msg_size integer | changed | The maximum size of a received message. Sample: 4000
msg_terminator string | changed | The string of characters used to terminate a message. Sample: %%%%
no_response boolean | changed | Disables matching of responses to requests. Sample: True
parent string | changed | The parent template of this parser profile. Sample: /Common/genericmsg

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]

### Authors

- Wojciech Wypior (@wojtek0806)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.