Versions Compared

Old Version 1

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

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

 

...

Panel

...

Table of Contents

...

maxLevel

...

4

...

Info

...

icon

...

Back to Table of Contents

Back to CLI System-Level Mode

Back to request Command Details

false

Related articles:

Tip

The request global command

 

...

is available from both System-level and Configure CLI modes.

Request Global 

To initiate action on global

...

objects, use the following command syntax.

Command Syntax

Code Block
languagenone
> request global

...


	callCountReset

...


	callTrace action command start
	dnsClearCache
	mediaCapture disabledByGcid gcid

...

<0-2147483647>

...

siprec
	terminateCall GCID <0-2147483647>

Command Parameters

Caption
0Table
1request global Parameters

Parameter

...

Length/Range

Description

global

...

Global objects applicable node-wide.

callCountReset

...

N/A

This object resets all statistics counts to zero.

callTrace

...

Call Trace Group configuration for the Node. 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

...

NOTE: This command is only exposed after a callTrace configuration is performed. If no entries are present in the callTrace, this command is not available from CLI.

dnsClearCache
Clear the full DNS cache.
mediaCapture

...

Reset call count for media capture with following arguments:

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

...

Use this object to start/stop recording for the 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

Include Page
Recordertype_recordingtype
Recordertype_recordingtype

Info
titleNote

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

Info

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

 

Command Syntax

Code Block
languagenone
> request global siprec
	startRecord
		callLeg
			egress
			ingress
		gcid <0-2147483647>
		numOfStreams
		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
		recorderPort

Command Parameters

Caption
0Table
1SIPREC Global Parameters
3SIPREC Global Parameters

Parameter

Description

startRecord

Use this configuration 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).

    • 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 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 configuration to halt a recording session.

...

    • gcid – GCID of the call to stop recording.
Note

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

    • recorderAddress – The IP address of the recorder to stop the recording of a GCID value.
    • recorderPort – The port number of the recorder to stop the recording of a GCID value.

NOTE: If only the GCID value is mentioned in this command, all recordings for that GCID are stopped at once.

 

Pagebreak

...

terminateCall

...

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

...