Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Add_workflow_for_techpubs
AUTH1UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26ca7f046c8a00a0c880e94aad0181077fa2530009, userName='null'}
JIRAIDAUTHSBX-96077131963
REV5UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26cb8305e98a00a02355cd1c2f0155cd26cd5909df, userName='null'}
REV6UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26cb8305e98a00a02355cd1c2f0155cd26cd5909df, userName='null'}
REV3UserResourceIdentifier{userKey=8a00a0c86603f2b701661a3b08fd00328a00a0c880e94aad0181077fa2530009, userName='null'}
REV1UserResourceIdentifier{userKey=8a00a0c86c120d6f016c46f8a7bb002d8a00a0c880e94aad0181077fa2530009, userName='null'}


Panel

In this section:

Table of Contents
maxLevel3
minLevel2


The SBC, which continuously captures encrypted signaling packets of SIP over TLS at layer 2, has been enhanced to to capture decrypted signaling packets as well.

The SIP PDUs (Protocol Data Units) are captured at the application layer and continuously streamed to the monitoring server. Configurable Headers are included in SIP PDUs to enable the monitoring server to decode SIP signaling properly. Headers have source and destination IP address/Port information along with additional information which is configurable – this information is needed by the monitoring server in order to correlate the stream received.

The packet is captured at ingress leg without SMM applied and with SMM applied on egress leg, which is essentially what is being sent on the wire.  To lessen performance impact, all socket-management activities to the monitoring server use a separate SIPSM (SIP Signaling Monitor ) process receives all signaling packets from the SIP Signaling Gateway (SIPSG) and streams to the configurable external monitoring server either over UDP or TCP.

A profile attached to the signaling port is a trigger for this feature. All feature-related configuration can be set in this profile.

Terminology

The following terminology and acronyms are used in this documentation:

TLSTransport Layer Security
 SIPSession Initiation Protocol
 UNIUser Network Interface 
 NNINetwork-Network Interface 
 TCPTransmission Control Protocol


Command Syntax

The command syntax to configure a Monitoring Profile is shown here:

Code Block
languagenone
%set profiles services monitoringProfile <monitoring profile name> 
    additionalInformation
     <string>
	filter <transport | trunkgroup>
		transport <tcp | udp header
| sctp | tls-tcp>
    headerPresence <disabled | enabled>
    mgmtInterfaceGroup <ip | mgmtGroup>
    monitoringIpAddress <Ip address>
    monitoringIpPort <int | 0 .. 65535>
    signalingPackets <all | none | tls>
    state <disabled | enabled>
    transport <tcp | udp>
    type <IP<ip | mgmt>

Command Parameters

Caption


0Table1

Command Parameters for monitoringProfile

ParameterLength/Range
Default
DescriptionM/O
additionalInformationstring: 256 characters

Additional information in the header

sent

to send towards the monitoring server.

O

date

Date in YYYY-MM-DDThh:mm:ss+offset format

This parameter is available when headerPresence is "enabled".

O
destinationIpPort

filter

Destination Ip/Port of the SIP PDU.

displayLevel

Depth to show.

  • unsignedLong
  • 1 .. 64
 O

filter

N/A

This table contains filters for the profile.

Filter

The filter parameter is displayed only when

no signalingPackets are selected

signalingPackets is set to "none".

  • transport – Transport type used to filter the packets.
    • tcp – Transmission Control Protocol
    • udp – (default) User Datagram Protocol
    • sctp – Stream Control Transmission Protocol
    • tls-tcp – Transport Layer Security running on top of TCP
  • trunkgroup – IP TG filter used to filter the packets.
O

header

Identifies headers which need to be encapsulated with SIP PDUs.

headerName

Specifies name of the header sent towards the monitoring server.

headerPresence

disabled
N/A

Specifies if X header presence towards monitoring server is enabled or not.

  • disabled(default)
  • enabled
O

mgmtInterfaceGroup

mgmtGroup
N/A

Choose the

The

Management Interface Group to use for communicating with monitoring server.

  • mgmtGroup (default)
O

monitoringIpAddress

<IP address format>

IP address of the monitoring server.

M

monitoringIpPort

0-65535

<TCP/UDP port> – Specify the TCP/UDP port for the monitoring server.

  • int
  • 0 .. 65535
M
monitoringProfileName24Name of Monitoring Profile used for this SIP Signaling Port.O

signalingPackets

monitoringProfile1-23 charactersThe name of the Monitoring Profile.M

signalingPackets

N/A

Specifies if all signaling packets, or only decrypted TLS packets, are sent towards monitoring server from all TGs.

O
  • all
  • none (default)
  • tls
O

sourceIpPort

Source Ip/Port of the SIP PDU.

state

disabled
N/A

Administrative state of this Monitoring Profile.

  • disabled (default)
  • enabled
timeStamp

Timestamp as seconds.microseconds since 1.1.1970 UTC.

O

transport

udp
N/A
Select

Choose the transport

type for

protocol to use for sending packets to the monitoring server.

  • tcp – Transmission Control Protocol
  • udp (default) User Datagram Protocol

Include Page
_Controlling transport protocols for SIP
_Controlling transport protocols for SIP

Info
titleNote

The maximum size of SIP PDUs sent to the monitoring server over UDP protocol is 4096 bytes. SIP PDUs exceeding 4096 bytes will get dropped. Ribbon recommends using the TCP protocol if PDUs of a size greater than 4096 bytes are sent to the monitoring server.

O

type

mgmt
N/A

Interface type supported by monitoring server. 

  • ip – When selected, two
fields
  • additional parameters are
suppoorted
  • supported: addressContext and ipInterfaceGroup.
mgmtGroup
  • mgmt (default) When selected, the mgmtInterfaceGroup parameter is supported.
O
vlanTag
disabled


Adds VLAN ID of the interface on which the monitored message is sent/received. When this parameter is enabled, the "vlanTag" field of the LIFs on which the SIP message are received/sent, is added to X-header.

The

enhancement helps in better segregation of signaling traffic.
  • disabled (default)
  • enabled
O 

The command syntax to set a Monitoring Profile Name per SigPort is shown here:

Code Block
titleExample
% set addressContext <address_context> zone <zone_name> sipSigPort 1 monitoringProfileName <monitoring_profile_name>

In general, you can configure monitoringProfile as shown below:

Code Block
% set profiles services monitoringProfile test_monitoring_profile monitoringIpAddress 10.54.21.25 monitoringIpPort 80 headerPresence enabled header 1 headerName To sourceIpPort enabled destinationIpPort enabled additionalInformation enabled date enabled timestamp enabled vlanTag enabled

294013471

Caption
0Table
1Command Parameters for monitoringProfile
ParameterLength/RangeDefaultDescriptionM/OmonitoringProfileName24Name of Monitoring Profile used for this SIP Signaling Port.Opagebreak