Manual Chapter : Using the Diameter Configuration Wizard

Applies To:

Show Versions Show Versions

BIG-IP LTM

  • 15.0.1, 15.0.0
Manual Chapter

Using the Diameter Configuration Wizard

Overview: Diameter Configuration Wizard

The Diameter Configuration Wizard provides a simple, straightforward way to configure Diameter message routing functionality for Stream Control Transmission Protocol (SCTP) support, load balancing, AVP transformation, and session management. Additionally, Diameter message routing functionality supports high availability (HA) functionality.
You can use this wizard to quickly configure the following functions.
Diameter Configuration Wizard functions
Function
Description
Routing
Specifies the routing table configuration to support Diameter functionality, including the routing decision parameters (such as Diameter protocol, expression test, and action associated with a matched expression).
Transformations
Enables you to insert, modify, or delete Attribute Value Pairs (AVPs) in Diameter messages.
Session Management
Specifies a session timeout value, as well as session binding parameters for master-only persistence and master-slave persistence.
System Configuration
Specifies the system configuration used to support Diameter functionality, including the following:
  • Virtual Servers. Specifies an applicable virtual server (including virtual server name, virtual IP address, port number, client transport protocol, and description).
  • Nodes. Specifies local traffic node parameters (including a node name, address, and description).
  • Pools. Specifies local traffic pool settings (including pool name, description, pool members, and port number), protocol, and multihoming settings (including alternative source IP addresses).
  • Routing Destinations. Specifies routing destination parameters (including a destination, pool selection mode, and pool).
  • List of Values. Specifies a list of values (including a list name, description, and values) that can be referenced in transformation rules.
Dictionaries
Enables you to manage Diameter dictionaries.
You must use a Chrome browser when setting up and using the Diameter Configuration Wizard. Browsers other than Chrome are not currently supported.
Workflow messages appear in the yellow banner to help guide you during the configuration of Diameter message routing functionality.

About setting up the Diameter Configuration Wizard

When you set up the Diameter Configuration Wizard, you need to complete the following actions:
  • Download the Diameter Configuration Wizard RPM package from the F5 Downloads site.
  • Import the downloaded file into iApps Package Management LX.
You must use a Chrome browser when setting up and using the Diameter Configuration Wizard. Browsers other than Chrome are not currently supported.

Download the Diameter Configuration Wizard RPM package

You can download the latest Diameter Configuration Wizard RPM package from F5 Networks.
  1. Log in to the F5 Downloads site,
    https://downloads.f5.com
    , and click the
    Find a Download
    button.
  2. Click the name of the product line.
    To download the Diameter Configuration Wizard RPM package, click the product line
    iAppLX Templates
    .
  3. Click the name of the version of the product you want to download.
    The name appears as
    iAppLX_Templates
    and the version appears as
    iAppLX
    .
  4. Read the End User License Agreement, and click the
    I Accept
    button if you agree with the terms.
    The Select a Download screen appears.
  5. Click the name of the file you want to download.
    The Diameter Configuration Wizard RPM package is named
    diameterConfigurationWizard-xx.x.x-x.xx.x.xxx.noarch.rpm
    .
The latest Diameter Configuration Wizard file is downloaded from F5 Networks.

Import the Diameter Configuration Wizard RPM package

You can import the latest Diameter Configuration Wizard RPM package onto a BIG-IP system.
  1. Log on to the command line of the system using the root account.
  2. Type the following command to enable iApps LX controls.
    touch /var/config/rest/iapps/enable
  3. Type the following command to restart
    restjavad
    .
    bigstart restart restjavad
  4. Open the BIG-IP Configuration utility.
  5. On the Main tab, click
    iApps
    Package Management LX
    .
    The Package Management LX screen appears.
  6. Click
    Import
    .
  7. For the
    File Name
    setting, click
    Browse
    to navigate to the Diameter Configuration Wizard RPM package, and then click
    Open
    to upload the package.
    The Diameter Configuration Wizard RPM package is named
    diameterConfigurationWizard-xx.x.x-x.xx.x.xxx.noarch.rpm
    .
  8. Click
    Upload
    .
    The Diameter Configuration Wizard RPM package uploads to the Applications Service List screen.
