ltm message-routing generic protocol

ltm message-routing generic prBIG-IP(TMltmMmessage-routing generic protocol(1)



NAME
       protocol - Configures a generic message protocol component for parsing
       generic messages.

MODULE
       ltm message-routing generic

SYNTAX
       Configure the protocol component within the ltm message-routing generic
       module using the syntax shown in the following sections.

   CREATE/MODIFY
	create protocol [name]
	modify protocol [name]
	  options:
	    defaults-from [ [name] | none]
	    description [string]
	    disable-parser [ yes | no ]
	    max-egress-buffer [integer]
	    max-message-size [integer]
	    message-terminator [string]
	    no-response [ yes | no ]

	edit protocol [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties

	reset-stats protocol
	reset-stats protocol [ [ [name] | [glob] | [regex] ] ... ]

   DISPLAY
	list protocol
	list protocol [ [ [name] | [glob] | [regex] ] ... ]
	show running-config protocol
	show running-config protocol [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties
	    one-line
	    partition

	show protocol
	show protocol [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    (default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
	    field-fmt

   DELETE
	delete protocol [name]

DESCRIPTION
       You can use the protocol component to implement a named generic message
       parser for use with the message routing framework. You can create a
       protocol component, and then add it to a virtual server. You do this
       when you want to separate a stream of bytes, from a connection to a
       peer, into messages for routing. This also enables a set of iRule
       commands to create, populate, and route messages.

EXAMPLES
       create protocol my_protocol defaults-from genericmsg

       Creates a message protocol component named my_protocol using the system
       defaults.

       create protocol my_protocol { welcome-message hello }

       Creates a protocol instance named my_protocol that sends a welcome
       message of "hello" to any new connection.

OPTIONS
       defaults-from
	    Specifies the protocol that you want to use as the parent
	    protocol. The new protocol inherits all of the settings and values
	    from the specified parent protocol. The default value is
	    genericmsg.

       description
	    User defined description.

       disable-parser
	    When set to yes, the generic message parser is disabled. The
	    parser ignores all incoming packets and does not directly send
	    message data. This mode supports iRule script protocol
	    implementations that generate messages from the incoming transport
	    stream and send messages on the outgoing transport stream.

       max-egress-buffer
	    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 parser stops receiving outgoing
	    messages from the router until the size of the buffer drops below
	    this setting. The default value is 32768.

       max-message-size
	    Specifies the maximum size of a received message. If a message
	    exceeds this size, the connection is reset. The default value is
	    32768.

       message-terminator
	    Specifies the string of characters used to terminate a message. If
	    the message-terminator parameter is empty, the generic message
	    parser does not separate the input stream into messages. The
	    default value is \n.

       no-response
	    When set to yes, matching of responses to requests is disabled.
	    The default value is no.

SEE ALSO
       create, delete, edit, glob, list, ltm virtual, modify, regex, reset-
       stats, show, tmsh, ltm message-routing generic route ltm message-
       routing generic protocol

COPYRIGHT
       No part of this program may be reproduced or transmitted in any form or
       by any means, electronic or mechanical, including photocopying,
       recording, or information storage and retrieval systems, for any
       purpose other than the purchaser's personal use, without the express
       written permission of F5 Networks, Inc.

       F5 Networks and BIG-IP (c) Copyright 2012-2014. All rights reserved.



BIG-IP				  2014-ltm1message-routing generic protocol(1)