In this section:


The service podName addressContext command applies to both system-level and configure modes except where noted.


Command Syntax

> request service <service> podName <pod name> addressContext <address context>
  cmds 
  dnsGroup
  dynamicBlackList
  enhancedDBL
  ipsec
  sipRegCountReset
  sipRegistrationAdaptiveNatLearning
  sipRegistrationDeleteByGuid
  sipRegistrationDeleteById
  sipRegistrationDeleteByIp
  sipSubCountReset
  sipSubscriptionDelete
  sipSubscriptionDeleteByGuid
  zone

Configurations

Cmds

Use cmds options Ping command to ping a SIP peer from the SBC using the SIP OPTIONS method.

Command Syntax

> request service <service> podName addressContext <addressContext name> cmds optionsPing
	peerFQDN <string>
	peerIpAddress <peer ip address>
	peerPort <SIP port number>
	sigPort <signaling port>
	transport <tcp | tls | udp>

Command Parameters

Parameter

Length/Range

Description

peerFQDN1-63

<string> – Use this parameter to activate a single options ping request to a particular FQDN peer. This command is deemed 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, the SBC sends the OPTIONS request to the next FQDN resolved IP. 

peerIpAddress IPv4 / IPv6 address<IPv4 or IPv6 address> – The IPv4 or IPv6 Peer SIP Address to ping.
peerPort 1-65535<SIP port number> – The Peer SIP Port Number to ping. (Default = 5060)
sigPort 1-4096<Signaling port number> – The Signaling Port number to use for the ping.

transport 

N/A

The Transport protocol. Select any one of the following transport types:

  • tcp
  • tls
  • udp (default)

DNS Group 

Use this command to perform manual actions against a specific DNS group.

Command Syntax

> request service <service> podName addressContext <addressContext_name> dnsGroup <dnsGroup name>
	dnsEntryDataStatus
	dnsEntryStatus
	dnsServerStatistics

Command Parameters 

ParameterDescription
<dnsGroup name>The DNS Group name.
dnsEntryDataStatus

DNS entry data status (up to 32 records are returned).

  • domainName – Domain name associated with this DNS entry.
  • hostName – The host name of the DNS entry.
  • ipAddress – The IP address of the DNS entry.
  • portNum – The port number of the DNS entry.
  • preference – The preference for the DNS entry.
  • priority – The priority of the DNS entry.
  • recordIndex – Record index of this DNS entry.
  • recordDataIndex – Record number of this DNS entry.
  • recordName – Record name of this DNS entry.
  • service – The service type of the DNS entry.
  • type – Local name service record data type.
  • ttl – The TTL for the DNS entry.
  • weight – The load-sharing weight of the DNS entry.
dnsEntryStatus

DNS entry record status. 

  • domainName – The domain name of the DNS entry record. 
  • foreignRecord – Flag indicating whether the entry record is foreign (true) or locally created (false).
  • type – The type of the DNS entry record.

dnsServerStatistics

DNS server statistics for this DNS group.

  • errors – The number of errors from queries to this DNS server.
  • ipAddress – The IP address of the DNS server requested for the statistics data.
  • queries – The number of queries to the DNS server for this DNS group.
  • referrals – The number of referrals from queries to the DNS server for this DNS group.
  • timeouts – The number of timeouts from queries to the DNS server for this DNS group.
  • ednsStatus – The EDNS support status for the DNS server in this DNS group. (supported/unsupported/monitoring).
  • ednsFailures – The number of eDNS query failures for the selected DNS Server.
  • totalTcpConnection – The number of attempts to connect to the DNS server for this DNS group.
  • tcpConnectionSuccess – The number of successful TCP connections to the DNS server for this DNS group.
  • tcpConnectionTornDown – The number of TCP connections torn down with DNS server for this DNS group.
  • tcpFallback – The number of times TCP fallback occurred for with DNS server for this DNS group.
server

Configured parameters for DNS servers in the DNS group.

  • dscpValue – The Differentiated Services Code Point (DSCP) value the SBC sends in the IP header of DNS queries to the specified DNS server.
  • ipAddress – The IPv4 or IPv6 address of this DNS server.
  • priority – The priority of this DNS server.
  • recordOrder –  The lookup order of the local name service records associated with the specified DNS server. (centralized-roundrobin, priority, roundrobin)
  • recursionDesired– Whether to use recursion for this DNS server.
  • state – The administrative state of this DNS server.
  • tcpFallback – Whether to support TCP fallback when the transport protocol is configured as UDP.
  • transportProtocol – The transport protocol to use for DNS queries for this DNS server.
  • weight – The load-sharing weight of this DNS server. 

Dynamic Black List

Use this command to remove Dynamic Blacklist (DBL) entries for the specified IP address.

Command Syntax 

> request service <service> podName addressContext <addressContext name> dynamicBlackList removeEntry sourceIpAddress <ip address>

Command Parameters 

Parameter

Description

dynamicBlackList

Collection of DBL policers.

removeEntryParameter to remove any DBL entries for specified IP address.
sourceIpAddressSource IP Address

Command Examples

request service CS podName 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

Enhanced DBL

Use the following Enhanced Dynamic Blacklist command to remove any IP-based entries matching the specified criteria.

