SIP

Command

Details

SIP BUSY PEER <PEER_NAME>

Busies the designated peer. This is a courtesy busy out. Existing calls are allowed to complete normally, but new calls are blocked. When a courtesy busy out is used, the number of active calls is displayed. When all calls are completed, the state of the link changes to MAN BUSY.

<PEER_NAME> The peer name is the "Name" from  the Network Elements form, and the name is case sensitive.

Example:

sip busy peer SoftSw2A

SIP BUSY ( COURTESY ) PEER SoftSw2A succeeded.

Link state changes from IDLE to MAN BUSY.

SIP BUSY FORCE PEER <PEER_NAME>

Forces busy on the designed peer name. The calls in progress are dropped.

SIP RTS PEER <PEER_NAME>

Returns the busied peer to service.

Example:

sip rts peer SoftSw2A

SIP RTS PEER SoftSw2A succeeded.

Link state changes from MAN BUSY to IDLE.

SIP LINK STATE PEER <PEER_NAME>

Displays the link state for the selected peer name.

The state can be one of:

"IDLE" - Initial state; no calls have been made on the link.

"IN SERVICE" - The link is in service.

"OUT OF SERVICE" - A temporary or permanent network outage/error was detected on the link.

"VALIDATING" - A new call is being attempted and is bringing the link from OUT OF SERVICE to IN SERVICE, if possible.

"MAN BUSY PENDING" - The link is being busied out, and no new calls can be made. One or more existing calls are still up.

"MAN BUSY" - The link is busied.

"UNKNOWN" - Unexpected error on the system.

SIP LINK STATE ALL

Displays the link state for all peers.

Example:

sip link state all

There are 2 SIP link(s) programmed.

Peer         41 state is      IN SERVICE.

Peer   SoftSw2A state is            IDLE.

SIP LINK STATUS

Displays the number of established links and non-established links.

SIP SHOW ACTIVE ALL

Displays a summary of all the active calls.

SIP SHOW ACTIVE PEER <PEER_NAME>

Displays an active call for the selected peer name.

SIP SHOW ACTIVE PROFILE <PROFILE_NAME>

Displays active calls for a specific profile name.

SIP SNMP COMMON STATS SUMMARY

Displays a summary of common statistics.

SIP SNMP OTHER COMMON STATS

Displays other common statistics.

SIP SNMP STATS METHOD <METHOD_NAME>

Displays the total number of incoming and outgoing requests for a particular method.

Method names:

INVITE, ACK, CANCEL, BYE, INFO, UPDATE, PRACK, OPTIONS, REGISTER, SUBSCRIBE, NOTIFY, REFER

SIP SNMP TIMERS CONFIGURATION

Displays the values for the configured timers.

SIP SNMP COMMON CONFIGURATION

Displays values for the common configuration.

SIP SNMP PORT CONFIGURATION

Displays the list of ports and transport types being used by the SIP module.

SIP SNMP SUPPORTED METHODS

Displays the list of all supported SIP methods.

SIP STATS PROFILE <PROFILE_NAME>

Displays statistics data for a specific profile name, including the number of active calls, rejected calls, incoming and outgoing non-authorized calls, incoming and outgoing authorized calls, incoming and outgoing authorized failures.

SIP STATS ALL

Displays statistics data for all SIP links in the system, including the number of active calls, rejected calls, incoming and outgoing non-authorized calls, incoming and outgoing authorized calls, incoming and outgoing authorized failures.

SIP REGISTRAR CONFIG

Displays configuration data for the Registrar:

Domain name-  the user name and IP address.

Authentication - whether Authentication is enabled.

Third Party Registrations - whether third-party registrations are allowed.

Default Expiry - the default time interval for registrations to be active.

Minimum Configurable Expiry Duration - the minimum  expiry duration that may be requested by a User Agent for a particular contact.

Maximum Configurable Expiry Duration - the maximum expiry duration.

Registrar Configuration

-----------------------

Domain:  mycompany.com IP Address 10.37.105.20

Authentication Enabled:               yes

Allow Third Party Registrations:      yes

Default Expiry Duration:              3600 seconds

Minimum Configurable Expiry Duration: 300 seconds

Maximum Configurable Expiry Duration: 7200 seconds

SIP REGISTRAR STATS

Displays the following statistics data:
 

Current - the current number registered.