The latest Diameter configuration wizard file is imported and available on the Applications LX screen.

Open the Diameter Configuration Wizard

Before you can open the Diameter Configuration Wizard, you need to set up the wizard in the iApps LX interface.
After you set up the Diameter Configuration Wizard in the iApps LX intereface, you can open the wizard to configure Diameter message routing functionality.
  1. On the Main tab, click
    iApps
    Application Services
    Applications LX
    .
    The Application Service List screen opens.
  2. Click the name of a Diameter application.
    The default iApps LX Diameter application is
    Diameter Configuration Wizard
    .
The Diameter Configuration Wizard is open and available for configuration.

About the Diameter system configuration

The Diameter Configuration Wizard System Configuration tab enables you to configure virtual servers, nodes, pools, routing destinations, and a list of values for Diameter functionality.
You must use a Chrome browser when setting up and using the Diameter Configuration Wizard. Browsers other than Chrome are not currently supported.

Configure a Diameter virtual server

Before you configure a Diameter virtual server, you need to configure the appropriate destination nodes and pools.
You can configure a Diameter virtual server to use a client transport protocol, and SCTP multihoming for Diameter clients.
Do not click
Save
until you have configured all Diameter functions. If you click
Save
before configuring all Diameter functions, an error might occur.
  1. In the Diameter Configuration Wizard, click the System Configuration tab, and then click the Virtual Servers tab.
    The Virtual Servers screen opens.
  2. In the
    Virtual Server Name
    field, type the name of the virtual server.
  3. In the
    Virtual Ip
    field, type the IP address for the virtual server.
  4. In the
    Port Number
    field, type the port number for the virtual server.
  5. From the
    Client Transport Protocol
    list, select one of the following protocols to use with Diameter clients.
    • TCP
    • SCTP
    • TLS/TCP
  6. Click
    More Options
    .
  7. In the
    Description
    field, type a description.
  8. Configure SCTP multihoming functionality for Diameter clients.
    1. Select the
      Enable Multihoming
      check box.
    2. In the
      Alternative Destination IPs
      field, type the address for an alternative BIG-IP destination that a client can use.
    3. For each additional
      Alternative Destination IPs
      address, click the plus (
      +
      ) button to add the destination IP address, as necessary.
  9. Click
    Add Virtual Server
    to configure an additional Diameter virtual server, as necessary.
A Diameter virtual server is configured to use a client transport protocol, and SCTP multihoming functionality for Diameter clients.

Configure a Diameter node

You can configure the properties of Diameter destination nodes for pools. Note that a destination node can include multiple active user sessions.
Do not click
Save
until you have configured all Diameter functions. If you click
Save
before configuring all Diameter functions, an error might occur.
  1. In the Diameter Configuration Wizard, click the System Configuration tab, and then click the Nodes tab.
    The Nodes screen opens.
  2. In the
    Node Name
    field, type the name for the node.
  3. In the
    Address
    field, type the address for the node.
  4. In the
    Description
    field, type a description for the node.
  5. Click
    Add Node
    to configure an additional node, as necessary.
The Diameter destination nodes are configured, and available to assign to a pool.

Configure a Diameter pool

Before you configure a Diameter pool, you need to configure the appropriate destination nodes.
In a basic Diameter message routing configuration, you can define a routing pool that contains Diameter servers as its members, specify a protocol to use with Diameter servers, and configure multihoming destination IP addresses.
Do not click
Save
until you have configured all Diameter functions. If you click
Save
before configuring all Diameter functions, an error might occur.
If a peer specifies a pool without pool members, the message is unroutable.
  1. In the Diameter Configuration Wizard, click the System Configuration tab, and then click the Pools tab.
    The Pools screen opens.
  2. In the
    Pool Name
    field, type the name of the pool.
  3. In the
    Description
    field, type a description for the pool.
  4. Add the applicable pool member destination nodes to the pool.
    1. Click the
      Show Pool Members
      button.
    2. For each pool member, click the
      Add Pool Member
      plus (
      +
      ) button.
    3. From the
      Pool Members
      list, select a pool member destination node.
    4. In the
      Port Number
      field, type the port number.
  5. Click
    More Options
    .
  6. From the
    Protocol
    list, select one of the following protocols to use with Diameter servers.
    • TCP
    • SCTP
    • TLS/TCP
  7. Configure SCTP multihoming functionality for Diameter servers.
    1. Select the
      Enable Multihoming
      check box.
    2. In the
      Alternative Source IPs
      field, type the address for an alternative BIG-IP destination address that a server can use.
    3. For each additional
      Alternative Source IPs
      address, click the plus (
      +
      ) button to add the source IP address, as necessary.
  8. Click
    Add Pool
    to configure an additional Diameter pool, as necessary.
