Command Syntax

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

Example
> show profiles services monitoringProfile <monitoring profile name>
    additionalInformation
    displayLevel
    filter
    header
    headerPresence
    mgmtInterfaceGroup
    monitoringIpAddress
    monitoringIpPort
    signalingPackets
    state
    transport
    type
	vlanTag

297379078


Command Parameters for monitoringProfile

ParameterLength/RangeDefaultDescriptionM/O

additionalInformation

256

Additional information in the header sent towards the monitoring server.

O
displayLevel

Depth to show.

  • unsignedLong –
  • 1 .. 64 –
 O

filter



This table contains filters for the profile.

  • transport – Transport type used to filter the packets
  • trunkgroup – IP TG filter used to filter the packets.
O

headerPresence


disabled

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

O

mgmtInterfaceGroup


mgmtGroup

The Management Interface Group to use for communicating with monitoring server.

O

monitoringIpAddress



IP address of the monitoring server.

M

monitoringIpPort



TCP/UDP port for the monitoring server.

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

signalingPackets



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

O

state



Administrative state of this Monitoring Profile.

  • disabled
  • enabled

transport


udp

Select the transport type for the monitoring server.

  • sctp – Stream Control Transmission Protocol
  • tcp – Transmission Control Protocol
  • tls-tcp – Transport Layer Security running on top of TCP
  • udp – User Datagram Protocol
O

type


mgmt

Interface type supported by monitoring server. 

  • IP – IP interface to be used for this monitoring server, addressContext and ipInterfaceGroup must be completed when this is selected.
  • mgmt – Mgmt interface to be used for this monitoring server, mgmtInterfaceGroup must be completed when this sis selected.
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

 


Configuration Example

admin@SAPOTA% show profiles services monitoringProfile
monitoringProfile test1 {
    monitoringIpAddress   NN.NN.NN.NN;
    monitoringIpPort      6786;
    type                  mgmt;
    mgmtInterfaceGroup    mgmtGroup;
    signalingPackets      none;
    headerPresence        enabled;
    additionalInformation SAPOTA;
    header 1 {
        headerName   x-Ribbon-SIP-Source;
        sourceIpPort enabled;
		vlanTag      enabled;
    }
    header 2 {
        headerName        x-Ribbon-SIP-Destination;
        destinationIpPort enabled;
		vlanTag           enabled;
    }
    header 3 {
        headerName x-Ribbon-Date;
        date       enabled;
		vlanTag    enabled;
    }
    header 4 {
        headerName            x-Ribbon-Network-Id;
        additionalInformation enabled;
		vlanTag               enabled;
    }
    header 5 {
        headerName x-Ribbon-SBGTIME;
        timestamp  enabled;
		vlanTag    enabled;
    }
    filter 1 {
        trunkgroup RHEL_1;
        transport  udp;
    }
}