Page History
Add_workflow_for_techpubs | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Panel | ||||
---|---|---|---|---|
In this section:
|
Tip |
---|
Request commands, such as the |
Request Global
To initiate action on global objects, use the following command syntax.
Command Syntax
Code Block | ||
---|---|---|
| ||
> request global callCountReset callTrace action command <start | stop> dnsClearCache dumpActiveRegistration dumpDeletedRegistration dumpGeneratedSubscription mediaCapture disabledByGcid gcid <0-2147483647> siprec terminateCall GCID <0-2147483647> |
Command Parameters
Table
1
: Global "Request" Parameters
Parameter | Description | ||
---|---|---|---|
| Global objects applicable node-wide. | ||
| 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:
| ||
| Clear the full DNS cache. | ||
dumpActiveRegistration | Collects a dump of the following statistics for active registration of all registered subscribers on the SBC.
| ||
dumpDeletedRegistration | Collects a dump of the following statistic for deleted registration of all registered subscribers on the SBC.
| ||
dumpGeneratedSubscription | Collects a dump of the following statistic for generated subscription of all registered subscribers on the SBC.
| ||
| |||
mediaCapture | Set a mediaCapture target to a disabled state:
| ||
sipRec | Use this object to start/stop recording for a specified call. (See SIPREC Global Parameters table below for parameter details) | ||
| Terminates call based on the specified Global Call Identifier (GCID).
|
SIPREC Commands
Include Page | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
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. |
Info | ||
---|---|---|
| ||
To support SIPREC INVITEs over TCP, the sipSigPort configured in the zone sending the request must have |
Command Syntax
Code Block | ||
---|---|---|
| ||
> 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
Table
2: SIPREC Global Parameters
Parameter | Description |
---|---|
startRecord | Use this parameter to define and initiate a SIPREC recording session.
NOTE: If the number of streams is one and secondary SRS details are provided in the |
stopRecord | Use this parameter and its sub-parameters to halt a recording session.
NOTE: If you specify only the GCID value with this command, all recordings for the related call are stopped at once. |
SIP Local Registrar Commands
Command Syntax
Code Block | ||
---|---|---|
| ||
> request global sipLocalRegistrar sipLocalRegistrarRegDeleteByAor <aor Name> > request global sipLocalRegistrar sipRegCountReset |
Command Parameters
Parameter | Length/Range | Default | Description | |||||
---|---|---|---|---|---|---|---|---|
sipLocalRegistrarRegDeleteByAor | N/A | N/A | Deletes the specified AOR entry from the Registrar. | |||||
sipRegCountReset | N/A | N/A | Resets the count of statistics.
|
Info | ||
---|---|---|
| ||
The |
Command Example
Code Block | ||
---|---|---|
| ||
request global sipLocalRegistrar sipRegCountReset request global sipLocalRegistrar sipRegistrationDeleteByAor sipRegAor 53056@10.xx.xx.x0 result success |
SIPREC Commands for SBC Cloud-Native Edition (CNe)
Info | ||
---|---|---|
| ||
The Global Unique Identifier (GUID) key is available on the SBC CNe. GUID is not accepted on non-CNe SBC products. |
"Global Unique Identifier" (GUID) Commands for CNe
Command Syntax
Code Block | ||
---|---|---|
| ||
% request service SC podName <SC podName | ALL> global siprec startRecordByGuid GUID <GUID> callLeg ingress numOfStreams <1 | 2> srsIpAddress <SRS IP ADDRESS> srsFqdn1 <FQDN> srsPort <SRS PORT> transport <tcp | udp> trunkGroup <TRUNK GROUP NAME> srsIpAddress2 <SRS IP ADDRESS> srsFqdn2 <secondary FQDN> srsPort2 <SRS Port> transport2 <tcp | udp> trunkGroup2 <SIP Trunk Group> |
Code Block | ||
---|---|---|
| ||
% request service SC podName <SC podName | ALL> global siprec stopRecordByGuid GUID <GUID> recorderAddress <IP Address> recorderFqdn <FQDN> recorderPort <Port Number> recorderId <recording session ID> |
Command Parameters
Table 3: SIPREC GUID Parameters for CNe
Command | Description |
---|---|
| Use this command and its sub-parameters to define and initiate a SIPREC recording session identified with GUID.
|
| Use this command and its sub-parameters to halt a recording session identified with GUID.
|
Info | ||
---|---|---|
| ||
Commands which take GUID as key need not specify the SC podName and use "ALL" option for podName to trigger the command. |
Configuration Examples
Code Block | ||
---|---|---|
| ||
request service SC podName ALL global siprec startRecordByGuid GUID 1234567 callLeg ingress numOfStreams 1 srsIpAddress 123.45.67.89 srsFqdn1 exampledomain.com srsPort 7321 transport udp trunkGroup exampleTrunkGroup
commit |
Code Block | ||
---|---|---|
| ||
request service SC podName ALL global siprec stopRecordByGuid GUID 1234567 recorderAddress 123.45.67.89 recorderFqdn exampledomain.com recorderPort 1 recorderId testID
commit |
"Global Call Identifier" (GCID) Commands for CNe
Command Syntax
Code Block | ||
---|---|---|
| ||
% request service SC podName <SC podName> global siprec startRecord gcid <gcid> callLeg ingress numOfStreams <1 | 2> srsIpAddress <SRS IP ADDRESS> srsFqdn1 <FQDN> srsPort <SRS PORT> transport <tcp | udp> trunkGroup <TRUNK GROUP NAME> srsIpAddress2 <SRS IP ADDRESS> srsFqdn2 <secondary FQDN> srsPort2 <SRS Port> transport2 <tcp | udp> trunkGroup2 <SIP Trunk Group> |
Code Block | ||
---|---|---|
| ||
% request service SC podName <SC podName> global siprec stopRecord gcid <gcid> recorderAddress <IP Address> recorderFqdn <FQDN> recorderPort <Port Number> recorderId <recording session ID> |
Command Description
Table 4: SIPREC GCID Parameters for CNe
Command | Description |
---|---|
| Use this command and its sub-parameters to define and initiate a SIPREC recording session identified with GCID.
|
| Use this parameter and its sub-parameters to halt a recording session identified with GCID.
|
Info | ||
---|---|---|
| ||
Commands which take GCID as key must specify the SC podName on which the call is hosted. |
Configuration Examples
Code Block | ||
---|---|---|
| ||
request service SC podName testPod global siprec startRecord gcid 1234567 callLeg ingress numOfStreams 1 srsIpAddress 123.45.67.89 srsFqdn1 exampledomain.com srsPort 7321 transport udp trunkGroup exampleTrunkGroup
commit |
Code Block | ||
---|---|---|
| ||
request service SC podName testPod global siprec stopRecord gcid 1234567 recorderAddress 123.45.67.89 recorderFqdn exampledomain.com recorderPort 1 recorderId testID
commit |