A Diameter message routing configuration is complete, including a routing pool that contains Diameter servers as its members, a protocol to use with Diameter servers, and SCTP multihoming destination IP addresses.

Configure Diameter routing destinations

To configure Diameter static routing destinations, you must first configure the applicable destination nodes and pools.
You can configure one or more static routing destinations for a Diameter application, specifying a destination address and a pool selection mode, comprising one or more pools.
Do not click
Save
until you have configured all Diameter functions. If you click
Save
before configuring all Diameter functions, an error might occur.
  1. In the Diameter Configuration Wizard, click the System Configuration tab, and then click the Routing Destinations tab.
    The Routing Destinations screen opens.
  2. In the
    Destination
    field, type an address for the static route destination.
  3. From the
    Pool Selection Mode
    list, select one of the following settings:
    Setting
    Description
    By Precedence
    Specifies 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 Percents
    Specifies 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.
  4. From the
    Pools
    list, select a Diameter pool.
  5. Click
    Add Pool
    to specify an additional pool for the routing destination, as necessary.
  6. For each pool, do one of the following:
    Pool Selection Mode
    Steps
    By Precedence
    • In the Pools area, from the
      Pools
      list, 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.
  7. Click
    Add Destination
    to add another routing destination, as necessary.
One or more Diameter static routing destinations are configured to manage traffic in accordance with a destination name and a pool selection mode, comprising one or more pools.

Configure a Diameter list of values

You can create a list composed of unique values and apply them in a routing decision to an Attribute Value Pairs (AVP) with a string-format output.
Do not click
Save
until you have configured all Diameter functions. If you click
Save
before configuring all Diameter functions, an error might occur.
  1. In the Diameter Configuration Wizard, click the System Configuration tab, and then click the List of Values tab.
  2. In the
    List Name
    field, type a name for the list.
  3. In the
    Description
    field, type a unique description for the list of values.
  4. Click
    Show List of Values
    .
  5. In the
    List of Values
    field, type a value.
  6. To specify an additional value for the list, in the
    Add Values
    area, click the plus (
    +
    ) button, and then, in the
    List of Values
    field, type a value..
  7. Click
    Add List
    to configure an additional list, as necessary.
A list of values is available.

About configuring Diameter routing

The Diameter Configuration Wizard Routing tab enables you to configure routing decisions. Routing decisions specify the protocol conditions and associated actions assigned to a virtual server.

Configure a Diameter routing decision