Accepted -  the number of registrations that have been accepted.  

Refreshed - the number of times registrations have been refreshed.  

Total failures - the total number of registration failures.  

Rejected registrations - number of rejected registrations caused by some system or messaging error, and not specifically by one of the other categories.  

Failure responses - the failure response with the associated SIP failure message (e.g., 400 bad request is a SIP error message).
 

Registrar Statistics

--------------------

Current:           3

Accepted:          3

Refreshed:         2

Total Failed:      0

  (Rejected        0)

  (400 Bad Request 0)

  (403 Forbidden   0)

  (404 Not Found   0)

  (423 Min Expires 0) 

SIP REGISTRAR CONTACTS <USER_NAME>

Displays the same information as SIP REGISTRAR CONTACTS ALL, except displays only those entries that have the user_name in the Addr:  For example, if 40500 is the contact name, the following is displayed:

Registrar Entry(s)

--------------------

3 (0xa3cda40) State:Registered Addr:sip:40500@10.37.105.20

 Contact1:  sip:40500@10.37.102.44

   Time Left:201 Expires:400 Priority:0 Port:506 Scheme:1 

SIP REGISTRAR CONTACTS ALL

Displays the following for all users:
 

First number -  local identifier followed by an address in brackets.  

State - either registered or pending.

Address -  the address that was registered and each contact registered is printed.  

(All these examples only list a single contact.)  

Time left  -  the time before expiry.  

Expires - the expiry time is the total time negotiated.  Priority -  the contact's priority.

Port -  the registered port.

Registrar Entry(s)

--------------------

3 (0xa3cda40) State:Registered Addr:sip:40500@10.37.105.20

   Contact1:  sip:40500@10.37.102.44

      Time Left:287 Expires:400 Priority:0 Port:5060

2 (0xa3be408) State:Registered Addr:sip:40501@10.37.105.20

   Contact1:  sip:40501@10.37.102.43

      Time Left:280 Expires:400 Priority:0 Port:5060

1 (0xa3be3e0) State:Registered Addr:sip:40503@10.37.105.20

   Contact1:  sip:40503@10.37.102.42:5060

      Time Left:3208 Expires:3600 Priority:0 Port:5060 

SIP MWI STATS

Displays the following information:
 

Current -  the number of current MWI subscriptions.  In the following example, three phones are registered, and two are also subscribed for MWI.  

Successful - the number of successful subscriptions.

Failed - the number of failures.
 

MWI Subscription Statistics

--------------

Current:           2 (out of 3 Registrations)

Successful:       6

Failed:              2

SIP MWI STATS CLEAR

Clears the number of successful and failed registrations. The following message is displayed:
 

"MWI Subscription Statistics Cleared" 

SIP MWI SUBSCRIBER INFO ALL

Displays the following information about the current state of MWI for all endpoints:

State - MWI state of the subscribers.

SIP URIs  - SIP URIs for the endpoints.

Time left - amount of time (in seconds) left in the subscriptions.

Expires  - the currently negotiated expiry time for this phone.

In the example below, the first entry shows the MWI lamp is OFF, and in the second entry, it's ON.  The phone's address is printed along with the time left before the subscription expires.  
 

MWI Entry(s)

------------

OFF sip:40500@10.37.105.20

      Time Left:96 Expires:400

ON  sip:40501@10.37.105.20

      Time Left:288 Expires:400 

SIP MWI SUBSCRIBER INFO <USER_NAME>

Displays the same information as SIP MWI SUBSCRIBER INFO ALL for a particular user, except the command uses a string to search for entries that match.  For example, using 40500 as the contact name, it displays only the first entry.  Using 405 displays both entries below.
 

MWI Entry(s)

------------

OFF sip:40500@10.37.105.20

      Time Left:96 Expires:400

ON  sip:40501@10.37.105.20

      Time Left:288 Expires:400

SIP URI TRANS DEBUGON

Turns on debug tracing to display URI/Number translations on a per call basis.

SIP URI TRANS DEBUGOFF

Turns off debug.

SIP URI TRANS LIST

Displays an unsorted list of all URI/Number entries in the translation table.

SIP URI TRANS SORTURI

Displays a sorted list (by URI) of all URI/Number entries in the translation table.

SIP URI TRANS SORTNUM

Displays a sorted list (by number) of all URI/Number entries in the translation table.