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_protocol.
New in version 1.0.0: of f5networks.f5_modules
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| description string | The user-defined description of the generic parser profile. | ||
| disable_parser boolean |
| When yes, the generic message parser is disabled, ignoring all incoming packets and not directly send message data.This mode supports iRule script protocol implementations that generates messages from the incoming transport stream and sends 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 |
| 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 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 |
| 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 |
| 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 |
| 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 |
| When present, ensures the route exists.When absent, ensures the route is removed. | |
Note
- 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
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 |
© 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_protocol_module.html