To assign a Diameter routing decision to a virtual server for SCTP server-side multihoming, you must first configure an applicable virtual server.
You can configure one or more routing decisions for a Diameter application to use SCTP server-side multihoming, specifying the protocol conditions and associated actions assigned to a virtual server.
  1. In the Diameter Configuration Wizard, click the Routing tab.
    The Routing screen opens.
  2. From the
    All Virtual Servers
    list, select the virtual server to which you want to assign the routing decision.
    The default is
    All Virtual Servers
    .
  3. In the Default Route area, from the
    Action
    list, select an action.
  4. From the
    Destination
    list, select a destination.
    Depending upon the Action that you select, the Destination list and associated paramenters might not appear.
  5. Click
    More Options
    .
  6. In the
    Description
    field, type a description.
  7. In the
    Origin Host
    field, type an identifier for the originating server, for example,
    siteserver.f5.com
    .
    If the
    Origin Host
    setting is not specified, the BIG-IP system host is used.
    To display the
    Origin Host
    field, from the Action list, select
    Reject
    ,
    Redirect
    , or
    Terminate
    .
  8. In the
    Origin Realm
    field, type the origin realm matching the Origin-Realm AVP value in the message.
    A blank value routes all origin-realms.
    To display the
    Origin Realm
    field, from the Action list, select
    Reject
    ,
    Redirect
    , or
    Terminate
    .
  9. Click
    Add
    to configure an additional routing decision, as necessary.
    Controls to configure a protocol, its attributes, and an associated action open.
  10. From the
    Protocol
    list, select a protocol.
  11. From the
    Attribute
    list, select a heading.
  12. From the
    Expression
    list, select an expression.
  13. For the Value setting, do one of the following:
    • From the
      Value
      list, select a value for the expression.
    • In the
      Value
      field, type a value for the expression.
  14. From the
    Action
    list, select an action.
  15. From the
    Destination
    list, select a destination.
    Depending upon the Action that you select, the Destination list and associated paramenters might not appear.
  16. Click
    More Options
    , and then, in the
    Description
    field, type a description for the configured routing decision.
  17. In the
    Origin Host
    field, type an identifier for the originating server, for example,
    siteserver.f5.com
    .
    If the
    Origin Host
    setting is not specified, the BIG-IP system host is used.
    To display the
    Origin Host
    field, from the Action list, select
    Reject
    ,
    Redirect
    , or
    Terminate
    .
  18. In the
    Origin Realm
    field, type the origin realm matching the Origin-Realm AVP value in the message.
    A blank value routes all origin-realms.
    To display the
    Origin Realm
    field, from the Action list, select
    Reject
    ,
    Redirect
    , or
    Terminate
    .
A routing decision is configured, specifying the protocol conditions and associated actions assigned to a virtual server.

About configuring Diameter transformations

The Diameter Configuration Wizard Transformations tab enables you to insert, modify, or delete Attribute Value Pairs (AVPs).
You must use a Chrome browser when setting up and using the Diameter Configuration Wizard. Browsers other than Chrome are not currently supported.

Configure a Diameter transformation

You can configure the transformation of Attribute Value Pairs (AVPs) by using the Transformations tab, preventing exposure of server topologies.
  1. In the Diameter Configuration Wizard, click the Transformations tab.
    The Transformation screen opens.
  2. From the
    All Virtual Servers
    list, select the virtual server to which you want to assign the transformation.
    The default is
    All Virtual Servers
    .
  3. From the
    Protocol
    list, select a protocol.
  4. From the
    Attribute
    list, select an attribute.
  5. From the
    Expression
    list, select an expression.
  6. For the Value setting, do one of the following:
    • From the
      Value
      list, select a value for the expression.
    • In the
      Value
      field, type a value for the expression.
  7. For each additional
    Attribute
    , click the plus (
    +
    ) button to add the parameters, as necessary.
  8. From the
    Operation
    list, select an operation.
  9. From the
    Attribute
    list for the operation, select a protocol attribute.
  10. For the Value setting, do one of the following:
    • From the
      Value
      list, select a value for the expression.
    • In the
      Value
      field, type a value for the expression.
  11. For each additional
    Operation
    , click the plus (
    +
    ) button to add the parameters, as necessary.
  12. Click
    More Options
    .
  13. In the
    Description
    field, type a description for the transformation.
  14. Select the check box for each transformation that you want to enable, and then click
    Enable
    .
The AVP transformations are configured, preventing exposure of server topologies

About Diameter session management

The Diameter Configuration Wizard Session Management tab enables you to configure the session management and session binding for Diameter functionality.
You must use a Chrome browser when setting up and using the Diameter Configuration Wizard. Browsers other than Chrome are not currently supported.

Configure Diameter session management

