Manual Chapter : Using the SIP Configuration Wizard

Applies To:

Show Versions Show Versions

BIG-IP LTM

  • 15.0.1, 15.0.0
Manual Chapter

Using the SIP Configuration Wizard

Overview: SIP Configuration Wizard

The Session Initiation Protocol (SIP) Configuration Wizard provides an easy way to configure SIP message routing functionality for forwarding, load balancing, routing, and transforming SIP messages. You can use this wizard to quickly configure the following functions.
SIP Configuration Wizard functions
Function
Description
General Configuration
Enables you to create one or more SIP applications, specifying the parameters for inbound, outbound, and wildcard virtual servers to manage SIP and RTP message traffic. Additionally, based on your configuration, you can enable session persistence, and manage Via headers and route headers. Finally, you can specify the SNAT functionality for each virtual server.
Transformation
Enables you to configure a template that specifies transformation parameters for conditions and actions, and apply them to a virtual server in a SIP application.
You can apply one or more templates to a virtual server. Also, you can apply one template to multiple virtual servers, as necessary.
Logging
Enables you to log request and response messages, as well as specific headers, and specify a logging destination.
Headers
Enables you to specify which SIP headers to make available for transformation.
You must use a Chrome browser when setting up and using the SIP Configuration Wizard. Only the Chrome browser is currently supported.
Workflow messages appear in the yellow banner to help guide you during the configuration of SIP message routing functionality.

About setting up the SIP Configuration Wizard

When you set up the SIP Configuration Wizard, you need to complete the following actions:
  • Download the SIP Configuration Wizard RPM package from the F5 Downloads site.
  • Import the downloaded file into iApps Package Management LX.

Task summary

Downloading the SIP Configuration Wizard RPM package

You can download the latest SIP Configuration Wizard RPM package from F5 Networks.
  1. Log in to the F5 Downloads site,
    downloads.f5.com
    , and click the
    Find a Download
    button.
  2. Click the name of the product line.
    To download the SIP 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 opens.
  5. Click the name of the file you want to download.
    The SIP Configuration Wizard RPM package is named
    SIPConfigurationWizard-xx.x.x-x.xx.x.xxx.noarch.rpm
    .
The latest SIP Configuration Wizard file downloads from F5 Networks.

Importing the SIP Configuration Wizard RPM package

You can import the latest SIP 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. Open the BIG-IP Configuration utility.
  4. On the Main tab, click
    iApps
    Package Management LX
    .
    The Package Management LX screen opens.
  5. Click
    Import
    .
  6. For the
    File Name
    setting, click
    Browse
    to navigate to the SIP Configuration Wizard RPM package, and then click
    Open
    to upload the package.
    The SIP Configuration Wizard RPM package is named
    sipConfigurationWizard-xx.x.x-x.xx.x.xxx.noarch.rpm
    .
  7. Click
    Upload
    .
    The SIP Configuration Wizard RPM package uploads to the Applications Service List screen.
The latest SIP Configuration wizard file is imported and available on the Applications LX screen.

Opening the SIP Configuration Wizard

Before you can open the SIP Configuration Wizard, you need to import the wizard into the iApps LX interface.
After you import the SIP Configuration Wizard into the iApps LX interface, you can open the wizard to configure SIP 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 SIP application.
    The default iApps LX SIP application is
    SIP Configuration
    .
The SIP Configuration Wizard opens and is available for configuration.

About the SIP general configuration

Using the SIP Configuration Wizard General Configuration tab, you can configure an application to specify SIP virtual server functionality.

Task summary

Creating a SIP application

