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

...

borderColorgreen
bgColortransparent
borderWidth2

...

Back to Table of Contents

Back to CLI System-Level Mode

Back to request Command Details

In this section:

...

Children Display

...

 

 The request addressContext command is available from both system-level and configure modes

...

  •  cmds – Incorporates SIP options ping feature.
  •  dnsGroup – DNS Server Groups in this address context.
  •  dynamicBlackList – The collection of DBL policers.
  •  ipsec – Ipsec configuration, security policy database, ike peer table.
  •  sipRegCountReset – Resets the SIP registration count.
  •  sipRegistrationAdaptiveNatLearning – reset/disable adaptive nat pinhole learning process.
  •  sipRegistrationDeleteById – Delete a SIP registration by ID.
  •  sipRegistrationDeleteByIp – Delete a SIP registration by IP address.
  •  sipSubCountReset – Reset the SIP subscription count.
  •  sipSubscriptionDelete – Delete a SIP subscription.
  •  zone – Signaling, media, and control for a zone in the address context.

cmds optionsPing

Command syntax to ping another system from

Spacevars
0product
: 

Code Block
languagenone
> request addressContext <addressContext name> cmds optionsPing
	peerFQDN <string>
	peerIpAddress <peer ip address>
	peerPort <SIP port number>
	sigPort <signaling port>
	transport <tcp | tls | udp>
Caption
0Table
1optionsPing 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.

cmds

N/A

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)

dnsGroup

Command Syntax

Command syntax to initiate action on DNS group object:

Code Block
languagenone
> request addressContext <addressContext name> dnsGroup <dnsGroup name> dnsServerReset

Command Parameters

Caption
0Table
1dnsGroup 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.

dnsGroup

1-23

Name of this DNS Group Entry.

dnsServerResetN/AResets all the DNS server statistics.

dynamicBlackList

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

Command Syntax

Code Block
languagenone
> request addressContext <addressContext name> dynamicBlackList removeEntry sourceIpAddress <ip address>

Command Parameters

Caption
0Table
1dynamicBlackList 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.

dynamicBlackList

N/A

Collection of DBL policers.

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

Example

The following command removes all DBL entries from IP address 10.10.123.8:

Code Block
languagenone
> request addressContext default dynamicBlackList removeEntry sourceIpAddress 10.10.128.8 
 
When prompted, enter 'y' to continue: 
This command will remove any DBL entry with a matching source IP address. Do you want to proceed (yes/no) y

ipsec

Command Syntax

Command syntax to initiate action on IPsec object:

Code Block
languagenone
> request addressContext <addressContext name> ipsec <ipsec parameter to delete>

Command Parameters

Caption
0Table
1ipsec 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.

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.

Example

 The following command deletes all entries from the IKE SA list for local SPI 13:

Code Block
languagenone
> request addressContext default ipsec ikeSaDelete saIndex 13
 
When prompted, enter 'y' to continue: 
This command will delete entry from the IKE SA list. Do you want to continue (yes/no) y

sipRegCountReset

 This object resets the SIP registration count.

Command Syntax

Code Block
languagenone
> request addressContext <addressContext name> sipRegCountReset

Example

The following example resets SIP registration count for address context “default”: 

Code Block
languagenone
> request addressContext default sipRegCountReset result success reason Registration Count is Reset

sipRegistrationAdaptiveNatLearning

This object provides flexibility to disable/reset adaptive NAT pinhole learning process for a specific user already registered with SBC.

Command Syntax

Code Block
languagenone
> request addressContext <addressContext name> 
   sipRegistrationAdaptiveNatLearning
   action <disable|reset>
   id <registration id nbr>

Command Parameters

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:

Code Block
languagenone
> request addressContext default sipRegistrationAdaptiveNatLearning id 13 action disable

sipRegistrationDeleteById

This object allows you to delete a SIP registration by the user’s ID number.

Command Syntax

Code Block
languagenone
> request addressContext <addressContext name> sipRegistrationDeleteById id <registration id>

Command Parameters

Caption
0Table
1sipRegistrationDeleteById 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.

sipRegistrationDeleteById

N/A

Delete SIP registration for the specified ID.

idN/A

Registration ID of user. <id number>

Note
The surrogate registration is not deleted by the following command.

Example

Code Block
languagenone
> request addressContext default sipRegistrationDeleteById id 13
result success

sipRegistrationDeleteByIp

This object allows you to delete a SIP registration by the IP address using the Registrar’s IP address (found in sipActiveGroupRegStatus table).

Command Syntax

Code Block
languagenone
> request addressContext <addressContext name> sipRegistrationDeleteByIp ipAddress <ip address>

Command Parameters

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>

Note
The surrogate registration is not deleted by the following command.

Example

Code Block
languagenone
> request addressContext default sipRegistrationDeleteByIp ipAddress 10.20.128.13 
result success

sipSubCountReset

This object resets the SIP subscription count.

Command Syntax

Code Block
languagenone
> request addressContext <addressContext name> sipSubCountReset

Command Parameters

Caption
0Table
1sipSubCountReset 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.

sipSubCountReset

N/A

Reset SIP subscription count.

Example

Code Block
languagenone
> request addressContext default sipSubCountReset result success reason Subscription Count is Reset

sipSubscriptionDelete

Command Syntax

Code Block
languagenone
> request addressContext <addressContext name> sipSubscriptionDelete <subcription id>

Command Parameters

Caption
0Table
1sipSubscriptionDelete 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.

sipSubscriptionDelete

N/A

<id> Delete a SIP subscription.

Example

Code Block
languagenone
> request addressContext default sipSubscriptionDelete id 13

zone

This object allows you to perform system-level commands against a particular zone, such as recovering blacklisted endpoints and resetting statistics counts on all signaling ports.

Command Syntax

Code Block
languagenone
> request addressContext <addressContext name> zone <zone name>
	ipPeer <peer name> pathCheck localAdminState state <block | unblock> remoteAdminState state <block | unblock>	
	mtrmConnPort <reset | statReset>
	sipArsEndpointRecoveryAll
	sipArsEndpointRecoveryByIp ipAddress <ip address> port <port#>
	sipSigConnResetAll
	sipSigPortResetAll
	sipTrunkGroup <TG name> packetOutage clear

Command Parameters

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

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”.

...

languagenone

...

. Choose a link in the TOC above for specific command details.


Pagebreak