Related articles:

Request commands, such as the request global command, are available in both System-level and Configure CLI modes.

Request Global 

To initiate action on global objects, use the following command syntax.

Command Syntax

> request global 
	callCountReset
	callTrace 
      action 
        command <start | stop>
	dnsClearCache
	dumpActiveRegistration
    dumpDeletedRegistration
    dumpGeneratedSubscription
    mediaCapture 
      disabledByGcid 
        gcid <0-2147483647> 
	siprec
	terminateCall 
      GCID <0-2147483647>

Command Parameters

Global "Request" Parameters

Parameter

Description

global

Global objects applicable node-wide.

callCountReset

This object resets all statistics counts to zero.

callTrace

Start or stop call trace for the node. For example, use this parameter to restart call trace when it is halted due to MaxTrigger or some other reason. Full syntax is:

> request global callTrace action command start 

dnsClearCache

Clear the full DNS cache.
dumpActiveRegistration

Collects a dump of the following statistics for active registration of all registered subscribers on the SBC. Currently these are restricted to 2,048 records only.

  • sipActiveGroupRegStatus
  • sipActiveGroupRegSummaryStatus
  • sipActiveRegisterNameStatus
dumpDeletedRegistration

Collects a dump of the following statistic for deleted registration of all registered subscribers on the SBC. Currently these are restricted to 2,048 records only.

  • sipDeletedRegisterNameStatus
dumpGeneratedSubscription

Collects a dump of the following statistic for generated subscription of all registered subscribers on the SBC. Currently these are restricted to 2,048 records only.

  • sipGeneratedSubscriptionStatus

Only one of the three dump requests above is active at any given time. If one dump request is already in progress, any further dump request returns a "DumpInProgress" status. A successful request returns a "Dump Initiated Successfully" reply.

Each dump request creates a unique compressed file (below) at /opt/sonus/external:

  • sipActiveRegistrationIntStatsSts.csv.gz
  • sipDeletedRegistrationIntStatsSts.csv.gz
  • sipGeneratedSubscriptionIntStatsSts.csv.gz

Note: Use the following Global Signaling command to enable these statistics (Default is 'disabled').

set global signaling sipSigControls sipBulkStatusForSubscribers enabled

mediaCapture

Set a mediaCapture target to a disabled state:

  • disabledByGcid
    • gcid <gcid #> (range: 0-2147483647)
sipRec

Use this object to start/stop recording for a specified call. (See SIPREC Global Parameters table below for parameter details)

terminateCall

Terminates call based on the specified Global Call Identifier (GCID). 

  • GCID <gcid #>

SIPREC Commands


Note
  • If there is more than one SRS associated with the SRS Cluster, the SBC records on both the legs (Ingress and Egress). The first two recordings are on Ingress leg and the rest on Egress.
  • For Quad SIPREC, there are four recordings triggered. Two recordings are triggered on the Ingress leg and two on the Egress leg.
  • If there is more than one SRS Group configured, it is recommended to set recordingType to "both legs" or "all legs".
  • When SIPREC is selected as the Recorder Type, and Recording Type is selected as “both legs” and “all legs”, the SBC by default records the ingress leg.

Note

The SIPREC feature is controlled by a system-wide SBC license (SBC-SIPREC). If the license is not available, any SIPREC recording request returned by a PSX is ignored.

To support SIPREC INVITEs over TCP, the sipSigPort configured in the zone sending the request must have transportProtocolsAllowed set to "sip-tcp". (Refer to Zone - SIP Sig Port - CLI).

Command Syntax

> request global siprec
	startRecord
		callLeg
			egress
			ingress
		gcid <0-2147483647>
		numOfStreams <1-2>
        srsFqdn1 <FQDN>
        srsFqdn2 <secondary FQDN>
		srsIpAddress <SRS IP address>
		srsIpAddress2 
		srsPort <IP port number>
		srsPort2 <Ip port number>
		transport <tcp | udp>
		transport2  <tcp | udp>
		trunkGroup <TRUNK GROUP NAME>
		trunkGroup2
	stopRecord 
		gcid <0-2147483647>
		recorderAddress <SRS IP address>
        recorderFqdn <SRS FQDN>
        recorderId <session ID>
		recorderPort <port number>

Command Parameters

SIPREC Global Parameters

Parameter

Description

startRecord

Use this parameter to define and initiate a SIPREC recording session.

    • callLeg – Call leg associated with this recording session.
      • egress
      • ingress
    • gcid <0-2147483647> – GCID of call to start recording.

    • numOfStreams – The number of simultaneous streaming to different Session Recording Server (SRS) IP addresses. (default = 1).

    • srsFqdn1 – The FQDN of the SRS server to use for this recording, up to 63 characters. If you specify both an FQDN and individual IP address, the IP address takes precedence.
    • srsFqdn2 – The FQDN of a secondary SRS server to use if the media stream is forked, up to 63 characters.

    • srsIpAddress – The IP address of the primary recording server.

    • srsIpAddress2 – The IP address of the secondary recording server to which the media stream is forked. (only applies when numOfStreams = 2)

    • srsPort – The IP port number of the primary recording server.

    • srsPort2 – The IP port number of the secondary recording server to which the media stream is forked. (only applies when numOfStreams = 2)

    • transport – The transport protocol for recording sessions on the primary SRS IP.

      • tcp
      • udp (default)

    • transport2 – The transport protocol for recording sessions on the secondary SRS IP (only applies when numOfStreams = 2)

      • tcp

      • udp (default)

    • trunkGroup  – The name of the SIPREC trunk group towards primary SRS IP for this recording session.

    • trunkGroup2 –  The name of the SIPREC trunk group towards secondary SRS IP for this recording session. (only applies when numOfStreams = 2)

NOTE: If the number of streams is one and secondary SRS details are provided in the srsIpAddress2, srsPort2, and trunkGroup2, this information will be used for redundancy when primary server goes down.

stopRecord

Use this parameter and its sub-parameters to halt a recording session.

    • gcid – GCID of the call to stop recording.
    • recorderAddress – The IP address of the recorder to stop the recording of a GCID value.
    • recorderFqdn – The FQDN of the SRS server on which to stop a recording, up to 63 characters.
    • recorderId –  The unique identifier of the recording session to stop.   You can determine the recorderId for a session using the show table global SipRecStatus command.
    • recorderPort – The port number of the recorder to stop the recording of a GCID value.

NOTE: If you specify only the GCID value with this command, all recordings for the related call are stopped at once.