You create a SIP application to define how the SIP virtual servers process SIP messages.
  1. In the SIP Configuration Wizard, click the General Configuration tab.
    The General Configuration screen opens.
  2. Click
    Add Application
    .
  3. In the
    Application Name
    field, type a unique name for the SIP application.
  4. For the inbound, outbound, and wildcard virtual servers, complete the following steps.
    1. In the
      Virtual Server Name
      field, type a unique name for the virtual server.
      A virtual server name cannot include special characters.
    1. In the
      Virtual Server IP
      field, type the IP address for the virtual server.
    2. In the
      Netmask
      field, type a value for the netmask.
    3. In the
      Port
      field, type a value for the ingress port for the virtual server.
    4. From the
      Type
      list, select a type of virtual server:
      SIP
      or
      RTP (forward)
      .
      RTP (forward)
      uses fastL4 functionality and requires no pool.
    5. From the
      Client Protocol
      list, select a client-side protocol:
      UDP
      or
      TCP
      .
    6. In the
      Egress Port
      field, type the egress port for the virtual server.
    7. From the
      Destination
      list, select a destination:
      Destination
      Description
      Pool
      Load balances traffic across pool members.
      When configuring a SIP ALG, do not configure a Port Block Allocation (PBA) translation LSN pool with a zombie timeout. Configuring a SIP ALG with an LSN pool that uses PBA mode with a zombie timeout can stop media translations.
      Route by URI
      Routes messages based on the URI (forwards messages to the IP address of the domain SIP proxy server associated with the Request-URI) in the SIP header. Resolves Name Authority Pointer (NAPTR) resource records.
      Forward
      For a wildcard virtual server using RTP, routes messages using the Transport Destination IP Address of the message. No pool is required.
    8. Click
      More Options
      .
    9. In the
      Vlan List
      list, select a VLAN for the virtual server, for example, internal, external, or HA.
    10. For a Route by URI destination, in the DNS Pool Members area, type an IP address and port number.
      You cannot configure a wildcard DNS pool member.
    11. Click the plus (
      +
      ) button to add another DNS pool member.
      You must configure a DNS pool member IP address and port number before you can add another DNS pool member.
    12. Select the
      Session Persistence
      check box to enable session persistence.
    13. Select the
      Insert Via Header
      check box to insert a top Via Header at the egress side of the flow, after the SIP_REQUEST_SEND event.
    14. Select the
      Honor Via Header
      check box to honor a Via header that was inserted by a system other than the BIG-IP system.
    15. Select the
      Insert Record-Route Header
      check box to insert a record-route header, that is, the local-IP address and port of the flow the system uses to forward the message.
    16. Select the
      Honor Route Header
      check box to honor a Route header that was inserted by a system other than the BIG-IP system.
    17. From the
      SNAT
      list, select the one of the options:
      • none
        .
      • automap
        .
      • snatpool
        .
        1. In the IP address field, type an IP address.
        2. Click the plus (
          +
          ) button to add an IP address, as necessary.
    18. For a Pool destination, in the Destination Pool Members area, type an IP address and port number.
      You cannot configure a wildcard destination pool member.
    19. Click the plus (
      +
      ) button to add another destination pool member.
      You must configure a destination pool member IP address and port number before you can add another destination pool member.
  5. Click
    Add Application
    to configure an additional SIP application, as necessary.

About configuring SIP transformations

With the SIP Configuration Wizard Transformations tab, you can configure templates to insert, modify, or delete SIP headers, and assign those templates to virtual servers.

Task summary

About logical operators for conditions, headers, and actions

SIP Transformation template conditions and actions provide you with different types of logical operators for matching and transforming headers, which are determined by the order and configuration of the headers within and between the conditions and actions. The different types of logical operators that you can configure are AND logical operators for multiple headers and actions within a condition, and OR logical operators for headers between conditions. When AND logical operators apply, then all logical operators must match. When OR logical operators apply, then any logical operator must match.

AND logical operators for multiple headers and actions within a condition

When you create a condition, you can configure two or more headers and actions that use AND logic within that condition. For example, you can create a condition with two headers,
a
and
b
, which uses AND logic when that condition is used by the transformation. This means that all headers within a condition must succeed in order to be used by a transformation.
Similarly, when you configure multiple actions for a header, AND logic determines if all matching actions for the header succeed. For example, you can create a condition with a header configured with two or more actions. The matching strategy uses AND logic to determine if all configured actions match.

OR logical operators for headers between conditions

When you create two or more conditions, you can configure each condition with multiple headers that use OR logic between the conditions. For example, you can create a first condition with a set of headers, and a second condition with another set of headers. The matching strategy uses OR logic to determine whether any condition matches.

Examples

These examples show the logical operation of three headers (
a
,
b
, and
c
) and two conditions (
condition1
and
condition2
).
In this first example, consider the following scenario, where you want to match header
a
or
b
, and
c
((a | b) & c). You can configure this logic by creating
condition1
to use headers
a
and
c
(a & c), and
condition2
to use headers
b
and
c
(b & c). The result is when
condition1
matches the strategy, headers
a
and
c
(a & c) are used for transformation, or when
condition2
matches, headers
b
and
c
(b & c) are used for transformation.
In this second example, consider the scenario where you want to match headers
a
and
b
, or
c
((a & b) | c). You can configure this logic by creating
condition1
to use headers
a
and
b
, and
condition2
to use header
c
. The result is when
condition1
matches the strategy, both headers
a
and
b
are used for transformation, or when
condition2
matches the strategy, header
c
is used for transformation.

