Manual Chapter :
Common Elements for
Diameter message routing Tasks
Applies To:
Show Versions
BIG-IP LTM
- 21.0.0, 17.5.1, 17.5.0, 17.1.3, 17.1.2, 17.1.1, 17.1.0, 17.0.0, 16.1.6, 16.1.5, 16.1.4, 16.1.3, 16.1.2, 16.1.1, 16.1.0, 16.0.1, 16.0.0, 15.1.10, 15.1.9, 15.1.8, 15.1.7, 15.1.6, 15.1.5, 15.1.4, 15.1.3, 15.1.2, 15.1.1, 15.1.0, 15.0.1, 15.0.0
Common Elements for
Diameter message routing Tasks
- On the Main tab, click .The Diameter session profiles list screen opens.
- On the Main tab, click .The Application Service List screen opens.
- On the Main tab, click .The Package Management LX screen appears.
- ClickImport.
- For theFile Namesetting, clickBrowseto navigate to the Diameter Configuration Wizard RPM package, and then clickOpento upload the package.The Diameter Configuration Wizard RPM package is nameddiameterConfigurationWizard-xx.x.x-x.xx.x.xxx.noarch.rpm.
- ClickUpload.The Diameter Configuration Wizard RPM package uploads to the Applications Service List screen.
- ClickCreate.The New Diameter Session Profile screen opens.
- Click the name of a Diameter application.The default iApps LX Diameter application isDiameter Configuration Wizard.
- In theNamefield, type a unique name for the diameter session profile.
- From theParent Profilelist, select a profile from which the new profile inherits properties.
- Add a description.
- In the General Properties area, for theDescriptionfield, select the check box.
- In theDescriptionfield, type a description.
- For the Settings area, select theCustomcheck box to enable editing, and specify the following parameters.
- In theDynamic Route Insertionfield, select the check box to create a dynamic route for the connection.
- In theDynamic Route Lookupfield, select the check box to have a previously created dynamic route consulted when routing a message.
- In theLoop Detectionfield, select theEnabledcheck box for insertion of route-record AVP and also rejection of looped messages.
- In theHandshake Timeoutfield, type the number of seconds before the handshake to a peer times out.
- In theMaximum Watchdog Failuresfield, type the maximum number of device watchdog failures that the traffic management system can receive before it tears down the connection.If the number of device watchdog failures exceeds the specified value, and theReset on Timeoutcheck box is selected, then the connection will be reset. If the number of device watchdog failures is greater than 3 times the specified value, the connection will be reset, even if theReset on Timeoutcheck box is cleared.
- Select theReset on Timeoutcheck box to reset the connection when watchdog failures exceed the specified number of maximum watchdog failures.
- In theWatchdog Timeoutfield, type the number of seconds that a client-side or server-side connection can be idle before a device watchdog request (DWR) is sent.The default value of0prevents sending a DWR.
- In theMaximum Message Sizefield, type the maximum number of bytes allowed for a message.
- For the Persistence area, select theCustomcheck box and specify the following parameters.
- From thePersist Typelist, select a type of persistence.SettingDescriptionNoneDisables persistence.AVPEnables persistence as determined by the AVP within the message.CustomEnables persistence as determined by a custom key specified within an iRule.
- In thePersist AVPfield, type an expression for the session-key that identifies the Diameter AVP.
- In thePersist Timeoutfield, type a timeout value for persistence entries in seconds.
- For the Rewrite area, select theCustomcheck box and specify the following parameters.
- In theOrigin Host Rewritefield, type a value to use in rewriting the Origin-Host AVP on egress.This value applies to all Diameter messages and can override specified Capabilities Handshake AVP values.
- In theOrigin Realm Rewritefield, type a value to use in rewriting the Origin-Realm AVP on egress.This value applies to all Diameter messages and can override specified Capabilities Handshake AVP values.
- In theDestination Host Rewritefield, type a value to use in rewriting the Destination-Host AVP on egress.
- In theDestination Realm Rewritefield, type a value to use in rewriting the Destination-Realm AVP on egress.
- For the Capabilities Handshake area, select theCustomcheck box and specify the following parameters.You must configure these settings to initiate Capabilities-Exchange-Request (CER) handshake requests to downstream peers, as well as to provide Capabilities-Exchange-Answer (CEA) responses to upstream peers within Device-Watchdog-Request (DWR), Device-Watchdog-Answer (DWA), Disconnect-Peer-Request (DPR), and Disconnect-Peer-Answer (DPA) messages.
- In theOrigin Hostfield, type an identifier for the originating server, for example,siteserver.f5.com.If theOrigin Hostsetting is not specified, the BIG-IP system host is used.
- In theOrigin Realmfield, type an identifier for the originating realm, for example,f5.If theOrigin Realmsetting is not specified, the BIG-IP system realm is used.
- In theVendor IDfield, type the vendor identification number assigned to the diameter server by the Internet Assigned Numbers Authority (IANA).You can use a vendor-specificvendor-id,auth-application-id, oracct-application-id.
- In theProduct Namefield, type a vendor-assigned name for the product.
- In theAuthentication Application IDfield, type the AAA identifier for a specific application.
- In theAccounting Application IDfield, type the accounting identifier for a specific application.
- From the Retransmission area, select theCustomcheck box and specify the following parameters.
- From theRetransmission Actionlist, select an action when retransmission is triggered for a request message.SettingDescriptionDisabledDisables retransmission functionality.BusySends back a response to the client with the error DIAMETER_TOO_BUSY (3004).UnableSends back a response to the client with the error DIAMETER_UNABLE_TO_DELIVER (3002).RetransmitRetransmits the original request message. The destination chosen depends on the message routing persistence and route lookup. By default (unless iRules are used), the message is resent to the same peer again. The Diameter error may then have to be transitory (i.e. 4*** Error Code) for retransmission to be beneficial.
- In theRetransmission Timeoutfield, type the number of seconds the message routing framework (MRF) will wait before retransmitting if no response is received. The default is5seconds.
- In theArray of Retransmission Result Codesfield, type a number that specifies the error response RESULT-CODES, which can trigger a retransmission action like retransmission.
- In theRetransmission Queue Maximum Messagesfield, type a number for the the maximum number of messages that may be held in the retransmission queue.If a request message is received that is enabled for retransmission, and the retransmission queue has reached its configured limit, a busy answer (DIAMETER_TOO_BUSY) is returned to the originator.
- In theRetransmission Queue Maximum Bytesfield, type the maximum number of bytes that may be held in the retransmission message queue.If a request message is received that is enabled for retransmission, and the retransmission queue has reached its configured limit, a busy answer (DIAMETER_TOO_BUSY) is returned to the originator.
- In theRetransmission Queue Low Limitfield, type a number that specifies, in percent, the low watermark for the retransmission queue.When the queue drops below theRetransmission Queue Low Limit, the TCP window reopens. This happens by default at a 60% queue depth.
- In theRetransmission Queue High Limitfield, type a number that specifies in percent, the high watermark for the retransmission queue.When theRetransmission Queue High Limitis exceeded, the TCP window starts closing. This happens by default at a 90% queue depth.
- On the menu bar, clickTransport Config.The Diameter screen opens.
- ClickCreate.The New Transport Config screen opens.
- In theNamefield, type a unique name for the transport configuration.
- For theProfilessetting, select a profile from theAvailablelist, and move it to theSelectedlist.
- For theProfilessetting, move both a transport protocol profile (TCP, UDP, or SCTP) and a Diameter session profile from theAvailablelist to theSelectedlist.You can only associate one protocol profile and one session profile with each transport configuration.
- For theiRulessetting, select an iRule from theAvailablelist, and move it to theSelectedlist.
- In theSource Portfield, type the number of the port this transport configuration uses to connect to the servers on your network.
- From theSource Address Translationlist, select an option to define how this transport configuration implements selective and intelligent source address translation. The default isAuto Map.OptionDescriptionSNATThe system uses the specified SNAT pool for source address translation.Auto MapThe system uses the self IP addresses of BIG-IP as the translation addresses.NoneThe system does not translate source addresses.
- On the menu bar, clickPeers.The Peers list screen opens.
- ClickCreate.The New Peer screen opens.
- In theNamefield, type a unique name for the peer.
- In theDescriptionfield, type a description of the peer.
- From theConnection Modelist, select an option to specify how connections are distributed to a remote host.OptionDescriptionPer BladeThe number of connections are distributed and controlled per blade on a VIPRION system.Per Peer(Default) The number of connections to a remote host is per peer.Per TMMThe number of connections to a remote host is per TMM on the BIG-IP system.Per ClientThe number of connections to a remote host is per client connection. Responses are delivered to the connection initiating the request. This option is typically used when implementing a firewall, because of its restrictive functionality.The configuredConnection Mode,Number of Connections, andRatiosettings determine how the BIG-IP system uses connections to pool members in delivering messages.
- From thePoollist, select the pool of servers to which the system load balances Diameter messages.If you configure only one peer on this BIG-IP system, ensure that you select a pool with only one member.If a peer does not specify a pool, the BIG-IP system uses the destination IP address and port of the ingress message's connection. If a peer specifies a pool without pool members, the message is unroutable.
- From thePoollist, select the pool of servers to which the system load balances Diameter messages.In the case where the calls should be always sent to a single SIP Server, you will still need to create a pool with a single member (the SIP Server) and add the same to the peer.
- From theTransport Configlist, select the transport configuration that defines the egress message routing peer connection.
- In theNumber of Connectionsfield, type the number of allowed connections between the BIG-IP system and the servers in the selected pool.
- In theRatiofield, type the ratio assigned to this peer for use within a static route.
- On the menu bar, clickStatic Routes.The static routes list screen opens.
- ClickCreate.The New Route screen opens.
- In theNamefield, type a unique name for the static route.
- In theDescriptionfield, type a description.
- In theApplication IDfield, type the identifier matching the application-id in the Diameter message. A value of0matches every application-id.
- In theDestination Realmfield, type the destination realm matching the Destination-Realm AVP value in the message.A blank value routes all destination-realms.
- In theOrigin Realmfield, type the origin realm matching the Origin-Realm AVP value in the message.A blank value routes all origin-realms.
- From theVirtual Serverlist, select the virtual server from which the system receives client requests for this static route.If you do not select a virtual server, the system uses this static route to route messages originating from any client.
- From thePeer Selection Modelist, select an option to specify how the system selects the Peer to route a message to:OptionDescriptionRatioPeer selection is based on the ratio that is set for each peer in theSelectedlist.SequentialPeer selection is based on the order of the peers in theSelectedlist.
- For thePeerssetting, move, from theAvailablelist to theSelectedlist, the peers that define the servers to which the system load balances or routes messages.Entries in theSelectedlist are not prioritized; consequently, the order of items appearing in the list is not enforced.
- ClickFinished.
- In the Statistics Collection Settings area, for thePer Peer Stats Collectionsetting, select the check box to enable capturing profile-specific stats per pool member.
- On the menu bar, clickRouter Profiles.The Router Profiles list screen opens.
- ClickCreate.The New Diameter Router Profile screen opens.
- In theNamefield, type a unique name for the diameter session profile.
- From theParent Profilelist, select a profile from which the new profile inherits properties.
- For theDescriptionsetting, select the check box at the right, and type a description in the field.
- ClickSave.
- At the top of the Settings area, select theCustomcheck box.
- For theUse Per-Message iRule Scopesetting, select the check box to specify iRule events are scoped to the message executing.The default, disabled, is when all Diameter iRule events are scoped to the connection flow; all share a single execution context per flow.
- Select theUse Local Connectioncheck box to specify that connections established by the ingress TMM are preferred to connections that are established by another TMM when selecting an egress connection to a destination peer.
- In theMaximum Pending Messagesfield, type the maximum number of pending messages held while waiting for a connection to a peer to be created.If the specified value is reached, any additional messages to the peer will be undeliverable, and held messages are delivered to the peer.
- In theMaximum Pending Bytesfield, type the maximum number of bytes contained within pending messages that will be held while waiting for a connection to a peer to be created.If the specified value is reached, any additional messages to the peer will be undeliverable, and held messages are delivered to the peer.
- In theMaximum Connection Retriesfield, type the maximum number of attempts to retry connecting to a peer.If the specified value is reached, all pending messages will be undeliverable and returned to the originator.
- In theConnection Retry Intervalfield, type the period in seconds to wait before attempting to retry connecting to a peer.
- In theTransaction Timeoutfield, type the maximum number of seconds the system allows for a transaction, that is, the time between a request and response.When the system receives a provisional response, the timer restarts.
- For use with connection mirroring, configure theTraffic Groupsetting:
- Clear theInherit traffic group from current partition / pathcheck box.
- From the list, select a traffic group, such as,traffic-group-1
Changing traffic groups with Connection Mirroring enabled drops all mirrored connections and loses all persistence data. If you change traffic groups, mirroring must restart. - Select theConnection Mirroringcheck box.For connection mirroring to properly function, this device must be a member of a device group.
- In theHA Message Sweeper Intervalfield, type a value (in milliseconds) for the frequency of the mirrored message sweeper.
- For theStatic Routessetting, select a static route from theAvailablelist, and move it to theSelectedlist.
- In the Diameter Configuration Wizard, click the System Configuration tab, and then click the Routing Destinations tab.The Routing Destinations screen opens.
- In theDestinationfield, type an address for the static route destination.
- From thePool Selection Modelist, select one of the following settings:SettingDescriptionBy PrecedenceSpecifies a sequential selection of pools based on availability. If only one pool is specified, the virtual server directs all traffic to it. If two or more pools are specified, the virtual server sends traffic to the next pool in the specified sequence (top to bottom) when the nodes in the preceding pool are down.By PercentsSpecifies a percentage of traffic for each specified pool. If only one pool is specified, the virtual server directs all traffic to it. If two or more pools are specified, the virtual server manages traffic sent to each pool in accordance with the specified percentage. You can drag the slider bar to specify a percentage for a pool.
- From thePoolslist, select a Diameter pool.
- ClickAdd Poolto specify an additional pool for the routing destination, as necessary.
- ClickAdd Destinationto add another routing destination, as necessary.
- For each pool, do one of the following:Pool Selection ModeStepsBy Precedence
- In the Pools area, from thePoolslist, sequentially select each pool, from top to bottom.
By Percents- In the Pools area, do one of the following for each selected pool:
- Drag the slider bar for each selected pool to specify the applicable percentage of traffic.
- In the percent field, type the applicable percentage of traffic.
- ClickSaveto save the routing destinations configuration.
- In the Diameter Configuration Wizard, click the Routing tab.The Routing screen opens.
- From theAll Virtual Serverslist, select the virtual server to which you want to assign the routing decision.The default isAll Virtual Servers.
- In the Default Route area, from theActionlist, select an action.
- ClickAddto configure an additional routing decision, as necessary.Controls to configure a protocol, its attributes, and an associated action open.
- From theProtocollist, select a protocol.
- From theAttributelist, select a heading.
- From theExpressionlist, select an expression.
- For the Value setting, do one of the following:
- From theValuelist, select a value for the expression.
- In theValuefield, type a value for the expression.
- To specify an additional attribute, expression, and value for the selected protocol, click the plus (+) button, and then configure the applicable routing decision parameters.
- From theActionlist, select an action.
- From theDestinationlist, select a destination.Depending upon the Action that you select, the Destination list and associated paramenters might not appear.
- ClickMore Options, and then, in theDescriptionfield, type a description for the configured routing decision.
- In theOrigin Hostfield, type an identifier for the originating server, for example,siteserver.f5.com.If theOrigin Hostsetting is not specified, the BIG-IP system host is used.To display theOrigin Hostfield, from the Action list, selectReject,Redirect, orTerminate.
- In theOrigin Realmfield, type the origin realm matching the Origin-Realm AVP value in the message.A blank value routes all origin-realms.To display theOrigin Realmfield, from the Action list, selectReject,Redirect, orTerminate.
- ClickActive.
- ClickAdd VSto configure another routing decision, and assign it to a virtual server.
- ClickSaveto save the routing decisions configuration.
- In the Diameter Configuration Wizard, click the System Configuration tab, and then click the List of Values tab.
- In theList Namefield, type a name for the list.
- In theDescriptionfield, type a unique description for the list of values.
- ClickShow List of Values.
- In theList of Valuesfield, type a value.
- To specify an additional value for the list, in theAdd Valuesarea, click the plus (+) button, and then, in theList of Valuesfield, type a value..
- ClickAdd Listto configure an additional list, as necessary.
- ClickSaveto save the configured lists of values.
- In the Diameter Configuration Wizard, click the System Configuration tab, and then click the Nodes tab.The Nodes screen opens.
- In theNode Namefield, type the name for the node.
- In theAddressfield, type the address for the node.
- In theDescriptionfield, type a description for the node.
- ClickAdd Nodeto configure an additional node, as necessary.
- ClickSaveto save the configured nodes.
- In the Diameter Configuration Wizard, click the System Configuration tab, and then click the Pools tab.The Pools screen opens.
- In thePool Namefield, type the name of the pool.
- In theDescriptionfield, type a description for the pool.
- Add the applicable pool member destination nodes to the pool.
- Click theShow Pool Membersbutton.
- For each pool member, click theAdd Pool Memberplus (+) button.
- From thePool Memberslist, select a pool member destination node.
- In thePort Numberfield, type the port number.
- ClickMore Options.
- From theProtocollist, select one of the following protocols to use with Diameter servers.
- TCP
- SCTP
- TLS/TCP
- From theProtocollist, selectSCTP.
- From theProtocollist, selectTCP.
- From theProtocollist, selectTLS/TCP.
- Configure SCTP multihoming functionality for Diameter servers.
- Select theEnable Multihomingcheck box.
- In theAlternative Source IPsfield, type the address for an alternative BIG-IP destination address that a server can use.
- For each additionalAlternative Source IPsaddress, click the plus (+) button to add the source IP address, as necessary.
- ClickAdd Poolto configure an additional Diameter pool, as necessary.
- ClickSaveto save the configured pools.
- In the Diameter Configuration Wizard, click the System Configuration tab, and then click the Virtual Servers tab.The Virtual Servers screen opens.
- In theVirtual Server Namefield, type the name of the virtual server.
- In theVirtual Ipfield, type the IP address for the virtual server.
- In thePort Numberfield, type the port number for the virtual server.
- From theClient Transport Protocollist, select one of the following protocols to use with Diameter clients.
- TCP
- SCTP
- TLS/TCP
- Configure SCTP multihoming functionality for Diameter clients.
- Select theEnable Multihomingcheck box.
- In theAlternative Destination IPsfield, type the address for an alternative BIG-IP destination that a client can use.
- For each additionalAlternative Destination IPsaddress, click the plus (+) button to add the destination IP address, as necessary.
- ClickAdd Virtual Serverto configure an additional Diameter virtual server, as necessary.
- ClickSaveto save the configured virtual servers.
- In the Diameter Configuration Wizard, click the Transformations tab.The Transformation screen opens.
- From theAll Virtual Serverslist, select the virtual server to which you want to assign the transformation.The default isAll Virtual Servers.
- From theProtocollist, select a protocol for transformation.
- From theAttributelist, select an attribute.
- From theExpressionlist, select an expression.
- In theValuefield, do one of the following:
- Select a transformation value from the list.
- Type a value.
- For each additionalAttribute, click the plus (+) button to add the parameters, as necessary.
- From theOperationlist, select an operation.
- From theAttributelist for the operation, select a protocol attribute.
- In theValuefield for the operation, do one of the following.
- Select a transformation value from the list.
- Type a value.
- For each additionalOperation, click the plus (+) button to add the parameters, as necessary.
- ClickMore Options.
- In theDescriptionfield, type a description for the transformation.
- Select the check box for each transformation that you want to enable, and then clickEnable.
- ClickActive.
- ClickSaveto save the configured transformations.
- In the Diameter Configuration Wizard, click the Session Management tab.The Session Management screen opens.
- Select theSession Managementcheck box.
- In theSession Timeoutfield, type a timeout value for the session persistence in minutes.
- Select theSession Bindingcheck box to configure a master-only or a master-slave persistence session.
- In the Master Session area, from theProtocollist, select a protocol.
- From theAVPlist, select an AVP attribute to apply to the master session.
- In the Slave Sessions area, from theProtocollist, select a protocol.
- From theAVP to use for resolvinglist, select an AVP attribute.For Master-Slave persistence, the specified AVP value for a Slave session must match the specified AVP value for a Master session, in order for the Slave messages to be routed according to a different protocol interface for a Master session.
- From theAVP to use in Master Session for persistencelist, select an AVP attribute.The default setting isSame as Slave session AVP.
- ClickAdd Rowto add another slave session protocol configuration, as necessary.
- ClickSaveto save the session management configuration.
- In the Diameter Configuration Wizard, click the Dictionaries tab.The Dictionaries screen opens.
- Click the name of a dictionary XML file to download the file.The XML file downloads to the workstation.
- Open the dictionary XML file in an editor application, modify the content, as necessary, and save the file.
- ClickUpload, clickBrowseto navigate to the modified dictionary XML file, and then clickOpento upload the modified dictionary XML file.
- ClickRenameto rename the applicable Diameter dictionary XML file.
- In theNew Dictionary Namefield, type a new name for the Diameter dictionary.
- Select the check box for the applicable dictionary.
- ClickDelete Dictionaryto remove the applicable dictionary.