Use the following commands to retrieve status and statistics related to SIP registrations.
SIP Active Group Registration Status
Active SIP group registration status for a list of SIP endpoints.
Command Syntax
| Code Block |
|---|
|
> show table addressContext <addressContext_name> sipActiveGroupRegStatus <id>
aorName | contactURI | creationTime | extExpirationTime | intExpirationTime | nextHopIpAddress | nextHopPortNum | regIdIsChild | registrarDomainName | registrarIpAddress | registrarPortNum | state |
| Multiexcerpt |
|---|
| MultiExcerptName | SIPActiveGroupRegistrationStatus |
|---|
|
Command Parameters| Caption |
|---|
| 0 | Table |
|---|
| 1 | SIP Active Group Registration Status Parameters |
|---|
| 3 | SIP Active Group Registration Status Parameters |
|---|
| | Parameter | Description |
|---|
aorName | The E.164 number and host portion plus optional BGID representing the Address of Record of the registering endpoint. | contactURI | The SIP CONTACT URI header. | creationTime | Octet string that identifies the date and GMT time at which the SIP registration is initiated. | extExpirationTime | The external expiration timer value in seconds. | intExpirationTime | The internal expiration timer value in seconds. | nextHopIpAddress | Next hop TSAP IP address. | nextHopPortNum | Next hop TSAP UDP port number. | regIdIsChild | Flag to optionally display results where the specified next registration ID is a child. | registrarDomainName | SIP registrar's domain name. | registrarIpAddress | SIP registrar's IP address. | registrarPortNum | SIP registrar's UDP port number. | regType | This field indicates the type of registrations. The registration type can be 'normal' or 'emergency'. | state
| The registration state of the endpoint: <challenged | completed | deleting | expired | initiating | null | refreshing | terminated | updating> See Registration State Descriptions table below. |
|
|
SIP Active Group Registration Summary Status
The active SIP group registration summary for a list of SIP endpoints.
Command Syntax
| Code Block |
|---|
|
> show table addressContext <addressContext_name> sipActiveGroupRegSummaryStatus |
| Multiexcerpt |
|---|
| MultiExcerptName | SIPActiveGroupRegistrationSummaryStatus |
|---|
|
Command Parameters| Caption |
|---|
| 0 | Table |
|---|
| 1 | SIP Active Group Registration Summary Status Parameters |
|---|
| 3 | SIP Active Group Registration Summary Status Parameters |
|---|
| | Parameter | Description |
|---|
aorName | The E.164 number and host portion plus optional BGID representing the Address of Record of the registering endpoint. | nextRegId | The next registration ID. | nextRegIdIsChild | Displays the next registration ID if it is a child. | registrarIpAddress | Registrar IP address. | registrationType | Registration type. The registration type can be 'normal' or 'emergency'. | state
| The registration state of the endpoint: <challenged | completed | deleting | expired | initiating | null | refreshing | terminated | updating> See Registration State Descriptions table below. |
|
|
SIP Active Register Name Status
The active SIP registration name status for a list of SIP endpoints.
Command Syntax
| Code Block |
|---|
|
> show table addressContext <addressContext_name> sipActiveRegisterNameStatus <name> |
| Multiexcerpt |
|---|
| MultiExcerptName | SIPActiveRegisterNameStatus |
|---|
|
Command Parameters| Caption |
|---|
| 0 | Table |
|---|
| 1 | SIP Active Register Name Status Parameters |
|---|
| 3 | SIP Active Register Name Status Parameters |
|---|
| | Parameter | Description |
|---|
name | AoR name. | contactURI | SIP CONTACT URI header. | creationTime | Octet string identifying date and GMT time at which the SIP registration is initiated. | destinationTrunkName | Name of the destination trunk group. | e2aeMediaSecurity | Media-security status of the UE in the registration record <sdes-srtp or none>. If set to sdes-srtp, UE has e2ae (end-to-access edge) capability. | endPointBehindNapt | If value is“1”, the registered endpoint is behind NAPT; otherwise, value is “0”. | externalExpirationTime | The time left, in seconds, before registration expires towards the end point. | internalExpirationTime | The time left, in seconds, before registration expires towards the AS. | isRoaming | A value of "1" indicates registered UE is roaming (not on home network). Otherwise, value is "0". | mobileCountryCode | Mobile Country Code of the UE's current location. | mobileNetworkCode | Mobile Network Code of the UE's current location. | natPinholeLearningStatus | NAT pinhole learning process status. <aborted-due-to-traffic | completed | completed-due-to-timeout | disabled | none | progressing> | nextHopIpAddress | Next hop Transport Service Access Point (TSAP) IP address. | nextHopPortNum | Next hop TSAP UDP port number. | registrarDomainName | The SIP registrar's domain name. | registrarIpAddress | SIP Registrar's IP Address. | registrarPortNum | SIP Registrar's UDP port number. | regType | This field indicates the type of registrations. The registration type can be 'normal' or 'emergency'. | securityMechanismType | The security mechanism type used for this registration. <ipsec-3gpp | none | tls> | state | The registration state of the endpoint: <challenged | completed | deleting | initiating | null | refreshing | terminated | updating> See Registration State Descriptions table below. | transportProtocolToAS | The transport protocol used on access toward AS. | transportProtocolToEndpoint | The transport protocol used on access towards the endpoint. | ueRoamingType | 0 – Home User
1 – Ravel Roaming User
2 – S8HR User Roaming in Visited Network
3 – S8HR User Roaming in Home Network
| viaHeaderAddress
| The IP address of the bottom-most Via header of a SIP Message populated by the very first originator of the REGISTER request. |
|
| Caption |
|---|
| 0 | Table |
|---|
| 1 | Registration State Descriptions |
|---|
| 3 | RegStateDesc |
|---|
| | State | Description |
|---|
| challenged | 401 received from Registrar and relayed to UAC. | | completed | Successful response received from Registrar and relayed to UAC. | | deleting | Unregister received from UAC. | | initiating | Resister sent to Registrar and waiting for response. | null | Initial state, waiting for Route response. | | refreshing | Register Refresh request sent to Registrar and waiting for response. | | terminated | Failure other than 401 or no response from Registrar. | | updating | Modify request sent to Registrar and waiting for response. |
|
|
SIP Deleted Registration Status
The SIP registration status for a list of deleted SIP endpoints.
Command Syntax
| Code Block |
|---|
|
> show table addressContext <addressContext_name> sipDeletedRegStatus |
| Multiexcerpt |
|---|
| MultiExcerptName | SIPDeletedRegistrationStatus |
|---|
|
Command Parameters| Caption |
|---|
| 0 | Table |
|---|
| 1 | SIP Deleted Registration Status Parameters |
|---|
| 3 | SIP Deleted Registration Status Parameters |
|---|
| | Parameter | Description |
|---|
id | SIP endpoint ID | aorName | The E.164 number and host portion plus optional BGID representing the address Of Record of the registering endpoint. | contactURI | The SIP CONTACT URI header. | creationTime | Octet string that identifies the date and GMT time at which the SIP registration is initiated. | nextHopIpAddress | Next hop Transport Service Access Point (TSAP) IP address. | nextHopPortNum | Next hop TSAP UDP port number. | reasonCode | Registration termination reason. <configProblem | endpointInitiated | internalError | none | regTimerExpired | registrationMoved | registrationRejected | serviceUnavailable> | registrarDomainName | The SIP registrar's domain name. | registrarIpAddress | SIP registrar's IP address. | registrarPortNum | SIP registrar's UDP port number. | terminationTime
| Date and GMT time at which the SIP registration is terminated. |
|
|
SIP Deleted Register Name Status
The deleted SIP registered name for a list of SIP endpoints.
Command Syntax
| Code Block |
|---|
|
> show table addressContext <addressContext_name> sipDeletedRegisterNameStatus |
| Multiexcerpt |
|---|
| MultiExcerptName | SIPDeletedRegisterNameStatus |
|---|
|
Command Parameters| Caption |
|---|
| 0 | Table |
|---|
| 1 | SIP Deleted Register Name Status Parameters |
|---|
| 3 | SIP Deleted Register Name Status Parameters |
|---|
| | |
|---|
aorName | The E.164 number and host portion plus optional BGID representing the Address Of Record of the registered endpoint. | id | The registration ID created for the registration session. | reasonCode | The registration termination reason. | contactURI | The SIP CONTACT URI header. | nextHopIpAddress | Next hop IP address. | nextHopPortNum | Next hop TSAP UDP port number. | registrarIpAddress | Registrar's IP address. | registrarPortNum | SIP registrar's UDP port number. | creationTime | Octet string that identifies the date and GMT time at which the SIP registration is initiated. | terminationTime | Octet string that identifies the date and GMT time at which the SIP registration is terminated. | registrarDomainName | The SIP registrar's domain name. |
|
|
SIP Registration Count Domain Statistics
Displays the SIP registration statistics on a per domain basis. An address context must be specified and specifying a domain is optional. If a specific domain is not specified the command returns per-domain statistics for up to 256 domains. The command returns no data if there are no domain names found.
Command Syntax
| Code Block |
|---|
|
> show table addressContext <AC<addressContext_Name>name> sipRegCountDomainStats <DomainName>
countAttempts
countCumCompletions
countPending
countStable
countTotal
emergAcceptTotal
emergActiveTotal |
| Multiexcerpt |
|---|
| MultiExcerptName | sipRegCountDomainStats |
|---|
|
Command Parameters| Caption |
|---|
| 0 | Table |
|---|
| 1 | SIP Registration Count Domain Statistics Parameters |
|---|
| 3 | SIP Registration Count Domain Statistics Parameters |
|---|
| | Parameter | Description |
|---|
countAttempts | The number of SIP registration attempts. | countCumCompletions | The cumulative number of completed SIP registration attempts. | countPending | The current number of pending SIP registrations. | countStable | The current number of stable SIP registrations. | countTotal | The current total number of SIP registrations. | emergAcceptTotal | The total number of emergency SIP registrations accepted. | emergActiveTotal | The total number of emergency SIP registrations currently active. |
|
|
SIP Registration Count Domain Current Statistics
Displays the SIP registration current statistics on a per domain basis. You must specify an address context, but specifying a domain is optional. If you do not specify a domain, the command returns per-domain statistics for all domains within the address context. The command returns no data if the SBC does not find any domain names within the specified address context.
| Code Block |
|---|
> show table addressContext <addressContext_name> sipRegCountDomainCurStats <DomainName> |
| Multiexcerpt |
|---|
| MultiExcerptName | sipRegCountCurDomainStats |
|---|
|
Command Parameters| Caption |
|---|
| 0 | Table |
|---|
| 1 | SIP Registration Count Current Domain Statistics Parameters |
|---|
| 3 | SIP Registration Count Current Domain Statistics Parameters |
|---|
| | Parameter | Description |
|---|
domainName | The name of the domain to which the statistics apply. The domain name can be an IP address or FQDN. | countAttempts | The number of SIP registration attempts during the current interval. | countCumCompletions | The cumulative number of completed SIP registration attempts during the current interval. | countPending | The current number of pending SIP registrations during the current interval. | countStable | The current number of stable SIP registrations during the current interval. | countTotal | The current total number of SIP registrations during the current interval. | emergencyAcceptTotal | The total number of emergency SIP registrations accepted during the current interval. | emergencyActiveTotal | The total number of emergency SIP registrations currently active during the current interval. |
|
|
SIP Registration Count Domain Interval Statistics
Displays the SIP registration interval statistics on a per domain basis.You must specify an address context, but specifying a domain is optional. If you do not specify a domain, the command returns per-domain statistics for all domains within the address context. The command returns no data if the SBC does not find any domain names within the specified address context.
| Code Block |
|---|
> show table addressContext <addressContext_name> sipRegCountDomainIntStats <DomainName> |
| Multiexcerpt |
|---|
| MultiExcerptName | sipRegCountDomainStatssipRegCountIntDomainStats |
|---|
|
Command Parameters| Caption |
|---|
| 0 | Table |
|---|
| 1 | SIP Registration Count Interval Domain Statistics Parameters |
|---|
| 3 | SIP Registration Count Interval Domain Statistics Parameters |
|---|
| | Parameter | Description |
|---|
number | For interval statistics, a sequence number which identifies the interval to which the set of statistics apply. | domainName | The name of the domain to which the statistics apply. The domain name can be an IP address or FQDN. | intervalValid | For interval statistics, a value of "true" indicates that the the interval to which the set of statistics apply is valid. | time | For interval statistics, the system uptime when the interval was collected. | countAttempts | The number of SIP registration attempts during the interval. | countCumCompletions | The cumulative number of completed SIP registration attempts during the interval. | countPending | The current number of pending SIP registrations during the interval. | countStable | The current number of stable SIP registrations during the interval. | countTotal | The current total number of SIP registrations during the interval. | emergAcceptTotalemergencyAcceptTotal | The total number of emergency SIP registrations accepted during the interval. | emergActiveTotalemergencyActiveTotal | The total number of emergency SIP registrations currently active during the interval. |
|
|
SIP Registration Count Statistics
Displays the SIP registration count statistics for the SIP endpoints or node.
Command Syntax
| Code Block |
|---|
|
> show table addressContext <addressContext_name> sipRegCountStatistics
sipRegCountAttempts
sipRegCountCumCompletions
sipRegCountPending
sipRegCountStable
sipRegCountTotal |
| Multiexcerpt |
|---|
| MultiExcerptName | SIPRegistrationCountStatistics |
|---|
|
Command Parameters| Caption |
|---|
| 0 | Table |
|---|
| 1 | SIP Registration Count Statistics Parameters |
|---|
| 3 | SIP Registration Count Statistics Parameters |
|---|
| | Parameter | Description | subscription |
|---|
Name of the subscription. | sipEmergencyRegAcceptTotal | The total number of accepted emergency SIP registrations. | sipEmergencyRegActiveTotal | The total number of active emergency SIP registrations. | sipRegCountAttempts | Number of SIP registration attempts on the SBC. | sipRegCountCumCompletions | Accumulative number of completed SIP registration attempts. | sipRegCountPending | Current number of pending SIP registrations. | sipRegCountStable | Current number of stable SIP registrations. | sipRegCountTotal
| The total number of current SIP registrations. |
|
|