Creating a SIP transformation template

You can create a SIP transformation template to specify transformation parameters for conditions and actions, and apply the template to a virtual server.
  1. On the Transformation tab, click the Templates tab.
    The Templates screen opens.
  2. Click
    Add Template
    .
  3. In the
    templatex
    field, type a name for the template.
  4. Click
    Add
    to open Conditions and Actions fields and controls.
    The Conditions and Actions fields and controls open.
  5. In the Conditions areas, from the
    Header
    list, select a header.
  6. From the
    Expression
    list, select an expression.
  7. In the
    Value
    field, type a value.
  8. To configure an additional header, click the plus (+) button.
  9. In the Actions area, from the
    Operation
    list, select an operation.
  10. From the
    Header
    list, select a header.
  11. In the
    Value
    field, type a value.
  12. To configure an additional operation, click the plus (+) button.
  13. Click
    More Options
    .
  14. In the
    Description
    field, type a description for the template.
  15. Click
    Add
    to configure additional Conditions and Actions, as necessary.
  16. Click
    Add Template
    to configure an additional SIP template, as necessary.

Creating a SIP transformation

You need to create a SIP application on the General Configuration tab before you can create a SIP transformation.
You can create a SIP transformation to apply transformation parameters, configured in the transformation template, to a virtual server.
  1. In the SIP Configuration Wizard, click the Transformation tab.
    The Transformation screen opens.
  2. Click
    Add Application
    .
  3. If multiple applications are configured, select an application name from the application list.
  4. Click
    Add
    .
  5. From the
    Virtual Server
    list, select a virtual server.
  6. In the
    Select Template(s)
    field, select one or more templates to assign to the virtual server.
  7. Select the check box for each configured virtual server that you want to enable.
  8. Click
    Enable
    .

About configuring SIP logging

Using the SIP Configuration Wizard Logging tab, you can configure logging parameters and a logging destination, and assign them to a virtual server.

Task summary

Configuring SIP logging

To use external logging or high-speed logging for SIP logging, you first need to configure the external logging or high-speed logging before configuring SIP logging.
You can configure SIP logging for local, external, or high-speed logging of SIP request and response messages and headers, as necessary.
  1. In the SIP Configuration Wizard, click the Logging tab.
    The Logging screen opens.
  2. In the Messages to Log area, select the check box for each request to log.
    Select the
    All Requests
    check box to log all of the requests in the requests list.
  3. In the Messages to Log area, select the check box for each response to log.
    Select the
    All Responses
    check box to log all of the responses in the responses list.
  4. In the
    Apply logging to following Virtual Servers
    setting, click the arrow to select the virtual servers to which you want to apply logging.
  5. In the Headers to log area, select the headers to log.
    Select the
    Log all Headers
    check box to log all headers in the headers list.
  6. To log additional headers excluded from the Headers to log area, in the Custom Headers area, click the arrow in the
    Select Headers
    field, and then click each header that you want to log.
  7. In the Log Destination area, click the arrow to select a log destination.

About configuring SIP headers

With the SIP Configuration Wizard Headers tab, you can create, modify, and delete SIP headers.

Creating a SIP header

You can create a SIP header, as necessary.
  1. In the SIP Configuration Wizard, click the Headers tab.
    The Headers screen opens.
  2. To create a header, either:
    • Click
      Add
      , and type the header value in the field.
    • Select the check box for a header, click
      Duplicate
      , and modify the copied header value.

Modifying a SIP header

You can modify a SIP header, as necessary.
  1. In the SIP Configuration Wizard, click the Headers tab.
    The Headers screen opens.
  2. To modify a header, type a modified header value in the applicable header field.

Deleting a SIP header

You can delete a SIP header, as necessary.
  1. In the SIP Configuration Wizard, click the Headers tab.
    The Headers screen opens.
  2. To delete a header, select the check box for the header, and click
    Delete
    .

Saving a SIP Configuration Wizard configuration

You must configure all SIP Configuration Wizard functionsbefore you save the configuration.
You can save the SIP Configuration Wizard configuration after you complete configuring all of the functions.
  1. In the SIP Configuration Wizard, click one of the tabs:
    • General Configuration
    • Transformations
    • Logging
    • Headers
  2. Click
    Save
    .
The system saves the SIP Configuration Wizard configuration.