ltm message-routing generic peer
ltm message-routing generic peBIG-IP TMSH Mltmamessage-routing generic peer(1)
NAME
peer - Configures a peer for routing generic message protocol messages.
MODULE
ltm message-routing generic
SYNTAX
Configure the peer component within the ltm message-routing generic
module using the syntax shown in the following sections.
CREATE/MODIFY
create peer [name]
modify peer [name]
options:
app-service [[string] | none]
auto-initialization [ enabled | disabled ]
auto-initialization-interval [integer]
connection-mode [ per-peer | per-blade | per-tmm | per-client ]
description [string]
number-connections [integer]
pool [name]
ratio [integer]
transport-config [ transport-config ]
edit peer [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list peer
list peer [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete peer [name]
DESCRIPTION
You can use the peer component to manage a named generic message peer.
A peer specifies the pool for the generic message parser to use as the
destination for generic message routes. You can also use the peer
component to specify how many connections the parser creates to a
remote host and what transport the parser uses to establish the
connection.
EXAMPLES
create peer my_peer { pool my_pool transport { type virtual name my_vip
} }
Creates a generic message peer named my_peer which uses the settings of
my_vip to establish a connection with a pool member from pool my_pool.
OPTIONS
app-service
Specifies the name of the application service to which the object
belongs. The default value is none. Note: If the strict-updates
option is enabled on the application service that owns the object,
you cannot modify or delete the object. Only the application
service can modify or delete the object.
auto-initialization
If enabled, the BIGIP will automatically create outbound
connections to the active pool members in the specified pool using
the configuration of the specified transport-config. For auto-
initialization to attempt to create a connection, the peer must be
included in a route that is attached to a router instance. For
each router instance that the peer is contained in, a connection
will be initiated. The auto-initialization logic will verify at a
configurable interval if the a connection exists between the BIG-
IP and the pool members of the pool. If a connection does not
exist, it will attempt to reestablish one. The default is
disabled.
auto-initialization-interval
Specifies the interval (in milliseconds) that attempts to initiate
a connection occur. Valid ranges are from 500ms to 65535ms. The
default is 5000ms.
connection-mode
Specifies how the number of connections per host is limited. Note
a host (specified in the referred pool) may exist more than one
peer object, and those peer objects may have different settings
for connection-mode and number_connections. Thus, these settings
specify how messages are routed through this peer are distributed
between a set of connections, not the maximum number of
connections to a specified host. The default value is per-peer.
per-peer
Specifies the number of connections to a remote host.
per-blade
Specifies the number of connections to a remote host per
blade in the cluster.
per-tmm
Specifies the number of connections to a remote host per TMM
in the system.
per-client
Specifies the number of connections to a remote host per
client connection.
description
User defined description.
number-connections
Specifies the distribution of connections between the BIG-IP
system and a remote host. The default value is 1.
pool Specifies the name of the pool to which the generic parser routes
messages.
ratio
Specifies the ratio the generic message parser uses to select a
peer from a list of peers for the ltm message-routing generic
route. The default value is 1.
transport-config
Specifies the name of the transport configuration (ltm message-
routing generic transport-config) the message router uses to
create an outgoing connection.
SEE ALSO
create, delete, edit, glob, list, ltm virtual, modify, regex, 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 2016-01-1ltm message-routing generic peer(1)