Versions Compared

Old Version 1

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version 2

changes.mady.by.user Ribbon Communications

Saved on

Key

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

...

Caption
0Table
1optionsPing Parameters
1-23

Parameter

Length/Range

Description

addressContext

Name of the address context. The address context is a container of objects that correspond to a specific IP Addressing domain.

cmds

N/A

cmds optionsPing


The commands object used to perform optionsPing actions.

optionsPing– Use

to ping a SIP peer using SIP OPTIONS method.

  • peerFQDN <string> – Use this parameter to activate a single options ping request to a particular FQDN peer (this command will be successful on the first responded OPTIONS request). The SBC sends the OPTIONS request to the highest priority FQDN-resolved IP. If required, the SBC retransmits the request eight additional times. If there is no response to any of these requests, SBC sends the OPTIONS request to the next FQDN resolved IP.
     
  • peerIpAddress – The IPv4 or IPv6 Peer SIP Address to ping.
  • peerPort – The Peer SIP Port Number to ping. (Default = 5060)
  • sigPort – The Signaling Port number to use for the ping.
  • transport – The Transport protocol. Select any one of the following transport types:
    • tcp
    • tls
    • udp (
    • Default
    • default)

dnsGroup

Command Syntax

Command syntax to initiate action on DNS group object:

Code Block
languagenone
> request addressContext <addressContext name> dnsGroup <dnsGroup name> 
	clearCache
	dnsServerReset
	query
	updateTtl

Command Parameters

Caption
0Table
1dnsGroup request Parameters
addressContext

Parameter

Length/Range

Description

clearCache

1-23

Name of the address context. The address context is a container of objects that correspond to a specific IP Addressing domain.

dnsGroup

1-23

Name of this DNS Group Entry.

  
dnsServerResetN/AResets all the DNS server statistics.
query 

Perform a DNS query to the server, with following additional configurations.

  • dnsServer – DNS server to use to perform lookup.
  • fqdn – Domain to use for lookup
  • recordType – Specify whether to use the DNS server for just A-record lookups, or for full NAPTR/SRV/A lookup as specified in RFC3263
updateTtl  

dynamicBlackList

This object allows you to remove Dynamic Blacklist (DBL) entries for the specified IP address.

...

Caption
0Table
1dynamicBlackList request Parameters
1-23

Parameter

Length/Range

Description

addressContext

Name of the address context. The address context is a container of objects that correspond to a specific IP Addressing domain.

dynamicBlackList

N/A

Collection of DBL policers.

removeEntryN/AParameter to remove any DBL entries for specified IP address.

...

Caption
0Table
1ipsec request Parameters
1-23

Parameter

Length/Range

Description

addressContext

Name of the address context. The address context is a container of objects that correspond to a specific IP Addressing domain.

ipsec

N/A

IP Security configuration, including security policy database and IKE peer table.

ikeSaDeleteN/A

Name of a specific IKE SA to be deleted by its IKE handle identifier.

  • saIndex <unsignedInt> – index number of IKE SA to delete.
ikeSaDeleteAllN/AGlobally deletes all IKE SAs. When prompted to delete all, enter Yes.
ipsecSaDeleteN/A

Delete the IPsec SA pair with a given local tunnel IP address (LOCAL TUNNEL IP ADDRESS) and a given incoming Security Parameter Index value (LOCAL SPI).

  • localSPI <sonusHexBinary value> – Local SPI (Security Parameter Index) of the SA to delete.

...

Caption
0Table
1sipRegistrationAdaptiveNatLearning request Parameters

Parameter

Length/Range

Description

addressContext

1-23

Name of the address context. The address context is a container of objects that correspond to a specific IP Addressing domain.

sipRegistrationAdaptiveNatLearning

N/A

Reset/disable adaptive NAT pinhole learning process.

idN/A

Registration ID of user. <id number>

actionN/A

Action to perform. Arguments include:

  • disable
  • reset

Example

The following example disables the NAT pinhole learning process for registered user with an ID of 13:

...

Caption
0Table
1sipRegistrationDeleteById request Parameters

ParameterLength/Range

Description

addressContext

1-23

Name of the address context. The address context is a container of objects that correspond to a specific IP Addressing domain.

sipRegistrationDeleteById

N/A

Delete SIP registration for the specified ID.

idN/A

Registration ID of user. <id number>

...

Caption
0Table
1sipRegistrationDeleteByIp request Parameters

Parameter

Length/Range

Description

addressContext

1-23

Name of the address context. The address context is a container of objects that correspond to a specific IP Addressing domain.

sipRegistrationDeleteByIp

N/A

Delete SIP registration associated with the specified IP address.

ipAddressN/A

IP address of the Registrar. <ip address>

...

Caption
0Table
1sipSubCountReset request Parameters

ParameterLength/Range

Description

addressContext

1-23

Name of the address context. The address context is a container of objects that correspond to a specific IP Addressing domain.

sipSubCountReset

N/A

Reset SIP subscription count.

...

Caption
0Table
1sipSubscriptionDelete request Parameters
Name of the address context. The address context is a container of objects that correspond to a specific IP Addressing domain.

ParameterLength/Range

Description

addressContext

1-23

sipSubscriptionDelete

N/A

<id> Delete a SIP subscription.

...

Caption
0Table
1request addressContext zone Parameters

Parameter

Description

ipPeer <peer name> pathCheck

 Use this parameter to manually block or unblock the Local Admin state or Remote Admin state of the peer in the specified zone. 

  • localAdminState state <block | unblock>
  • remoteAdminState state <block | unblock>
mtrmConnPort

Use this object to reset Master Trunk Resource Manager (MTRM) connection port and/or MTRM port statistics.

  • reset – Resets the Master Trunk Group Connection Port and resets all stats related to the connection port.
  • statReset – Resets the Master Trunk Group Connection Port statistics.
Note

The reset command has no impact if executed on a disabled or out-of-service object.

sipArsEndpointRecoveryAll

Recovers all blacklisted endpoints in this zone.

Note

This command only applies for peers blacklisted using ARS mechanism (not via PATHCHECK).

sipArsEndpointRecoveryByIp

Recovers a blacklisted endpoints in this zone by IP address and port. 

  • ipAddress <ip adddress> – Endpoint's IP address.
  • port <endpoint port#> – Endpoint's port number.
Note
This command only applies for peers blacklisted using ARS mechanism (not via PATHCHECK).
sipSigConnResetAllResets all the statistics counts to zero on all SIP signaling port connections.
sipSigPortResetAllResets all the statistics counts to zero on all SIP signaling ports.
sipTrunkGroup

<TG_NAME>  --  Specify the SIP trunk group for which to clear packet outage counts. Arguments include:

<TG_NAME>

  • packetOutage clear

Example

The following example clears packet outage counts for SIP trunk group “TG-1” in zone “INTERNAL_ZONE” for address context “default”.

...