Command Syntax 

> request service <service> podName addressContext default enhancedDBL removeEnhancedDblEntry removeIpEntry
	sourceIpAddress <IP address>
	sourcePort <port>
	transport <none | sctp | tcp | tls | tcp | udp>

Command Parameters

ParameterLength/RangeDescription
sourceIpAddressIPv4 or IPv6 addressThe source IP address for the DBL entry to remove.
sourcePort0-65535

Source port value. A value of "0" means no port. (Default = 0)

transportN/A

The transport type

  • none (default)
  • sctp
  • tcp
  • tls-tcp
  • udp

IPsec

Use this command to initiate a delete action on an IP Security configuration object.

Command Syntax

> request service <service> podName addressContext <addressContext_name> ipsec 
   ikeSaDelete saIndex <SA index>
   ikeSaDeleteAll
   ipsecSaDelete localSPI <local SPI>

Command Parameters

Parameter

Description

ikeSaDelete saIndex

<SA index> – Enter the SA index to delete a specific IKE SA and its IPsec SAs.

ikeSaDeleteAll

Use this parameter to delete ALL IKE and IPsec SAs.

  • For IKEv1, this is an ungraceful delete message (peer is not notified).
  • For IKEv2, a tear-down message is sent to the peer.

ipsecSaDelete localSPI

<local SPI> – Enter the local SPI to delete the IPsec SA pair (local_SPI: incoming Security Parameter Index value).

This command supports the deletion of IKE IPsec SAs only. You cannot delete IPsec SAs created during IMS AKA registration using this command.

Command Example

request service CS podName 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) yes

SIP Reg Count Reset

Use this command to reset the SIP registration count.

Command Syntax

> request service <service> podName addressContext <addressContext name> sipRegCountReset

 

Command Example

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

request service CS podName addressContext default sipRegCountReset 
result success reason Registration Count is Reset


SIP Registration Adaptive Nat Learning

Use this command to provide flexibility in disabling/resetting adaptive NAT pinhole learning process for a specific user already registered with the SBC.

Command Syntax

> request service <service> podName addressContext <addressContext name> 
   sipRegistrationAdaptiveNatLearning
   action <disable | reset>
   id <registration id number>

 

Command Parameters

Parameter

Description

sipRegistrationAdaptiveNatLearning

Reset/disable adaptive NAT pinhole learning process.

id

Registration ID of the user. <id number>

action

Action to perform. Arguments include:

  • disable
  • reset

 

Command Example

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

request service CS podName addressContext default sipRegistrationAdaptiveNatLearning id 13 action disable


SIP Registration Delete By GUID

Use this object to delete a SIP registration by the user's GUID number.

Command Syntax

> request service <service> podName addressContext <addressContext name> sipRegistrationDeleteByGuid GUID <GUID>


SIP Registration Delete By ID

Use this object to delete a SIP registration by the user’s ID number.

Command Syntax

> request service <service> podName addressContext <addressContext name> sipRegistrationDeleteById id <registration id>


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

 

Command Example

request service CS podName addressContext default sipRegistrationDeleteById id 13
result success


SIP Registration Delete By IP

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

Command Syntax

> request service <service> podName addressContext <addressContext name> sipRegistrationDeleteByIp ipAddress <ip address>


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


Command Example

request service CS podName addressContext default sipRegistrationDeleteByIp ipAddress 10.20.128.13 
result success

Zone

The request addressContext zone command is available from both system-level and configure modes. This command 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

> request addressContext <addressContext name> zone <zone name>
	cacNonRegEndPointRemoveEntry sourceIpAddress <IP address>
	filterSipSrc fqdnEntry <IP address>
	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

Parameter

Description

cacNonRegEndPointRemoveEntry

sourceIpAddress <IP address> – Use this command to remove any CAC entries associated with the specified source IP address.

filterSipSrc 

Use this object to define information related to filtering a SIP message against the source IP address.
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. Options include:

  • cmds queryPsxOnNextRefreshRegister – Use this command in Ingress trunk group (only) to force the SBC to do a PSX dip for the next refresh REGISTER sent to the core. This command is applied to all refresh REGISTERs on all active registrations currently handled by the SBC.
    • newRegistrarIndex – Specify the route index to route to if more than one route is configured.(Default = 0)
    • overRideInternalExpires– Enable flag to override SBX internal expires timer.
      • disable (default)
      • enable
    • registrarFqdn – Refresh REGISTERs on active registrations only towards this FQDN are sent for PSX query.
    • registrarIpAddress – Refresh REGISTERs on active registrations only towards this Registrar IP are sent for PSX query.
  • packetOutage clear
  • services natTraversal adaptiveLearning clearStats


queryPsxOnNextRefreshRegister conditions:

  • This feature requires Pathcheck support using OPTIONS Ping and ARS static blacklisting to detect the reachability of a particular IP/FQDN.
  • If both request command and IPSP flags are configured, the request command takes precedence over IPSP flags.
  • The parameters registerFqdn and registerIpAddress are mutually exclusive. Use one or the other in the command, but not both.

Command Example

request addressContext default zone INTERNAL_ZONE sipTrunkGroup TG-1 packetOutage clear 
reason Trunk Group Packet Outage Detection State is cleared