LocalLB::MessageRoutingPeer¶
Introduced : BIG-IP_v11.6.0
The MessageRoutingPeer interface enables you to work with the
definitions contained in a message routing peer. A peer specifies the
pool for the message parser to use as the destination for message
routes. You can also use the peer component to specify how many
connections the parser creates to a remote host and which
MessageRoutingTransportConfig the parser uses to establish the
connection.
Methods¶
| Method | Description | Introduced |
| create | Creates the specified peers. | BIG-IP_v11.6.0 |
| delete_all_peers | Deletes all peers. | BIG-IP_v11.6.0 |
| delete_peer | Deletes a specified list of peers. | BIG-IP_v11.6.0 |
| get_connection_mode | Gets the mode for limiting connections to the specified peers. See LocalLB::MessageRoutingPeer::ConnectionMode for more details. | BIG-IP_v11.6.0 |
| get_description | Gets the descriptions for a set of peers. | BIG-IP_v11.6.0 |
| get_list | Gets a list of all peers. | BIG-IP_v11.6.0 |
| get_number_connections | Gets the distribution of connections between the load balancer and a remote host for the specifed peers. | BIG-IP_v11.6.0 |
| get_pool | Gets the pools associated with the specified peers. | BIG-IP_v11.6.0 |
| get_protocol | Gets the message routing protocol which was set for the specified peers upon creation. See the LocalLB::MessageRoutingProtocol for more details. | BIG-IP_v11.6.0 |
| get_ratio | Gets a list of ratios for the specified peers within a route. | BIG-IP_v11.6.0 |
| get_transport_config | Gets the transport configs associated with the specified peers. | BIG-IP_v11.6.0 |
| get_version | Get the version information for this interface. | BIG-IP_v11.6.0 |
| set_connection_mode | Sets the mode for limiting connections to the specified peers. See LocalLB::MessageRoutingPeer::ConnectionMode for more details. | BIG-IP_v11.6.0 |
| set_description | Sets the description for a set of peers. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.6.0 |
| set_number_connections | Sets the distribution of connections between the load balancer and a remote host for the specifed peers. The default value is 1 meaning that all messages through a peer will use a single connection. Higher values will distribute the messages accross the specified number of connections. | BIG-IP_v11.6.0 |
| set_pool | Sets the pool associated with the specified peers. The message parser routes messages to the specified pool. | BIG-IP_v11.6.0 |
| set_ratio | Sets a list of ratios for the specified peers within a route. The ratio is used by the message parser for selecting peers from a list of peers assigned to a route. The default value is 1. See LocalLB::MessageRoutingSIPRoute::SelectionMode for further details about how the ratio is used. | BIG-IP_v11.6.0 |
| set_transport_config | Sets the transport configs associated with the specified peers. A transport_config (See LocalLB::MessageRoutingTransportConfig) is used by the message router to create an outgoing connection. | BIG-IP_v11.6.0 |
Enumerations¶
| Enumeration | Description |
| ConnectionMode | A list of peer connection modes. The connection mode specifies how connections are to be limited. |
Aliases¶
| Alias | Type | Description |
| ConnectionModeSequence | ConnectionMode [] | A sequence of peer connection modes. |
| ConnectionModeSequenceSequence | ConnectionMode [] [] | A sequence of sequences of peer connection modes. |
See Also¶
iControl ::
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.