Try SpotterManage the generic message parser profile.
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Wojciech Wypior (@wojtek0806)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Manages the generic message parser profile for use with the message routing framework.
- name: Create a generic parser
bigip_message_routing_protocol:
name: foo
description: 'This is parser'
no_response: true
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: false
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
name:
description:
- Specifies the name of the generic parser profile.
required: true
type: str
state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the route exists.
- When C(absent), ensures the route is removed.
type: str
parent:
description:
- 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 C(genericmsg) profile.
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 generic parser profile.
type: str
no_response:
description:
- When set, matching of responses to requests is disabled.
type: bool
max_msg_size:
description:
- 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.
type: int
disable_parser:
description:
- When C(true), 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.
type: bool
msg_terminator:
description:
- 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.
type: str
max_egress_buffer:
description:
- 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.
type: int
description: description: The user-defined description of the parser profile. returned: changed sample: My description type: str disable_parser: description: Disables generic message parser. returned: changed sample: true type: bool max_egress_buffer: description: The maximum size of the send buffer in bytes. returned: changed sample: 10000 type: int max_msg_size: description: The maximum size of a received message. returned: changed sample: 4000 type: int msg_terminator: description: The string of characters used to terminate a message. returned: changed sample: '%%%%' type: str no_response: description: Disables matching of responses to requests. returned: changed sample: true type: bool parent: description: The parent template of this parser profile. returned: changed sample: /Common/genericmsg type: str