You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

 

Back to Table of Contents

Back to CLI System-Level Mode

Back to Request Command Details - CLI

Additional section:

Request Address Context Zone - CLI


In this section:

 The request addressContext command is available from both system-level and configure modes, and includes the following objects:

  •  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

Unable to show "metadata-from": No such page "_space_variables"
: 

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

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:
    • tcp
    • tls
    • udp (default)

Back to Top

dnsGroup

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

Command Syntax

Command syntax to initiate action on DNS group object:

> request addressContext <addressContext name> dnsGroup <dnsGroup name> 
	clearCache
		domainName <domain name>
		recordType <a | aaaa | default | naptr | ns | srv>
	dnsServerReset
	query
		dnsServer <server name>
		fqdn <FQDN>
		recordType <a | aaaa | naptr | ns | srv>
	updateTtl
		fqdn <FQDN>
		recordType <a | aaaa | naptr | ns | srv>
		ttl <vaLue>

Command Parameters

dnsGroup request Parameters

Parameter

Description

clearCache

Clear the cache of the matching record.

  • domainName <domain name> – Enter the name of the domain from which to clear the cache.
  • recordType – Choose the DNS record type. 
    • a
    • aaaa
    • default
    • naptr
    • ns
    • srv
dnsServerResetReset all DNS server statistics.
query

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

  • dnsServer <server name> – DNS server to use to perform lookup.
  • fqdn <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. 
    • a
    • aaaa
    • naptr
    • ns
    • srv
updateTtl

Updates the cache of the matching record with the new TTL value.

  • fqdn <FQDN> – FQDN to be updated from the Cache.
  • recordType – Specifies whether to use the DNS server for just A-record lookups, or for full NAPTR/SRV/A lookup as specified in RFC3263.
    • a
    • aaaa
    • naptr
    • ns
    • srv
  • ttl <value> – Enter the Time To Live (TTL) duration, in seconds, to cache a particular record.

Command Examples

To send the manual DNS query with server:

> request addressContext <addressContextName> dnsGroup <dnsGroupName> query dnsServer <dnsServerName> fqdn <fqdnValue> recordType <a | aaaa | srv | ns | naptr>

To send the manual DNS query without DNS server:

> request addressContext <addressContextName> dnsGroup <dnsGroupName> query fqdn <fqdnValue> recordType <a | aaaa | srv | ns | naptr>

To clear the particular DNS group cache (under Address Context):

> request addressContext <addressContextName> dnsGroup <dnsGroupName> clearCache

 To clear a particular Domain Name/FQDN under a DNS Group (under Address Context): 

> request addressContext <addressContextName> dnsGroup <dnsGroupName> clearCache domainName <domainName>

To clear a particular record under Address Context: 

> request addressContext <addressContextName> dnsGroup <dnsGroupName> clearCache domainName <domainName> recordType <a | aaaa | srv |naptr>

To clear the full DNS Cache, use the command:

> request global dnsClearCache

 

Back to Top

 

dynamicBlackList

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

Command Syntax

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

Command Parameters

dynamicBlackList request Parameters

Parameter

Description

dynamicBlackList

Collection of DBL policers.

removeEntryParameter to remove any DBL entries for specified IP address.

Example

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

> 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

Back to Top

ipsec

Command Syntax

Command syntax to initiate action on IPsec object:

> request addressContext <addressContext name> ipsec <ipsec parameter to delete>

Command Parameters

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.
ikeSaDeleteAllGlobally 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:

> 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

Back to Top

sipRegCountReset

 This object resets the SIP registration count.

Command Syntax

> request addressContext <addressContext name> sipRegCountReset

Example

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

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

Back to Top

sipRegistrationAdaptiveNatLearning

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

Command Syntax

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

Command Parameters

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:

  • disable
  • reset

Example

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

> request addressContext default sipRegistrationAdaptiveNatLearning id 13 action disable

Back to Top

sipRegistrationDeleteById

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

Command Syntax

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

Command Parameters

sipRegistrationDeleteById request Parameters

Parameter

Description

sipRegistrationDeleteById

Delete SIP registration for the specified ID.

id

Registration ID of user. <id number>

The surrogate registration is not deleted by the following command.

Example

> request addressContext default sipRegistrationDeleteById id 13
result success

 

Back to Top

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

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

Command Parameters

sipRegistrationDeleteByIp request Parameters

Parameter

Description

sipRegistrationDeleteByIp

Delete SIP registration associated with the specified IP address.

ipAddress

IP address of the Registrar. <ip address>


The surrogate registration is not deleted by the following command.

Example

> request addressContext default sipRegistrationDeleteByIp ipAddress 10.20.128.13 
result success

Back to Top

sipSubCountReset

This object resets the SIP subscription count.

Command Syntax

> request addressContext <addressContext name> sipSubCountReset

Command Parameters

sipSubCountReset request Parameters

Parameter

Description

sipSubCountReset

Reset SIP subscription count.

Example

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

Back to Top

sipSubscriptionDelete

Command Syntax

> request addressContext <addressContext name> sipSubscriptionDelete <subcription id>

Command Parameters

sipSubscriptionDelete request Parameters

Parameter

Description

sipSubscriptionDelete

<id> Delete a SIP subscription.

Example

> request addressContext default sipSubscriptionDelete id 13

Back to Top

zone

See Request Address Context Zone - CLI for details.

 

Back to Top

  • No labels