A session management configuration provides a session timeout setting and session binding settings that you can apply to master-only or master-slave persistence sessions.
  1. In the Diameter Configuration Wizard, click the Session Management tab.
    The Session Management screen opens.
  2. Select the
    Session Management
    check box.
  3. In the
    Session Timeout
    field, type a timeout value for the session persistence in minutes.
  4. Select the
    Session Binding
    check box to configure a master-only or a master-slave persistence session.
  5. In the Master Session area, from the
    Protocol
    list, select a protocol.
  6. From the
    AVP
    list, select an AVP attribute to apply to the master session.
  7. In the Slave Sessions area, from the
    Protocol
    list, select a protocol.
  8. From the
    AVP to use for resolving
    list, 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.
  9. From the
    AVP to use in Master Session for persistence
    list, select an AVP attribute.
    The default setting is
    Same as Slave session AVP
    .
  10. Click
    Add Row
    to add another slave session protocol configuration, as necessary.
  11. Click
    Save
    to save the session management configuration.
A session management configuration is available to provide a session timeout and session binding for master-only or master-slave persistence sessions.

About Diameter dictionaries

The Diameter Configuration Wizard Dictionaries tab enables you to easily manage each 3GPP protocol interface Diameter dictionary. You can modify, download, upload, rename, and delete dictionary files, as necessary.
You must use a Chrome browser when setting up and using the Diameter Configuration Wizard. Browsers other than Chrome are not currently supported.

Modify a Diameter dictionary file

You can modify a Diameter dictionary file to add proprietary AVPs, as necessary.
  1. In the Diameter Configuration Wizard, click the Dictionaries tab.
    The Dictionaries screen opens.
  2. Click the name of a dictionary XML file to download the file.
    The XML file downloads to the workstation.
  3. Open the dictionary XML file in an editor application, modify the content, as necessary, and save the file.
  4. Click
    Upload
    , click
    Browse
    to navigate to the modified dictionary XML file, and then click
    Open
    to upload the modified dictionary XML file.
The Diameter dictionary file is modified and available for use.

Download a Diameter dictionary file

You can download a Diameter dictionary file to modify it, to copy and customize it, or to examine its contents.
  1. In the Diameter Configuration Wizard, click the Dictionaries tab.
    The Dictionaries screen opens.
  2. Click the name of a dictionary XML file to download the file.
    The XML file downloads to the workstation.
The Diameter dictionary file is downloaded.

Upload a Diameter dictionary file

Before you can upload a Diameter dictionary XML file to the BIG-IP device, you need to download the Diameter dictionary file to a preferred location, for example, the workstation.
You can upload a Diameter dictionary file to the BIG-IP device, as necessary.
  1. In the Diameter Configuration Wizard, click the Dictionaries tab.
    The Dictionaries screen opens.
  2. Click
    Upload
    , click
    Browse
    to navigate to the modified dictionary XML file, and then click
    Open
    to upload the modified dictionary XML file.
A Diameter dictionary XML file is uploaded to the BIG-IP device.

Rename a Diameter dictionary file

You can rename a Diameter dictionary XML file, as necessary.
  1. In the Diameter Configuration Wizard, click the Dictionaries tab.
    The Dictionaries screen opens.
  2. Click
    Rename
    to rename the applicable Diameter dictionary XML file.
  3. In the
    New Dictionary Name
    field, type a new name for the Diameter dictionary.
  4. Click
    Rename
    to rename the applicable Diameter dictionary XML file.
The Diameter dictionary is renamed.

Delete a Diameter dictionary file

You can delete a Diameter dictionary file, as necessary.
  1. In the Diameter Configuration Wizard, click the Dictionaries tab.
    The Dictionaries screen opens.
  2. Select the check box for the applicable dictionary.
  3. Click
    Delete Dictionary
    to remove the applicable dictionary.
The dictionary XML file is deleted from the BIG-IP device.

Save a Diameter Configuration Wizard configuration

All Diameter Configuration Wizard functions need to be configured before saving the configuration.
You can save the Diameter Configuration Wizard configuration after you complete configuring all of the functions.
  1. In the Diameter Configuration Wizard, click one of the following tabs:
    • Routing
    • Transformations
    • Session Management
    • System Configuration
  2. Click
    Save
    .
The Diameter Configuration Wizard configuration is saved.