LocalLB::MessageRoutingSIPRoute::replace_peer

Introduced : BIG-IP_v11.6.0
Replace the peer list associated with the specified SIP route with the specified list of peers. Peers are responsible for forwarding messages. See LocalLB::MessageRoutingPeer for more details about peers. See LocalLB::SelectionMode for more details about how the mode determines peer selection.

Prototype

 replace_peer(
    in String [] sip_routes,
    in String [] [] peers,
    in long [] [] priorities
);

Parameters

Parameter Type Description
sip_routes String [] The SIP route names.
peers String [] [] The list of child message routing peers.
priorities long [] [] The list of priorities indicating the peer selection order when the selection mode is set to sequential. The priority must be unique for each peer. 0 is the highest possible priority.

Return Type

Type Description
void  

Exceptions

Exception Description
Common::AccessDenied Raised if the client credentials are not valid.
Common::InvalidArgument Raised if one of the arguments is invalid.
Common::OperationFailed Raised if an operation error occurs.

See Also

iControl ::
iControl :: LocalLB :: MessageRoutingSIPRoute

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


Copyright © 1996-2012, F5 Networks, Inc. All rights reserved.

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.