...
...
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 :
Code Block |
---|
|
> request addressContext <addressContext name> cmds optionsPing
peerFQDN <string>
peerIpAddress <peer ip address>
peerPort <SIP port number>
sigPort <signaling port>
transport <tcp | tls | udp> |
Caption |
---|
0 | Table |
---|
1 | optionsPing Parameters |
---|
|
Parameter | Description |
---|
cmds optionsPing
| The commands object used 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:
|
|
dnsGroup
Command Syntax
Command syntax to initiate action on DNS group object:
Code Block |
---|
|
> request addressContext <addressContext name> dnsGroup <dnsGroup name>
clearCache
dnsServerReset
query
updateTtl |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | dnsGroup request Parameters |
---|
|
Parameter | Length/Range | Description |
---|
clearCache | | | dnsServerReset | N/A | Resets 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 lookuprecordType – 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.
Command Syntax
Code Block |
---|
|
> request addressContext <addressContext name> dynamicBlackList removeEntry sourceIpAddress <ip address> |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | dynamicBlackList request Parameters |
---|
|
Parameter | Description |
---|
dynamicBlackList
| Collection of DBL policers. | removeEntry | Parameter 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 |
---|
|
> 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 |
---|
|
> request addressContext <addressContext name> ipsec <ipsec parameter to delete> |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | ipsec request Parameters |
---|
|
Parameter | Description |
---|
ipsec
| IP Security configuration, including security policy database and IKE peer table. | ikeSaDelete | Name of a specific IKE SA to be deleted by its IKE handle identifier. saIndex <unsignedInt> – index number of IKE SA to delete.
| ikeSaDeleteAll | Globally deletes all IKE SAs. When prompted to delete all, enter Yes . | ipsecSaDelete | 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 |
---|
|
> 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 |
---|
|
> request addressContext <addressContext name> sipRegCountReset |
Example
The following example resets SIP registration count for address context “default”:
Code Block |
---|
|
> 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 |
---|
|
> request addressContext <addressContext name>
sipRegistrationAdaptiveNatLearning
action <disable|reset>
id <registration id nbr> |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | sipRegistrationAdaptiveNatLearning request Parameters |
---|
|
Parameter | Description |
---|
sipRegistrationAdaptiveNatLearning
| Reset/disable adaptive NAT pinhole learning process. | id
| Registration ID of user. <id number> | action | Action to perform. Arguments include: |
|
Example
The following example disables the NAT pinhole learning process for registered user with an ID of 13:
Code Block |
---|
|
> 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 |
---|
|
> request addressContext <addressContext name> sipRegistrationDeleteById id <registration id> |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | sipRegistrationDeleteById request Parameters |
---|
|
Parameter | Description |
---|
sipRegistrationDeleteById
| Delete SIP registration for the specified ID. | id
| Registration ID of user. <id number> |
|
Note |
---|
The surrogate registration is not deleted by the following command. |
Example
Code Block |
---|
|
> 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 |
---|
|
> request addressContext <addressContext name> sipRegistrationDeleteByIp ipAddress <ip address> |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | sipRegistrationDeleteByIp request Parameters |
---|
|
Parameter | Description |
---|
sipRegistrationDeleteByIp
| Delete SIP registration associated with the specified IP address. | ipAddress
| IP address of the Registrar. <ip address> |
|
Note |
---|
The surrogate registration is not deleted by the following command. |
Example
Code Block |
---|
|
> request addressContext default sipRegistrationDeleteByIp ipAddress 10.20.128.13
result success |
sipSubCountReset
This object resets the SIP subscription count.
Command Syntax
Code Block |
---|
|
> request addressContext <addressContext name> sipSubCountReset |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | sipSubCountReset request Parameters |
---|
|
Parameter | Description |
---|
sipSubCountReset
| Reset SIP subscription count. |
|
Example
Code Block |
---|
|
> request addressContext default sipSubCountReset result success reason Subscription Count is Reset |
sipSubscriptionDelete
Command Syntax
Code Block |
---|
|
> request addressContext <addressContext name> sipSubscriptionDelete <subcription id> |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | sipSubscriptionDelete request Parameters |
---|
|
Parameter | Description |
---|
sipSubscriptionDelete
| <id> Delete a SIP subscription. |
|
Example
Code Block |
---|
|
> 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 |
---|
|
> 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 |
---|
0 | Table |
---|
1 | request 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). |
| sipSigConnResetAll | Resets all the statistics counts to zero on all SIP signaling port connections. | sipSigPortResetAll | Resets 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:
|
|
Example
The following example clears packet outage counts for SIP trunk group “TG-1” in zone “INTERNAL_ZONE” for address context “default”.
...
...
. Choose a link in the TOC above for specific command details.