Cisco Unified Communications Manager Express Command Reference
Cisco Unified CME Commands: sast1 trustpoint through show fb-its-log

Table Of Contents

Cisco Unified CME Commands: sast1 trustpoint through show fb-its-log

sast1 trustpoint

sast2 trustpoint

sdspfarm conference mute-on mute-off

sdspfarm tag

sdspfarm transcode sessions

sdspfarm units

sdspfarm unregister force

secondary start

secondary-dialtone

secure-signaling trustpoint

security (ephone-type)

semi-attended enable (voice register template)

server (CTL-client)

server (presence)

server-security-mode

service-digit

service directed-pickup

service dnis dir-lookup

service dnis overlay

service-domain

service-domain (voice class)

service-domain midcall-mismatch

service dss

service local-directory

service phone

session-server

session-transport

shared-line

show capf-server

show credentials

show cti

show ctl-client

show ephone

show ephone attempted-registrations

show ephone cfa

show ephone dn

show ephone dnd

show ephone login

show ephone offhook

show ephone overlay

show ephone phone-load

show ephone registered

show ephone remote

show ephone ringing

show ephone socket

show ephone summary

show ephone tapiclients

show ephone telephone-number

show ephone unregistered

show ephone-dn

show ephone-dn callback

show ephone-dn conference

show ephone-dn loopback

show ephone-dn park

show ephone-dn statistics

show ephone-dn summary

show ephone-dn whisper

show ephone-hunt

show ephone-hunt statistics

show fb-its-log


Cisco Unified CME Commands: sast1 trustpoint through show fb-its-log


Revised: ONovember 3, 2009

.

This chapter contains commands to configure and maintain Cisco Unified Communications Manager Express (formally known as Cisco Unified CallManager Express). The commands are presented in alphabetical order. Some commands required for configuring Cisco Unified Communications Manager Express (Cisco Unified CME) may be found in other Cisco IOS references. Use the reference master index or search online to find these commands.

sast1 trustpoint

To specify the name of the SAST1 trustpoint, use the sast1 trustpoint command in CTL-client configuration mode. To return to the default, use the no form of this command.

sast1 trustpoint label

no sast1

Syntax Description

label

Name of the SAST1 trustpoint.


Command Default

No SAST1 trustpoint name is specified

Command Modes

CTL-client configuration (config-ctl-client)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(4)XC

Cisco Unified CME 4.0

This command was introduced.

12.4(9)T

Cisco Unified CME 4.0

This command was integrated into Cisco IOS Release 12.4(9)T.


Usage Guidelines

This command is used with Cisco Unified CME phone authentication.

The sast1 trustpoint and sast2 trustpoint commands are used to set up the System Administrator Security Token (SAST) credentials, which are used to sign the CTL file. The SAST1 and SAST2 certificates must be different from each other, but to conserve memory either one of them can use the same certificate as Cisco Unified CME. The CTL file is always signed by SAST1 credentials. The SAST2 credentials are included in the CTL file so that if the SAST1 certificate is compromised, the CTL file can be signed by SAST2 to prevent the phones from being reset to their factory defaults.

Examples

The following example names sast1tp as the SAST1 trustpoint.

Router(config)# ctl-client

Router(config-ctl-client)# server capf 10.2.2.2 trustpoint capftrust

Router(config-ctl-client)# server cme 10.2.2.3 trustpoint cmetp

Router(config-ctl-client)# server tftp 10.2.2.4 trustpoint tftptp

Router(config-ctl-client)# sast1 trustpoint sast1tp

Router(config-ctl-client)# sast2 trustpoint sast2tp

Router(config-ctl-client)# regenerate

 

Related Commands

 
Description

sast2 trustpoint

Specifies the name of the SAST2 trustpoint.


sast2 trustpoint

To specify the name of the SAST2 trustpoint, use the sast2 trustpoint command in CTL-client configuration mode. To return to the default, use the no form of this command.

sast2 trustpoint label

no sast2

Syntax Description

label

Name of the SAST2 trustpoint.


Command Default

No SAST2 trustpoint name is specified.

Command Modes

CTL-client configuration (config-ctl-client)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(4)XC

Cisco Unified CME 4.0

This command was introduced.

12.4(9)T

Cisco Unified CME 4.0

This command was integrated into Cisco IOS Release 12.4(9)T.


Usage Guidelines

This command is used with Cisco Unified CME phone authentication.

The sast1 trustpoint and sast2 trustpoint commands are used to set up the System Administrator Security Token (SAST) credentials, which are used to sign the CTL file. The SAST1 and SAST2 certificates must be different from each other, but to conserve memory either one of them can use the same certificate as Cisco CME. The CTL file is always signed by SAST1 credentials. The SAST2 credentials are included in the CTL file so that if the SAST1 certificate is compromised, the CTL file can be signed by SAST2 to prevent the phones from being reset to their factory defaults.

Examples

The following example names sast2tp as the SAST2 trustpoint.

Router(config)# ctl-client

Router(config-ctl-client)# server capf 10.2.2.2 trustpoint capftrust

Router(config-ctl-client)# server cme 10.2.2.3 trustpoint cmetp

Router(config-ctl-client)# server tftp 10.2.2.4 trustpoint tftptp

Router(config-ctl-client)# sast1 trustpoint sast1tp

Router(config-ctl-client)# sast2 trustpoint sast2tp

Router(config-ctl-client)# regenerate

 

Related Commands

 
Description

sast1 trustpoint

Specifies the name of the SAST1 trustpoint.


sdspfarm conference mute-on mute-off

To define mute-on and mute-off DTMF digits for use during conferencing, use the sdspfarm conference mute-on mute-off command in telephony-service configuration mode. To disable the mute-on and mute-off digits, use the no form of this command.

sdspfarm conference mute-on mute-on-digits mute-off mute-off-digits

no sdspfarm conference mute-on mute-on-digits mute-off mute-off-digits

Syntax Description

mute-on mute-on-digits

Defines the buttons you press on your phone to mute during a conference. Maximum: 3 digits. Valid values are the numbers and symbols that appear on your telephone keypad: 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, *, and #.

mute-off mute-off-digits

Defines the buttons you press on your IP phone to unmute during a conference. Maximum: 3 digits. Valid values are the numbers and symbols that appear on your telephone keypad: 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, *, and #.


Command Default

No mute-on or mute-off digits are defined.

Command Modes

Telephony-service configuration (config-telephony)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(11)XJ2

Cisco Unified CME 4.1

This command was introduced.

12.4(15)T

Cisco Unified CME 4.1

This command was integrated into Cisco IOS Release 12.4(15)T.


Usage Guidelines

You must define mute-on and mute-off digits to mute or unmute your phone using the keypad during a conference. The mute-on digits and mute-off digits can be the same or different. You can mute and unmute your phone using the phone's mute button also. You must unmute the phone in the same way that you muted it, either with the keypad or the mute button.

Examples

The following example configures #5 as the buttons to press to mute and unmute the phone during a conference:

Router(config-telephony)# sdspfarm conference mute-on #5 mute-off #5

 

sdspfarm tag

To permit a digital-signal-processor (DSP) farm to be to registered to Cisco Unified CME and associate it with a Skinny Client Control Protocol (SCCP) client interface's MAC address, use the sdspfarm tag command in telephony-service configuration mode. To delete a tag generated by the sdspfarm tag command, use the no form of this command.

sdspfarm tag number device-name

no sdspfarm tag number device-name

Syntax Description

number

Numeric name for a DSP farm. Number from 1 to 5.

device-name

MAC address of the SCCP client interface that is preceded by the Message Transfer Part (MTP).


Command Default

DSP farm is not created.

Command Modes

Telephony-service configuration (config-telephony)

Command History

Cisco IOS Release
Cisco Product
Modification

12.3(11)T

Cisco CME 3.2

This command was introduced.


Usage Guidelines

DSP farms are sets of DSP resources used for conferencing and transcoding only. DSP farms do not include voice termination resources. Use the show interface command to find the MAC address of the SCCP client interface.

Examples

The following example declares tag 1 as the MAC address of mac000a.8aea.ca80. The show interface command is used to obtain the MAC address.

Router# show interface FastEthernet 0/0

.

.

.

FastEthernet0/0 is up, line protocol is up

Hardware is AmdFE, address is 000a.8aea.ca80 (bia 000a.8aea.ca80)

.

.

.

Router(config)# telephony-service

Router(config-telephony)# sdspfarm tag 1 mac000a.8aea.ca80

 

Related Commands

 
Description

sdspfarm transcode

Specifies the maximum number of transcoding sessions allowed per Cisco CME router.

sdspfarm units

Specifies the maximum number of DSP farms that are allowed to be registered to the SCCP server.


sdspfarm transcode sessions

To specify the maximum number of transcoding sessions allowed per Cisco CallManager Express (Cisco CME) router, use the sdspfarm transcode sessions command in telephony-service configuration mode. To return to the default transcode session of 0, use the no form of this command.

sdspfarm transcode sessions number

no sdspfarm transcode sessions number

Syntax Description

number

Declares the number of DSP farm sessions. Valid values are numbers from 1 to 128.


Command Default

The default is 0.

Command Modes

Telephony-service configuration (config-telephony)

Command History

Cisco IOS Release
Cisco Product
Modification

12.3(11)T

Cisco CME 3.2

This command was introduced.


Usage Guidelines

The transcoding is allowed between G.711 and G.729. A session consists of two transcode streams. To configure this information, you must know how many digital-signal-processor (DSP) farms are configured on the network module (NM) farms in your Cisco CME router. DSP farms are sets of DSP resources used for conferencing and transcoding only. DSP farms do not include voice termination resources. To learn how many DSP farms have been configured on your Cisco CME router, use the show sdspfarm command.

Examples

The following example sets the maximum number of transcoding sessions allowed on the Cisco CME router to 20:

Router(config)# telephony-service

Router(config-telephony)# sdspfarm transcode sessions 20

 

Related Commands

 
Description

sdspfarm tag

Declares a DSP farm and associates it with an SCCP client interface's MAC address.

sdspfarm unit

Specifies the maximum number of DSP farms that are allowed to be registered to the SCCP server.

show sdspfarm

Displays the status of the configured DSP farms and transcoding streams.


sdspfarm units

To specify the maximum number of digital-signal-processor (DSP) farms that are allowed to be registered to the Skinny Client Control Protocol (SCCP) server, use the sdspfarm units command in telephony-service configuration mode. To set the number of DSP farms to the default value of 0, use the no form of this command.

sdspfarm units number

no sdspfarm units number

Syntax Description

number

Declares the number of DSP farms. Valid values are numbers from 0 to 5.


Command History

The default number is 0.

Command Modes

Telephony-service configuration

Command History

Cisco IOS Release
Cisco Product
Modification

12.3(11)T

Cisco CME 3.2

This command was introduced.


Usage Guidelines

DSP farms are sets of DSP resources used for conferencing and transcoding only. DSP farms do not include voice termination resources.

Examples

The following example configures a Cisco CME router to register one DSP farm:

Router(config)# telephony-service

Router(config-telephony)# sdspfarm units 1

 

Related Commands

 
Description

sdspfarm tag

Declares a DSP farm and associates it with an SCCP client interface's MAC address.

sdspfarm transcode

Specifies the maximum number of transcoding sessions allowed per Cisco CME router.


sdspfarm unregister force

To remove all transcoding streams associated with active calls, use the sdspfarm unregister force command in telephony-service configuration mode. To deactivate the removal of transcoding streams, use the no form of this command.

sdspfarm unregister force

no sdspfarm unregister force

Syntax Description

This command has no arguments or keywords.

Command Default

The default is transcoding streams are not removed.

Command Modes

Telephony-service configuration (config-telephony)

Command History

Cisco IOS Release
Cisco product
Modification

12.3(11)T

Cisco CME 3.2

This command was introduced.


Usage Guidelines

If any of the SCCP server's associated streams are functioning in active calls, the default response for the sdspfarm unregister force command is to reject them. If no stream is used in a call, all of the transcoding streams associated with the DSP farm will be released, and SCCP server can recycle those streams for other DSP farms.

Examples

The following example removes all transcoding streams for active calls.

Router(config)# telephony-service

Router(config-telephony)# sdspfarm unregister force

 

Related Commands

 
Description

sdspfarm tag

Declares a DSP farm and associates it with an SCCP client interface's MAC address.

sdspfarm unit

Specifies the maximum number of DSP farms that are allowed to be registered to the SCCP server.

show sdspfarm

Displays the status of the configured DSP farms and transcoding streams.


secondary start

To specify the ephone hunt group agent to receive parked calls that are forwarded to the secondary pilot number, use the secondary start command in ephone-hunt configuration mode. To disable this setting, use the no form of this command.

secondary start [current | next | list-position]

no secondary start [current | next | list-position]

Syntax Description

current

The ephone-dn that parked this call.

next

The ephone-dn that follows the parking ephone-dn in the list specified by the list command.

list-position

The ephone-dn at the specified position in the list specified by the list command. Range is from 1 to 20.


Command Default

No hunt-group agent is specified for receiving parked calls that are forwarded to the secondary pilot number.

Command Modes

Ephone-hunt configuration (config-ephone)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(4)XC

Cisco Unified CME 4.0

This command was introduced.

12.4(9)T

Cisco Unified CME 4.0

This command was integrated into Cisco IOS Release 12.4(9)T.


Usage Guidelines

When a call that has been parked by a hunt group agent meets either of these conditions, the hunt group agent to receive the call can be specified with the secondary start command:

The call is recalled from call park to the hunt group secondary pilot number.

The call is transferred from call park to an ephone-dn that forwards the call to the hunt group secondary pilot number.

Examples

The following example specifies that the third hunt group member (3031) will receive calls that are recalled or forwarded to the secondary group hunt pilot number (3001) after the calls have been parked by an ephone-dn.

ephone-hunt 17 sequential

pilot 3000 secondary 3001

list 3011, 3021, 3031

timeout 10

final 7600

secondary start 3

 

Related Commands

 
Description

ephone-hunt

Defines an ephone hunt group and enters ephone-hunt configuration mode.

list

Creates a list of extensions that are members of an ephone hunt group


secondary-dialtone

To activate a secondary dial tone when a Cisco IP phone user dials a defined public switched telephone network (PSTN) access prefix, use the secondary-dialtone command in telephony-service configuration mode. To disable the secondary dial tone, use the no form of this command.

secondary-dialtone digit-string

no secondary-dialtone

Syntax Description

digit-string

String of up to 32 numbers that defines an access prefix.


Command Default

No secondary dial tone is enabled.

Command Modes

Telephony-service configuration (config-ephone)

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(15)ZJ

Cisco CME 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.


Usage Guidelines

The secondary dial tone is turned off when the next number after the access prefix is pressed. For example, if 8 is the access prefix and a person dials 8 555-0145, the secondary dial tone is turned off when the digit 5 is pressed.

Examples

The following example enables a secondary dial tone when a Cisco IP phone users press the digit 9 to get an outside line:

Router(config)# telephony-service

Router(config-telephony)# secondary-dialtone 9

 

Related Commands

 
Description

telephony-service

Enters telephony-service configuration mode.


secure-signaling trustpoint

To specify the name of the PKI trustpoint with the certificate to use for TLS handshakes with IP phones on TCP port 2443, use the secure-signaling trustpoint command in telephony-service configuration mode. To return to the default, use the no form of this command.

secure-signaling trustpoint label

no secure-signaling trustpoint

Syntax Description

label

Name of a configured PKI trustpoint with a valid certificate.


Command Default

No trustpoint is specified.

Command Modes

Telephony-service configuration (config-telephony)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(4)XC

Cisco Unified CME 4.0

This command was introduced.

12.4(9)T

Cisco Unified CME 4.0

This command was integrated into Cisco IOS Release 12.4(9)T.


Usage Guidelines

This command is used with Cisco Unified CME phone authentication to name the trustpoint that enables handshaking between Cisco Unified CME and a phone to ensure secure SCCP signaling on TCP port 2443.

Examples

The following example names server25, the CAPF server, as the trustpoint to enable secure SCCP signaling:

Router(config)# telephony-service

Router(config-telephony)# device-security-mode authenticated

Router(config-telephony)# secure-signaling trustpoint server25

Router(config-telephony)# tftp-server-credentials trustpoint server12

Router(config-telephony)# load-cfg-file slot0:Ringlist.xml alias Ringlist.xml sign create

Router(config-telephony)# exit

 

security (ephone-type)

To define whether a phone type supports security features, use the security command in ephone-type configuration mode. To disable security support, use the no form of this command.

security

no security

Syntax Description

This command has no arguments or keywords.

Command Default

Enabled (phone type supports security features).

Command Modes

Ephone-type configuration (config-ephone-type)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(15)XZ

Cisco Unified CME 4.3
Cisco Unified SRST 4.3

This command was introduced.

12.4(20)T

Cisco Unified CME 7.0
Cisco Unified SRST 7.0

This command was integrated into Cisco IOS Release 12.4(20)T.


Usage Guidelines

This command specifies whether security features are supported by the type of phone being added with a phone-type template.

Examples

The following example shows that support for security is disabled for the Nokia E61 when creating the ephone-type template:

Router(config)# ephone-type E61

Router(config-ephone-type)# no security

Related Commands

Command
Description

device-id

Specifies the device ID for a phone type.

type

Assigns a phone type to an SCCP phone.


semi-attended enable (voice register template)

To enable call transfer at the alert call stage for supported SIP phones in Cisco Unified CME, use the semi-attended enable command in the voice register template mode. To disable call transfer, use the no form of this command.

semi-attended enable

no semi-attended enable

Syntax Description

This command has no arguments or keywords.

Command Default

Call transfer at the alert call stage is enabled.

Command Modes

Voice register template (config-register-temp)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(4)T

Cisco CME 3.4

This command was introduced.


Usage Guidelines

This command enables a call transfer at the alert stage in the specified template which can then be applied to SIP phones in Cisco Unified CME. Semi-attended call transfer is enabled by default. To disable semi-attended call transfer, use the no semi-attended command.

To apply the template to a SIP phone, use the template command in voice register pool configuration mode.

Examples

The following partial output from the show-running config command shows that the semi-attended call transfer is disabled in voice register template 1:

Router# show running-config

!

.

.

.

!

voice register template 1

 no semi-attended enabled

!

 

The following example shows how to enable semi-attended call transfer in a template:

Router(config)# voice register template 1

Router(config-register-temp)# semi-attend enable

 

Related Commands

 
Description

template (voice register pool)

Applies template to SIP IP phone being configured.


server (CTL-client)

To enter trustpoint information for the CAPF server, Cisco Unified CME router, or TFTP server into the router configuration, use the server command in CTL-client configuration mode. To return to the default, use the no form of this command.

server {capf | cme | cme-tftp | tftp} ip-address trustpoint label

no server {capf | cme | cme-tftp | tftp} ip-address

Syntax Description

capf

CAPF server.

cme

Cisco Unified CME router.

cme-tftp

Combined Cisco Unified CME router and TFTP server.

tftp

TFTP server.

ip-address

IP address of the entity.

trustpoint label

Name of the PKI trustpoint for the entity.


Command Default

Trustpoint information about the CAPF server, Cisco Unified CME router, or TFTP server is not present in the security configuration.

Command Modes

CTL-client configuration (config-ctl-client)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(4)XC

Cisco Unified CME 4.0

This command was introduced.

12.4(9)T

Cisco Unified CME 4.0

This command was integrated into Cisco IOS Release 12.4(9)T.


Usage Guidelines

This command is used with Cisco Unified CME phone authentication. Cisco IOS software stores credential information in a trustpoint. The trustpoint label in this command names the specified PKI trustpoint.


Note Repeat this command for each entity that requires a trustpoint.


Examples

The following example defines trustpoint names and IP addresses for the CAPF server, the Cisco Unified CME router, and the TFTP server:

Router(config)# ctl-client

Router(config-ctl-client)# server capf 10.2.2.2 trustpoint capftrust

Router(config-ctl-client)# server cme 10.2.2.3 trustpoint cmetp

Router(config-ctl-client)# server tftp 10.2.2.4 trustpoint tftptp

Router(config-ctl-client)# sast1 trustpoint sast1tp

Router(config-ctl-client)# sast2 trustpoint sast2tp

Router(config-ctl-client)# regenerate

 

server (presence)

To specify the IP address of a presence server for sending presence requests from internal watchers to external presence entities, use the server command in presence configuration mode. To remove the server, use the no form of this command.

server ip-address

no server

Syntax Description

ip-address

IP address of the remote presence server.


Command Default

A remote presence server is not used.

Command Modes

Presence configuration (config-presence)

Command History

Release
Modification

12.4(11)XJ

This command was introduced.

12.4(15)T

This command was integrated into Cisco IOS Release 12.4(15)T.


Usage Guidelines

This command specifies the IP address of a presence server that handles presence requests when the watcher and presence entity (presentity) are not collocated. The router acts as the presence server and processes all presence requests and status notifications when a watcher and presentity are both internal. If a subscription request is for an external presentity, the request is sent to the remote server specified by this command.

Examples

The following example shows a presence server with IP address 10.10.10.1:

Router(config)# presence

Router(config-presence)# allow subscribe

Router(config-presence)# server 10.10.10.1

 

Related Commands

 
Description

allow subscribe

Allows internal watchers to monitor external presence entities (directory numbers).

allow watch

Allows a directory number on a phone registered to Cisco Unified CME to be watched in a presence service.

max-subscription

Sets the maximum number of concurrent watch sessions that are allowed.

show presence global

Displays configuration information about the presence service.

show presence subscription

Displays information about active presence subscriptions.

watcher all

Allows external watchers to monitor internal presence entities (directory numbers).


server-security-mode

To change the security mode of the Cisco Unified CME phone authentication server, use the server-security-mode command in telephony-service configuration mode. To change the mode from secure to nonsecure, use the no form of this command.

server-security-mode {erase | non-secure | secure}

no server-security-mode

Syntax Description

erase

Deletes the certificate trust list (CTL) file.

non-secure

Enables nonsecure mode.

secure

Secure mode.


Command Default

When the CTL file is initially generated, the mode is set to secure.

Command Modes

Telephony-service configuration (config-telephony)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(4)XC

Cisco Unified CME 4.0

This command was introduced.

12.4(9)T

Cisco Unified CME 4.0

This command was integrated into Cisco IOS Release 12.4(9)T.

12.4(22)T

Cisco Unified CME 7.0

The erase keyword was added.


Usage Guidelines

This command is used with Cisco Unified CME phone authentication.

This command has no effect until the CTL file is initially generated by the CTL client. When the CTL file is successfully generated, the CTL client automatically sets the server security mode to secure. You can then toggle the mode from secure to nonsecure using this command.

After toggling between secure and non-secure mode, you must use the regenerate command in CTL-client configuration mode to generate the CTL file. This is necessary because if the security mode is nonsecure, its credentials are zeroed out in the CTL file. If the security mode is secure, the CTL file contains the server's credentials.

The no version of this command sets the mode to non-secure; it does not remove the command from your configuration.

To remove this command from your configuration and revert to the state before the Cisco Unified CME security feature was activated, use the erase keyword and follow the instructions displayed on the console. When you use this command with the erase keyword, the router checks whether the Cisco IOS CTL-provider process is running, and if not, it deletes the CTL file from router storage. After using this command to delete the CTL file, you must manually delete the CTL file from any SCCP phones that had downloaded it previously.

Examples

The following example changes the mode of the server to non-secure.

telephony-service

 server-security-mode non-secure

 

Related Commands

Command
Description

regenerate

Creates a new CTLFile.tlv file after changes are made to the CTL client configuration.


service-digit

To enable phone users to dial a service digit to request off-net services, use the service-digit command in voice MLPP configuration mode. To reset to the default, use the no form of this command.

service-digit

no service-digit

Syntax Description

This command has no arguments or keywords.

Command Default

Service digit is disabled.

Command Modes

Voice MLPP configuration (config-voice-mlpp)

Command History

Cisco IOS Release
Cisco Product
Modification

15.0(1)XA

Cisco Unified CME 8.0

This command was introduced.


Usage Guidelines

This command enables users to request off-net services by dialing a service digit, after dialing the MLPP access digit. The service digit provides information to the switch when connecting calls to government or public telephone services or networks that are not part of the Defense Switched Network (DSN).

Phone users request a service by dialing the access code NS, where N is the preconfigured MLPP access digit and S is the service digit. The service digit is a number from 5 to 9.

In Cisco Unified CME, the dial plan must be configured to play secondary dial-tone and the rest of the dialed digits are collected and passed to the off-net trunk. The digits that follow the prefix NS must be E.164 compliant.

Examples

The following example shows how to enable users to dial a service digit:

Router(config)# voice mlpp
Router(config-voice-mlpp)# service-digit

Related Commands

Command
Description

access-digit

Defines the access digit that phone users dial to request a precedence call.

mlpp preemption

Enables preemption capability on an SCCP phone or analog FXS port.


service directed-pickup

To enable Directed Call Pickup and modify the function of the GPickUp and PickUp soft keys, use the service directed-pickup command in telephony-service configuration mode. To disable Directed Call Pickup, use the no form of this command.

service directed-pickup [gpickup]

no service directed-pickup [gpickup]

Syntax Description

gpickup

(Optional) Enables phone users to perform Directed Call Pickup using the GPickUp soft key.


Command Default

For SCCP phones, Directed Call Pickup using the PickUp soft key is enabled.
For SIP phones, Directed Call Pickup is not enabled.

Command Modes

Telephony-service configuration (config-telephony)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(4)XC

Cisco Unified CME 4.0

This command was introduced.

12.4(9)T

Cisco Unified CME 4.0

This command was integrated into Cisco IOS Release 12.4(9)T.

12.4(22)YB

Cisco Unified CME 7.1

The gpickup keyword and support for SIP phones was added.

12.4(24)T

Cisco Unified CME 7.1

This command was integrated into Cisco IOS Release 12.4(24)T.


Usage Guidelines

This command modifies the function of the GPickUp and PickUp soft keys for the Directed Call Pickup and Local Group Pickup features.

To globally disable Directed Call Pickup on all phones, use the no form of this command. The no form of this command also changes the behavior of the PickUp soft key on IP phones so that a user pressing it invokes Local Group Pickup instead of Directed Call Pickup.

To selectively remove the PickUp soft key from one or more SCCP phones, use the features blocked command in ephone-template mode. The features blocked command removes the PickUp soft key from SCCP IP phones and blocks Directed Call Pickup on analog phones to which you apply the template.

Table 16 describes the use of the GPickUp and PickUp soft keys for each feature depending on the setting of this command.

Table 16 service directed-pickup Command Comparison

Cisco IOS Command Syntax
SCCP Phones
SIP Phones
service directed-pickup gpickup1

Directed Call Pickup
(Call on any ringing extension)

GPickUp soft key and extension

Local Group Pickup
(Call in same group)

GPickUp soft key and * or PickUp soft key

Other Group Pickup
(Call in different group)

GPickUp soft key and pickup group number

service directed-pickup (default)

Directed Call Pickup

PickUp soft key and extension

Local Group Pickup

GPickUp soft key and *

GPickUp soft key and *
or Pickup soft key

Other Group Pickup

GPickUp soft key and pickup group number

no service directed-pickup

Directed Call Pickup

Local Group Pickup

GPickUp soft key and * or PickUp soft key

Other Group Pickup

GPickUp soft key and pickup group number

1 Supported in Cisco Unified CME 7.1 and later versions.


Examples

The following example shows that Directed Call Pickup is disabled globally:

telephony-service

 no service directed-pickup

 

The following example shows that Directed Call Pickup, Group Pickup, and Local Group Pickup can be performed using the GPickUp soft key:

telephony-service

 service directed-pickup gpickup

Related Commands

Command
Description

call-feature-uri

Specifies the uniform resource identifier (URI) for soft keys on SIP phones registered to Cisco Unified CME.

features blocked

Prevents one or more features from being used on SCCP phones.

pickup-group

Assigns an extension to a call-pickup group.


service dnis dir-lookup

To allow the display of names associated with called numbers for incoming calls on IP phones, use the service dnis dir-lookup command in telephony-service configuration mode. To deactivate directory lookup, use the no form of this command.

service dnis dir-lookup

no service dnis dir-lookup

Command Default

The default is directory service lookup is inactive.

Command Modes

Telephony-service configuration (config-telephony)

Command History

Cisco IOS Release
Cisco Product
Modification

12.3(11)T

Cisco CME 3.2

This command was introduced.


Usage Guidelines

The service dnis dir-lookup command provides a called number to the name-lookup service to support display of the name associated with the called number for incoming calls to IP phones. The display name is obtained from the Cisco CME system's list of Cisco CME directory names created using the directory entry command in the telephony-service configuration mode.

Called numbers can be displayed for overlaid ephone-dn and for ephone-dns that are not overlaid. Secondary line are supported.

To allow a single ephone-dn to receive calls for multiple different called numbers (with different names), you must use wildcard "." characters in the number field for the ephone-dn.

To use the service dnis dir-lookup command in conjunction with the ephone-hunt, you can configure the ephone-hunt group to use a pilot number that contains wildcard "." characters. This command allows the ephone-hunt group to receive calls from different numbers. Individual ephone-dns that are configured as members of the hunt group with the ephone-hunt list must not have wildcard characters in their number fields.

If the service dnis dir-lookup is used at the same time as the service dnis overlay, the directory-lookup service takes precedence in resolving the name for the called number.

Examples

The following is an example of an overlaid ephone-dn configuration, where the service dnis dir-lookup allows one of three directory entry names to be displayed on three IP phones when a call is placed to a number declared in the directory entry command.

telephony-service

 service dnis dir-lookup


 directory entry 1 0001 name dept1

directory entry 2 0002 name dept2

directory entry 3 0003 name dept3


ephone-dn 1

number 0001

ephone-dn 2

number 0002


ephone-dn 2

number 0002


ephone 1

 button 1o1,2,3

ephone 2

 button 1o1,2,3

ephone 3

 button 1o1,2,3


The following is an example of an ephone-dn configuration in which the overlay function is not in use. There are three IP phones, each with two buttons. Button 1 receives calls from user1, user2, and user3; button 2 receives calls from user4, user5, and user6.

telephony-service

 service dnis dir-lookup


 directory entry 1 5550001 name user1

directory entry 2 5550002 name user2

directory entry 3 5550003 name user3


 directory entry 4 5550010 name user4

directory entry 5 5550011 name user5

directory entry 6 5550012 name user6


ephone-dn 1

number 555000.


ephone-dn 2

number 5552001.


ephone 1

 button 1:1

 button 2:2

 mac-address 1111.1111.1111


ephone 2

 button 1:1

 button 2:2

 mac-address 2222.2222.2222


The following is an example of a hunt-group configuration. There are three phones, each with two buttons, and each button is assigned two numbers. When a person calls 5550341, Cisco CME matches the hunt-group pilot secondary number (555....) and rings button 1 on one of the two phones and displays "user1." The selection of the phone is dependent on the ephone-hunt settings.

telephony-service

 service dnis dir-lookup

 max-redirect 20

 directory entry 1 5550341 name user1

directory entry 2 5550772 name user2

directory entry 3 5550263 name user3

 directory entry 4 5550150 name user4


ephone-dn 1

number 1001

ephone-dn 2

number 1002

ephone-dn 3

number 1003

ephone-dn 4

number 1004


ephone 1

 button 1o1,2

 button 2o3,4

 mac-address 1111.1111.1111


ephone 2

 button 1o1,2

 button 2o3,4

 mac-address 2222.2222.2222



ephone-hunt 1 peer

 pilot 1000 secondary 555....

 list 1001, 1002, 1003, 1004

 final 5556000

 hops 5

 preference 1

 timeout 20

 no-reg


The following is an example of a secondary-line configuration. Ephone-dn 1 can accept calls from extension 1001 and from 5550000, 5550001, and 5550002.

telephony-service

 service dnis dir-lookup


 directory entry 1 5550000 name doctor1

directory entry 2 5550001 name doctor2

directory entry 3 5550002 name doctor3


ephone-dn 1

 number 1001 secondary 555000.


ephone 1

 button 1:1

 mac-address 2222.2222.2222


Related Commands

 
Description

directory entry

Adds an entry to a local phone directory that can be displayed on IP phones.

ephone-hunt

Enters ephone-hunt configuration mode to create a hunt group for use in a Cisco CME system.

list

Creates a list of extensions that are members of a Cisco CME ephone hunt group.

service dnis overlay

Allows an ephone-dn name to appear on receiving IP phones' displays when the ephone-dn's number is called.


service dnis overlay

To allow incoming calls to an ephone-dn overlay to display called ephone-dn names, use the service dnis overlay command in telephony-service configuration mode. To deactivate the service dialed number identification service (DNIS) overlay, use the no form of this command.

service dnis overlay

no service dnis overlay

Defaults

The ephone-dn names in an ephone-dn overlay are not displayed on IP phones.

Command Modes

Telephony-service configuration (config-telephony)

Command History

Cisco IOS Release
Cisco CME Version
Modification

12.3(11)T

3.2

This command was introduced.


Usage Guidelines

The service dnis overlay allows phone users to determine which ephone-dn within an overlay set is being called. Up to ten ephone-dns are allowed per overlay set. When an incoming call is presented under a service dnis overlay configuration, the phone displays the name of the individual ephone-dn according to the name configured under the ephone-dn configuration mode. Note that for an ephone-dn name to be displayed on IP phones, you must first assign ephone-dn names with the name command in ephone-dn configuration mode.

The number of the first ephone-dn listed in the button is the default display for all phones using the same set of overlaid ephone-dns. Calls to the first ephone-dn display the caller ID. Calls to the remaining ephone-dns display ephone-dn names. For example, if there are three phones with one overlay set containing five ephone-dns, the first ephone-dn's number listed is the default display for all three phones. A call to the first ephone-dn displays the caller ID on all phones until the call is picked up. When the call is answered by phone 1, the displays in phone 2 and phone 3 return to the default display. Calls to the last four ephone-dns display ephone-dn names.

If the service dnis overlay is used at the same time as the service dnis dir-lookup, the service dnis dir-lookup takes precedence in determining the name to be displayed.

Examples

The following is an overlay configuration for two phones with button 1 assigned to pick up three 800 numbers from three ephone-dns that have been assigned names. The default display for button 1 is 18005550100. A call to 18005550100 displays the caller ID. Calls to 18005550001 and 18005550002 display "name1" and "name2," respectively.

telephony-service
 service dnis overlay

ephone-dn 1
 name mainnumber
 number 18005550100
ephone-dn 2
 name name1
 number 18005550001
ephone-dn 3
 name name2
 number 18005550002

ephone 1
 button 1o1,2,3
ephone 2
 button 1o1,2,3

Related Commands

 
Description

name

Associates a name with a Cisco CME extension (ephone-dn).

service dnis dir-lookup

Allows directory entry lookup for the display of directory entry names on IP phones.


service-domain

To set the global MLPP domain type and number, use the service-domain command in voice MLPP configuration mode. To reset to the default, use the no form of this command.

service-domain {drsn | dsn} identifier domain-number

no service-domain

Syntax Description

drsn

Defense Red Switched Network (DRSN).

dsn

Defense Switched Network (DSN). This is the default value.

domain-number

Number to identify the global domain, in three-octet format. Range: 0x000000 to 0xFFFFFF. Default: 0.


Command Default

Domain type is dsn; domain number is 0.

Command Modes

Voice MLPP configuration (config-voice-mlpp)

Command History

Cisco IOS Release
Cisco Product
Modification

15.0(1)XA

Cisco Unified CME 8.0

This command was introduced.


Usage Guidelines

This command sets the global domain type and number in Cisco Unified CME. Use the mlpp service-domain command to assign registered phones to different service domains. Any phone not configured with a specific service domain uses this global domain for MLPP calls.

Examples

The following example shows the global domain set to DSN with identifier 0010:

Router(config)# voice mlpp
Router(config-voice-mlpp)# service-domain dsn identifier 0010

Related Commands

Command
Description

mlpp service-domain

Sets the service domain and maximum precedence (priority) level for MLPP calls.

preemption trunkgroup

Enables preemption capabilities on a trunk group.

service-domain (voice class)

Sets the service domain name in the MLPP voice class.


service-domain (voice class)

To set the service domain name in the MLPP voice class, use the service-domain command in voice class configuration mode. To reset to the default, use the no form of this command.

service-domain {drsn | dsn}

no service-domain

Syntax Description

drsn

Defense Red Switched Network (DRSN).

dsn

Defense Switched Network (DSN).


Command Default

Domain name is dsn.

Command Modes

Voice class configuration (config-class)

Command History

Cisco IOS Release
Cisco Product
Modification

15.0(1)XA

Cisco Unified CME 8.0

This command was introduced.


Usage Guidelines

This command sets the domain name that is used for off-net MLPP calls.

After using this command, assign the voice class to an outbound POTS or VoIP dial peer by using the voice-class mlpp command.

Examples

The following example shows the domain name set to DSN:

Router(config)# voice class mlpp

Router(config-class)# service-domain dsn

Related Commands

Command
Description

mlpp service-domain

Sets the domain number and maximum precedence (priority) level for an MLPP call.

service-domain

Sets the global MLPP domain type and number.

voice-class mlpp

Assigns an MLPP voice class to a POTS or VoIP dial peer.


service-domain midcall-mismatch

To define the behavior when there is a domain mismatch between the two legs of a call, use the service-domain midcall-mismatch command in voice MLPP configuration mode. To reset to the default, use the no form of this command.

service-domain midcall-mismatch {method1 | method2 | method3 | method4}

no service-domain midcall-mismatch

Syntax Description

method1

Domain remains unchanged for each of the connections and the precedence level of the lower priority call changes to that of the higher priority call. This is the default value.

method2

Domain and precedence level of the lower priority call changes to that of the higher priority call.

method3

Domain remains unchanged for each of the connections and the precedence levels change to Routine for both calls.

method4

Domains change to that of the connection for which supplementary service was invoked (for example, transferee in case of transfer). Precedence levels change to Routine for both calls.


Command Default

The default is method1.

Command Modes

Voice MLPP configuration (config-voice-mlpp)

Command History

Cisco IOS Release
Cisco Product
Modification

15.0(1)XA

Cisco Unified CME 8.0

This command was introduced.


Usage Guidelines

This command determines the service domain and precedence level to apply in the case of a mismatch of these values between the two connections (call legs) of a call. This typically occurs when supplementary services such as Call Transfer or Conferencing are invoked during a call.

Examples

The following example shows the domain mismatch method set to 2:

Router(config)# voice mlpp
Router(config-voice-mlpp)# service-domain midcall-mismatch method2

Related Commands

Command
Description

mlpp service-domain

Sets the domain number and maximum precedence (priority) level for an MLPP call.

preemption trunkgroup

Enables preemption capabilities on a trunk group.

service-domain

Sets the default MLPP domain name and number.


service dss

To enable DSS (Direct Station Select) in a Cisco Unified CME system, use the service dss command in telephony-service configuration mode. To globally disable the DSS feature, use the no form of this command.

service dss

no service dss

Syntax Description

This command has no arguments or keywords.

Command Default

DSS service is disabled.

Command Modes

Telephony-service configuration (config-telephony)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(6)XE

Cisco Unified CME 4.0(2)

This command was introduced.

12.4(4)XC4

Cisco Unified CME 4.0(3)

This command was introduced.

12.4(11)T

Cisco Unified CME 4.0(3)

This command is integrated into Cisco IOS Release 12.4(11)T.


Usage Guidelines

This command enables phone users to quickly transfer calls to an extension selected by a speed-dial or monitor line button without having to press the Transfer button. If this command is enabled, a user can transfer a call when the call is in the connected state by simply pressing a speed-dial or monitor line button to select the transfer destination. The transfer action is automatically implied by CME if the service dss is enabled.

This feature is supported only on phones on which monitor-line buttons for speed dial or speed-dial line buttons are configured.

Using the no form of the changes the behavior of the speed-dial line button on all IP phones so that a user pressing a speed-dial button in the middle of a connected call will play out the speed-dial digits into the call without transferring the call. If the service dss is disabled, the phone user must press the Transfer button before pressing the speed-dial line button or monitor line button to transfer the call.

For Cisco Unified CME 4.0 and earlier, the transfer-system full-consult dss is used to select between blind transfers and consult transfers for the DSS case.

Examples

The following example globally enables directed call pickup.

telephony-service

 service dss

 

Related Commands

 
Description

button

Associates ephone-dns with individual buttons on a Cisco Unified IP phone and to specify line type, such as monitor mode for a shared line.

speed-dial

Defines a unique speed-dial identifier, a digit string to dial, and an optional label to display next to a line button.


service local-directory

To enable the availability of the local directory service on IP phones served by the Cisco CallManager Express (Cisco CME) router, use the service local-directory command in telephony service configuration mode. To disable the display, use the no form of this command.

service local-directory [authenticate]

no service local-directory [authenticate]

Syntax Description

authenticate

(Optional) Requires authentication for local directory search requests.


Command Default

Local directory service is available on IP Phones.

Command Modes

Telephony-service configuration (config-telephony)

Command History

Cisco IOS Release
Cisco Product
Modifications

12.2(11)YT

Cisco ITS 2.1

This command was introduced.

12.2(15)T

Cisco ITS 2.1

This command was integrated into Cisco IOS Release 12.2(15)T.

12.2(15)ZJ

Cisco CME 3.0

The authenticate keyword was introduced.

12.3(4)

Cisco CME 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.


Usage Guidelines

Use this command with Cisco IOS Telephony Services V2.1, Cisco CME 3.0, or a later version.

Examples

The following example specifies that the directory service should not be available on the IP phones served by this ITS router:

Router(config)# telephony-service

Router(config-telephony-service)# no service local-directory

 

Related Commands

 
Description

telephony-service

Enters telephony-service configuration mode.


service phone

To modify the vendorConfig parameters in the configuration file, use the service phone command in telephony-service or ephone-template configuration mode. To disable a setting, use the no form of this command.

service phone parameter-name parameter-value

no service phone parameter-name parameter-value

Syntax Description

parameter-name

Name of the vendorConfig parameter in the configuration file. For valid parameter names, see Table 17. Parameter names are word and case-sensitive and must be entered exactly as shown.

parameter-value

Value for the vendorConfig parameter. For valid values and defaults, see Table 17.


Command Default

The vendorConfig parameters in phone configuration files are set to default values.

Command Modes

Telephony-service configuration (config-telephony)
Ephone-template configuration (config-ephone-template)

Command History

Cisco IOS Release
Cisco Product
Modification

12.3(11)XL

Cisco CME 3.2.1

This command was introduced.

12.3(14)T

Cisco CME 3.3

This command was integrated into Cisco IOS Release 12.3(14)T.

12.4(4)XC

Cisco Unified CME 4.0

This command was made available in ephone-template configuration mode for certain parameters.

12.4(9)T

Cisco Unified CME 4.0

This command in ephone-template configuration mode was integrated into Cisco IOS Release 12.4(9)T.


Usage Guidelines

This command in telephony-service configuration mode modifies vendorConfig parameters in configuration file for phones in a Cisco Unified CME system.

The vendorConfig section of a configuration file is read by a phone's firmware when that Cisco Unified IP phone is booted. The number and type of parameters may vary from one firmware version to the next.

If a firmware version does not support a particular parameter, that parameter cannot be implemented. For example, Cisco phone firmware 8.2.1 or a later version is required to support the G.722-64K codec on G.722-capable SCCP phones and Cisco phone firmware 8.3.1 or a later version is required to support the G.722-64K codec on G.722-capable SIP phones. If your phones are loaded with an earlier version of phone firmware, they cannot support the G.722-64K codec regardless of how the g722CodecSupport parameter is configured.

The IP phone that downloads the configuration file will implement only those parameters that it can support and ignore configured parameters that it cannot implement. For example, a Cisco IP phone without a backlit display cannot implement backlight parameters regardless of how they are configured.

In Cisco Unified CME 4.0 and later versions, support for creating configuration files at a phone level was added for SCCP phones. This command in ephone-template configuration mode creates an template of vendorConfig parameters that can be applied to individual SCCP phones in Cisco Unified CME. This command in ephone-template configuration mode does not work for all vendorConfig parameters. See Table 17 for information about individual parameters.

In Cisco Unified CME 4.0 and later versions, if you use an ephone template to apply this command to one or more phones, you must also configure the cnf-file perphone command so that a separate configuration file is created for each phone, by MAC address. To apply this command in telephony-service mode to all phones of a particular type in Cisco Unified CME 4.0 and later versions, you can configure the cnf-file perphonetype command to specify that configuration files are generated by phone type.

To apply this command in telephony-service configuration mode to all phones in your Cisco Unified CME system, ensure that the system is configured for the default single per-system configuration file for all phones.

If you use an ephone template to apply this command to a phone and you also use this command in telephony-service configuration mode for the same phone, the value that you set in ephone-template configuration mode has priority.

After modifying the vendorConfig parameters, you must generate new configuration files.

After generating configuration files, reset or reboot the IP phone to be configured to download the new configuration file.

Use the show telephony-service tftp-binding command to view the SEP*.cnf.xml files that are associated with individual phones. The following example entry from a Sep*.conf.xml file disables the PC port on a phone:

<vendorConfig>
<pcPort>1</pcPort>
</vendorConfig>

Table 17 lists the basic vendorConfig parameters in alphabetical order.


Note Parameter names are word and case-sensitive and must be typed exactly as shown.

Table 17 vendorConfig Parameter-Name and Parameter-Value Descriptions 

Parameter Name and Value
Description

adminPassword password

(For the Cisco Unified IP Phone 7921G only) Creates a password for accessing the web interface on a phone.

password—String of up to 32 characters.

autoSelectLineEnable {0 | 1}

Enables and disables auto line selection.

0—Disabled.

1—Enabled (default).

backlightIdleTimeout HH:MM

Sets the length of time in hours and minutes after which the backlighting of the IP phone displays will switch off again once the phone is inactive.

This parameter is applicable only on the days specified using the daysBacklightNotActive parameter.

This parameter does not affect the display during the period of time specified using the backlightOnDuration parameter.

Hour (HH) and minute (MM). You must enter all four characters. For example, 9:05 a.m. must be entered as 09:05. Default is one hour (01:00).

backlightOnDuration HH:MM

Sets the length of time in hours and minutes for which IP phone displays will be backlit.

This parameter does not affect the display on the days specified using the daysBacklightNotActive parameter.

Hour (HH) and minute (MM). You must enter all four characters. For example, 9:05 a.m. must be entered as 09:05. Default is 10 hours (10:00).

backlightOnTime HH:MM

Sets the time of day at which backlighting of the IP phone displays is switched on, using a 24-hour time format.

This parameter does not affect the display on the days specified using the daysBacklightNotActive parameter.

Hour (HH) and minute (MM). You must enter all four characters. For example, 9:05 a.m. must be entered as 09:05. Default is 07:30.

daysBacklightNotActive number[,number...]

Sets the days of the week on which backlighting of the IP phone displays is switched off unless there is user interaction with the IP phone.

number—Represents the days of the week numerically, starting with Sunday (1) and ending with Saturday (7). Each number must be separated with a comma, without spaces: daysBacklightNotActive 1,2,3.

Default is no backlighting on Sun (1) and Sat (7).

daysDisplayNotActive number[,number...]

Sets the days of the week on which IP phone displays will be blank.

number—Represents the days of the week numerically, starting with Sunday (1) and ending with Saturday (7). Each number must be separated with a comma, without spaces: daysDisplayNotActive 1,2,3

Default is an inactive display on Sun (1) and Sat (7).

To disable this parameter so that IP phone displays are always active, configure this parameter in telephony-service configuration mode using a space plus a comma ( ,): daysDisplayNotActive , for the parameter-value.

Note This parameter is not supported in ephone-template configuration mode.

displayIdleTimeout HH:MM

Sets the length of time in hours and minutes for which IP phone displays will remain active, starting from the last time that the phone was used.

Hour (HH) and minute (MM). You must enter all four characters. For example, 9:05 a.m. must be entered as 09:05. Default is one hour (01:00).

Note This parameter is not supported in ephone-template configuration mode.

displayOnDuration HH:MM

Sets the length of time in hours and minutes for which IP phone displays will be active.

Hour (HH) and minute (MM). You must enter all four characters. For example, 9:05 a.m. must be entered as 09:05. Default is 10 hours (10:00).

Note This parameter is not supported in ephone-template configuration mode.

displayOnTime HH:MM

Sets the time of day at which IP phone displays are activated, using a 24-hour time format.

Hour (HH) and minute (MM). You must enter all four characters. For example, 9:05 a.m. must be entered as 09:05. Default is 07:30.

Note This parameter is not supported in ephone-template configuration mode.

displayOnWhenIncomingCall {0 | 1}

Enables and disables an IP phone display to be activated when an incoming call is received (Line state is Ring in). The display will switch off again once the ringing stops if the user has not touched the phone and if the phone display is supposed to be off.

0—Disabled (default).

1—Enabled.

Note This parameter is not supported in ephone-template configuration mode.

disableSpeaker {true | false}

Enables and disables the speakerphone.

true—Disabled.

false—Enabled (default).

disableSpeakerAndHeadset {true | false}

Enables and disables the speakerphone and headset.

true—Disabled.

false—Enabled (default).

enableGroupListen {true | false}

(For Cisco Unified IP Phone 7906 and 7911 only) Enables and disables Group Listen mode in which the handset and speaker are both active to allow multiple listeners to hear the conversation over the speaker while one user talks on the handset.

true—Enabled.

false—Disabled (default).

Note To support Group Listen, the speaker and headset must be enabled. See the diasableSpeakerandHeadset parameter for this command.

forwardingDelay {0 | 1}

Enables and disables the activation of the IP phone's PC Ethernet switch port when the IP phone boots to prevent Ethernet traffic from interfering with the bootup process.

0—Disabled.

1—Enabled (default).

garp {0 | 1}

Enables and disables IP phone response to gratuitous Address Resolution Protocol (ARP) messages from the IP phone's Ethernet interface.

0—Disabled.

1—Enabled (default).

g722CodecSupport {0 | 1 | 2}

Enables and disables the registration of the G.722 codec on the IP phone.

0—Phone default (default), equal to disabled or enabled and set by manufacturer.

1—Disabled. Disables G.722-64K2 codec on phone.

2—Enabled. Enables G.722-64K codec on phone.

handsetWidebandEnable {0 | 1 | 2}

Enables or disables wideband handset option on supported IP phones.

If the handsetWidebandUIControl parameter is set to Enable (2), the option set in the phone UI, by the phone user, has priority over the value set for this parameter.

0—Phone default (default), equal to disabled or enabled and set by manufacturer.

1—Disabled. Disables wideband headset on phone.

2—Enabled. Enables wideband handset on phone.

Wideband handset should only be used on supported IP phones with firmware version 8.3 or a later version.

handsetWidebandUIControl {0 | 1}

Enables or disables control of handset options by phone user.

0—Enabled (default). Allows phone user to select either narrowband or wideband handset in the phone UI.

1—Disabled.

headsetWidebandEnable {0 | 1}

Enables or disables wideband headset option on supported IP phones.

If the headsetWidebandUIControl parameter is set to Enable (0), the option set in the phone UI, by the phone user, has priority over the value set for this parameter.

0—Enabled (default). Enables wideband headset on phone.

1—Disabled. Disables wideband headset on phone.

Wideband handset should only be used on supported IP phones with firmware version 8.3 or a later version.

headsetWidebandUIControl {0 | 1}

Enables or disables control of headset option by phone user.

0—Enabled (default). Allows phone user to select either narrowband or wideband headset

1—Disabled.

homeScreen {0 | 1}

(For Cisco Unified Wireless Phone 7921G only) Specifies view to be displayed on phone home screen.

0—Display main phone screen (default).

1—Display line view.

Implemented only on supported IP phones with firmware version 1.2.1 or a later version.

loadServer [hostname | IPaddress]

(For the Cisco Unified IP Phone 7921G only) Directs the IP phone to use an alternative TFTP server such as a local server to obtain firmware loads and upgrades. Using this parameter can help to reduce installation time, particularly for upgrades over a WAN. The specified server must be running TFTP services and have the firmware file in the TFTP path.

Note If the firmware file is not found, the firmware will not install. The phone will not be redirected to the TFTP server specified by the option 150 ip command.

hostname—Name of the server from which the IP phone must retrieve phone firmware. Maximum length: 256 characters.

IPaddress—IP address of server from which the IP phone must retrieve phone firmware.

To disable this command and redirect the phone to use the TFTP server specified by the option 150 ip command to obtain its load files and upgrades, use this parameter name without the hostname or IPaddress argument.

pcPort {0 | 1}

Enables and disables the Ethernet switch port on the phone so the IP phone can have access to an Ethernet connection for a PC connection through the phone.

0—Enabled (default).

1—Disabled.

PushToTalkURL url

(For the Cisco Unified IP Phone 7921G only) Provisions the URL to be contacted for application services such as Push-To-Talk services.

urlURL as defined in RFC 2396. Maximum length is 256 characters.

settingsAccess {0 | 1 | 2}

Enables and disables the Settings button on an IP phone.

0—Disabled.

1—Enabled (default). The phone user can modify features by using the Settings menu.

2—Restricted. The phone user is allowed to access User Preferences and volume settings only.

spanToPCPort {0 | 1}

Enables and disables the path between the Ethernet switch port of an IP phone and a connection to a PC.

0—Enabled (default).

1—Disabled.

Note The path must be disabled to support Desktop Monitoring and Recording in a Cisco UCCX/Cisco Unified CME integration.

specialNumbers number[,number...]

(For the Cisco Unified IP Phone 7921G only) Identifies a number that can be dialed on a phone regardless of whether the phone is locked or unlocked. For example, in the United States, the 911 emergency number is a good special number candidate to be dialed without unlocking the phone.

number—Numerical string. Maximum length: 16 characters.

To identify more than one special number, separate the numbers with a comma (,). Do not include spaces between numbers.

The following example shows how to configure 411, 511, and 911 as special numbers:

Router(config)# telephony-service
Router(config telephony-service)# service phone specialNumbers 
411,511,911

thumbButton1 PTTHbutton_number

(For Cisco Unified Wireless IP Phone 7921 and 7925) Associates thumb button on Cisco wireless IP phone with a phone button for one-way Push-To-Talk (PTT) functionality in Cisco Unified CME without requiring an external server.

button_number—Button on phone that is configured with an intercom dn that targets a paging number when user presses the thumb button. Range is 1 to 6.

The PTTHbutton_number keyword/argument combination is a contiguous character string and cannot contain spaces.

Implemented on supported phones with firmware version 1.0.4 or a later version.

videoCapability {0 | 1}

Enables and disables video capability for all applicable IP phones associated with a Cisco Unified CME router.

0—Disabled (default).

1—Enabled.

After using this parameter to enable video at a system level, you must configure the video command in ephone configuration mode for each video-capable phone.

Note This parameter is not supported in ephone-template configuration mode.

voiceVlanAccess {0 | 1}

Enables and disables spanning, which is the IP phone's access to the voice VLAN of the PC to which the IP phone's Ethernet port is connected.

0—Enabled (default).

1—Disabled.

Note For Cisco Unified IP Phone 7985, the default is Disabled (1).

webAccess {0 | 1 | 2}

Enables and disables web access that allows phone users to configure settings and features on User Option web pages.

0—Enabled (default).

1—Disabled.

2—Read Only. For the Cisco Unified IP Phone 7921G only. The phone user can view only User Option web pages and cannot modify settings and features on the pages.

Note For the Cisco Unified IP Phone 7921G, the default is Read Only (2).

WLanProfile tag {0 | 1}

(For Cisco Unified IP Phone 7921G only) Locks or unlocks a specific profile.

tagUnique number assigned to profile. Range is 1 to 4.

0—Locked (default).

1—Unlocked. User can modify a profile.

Repeat this command for each profile to be locked or unlocked.



Examples

The following example shows how to configure multiple service phone parameters. This configuration is applied only in as much as IP phone firmware supports each parameter.

Router(config)# telephony-service

Router(config-telephony)# service phone disableSpeaker true

Router(config-telephony)# service phone disableSpeakerAndHeadset true

Router(config-telephony)# service phone forwardingDelay 1

Router(config-telephony)# service phone garp 1

Router(config-telephony)# service phone pcPort 1

Router(config-telephony)# service phone voiceVlanAccess 0

Router(config-telephony)# service phone settingsAccess 1

Router(config-telephony)# service phone videoCapability 1

Router(config-telephony)# service phone daysDisplayNotActive 1,7

Router(config-telephony)# service phone displayOnTime 07:30

Router(config-telephony)# service phone displayOnDuration 10:00

Router(config-telephony)# service phone displayIdleTimeout 01:00

Router(config-telephony)# service phone daysBacklightNotActive 1,7

Router(config-telephony)# service phone backlightOnTime 07:30

Router(config-telephony)# service phone backlightOnDuration 10:00

Router(config-telephony)# service phone backlightIdleTimeout 01:00

Router(config-telephony)# create cnf-files

Router(config-telephony)# reset all


The following example shows how to set the default values for backlighting the phone display for all 
Cisco Unified IP phones with backlight capabilities in Cisco Unified CME:

Router(config)# telephony-service

Router(config-telephony)# service phone daysBacklightNotActive 1,7

Router(config-telephony)# service phone backlightOnTime 07:30

Router(config-telephony)# service phone backlightOnDuration 10:00

Router(config-telephony)# service phone backlightIdleTimeout 01:00

Router(config-telephony)# create cnf-files

Router(config-telephony)# reset all

The following example shows how to set the backlighting parameters so that there is no backlighting of the phone display for all Cisco Unified IP phones with backlight capabilities until there is user interaction with the phone. The backlightIdleTimeout parameter is configured so that the backlight will switch off again after 60 seconds of inactivity.

Router(config)# telephony-service

Router(config-telephony)# service phone daysBacklightNotActive 1,2,3,4,5,6,7

Router(config-telephony)# service phone backlightOnTime 07:30

Router(config-telephony)# service phone backlightOnDuration 10:00

Router(config-telephony)# service phone backlightIdleTimeout 00.01

Router(config-telephony)# create cnf-files

Router(config-telephony)# reset all


The following example shows how to set the display parameters so that the phone display for all Cisco Unified IP phones with luminous displays are blank on Sunday (1), Monday (2), and Saturday (7):

Router(config)# telephony-service

Router(config-telephony)# service phone daysDisplayNotActive 1,2,7

Router(config-telephony)# create cnf-files

Router(config-telephony)# reset all


The following example shows how to disable the PC port on an individual IP phone (ephone 15) using an ephone template:

Router(config)# ephone-template 8

Router(config-ephone-template)# service phone pcPort 1

Router(config-ephone-template)# exit

Router(config)# ephone 15

Router(config-ephone)# ephone-template 8

Router(config-ephone)# exit

Router(config)# telephony-service

Router(config-telephony)# create cnf-files

Router(config-telephony)# exit

Router(config)# ephone 15

Router(config-ephone)# reset

Related Commands

Command
Description

cnf-file

Specifies that separate configuration files be generated for individual SCCP phones or types of SCCP phones.

create cnf-files

Builds XML configuration files that set IP phone displays and functionality.

create profile

Generates configuration profile files required for SIP phones

ephone-template (ephone)

Applies a template to the ephone being configured.

reset (telephony-service)

Performs a complete reboot of one or all phones associated with a Cisco Unified CME router.

show telephony-service tftp-binding

Displays the current configuration files accessible to IP phones.

video (ephone)

Enables video capabilities on specified phones.


session-server

To specify a session manager to manage and monitor Register and Subscribe messages during a feature-server session, use the session-server command in voice register dn configuration mode, voice register pool configuration mode, or ephone-dn configuration mode. To return to the default, use the no form of this command.

session-server session-server-tag [, ...session-server-tag]

no session-server session-server-tag

Syntax Description

session-server-tag

Unique identifier of previously configured session manager in Cisco Unified CME. Range: 1 to 8. When configured in voice register dn configuration mode or in ephone-dn configuration mode, this argument can contain up to eight session-server-tags, separated by commas (,).


Command Default

Session manager is not assigned.

Command Modes

Ephone-dn configuration (ephone-dn)
Voice register dn configuration (voice-register-dn)
Voice register pool configuration (voice-register-pool)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(11)XW2

Cisco Unified CME 4.2

This command was introduced.

12.4(15)XY

Cisco Unified CME 4.2(1)

This command was introduced.

12.4(15)XZ

Cisco Unified CME 4.3

This command was introduced.

12.4(20)T

Cisco Unified CME 7.0

This command was integrated into Cisco IOS Release 12.4(20)T.


Usage Guidelines

Cisco Unified CME 4.2 and later versions provide a general interface for interoperating with external feature servers, such as the Cisco Unified CCX application on Cisco CRS, including call monitoring and device monitoring based on SIP presence and dialog event package. A session manager in Cisco Unified CME can manage and monitor Register and Subscribe messages.

Before configuring this command, a session manager must already configured in Cisco Unified CME by using the voice register session-server command.

Use the session-server command in voice register pool configuration mode to specify that Register and Subscribe messages for an external feature-server route point must contain a Cisco-referenceID field. Registration or subscription will be granted only for the specified route point. The route point for which Register and Subscribe messages are to be managed by this session manager must already be configured as a SIP endpoint in Cisco Unified CME. Typically, the configuration for the route point is provided from the feature server. If the configuration for the route point is deleted or must be modified, it can be reconfigured directly in Cisco Unified CME by using Cisco IOS commands. Each route point can be managed by only one session manager. Each session manager can manage multiple route points.

Use the session-server command in ephone-dn configuration mode or in voice register dn configuration mode to specify that Subscribe messages for a directory number must contain a Cisco-referenceID field. Registration or subscription will be granted only for the specified directory number. The directory number for which Subscribe messages are to be monitored by this session manager must already be configured in Cisco Unified CME. Each directory number can be monitored by up to eight session managers. Each session manager can subscribe for multiple directory numbers.

Examples

The following example shows the configuration for specifying that session manager 1 can control a route point (voice register pool) for an external feature server:

voice register pool 1

 session-server 1

 The following example shows the configuration specifying which session managers can monitor Register and Subscribe messages to directory numbers associated with Cisco Unified CCX agent phones. Notice that several session managers (1, 3, 5, and 7) can subscribe for both directory numbers.

ephone-dn 1

 session-server 1,2,3,4,5,6,7,8

.

ephone-dn 2

 session-server 1,3,5,7

 

Related Commands

Command
Description

voice register session-server

Enters voice register session configuration mode for the purpose of configuring a session manager.


session-transport

To specify the transport layer protocol that a SIP phone uses to connect to Cisco Unified CME, use the session-transport command in voice register pool or voice register template configuration mode. To reset to the default value, use the no form of this command.

session-transport {tcp | udp}

no session-transport

Syntax Description

tcp

Transmission Control Protocol (TCP) is used.

udp

User Datagram Protocol (UDP) is used. This is the default.


Command Default

UDP is the default protocol.

Command Modes

Voice register pool configuration (config-register-pool)
Voice register template configuration (config-register-temp)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(11)XJ

Cisco Unified CME 4.1

This command was introduced.

12.4(15)T

Cisco Unified CME 4.1

This command was integrated into Cisco IOS Release 12.4(15)T.


Usage Guidelines

This command sets the transport layer protocol parameter in the phone's configuration file.

If you use a voice register template to apply a to a phone and you also use the same command in voice register pool configuration mode for the same phone, the value that you set in voice register pool configuration mode has priority.

This command is not supported on the Cisco Unified IP Phone 7905, 7912, 7940, or 7960.


Note Although this command is not supported for the Cisco Unified IP Phone 7905, 7912, 7940, or 7960, it can be used to assign TCP as the session transport type for these phones. If TCP is selected for an unsupported phone using this command, calls to that phone will not complete successfully. The phone can originate calls but it uses UDP, although TCP has been assigned.


Examples

The following example sets the transport layer protocol to TCP for SIP phone 10:

Router(config)# voice register pool 10

Router(config-register-pool)# session-transport tcp

 

Related Commands

 
Description

create profile

Generates the configuration profile files required for SIP phones.

show sip-ua status

Displays the status of SIP call service on a SIP gateway.

template (voice register pool)

Applies template to voice register pool being configured.


shared-line

To create a directory number to be shared by multiple SIP phones, use the shared-line command in voice register dn configuration mode. To return to the default, use the no form of this command.

shared-line [max-calls number-of-calls]

no shared-line

Syntax Description

max-calls number-of-calls

(Optional) Maximum number of active calls allowed on the shared line. Range: 2 to 16. Default: 2.


Command Default

Directory number is not a shared line.
Maximum number of calls on a shared line is 2.

Command Modes

Voice register dn configuration

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(22)YB

Cisco Unified CME 7.1

This command was introduced.

12.4(24)T

Cisco Unified CME 7.1

This command was integrated into Cisco IOS Release 12.4(24)T.


Usage Guidelines

This command enables a shared line on an individual SIP phone directory number.

This command is supported only on the Cisco Unified IP Phone 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE.

Examples

The following example shows that extension 5001 associated with directory number 2 is defined as a shared line and can support up to four calls:

Router(config)# voice register dn 2

Router(config-register-dn)# number 5001

Router(config-register-dn)# shared-line max-calls 4

Related Commands

Command
Description

busy-trigger-per-button

Sets the maximum number of calls allowed on a SIP shared line before activating Call Forward Busy or a busy tone.

debug shared-line

Displays debugging information about shared lines on SIP phones.

huntstop

Disables call hunting behavior for a directory number on a SIP phone.

number (voice register din)

Associates a telephone or extension number with a SIP phone.

show shared-line

Displays information about shared lines on SIP phones.

show voice register dn

Displays all configuration information associated with a specific voice register dn.


show capf-server

To display CAPF server configuration and session information, use the show capf-server command in privileged EXEC configuration mode.

show capf-server {auth-string | sessions | summary}

Syntax Description

auth-string

Display authentication strings for ephones.

sessions

Display information about active CAPF sessions.

summary

Display CAPF server configuration details.


Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(4)XC

Cisco Unified CME 4.0

This command was introduced.

12.4(9)T

Cisco Unified CME 4.0

This command was integrated into Cisco IOS Release 12.4(9)T.


Usage Guidelines

This command is used with Cisco Unified CME phone authentication.

Examples

The following example output displays CAPF server parameters:

Router# show capf-server summary 

CAPF Server Configuration Details
        Trustpoint for TLS With Phone: cmeserver
        Trustpoint for CA operation: iosra
        Source Address: 10.1.1.1
        Listening Port: 3804
        Phone Key Size: 1024
        Phone KeyGen Retries: 100
        Phone KeyGen Timeout: 120 minutes
        Device Authentication Mode: Auth-String

The following example output displays the authentication strings that have been defined for the phones with the listed MAC addresses:

Router# show capf-server auth-string 

Authentication Strings for configured Ephones
Mac-Addr        Auth-String
--------        -----------
000CCE3A817C    7012
001121116BDD    922
000D299D50DF    9182
000ED7B10DAC    3114
000F90485077    3328
0013C352E7F1    0678

The following example output displays active sessions between phones (identified by their MAC addresses) and the CAPF server. The phone ID field lists standard phone identifications, which include the letters "SEP" plus the MAC addresses of the phones. Table 18 defines the session states that can appear in the output.

Router# show capf-server sessions 

Active CAPF Sessions
Phone ID                State
SEP000CCE3A817C         AWAIT-KEYGEN-RES


Table 18 show capf-server sessions State Descriptions  

State
Description

IDLE

Phone is idle.

AWAIT AUTH RES

A TLS connection was established on the TCP port that is specified in the configuration file. After a successful handshake verified the server certificate, a dialog was started between the CAPF server and the phone's CAPF client. The server has challenged the phone by sending an authentication request and is waiting for a response.

AWAIT KEYGEN RESP

Phone authentication was successful. The CAPF server has sent a key generation request message to the phone and is waiting for a response.

AWAIT ENCRYPT MSG RESP

A key has been generated and the CAPF has used the phone's public key to start the enrollment process with PKI. The CAPF sent an encrypt-message request to the phone and is waiting for a response.

AWAIT CA RESP

The phone has signed the received message using its private key and the CAPF has continued the enrollment process. PKI has forwarded the certificate request to the CA and is waiting for a response.

AWAIT STORE CERT RESP

Upon receiving an certificate issued from the CA, the CAPF has sent a store-certificate request message to the phone. The store-certificate request contains the certificate to be written to the phone's flash memory. The CAPF is waiting for a store-certificate response message to confirm that the certificate has been stored.


show credentials

To display the credentials settings that have been configured for use during Cisco Unified CME phone authentication communications or secure Cisco Unified SRST fallback, use the show credentials command in privileged EXEC mode.

show credentials

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.3(14)T

Cisco SRST 3.3

This command was introduced for Cisco SRST.

12.4(4)XC

Cisco Unified CME 4.0

This command was introduced for Cisco Unified CME.

12.4(9)T

Cisco Unified CME 4.0

This command for Cisco Unified CME was integrated into Cisco IOS Release 12.4(9)T.


Usage Guidelines

Cisco Unified CME

This command displays the credentials settings on a Cisco Unified CME router that has been configured with a CTL provider to be used with Cisco Unified CME phone authentication.

Cisco Unified SRST

This command displays the credentials settings on the Cisco Unified SRST router that are supplied to Cisco Unified CallManager for use during secure SRST fallback.

Examples

The following is sample output from the show credentials:

Router# show credentials 

Credentials IP: 10.1.1.22
Credentials PORT: 2445
Trustpoint: srstca

Table 19 describes the fields in the sample output.

Table 19 show credentials Field Descriptions  

Field
Description

Credentials IP

Cisco Unified CME—IP address where the CTL provider is configured.

Cisco Unified SRST—The specified IP address where certificates from Cisco Unified CallManager to the SRST router are received.

Credentials PORT

Cisco Unified CME—TCP port for credentials service communication. Default is 2444.

Cisco Unified SRST—The port to which the SRST router connects to receive messages from the Cisco Unified IP phones. The port number is from 2000 to 9999. The default port number is 2445.

Trustpoint

Cisco Unified CME—CTL provider trustpoint label that will be used for TLS sessions with the CTL client.

Cisco Unified SRST—The name of the trustpoint that is associated with the credentials service between the Cisco Unified CallManager client and the SRST router.


Related Commands

 
Description

credentials

Enters credentials configuration mode to configure a Cisco Unified CME CTL provider certificate or a Cisco Unified SRST router certificate.

ctl-service admin

Specifies a user name and password to authenticate the CTL client during the CTL protocol.

debug credentials

Sets debugging on the credentials service that runs between a Cisco Unified CME CTL provider and the CTL client or between a Cisco Unified SRST router and Cisco Unified CallManager.

ip source-address (credentials)

Enables the Cisco Unified CME or SRST router to receive messages through the specified IP address and port.

trustpoint (credentials)

Specifies the name of the trustpoint to be associated with a Cisco Unified CME CTL provider certificate or with a Cisco Unified SRST router certificate.


show cti

To display the status of the CTI subsystem, use the show cti command in privileged EXEC mode.

show cti {call | gcid | line node | session}

Syntax Description

call

Details for active (ACT) calls only.

gcid

List of Global Call IDs for active calls only.

line node

List of line nodes.

session

Details for active CTI sessions.


Command Modes

Privileged EXEC (#)

Command History

Release
Cisco Product
Modification

15.0(1)XA

Cisco Unified CME 8.0

This command was introduced.


Usage Guidelines

This commands displays status information for the CTI subsystem in Cisco Unified CME.

Examples

The following sample output is for each command when there are no active calls.

Router#show cti gcid
GCID                                 callIDs
===================================  =================
no active GCID
Router#show cti call
DN         CallID GCID                                Calling    Called     State
=========  ====== =================================== ========== ========== =====
201       
204       

A line-node is the internal data structure of a directory number. Once a line-node is created, the 
structure remains until the CTI interface is shut down.
Router#show cti line-node
line dn             number of call instance
================    =======================
1001                0
201                 0
202                 0
203                 0
204                 0
233                 0
6789                0
A0001               0

Router#
 

The following is sample output from the show cti gcid command for one call. This sample contains a single Gcid with two callIDs, one for each call leg.

Router#show cti gcid
GCID                                 callIDs
===================================  =================
1E2E3483-5ACB11DE-BA9EF925-DF2AFB55  59291, 59292,
 

The following is sample output from the show cti call command. This samples shows that a call was placed from (DN) 201 to (DN) 204 and both directory numbers are now Active (ACT). Note that the Gcid and callIDs in this sample correspond to those in the output from the show cti gcid command.

Router#show cti call
DN         CallID GCID                                Calling    Called     State

=========  ====== =================================== ========== ========== ======

201
           59291   1E2E3483-5ACB11DE-BA9EF925-DF2AFB55 201        204        ACT

204
           59292   1E2E3483-5ACB11DE-BA9EF925-DF2AFB55 201        204        ACT
 

The following is sample output from the show cti line-node command. In the following sample, there are eight line-nodes and two (201 and 204) are in use.

Router#show cti line-node
line dn             number of call instance
================    =======================
                    0
1001                0
201                 1
      callID 59291(C7C ),  *cg = 201, cd = 204
202                 0
203                 0
204                 1
      callID 59292(C7C ),  cg = 201, *cd = 204
233                 0
6789                0
A0001               0
 

<<Table number>> describes the significant fields shown in the display.

Table 20 show xxx Field Descriptions 

Field
Description

GCID

Global Call ID (Gcid)—Unique identifier in for every call on an outbound leg of a VoIP dial peer for an endpoint. A single Gcid remains the same for the same call in the system, and is valid for redirect, transfer, and conference events.

CallID

Unique identifier for each call leg of a call.


Related Commands

Command
Description

clear cti session

Clears the session between a CSTA client application and Cisco Unified CME.


show ctl-client

To display information about the certificate trust list (CTL) client, use the show ctl-client command in privileged EXEC configuration mode.

show ctl-client

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(4)XC

Cisco Unified CME 4.0

This command was introduced.

12.4(9)T

Cisco Unified CME 4.0

This command was integrated into Cisco IOS Release 12.4(9)T.


Usage Guidelines

This command is used with Cisco Unified CME phone authentication.

Examples

The following example displays trustpoints and IP addresses known to the CTL client.

Router# show ctl-client 

CTL Client Information
-----------------------------
        SAST 1 Certificate Trustpoint: cmeserver
        SAST 1 Certificate Trustpoint: sast2
        List of Trusted Servers in the CTL
                CME     10.1.1.1        cmeserver
                TFTP    10.1.1.1        cmeserver
                CAPF    10.1.1.1        cmeserver

show ephone

To display information about registered Cisco Unified IP phones, use the show ephone command in user EXEC or privileged EXEC mode.

show ephone [mac-address | phone-type]

Syntax Description

mac-address

(Optional) Displays information for the phone with the specified MAC address.

phone-type

(Optional) Displays information for phones of the specified phone type. Supported phone types are version-specific. Type ? to display a list of values.


Command Modes

User EXEC (>)
Privileged EXEC (#)

Command History

Cisco IOS Release
Cisco Product
Modification

12.1(5)YD

Cisco ITS 1.0
Cisco SRST 1.0

This command was introduced.

12.2(8)T

Cisco ITS 2.0
Cisco SRST 2.0

This command was integrated into Cisco IOS Release 12.2(8)T.

12.2(11)T

Cisco ITS 2.01
Cisco SRST 2.01

The ata keyword was added and this command was implemented on the Cisco 1760.

12.2(11)YT

Cisco ITS 2.1
Cisco SRST 2.1

The 7914 keyword was added.

12.2(15)ZJ

Cisco CME 3.0
Cisco SRST 3.0

The 7902, 7905, and 7912 keywords were added.

12.3(7)T

Cisco CME 3.1
Cisco SRST 3.1

The 7920 and 7936 keywords were added.

12.3(11)XL

Cisco CME 3.2.1
Cisco SRST 3.2.1

The 7970 keyword was added.

12.3(14)T

Cisco CME 3.3
Cisco SRST 3.3

The 7971 keyword was added, and this command was integrated into Cisco IOS Release 12.3(14)T.


12.4(4)XC

Cisco Unified CME 4.0
Cisco Unified SRST 4.0

The 7911, 7941, 7941GE, 7961, and 7961GE keywords were added.

12.4(9)T

Cisco Unified CME 4.0
Cisco Unified SRST 4.0

The 7911, 7941, 7941GE, 7961, and 7961GE keywords were integrated into Cisco IOS Release 12.4(9)T.

12.4(6)XE

Cisco Unified CME 4.0(2)

The 7931 keyword was added for Cisco Unified CME.

12.4(4)XC4

Cisco Unified CME 4.0(3)

The 7931 keyword was added for Cisco Unified CME.

12.4(11)T

Cisco Unified CME 4.0(3)

The 7931 keyword for Cisco Unified CME was integrated into Cisco IOS Release 12.4(11)T.

12.4(11)XJ2

Cisco Unified CME 4.1
Cisco Unified SRST 4.1

The 7921 and 7985 keywords were added.

12.4(15)T1

Cisco Unified CME 4.1(1)
Cisco Unified SRST 4.1(1)

The 7942, 7945, 7962, 7965, and 7975 keywords were added and this command was integrated into Cisco IOS Release 12.4(15)T1.

12.4(15)XY

Cisco Unified CME  4.2(1)
Cisco Unified SRST 4.2(1)

Emergency response location (ERL) information displays in the output.

12.4(15)XZ

Cisco Unified CME 4.3
Cisco Unified SRST 4.3

Support for user-defined phone types created with the ephone-type command was added.

12.4(15)XZ1

Cisco Unified CME 4.3
Cisco Unified SRST 4.3

The 7915-12, 7915-24, 7916-12, 7916-24, and 7937 keywords were added.

12.4(20)T

Cisco Unified CME  7.0
Cisco Unified SRST 7.0

The 7915-12, 7915-24, 7916-12, 7916-24, and 7937 keywords were added and this command was integrated into Cisco IOS Release 12.4(20)T.

15.0(1)XA

Cisco Unified CME 8.0

This command was modified. The IP-STE keyword was added and logical partitioning class of restriction (LPCOR) and Cancel Call Waiting information was added to the output.


Examples

Significant fields in the output from this command are described in Table 18.

The following sample output shows general information for registered phones:

Router# show ephone


ephone-8[7] Mac:000A.B7B1.444A TCP socket:[5] activeLine:0 whisperLine:0 REGISTERED in SCCP ver 11/9 max_streams=1

mediaActive:0 whisper_mediaActive:0 startMedia:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0 caps:8 privacy:0

IP:10.4.188.99 * 50007 Telecaster 7940 keepalive 8424 max_line 2 available_line 2

button 1: cw:1 ccw:(0 0)

dn 6 number 6006 CH1 IDLE CH2 IDLE overlay shared

button 2: cw:1 ccw:(0 0 0 0 0 0 0 0)

dn 42 number 6042 CH1 IDLE CH2 IDLE CH3 IDLE CH4 IDLE CH5 IDLE CH6 IDLE CH7 IDLE CH8 IDLE shared

overlay 1: 6(6006) 7(6007) 8(6008)

Preferred Codec: g711ulaw

Lpcor Type: local Incoming: ephone_group1 Outgoing: ephone_group1


Table 18 describes significant fields in the output.

Table 21 show ephone Field Descriptions  

Field
Description

Active Call

An active call is in progress.

activeLine

Line (button) on the phone that is in use. Zero indicates that no line is in use.

auto-dial number

Intercom extension that automatically dials number.

button number: dn number

Phone button number and the extension (ephone-dn) dn-tag number associated with that button.

bytes

Total number of voice data bytes sent or received by the phone.

Called Dn, Calling Dn

Ephone-dn tag numbers of the called and calling ephone-dn. Set to -1 if the call is not to or from an ephone-dn, or if there is no active call.

cfa number

Call-forward-all to number is enabled for this extension.

CH1
CH2

Status of channel 1 and, if this is a dual-line ephone-dn, the status of channel 2.

cw

1 indicates that Call Waiting is enabled.
0 indicates that Call Waiting is disabled.

debug

1 indicates that debug for the phone is enabled.
0 indicates that debug is disabled.

DnD

Do Not Disturb is set on this phone.

DP tag

Not used.

ephone-number

Unique sequence number used to identify this phone during configuration (phone-tag).

IP

Assigned IP address of the Cisco Unified IP phone.

Jitter

Amount of variation (in milliseconds) of the time interval between voice packets received by the Cisco Unified IP phone.

keepalive

Number of keepalive messages received from the Cisco Unified IP phone by the router.

Latency

Estimated playout delay for voice packets received by the Cisco Unified IP phone.

line number

Button number on an IP phone. Line 1 is the button nearest the top of the phone.

Lost

Number of voice packets lost, as calculated by the Cisco Unified IP phone, on the basis of examining voice packet time-stamp and sequence numbers during playout.

Lpcor Incoming

Setting of the lpcor incoming command.

Lpcor Outgoing

Setting of the lpcor outgoing command.

Lpcor Type

Setting of the lpcor type command.

Mac

MAC address.

Max Conferences

Maximum number of allowable conference calls and number of active conference calls.

max_line number

Maximum number of line buttons that can be configured on this phone.

mediaActive

1 indicates that an active conversation is in progress.
0 indicates that no conversation is ongoing.

monitor-ring

This button is set up as a monitor button.

number

Telephone or extension number associated with the Cisco Unified IP phone button and its dn-tag.

offhook

1 indicates that the phone is off-hook.
0 indicates that the phone is on-hook.

overlay

This button contains an overlay set. Use show ephone overlay to display the contents of overlay sets.

paging

1 indicates that the phone has received an audio page.
0 indicates that the phone has not received an audio page.

paging-dn

Ephone-dn that is dedicated for receiving audio pages on this phone. The paging-dn number is the number of the paging set to which this phone belongs.

Password

Authentication string that the phone user types when logging in to the web-based Cisco Unified CME GUI.

Port

Port used for TAPI transmissions.

REGISTERED

The Cisco Unified IP phone is active and registered. Alternative states are UNREGISTERED (indicating that the connection to the Cisco Unified IP phone was closed in a normal manner) and DECEASED (indicating that the connection to the Cisco Unified IP phone was closed because of a keepalive timeout).

reset

Pending reset.

reset_sent

Request for reset has been sent to the Cisco Unified IP phone.

ringing

1 indicates that the phone is ringing.
0 indicates that the phone is not ringing.

Rx Pkts

Number of received voice packets.

silent-ring

Silent ring has been set on this button and extension.

socket

TCP socket number used to connect to IP phone.

speed dial speed-tag:digit-string label-text

This button is a speed-dial button, assigned to the speed-dial sequence number speed-tag. It dials digit-string and displays the text label-text next to the button.

sub=3, sub=4

Subtype 3 means that one Cisco Unified IP Phone 7914 Expansion Module is attached to the main Cisco Unified IP Phones 7960 and 7960G, and subtype 4 means that two are attached.

Tag number

Dn-tag number, the unique sequence number that identifies an ephone-dn during configuration, followed by the type of ephone-dn it is.

TAPI Client IP Address

IP address of the PC running the TAPI client.

TCP socket

TCP socket number used to communicate with the Cisco Unified IP phone. This can be correlated with the output of other debug and show commands.

Telecaster model-number

Type and model of the Cisco Unified IP phone. This information is received from the phone during its registration with the router.

Tx Pkts

Number of transmitted voice packets.

Username

Username that the phone user types when logging in to the web-based Cisco Unified CME GUI.


Related Commands

Command
Description

show ephone-dn

Displays information about Cisco Unified IP phone extensions (ephone-dns).

show ephone login

Displays the login states of all local ephones.

show telephony-service all

Displays systemwide status and information for a Cisco Unified CME system.


show ephone attempted-registrations

To display the log of ephones that unsuccessfully attempt to register with Cisco Unified CME, use the show ephone attempted-registrations command in privileged EXEC mode.

show ephone attempted-registrations

Syntax Description

This command has no keywords or arguments.

Command Modes

Privileged EXEC (#)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(4)XC

Cisco Unified CME 4.0

This command was introduced.

12.4(9)T

Cisco Unified CME 4.0

This command was integrated into Cisco IOS Release 12.4(9)T.


Usage Guidelines

The no auto-reg-ephone blocks the automatic registration of ephones whose MAC addresses are not explicitly listed in the configuration. When automatic registration is blocked, Cisco Unified CME records the MAC addresses of phones that attempt to register but cannot because they are blocked.

Use the show ephone attempted-registrations to view the list of phones that have attempted to register but have been blocked. The clear telephony-service ephone-attempted-registrations clears the list.

Examples

The following example displays ephones that unsuccessfully attempted to register with Cisco Unified CME:

Router# show ephone attempted-registrations

Attempting Mac address:

Num    Mac Address         DateTime                          DeviceType
-----------------------------------------------------------------------------

1      C863.8475.5417      22:52:05 UTC Thu Apr 28 2005      SCCP Gateway (AN) 
2      C863.8475.5408      22:52:05 UTC Thu Apr 28 2005      SCCP Gateway (AN) 
.....
25     000D.28D7.7222      22:26:32 UTC Thu Apr 28 2005      Telecaster 7960 
26     000D.BDB7.A9EA      22:25:59 UTC Thu Apr 28 2005      Telecaster 7960 
...
47     C863.94A8.D40F      22:52:17 UTC Thu Apr 28 2005      SCCP Gateway (AN) 
48     C863.94A8.D411      22:52:18 UTC Thu Apr 28 2005      SCCP Gateway (AN) 

49     C863.94A8.D400      22:52:15 UTC Thu Apr 28 2005      SCCP Gateway (AN) 

Table 22 describes the significant fields shown in the display.

Table 22 show ephone attempted-registrations Field Descriptions 

Field
Description

Num

Index number.

Mac Address

MAC address of the ephone.

DateTime

Date and time that the attempt to register was made.

DeviceType

Type of ephone.


Related Commands

 
Description

auto-reg-ephone

Enables automatic registration of ephones with the Cisco Unified CME system.

clear telephony-service ephone-attempted-registrations

Empties the log of ephones that unsuccessfully attempt to register with Cisco Unified CME.


show ephone cfa

To display status and information on the registered phones that have call-forward-all set on one or more of their extensions (ephone-dns), use the show ephone cfa command in privileged EXEC mode.

show ephone cfa

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC (#)

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(15)ZJ

Cisco CME 3.0
Cisco SRST 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0
Cisco SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.


Examples

The following is sample output from the show ephone cfa command:

Router# show ephone cfa

ephone-1 Mac:0007.0EA6.353A TCP socket:[2] activeLine:0 REGISTERED
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0
IP:1.2.205.205 52491 Telecaster 7960  keepalive 14 max_line 6
button 1: dn 11 number 60011 cfa 60022 CH1 IDLE 
button 2: dn 17 number 60017 cfa 60021 CH1 IDLE

The show ephone describes significant fields in this output.

Related Commands

 
Description

show ephone

Displays statistical information about registered Cisco IP phones.


show ephone dn

To display phone information for specified dn-tag or for all dn-tags, use the show ephone dn command in privileged EXEC mode.

show ephone dn [dn-tag]

Syntax Description

dn-tag

(Optional) Unique sequence number that is used during configuration to identify a particular extension (ephone-dn).


Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(15)ZJ

Cisco CME 3.0
Cisco SRST 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0
Cisco SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.


Usage Guidelines

Use this command to identify the phone on which a particular dn-tag has been assigned.

Examples

The following is sample output for the two appearances of DN 5:

Router# show ephone dn 5

Tag 5, Normal or Intercom dn 
ephone 1, mac-address 0030.94C3.CAA2, line 2
ephone 2, mac-address 0030.94c2.9919, line 3

The show ephone describes significant fields in this output.

Related Commands

 
Description

show ephone

Displays statistical information about registered Cisco IP phones.


show ephone dnd

To display information on the registered phones that have "do not disturb" set on one or more of their extensions (ephone-dns), use the show ephone dnd command in privileged EXEC mode.

show ephone dnd

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(15)ZJ

Cisco CME 3.0
Cisco SRST 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0
Cisco SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.


Usage Guidelines

This command does not apply to Cisco Unified SRST.

Examples

The following is sample output from the show ephone dnd command:

Router# show ephone dnd

ephone-1 Mac:0007.0EA6.353A TCP socket:[1] activeLine:0 REGISTERED
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0
IP:1.2.205.205 52486 Telecaster 7960  keepalive 2729 max_line 6 DnD
button 1: dn 11 number 60011 CH1 IDLE 

The show ephone describes significant fields in this output.

Related Commands

 
Description

show ephone

Displays statistical information about registered Cisco IP phones.


show ephone login

To display the login states of all local IP phones, use the show ephone login command in privileged EXEC mode.

show ephone login

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC (#)

Command History

Cisco  IOS Release
Cisco Product
Modification

12.2(15)ZJ

Cisco CME 3.0
Cisco SRST 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0
Cisco SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.

15.0(1)XA

Cisco Unified CME 8.0
Cisco Unified SRST 8.0

This command was modified. LOCAL and GLOBAL replace TRUE in the output for "Pin enabled."


Usage Guidelines

The show ephone login command displays whether an ephone has a personal identification number (PIN) and whether its owner is logged in.

In Cisco Unified CME 7.1 and earlier versions, FALSE is displayed if there is no PIN configured for the specified ephone. TRUE is displayed if there is a PIN configured for the specified ephone.

In Cisco Unified CME 8.0 and later versions, the show output is modified as follows:

FALSE is displayed only if no PIN is defined, neither in an ephone configuration nor in the telephony-service configuration.

LOCAL is displayed if an individual PIN is defined for the specific ephone.

GLOBAL is displayed if a global PIN is defined.

Examples

Cisco Unified CME 8.0 or later versions

The following is sample output from the show ephone login command. It shows that a PIN is defined for ephone 1 and that its owner has not logged in. The other phones do not have PINs associated with them.

Router# show ephone login

ephone 1        Pin enabled:LOCAL       Logged-in:FALSE
ephone 2        Pin enabled:FALSE
ephone 3        Pin enabled:FALSE

 

The following is sample output from the show ephone login command. It shows that a PIN is defined for ephone 1 and that its owner has not logged in. A global PIN is defined also defined for this system. If the pin command is configured in ephone configuration mode and telephony-service configuration mode, the command in ephone configuration mode takes precedence.

Router# show ephone login

ephone 1        Pin enabled:LOCAL       Logged-in:FALSE
ephone 2        Pin enabled:GLOBAL      Logged-in:TRUE
ephone 3        Pin enabled:GLOBAL      Logged-in:TRUE

 

The following is sample output from the show ephone login command. It shows that neither a local nor a global PIN is enabled for ephones 1 to 3.

Router# show ephone login

ephone 1        Pin enabled:FALSE
ephone 2        Pin enabled:FALSE
ephone 3        Pin enabled:FALSE

 

Cisco CME 3.0 to Cisco Unified CME 7.1

The following is sample output from the show ephone login command. It shows that a PIN is enabled for ephone 1 and that its owner has not logged in. The other phones do not have PINs associated with them.

Router# show ephone login

ephone 1        Pin enabled:TRUE        Logged-in:FALSE
ephone 2        Pin enabled:FALSE
ephone 3        Pin enabled:FALSE
ephone 4        Pin enabled:FALSE
ephone 5        Pin enabled:FALSE
ephone 6        Pin enabled:FALSE
ephone 7        Pin enabled:FALSE
ephone 8        Pin enabled:FALSE
ephone 9        Pin enabled:FALSE

Table 23 describes significant fields in this output.

Table 23 show ephone login Field Descriptions 

Field
Description

ephone phone-tag

Phone identified with its unique phone-tag sequence number.

Pin enabled

In Cisco Unified CME 7.1 and earlier versions:

TRUE—A PIN is defined for this phone.

FALSE —No PIN is defined for this phone.

In Cisco Unified CME 8.0 and later versions:

LOCAL—A PIN has been defined for this phone.

GLOBAL—A global PIN is defined for this Cisco Unified CME system.

FALSE—No PIN is defined.

Logged-in

TRUE indicates that a phone user is currently logged in on this phone.

FALSE indicates that no phone user is currently logged in on this phone.


Related Commands

Command
Description

login (telephony-service)

Defines when users of IP phones in a Cisco Unified CME system are logged out automatically.

pin

Sets set a personal identification number (PIN) for an IP phone in a Cisco Unified CME system.

show ephone

Displays statistical information about registered Cisco IP phones.


show ephone offhook

To display information and packet counts for the phones that are currently off hook, use the show ephone offhook command in privileged EXEC mode.

show ephone offhook

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(15)ZJ

Cisco CME 3.0
Cisco SRST 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0
Cisco SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.


Examples

The following sample output is displayed when no phone is off hook:

Router# show ephone offhook

No ephone in specified type/condition.

The following sample output displays information for a phone that is off hook:

Router# show ephone offhook

ephone-5 Mac:000A.8A2C.8C6E TCP socket:[20] activeLine:1 REGISTERED
mediaActive:0 offhook:1 ringing:0 reset:0 reset_sent:0 paging 0 debug:0
IP:10.22.84.71 51228 Telecaster 7960  keepalive 43218 max_line 6
button 1:dn 9  number 59943 CH1 SIEZE     silent-ring
button 2:dn 10 number 59943 CH1 IDLE
button 3:dn 42 number A4400  auto dial A4500 CH1 IDLE
button 4:dn 96 number 69943  auto dial 95259943 CH1 IDLE
button 5:dn 75 number 49943  auto dial 49943 CH1 IDLE
speed dial 1:57514 marketing
Active Call on DN 9 chan 1 :59943 0.0.0.0 0 to 0.0.0.0 2000 via 172.30.151.1
G711Ulaw64k  160 bytes vad
Tx Pkts 0 bytes 0 Rx Pkts 0 bytes 0 Lost 0
Jitter 0 Latency 0 callingDn -1 calledDn -1
Username:user1 Password:newuser

The following sample output displays information for a phone that has just completed a call:

Router# show ephone offhook

ephone-5 Mac:000A.8A2C.8C6E TCP socket:[20] activeLine:1 REGISTERED
mediaActive:1 offhook:1 ringing:0 reset:0 reset_sent:0 paging 0 debug:0
IP:10.22.84.71 51228 Telecaster 7960  keepalive 43224 max_line 6
button 1:dn 9  number 59943 CH1 CONNECTED silent-ring
button 2:dn 10 number 59943 CH1 IDLE
button 3:dn 42 number A4400  auto dial A4500 CH1 IDLE
button 4:dn 96 number 69943  auto dial 95259943 CH1 IDLE
button 5:dn 75 number 49943  auto dial 49943 CH1 IDLE
speed dial 1:57514 marketing
Active Call on DN 9 chan 1 :59943 10.23.84.71 22926 to 172.30.131.129 2000 via 
172.30.151.1
G711Ulaw64k  160 bytes no vad
Tx Pkts 0 bytes 0 Rx Pkts 0 bytes 0 Lost 0
Jitter 0 Latency 0 callingDn -1 calledDn -1 (media path callID 19288 srcCallID 1
9289)
Username:user1 Password:newuser

The show ephone describes significant fields in this output.

Related Commands

 
Description

show ephone

Displays statistical information about registered Cisco IP phones.


show ephone overlay

To display information for the registered phones that have overlay ephone-dns associated with them, use the show ephone overlay in privileged EXEC mode.

show ephone overlay

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(15)ZJ

Cisco CME 3.0
Cisco SRST 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0
Cisco SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.


Usage Guidelines

This command does not apply to Cisco Unified SRST.

Examples

The following is sample output from the show ephone overlay command:

Router# show ephone overlay

ephone-1 Mac:0007.0EA6.353A TCP socket:[1] activeLine:0 REGISTERED
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0
IP:10.2.225.205 52486 Telecaster 7960  keepalive 2771 max_line 6
button 1: dn 11 number 60011 CH1 IDLE      overlay 
button 2: dn 17 number 60017 CH1 IDLE      overlay 
button 3: dn 24 number 60024 CH1 IDLE      overlay 
button 4: dn 30 number 60030 CH1 IDLE      overlay 
button 5: dn 36 number 60036 CH1 IDLE      CH2 IDLE      overlay 
button 6: dn 39 number 60039 CH1 IDLE      CH2 IDLE      overlay 
overlay 1: 11(60011) 12(60012) 13(60013) 14(60014) 15(60015) 16(60016) 
overlay 2: 17(60017) 18(60018) 19(60019) 20(60020) 21(60021) 22(60022) 
overlay 3: 23(60023) 24(60024) 25(60025) 26(60026) 27(60027) 28(60028) 
overlay 4: 29(60029) 30(60030) 31(60031) 32(60032) 33(60033) 34(60034) 
overlay 5: 35(60035) 36(60036) 37(60037) 
overlay 6: 38(60038) 39(60039) 40(60040) 

The show ephone command describes significant fields in this output. Table 24 describes a field that is not in that table.

Table 24 show ephone overlay Field Descriptions 

Field
Description

overlay number

Displays the contents of an overlay set, including each dn-tag and its associated extension number.


Related Commands

 
Description

show ephone

Displays statistical information about registered Cisco IP phones.


show ephone phone-load

To display information about the phone firmware that is loaded on registered phones, use the show ephone phone-load command in privileged EXEC mode.

show ephone phone-load

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(15)ZJ

Cisco CME 3.0
Cisco SRST 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0
Cisco SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.


Examples

The following is sample output that displays the phone firmware versions for all phones in the system:

Router# show ephone phone-load

DeviceName        CurrentPhoneload       PreviousPhoneload      LastReset
=====================================================================
SEP0002B9AFC49F   3.2(2.14)              3.2(2.14)              TCP-timeout
SEP003094C2D0B0   3.2(2.14)              3.2(2.14)              TCP-timeout
SEP000C30F03707   3.2(2.14)              3.2(2.14)              TCP-timeout
SEP003094C2999F   3.2(2.14)              3.2(2.14)              TCP-timeout
SEP000A8A2C8C6E   3.2(2.14)              3.2(2.14)              Initialized
SEP0002B9AFBB4D   3.2(2.14)              3.2(2.14)              TCP-timeout
SEP00075078627F   3.2(2.14)              3.2(2.14)              TCP-timeout
SEP0002FD659E59   3.2(2.14)              3.2(2.14)              TCP-timeout
SEP00024BCCD626   3.2(2.14)                                     CM-closed-TCP
SEP0008215F88C1   3.2(2.14)              3.2(2.14)              TCP-timeout
SEP000C30F0390C   3.2(2.14)              3.2(2.14)              TCP-timeout
SEP003094C30143   3.2(2.14)              3.2(2.14)              TCP-timeout

Table 25 describes significant fields in this output.

Table 25 show ephone phone-load Field Descriptions 

Field
Description

DeviceName

Device name.

CurrentPhoneLoad

Current phone firmware version.

PreviousPhoneLoad

Phone firmware version before last phone load.

LastReset

Reason for last reset of phone.


Related Commands

 
Description

show ephone

Displays statistical information about registered Cisco IP phones.


show ephone registered

To display the status of registered phones, use the show ephone registered command in privileged EXEC mode.

show ephone registered

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(15)ZJ

Cisco CME 3.0
Cisco SRST 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0
Cisco SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.

15.0(1)XA

Cisco CME 8.0

This command was modified. The output was enhanced to include the setting of the feature-button command.


Examples

The following is sample output from the show ephone registered command:

Router# show ephone registered

ephone-12[11] Mac:001A.A11B.7D6D TCP socket:[5] activeLine:0 whisperLine:0 REGIS
TERED in SCCP ver 15/12 max_streams=1
mediaActive:0 whisper_mediaActive:0 startMedia:0 offhook:0 ringing:0 reset:0 res
et_sent:0 paging 0 debug:0 caps:7
IP:10.10.1.17 * 35177 6941  keepalive 3593 max_line 4 available_line 3
button 1: cw:1 dn 11 number 1001 CH1   IDLE         CH2   IDLE
button 2: cw:1 dn 56 number 6971  auto dial 6970 CH1   IDLE
button 3: cw:1 dn 10 number 1000 CH1   IDLE         CH2   IDLE
1 feature buttons enabled: dnd
Preferred Codec: g711ulaw
Lpcor Type: none

Table 26 describes significant fields in this output.

Table 26 show ephone registered Field Descriptions 

Field
Description

active

Number of active parties registered.

ephone

Cisco IP phone.

mac-address

MAC address of the Cisco IP phone.

keepalive

Defines keepalive timeout period to unregister IP phone.

feature-buttons

Displays the type of feature button on the ephone.


Related Commands

Command
Description

show ephone

Displays statistical information about registered Cisco IP phones.


show ephone remote

To display nonlocal phones (phones with no Address Resolution Protocol [ARP] entry), use the show ephone remote command in privileged EXEC mode.

show ephone remote

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(15)ZJ

Cisco CME 3.0
Cisco SRST 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0
Cisco SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.


Usage Guidelines

Phones without ARP entries are suspected not to be on the LAN. Use the show ephone remote command to identify phones without ARP entries that might have operational issues.

Examples

The following is sample output that identifies ephone 2 as not having an ARP entry:

Router# show ephone remote

ephone-2 Mac:0185.047C.993E TCP socket:[4] activeLine:0 REGISTERED
mediaActive:1 offhook:0 ringing:0 reset:0 reset_sent:0 paging 1 debug:0
IP:10.50.50.20 49231 Telecaster 7910  keepalive 112 max_line 2 dual-line
button 1:dn 3  number 95021 CH1 IDLE
paging-dn 25

The show ephone describes significant fields in this output.

Related Commands

 
Description

show ephone

Displays statistical information about registered Cisco IP phones.


show ephone ringing

To display information on phones that are ringing, use the show ephone ringing command in privileged EXEC mode.

show ephone ringing

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(15)ZJ

Cisco CME 3.0
Cisco SRST 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0
Cisco SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.


Examples

The following is sample output from the show ephone ringing command:

Router# show ephone ringing

ephone-1 Mac:0005.5E37.8090 TCP socket:[1] activeLine:0 REGISTERED
mediaActive:0 offhook:0 ringing:1 reset:0 reset_sent:0 paging 0 debug:0
IP:10.50.50.10 49329 Telecaster 7960  keepalive 17602 max_line 6
button 1:dn 1  number 95011 CH1 RINGING   CH2 IDLE
button 2:dn 2  number 95012 CH1 IDLE

The show ephone describes significant fields in this output.

Related Commands

 
Description

show ephone

Displays statistical information about registered Cisco IP phones.


show ephone socket

To display IP addresses (IPv4, IPv6, or dual-stack) being used by ephone sockets, use the show ephone socket command in privileged EXEC mode.

show ephone socket

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC (#)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(24)YF

Cisco Unified CME 8.0
Cisco Unified SRST 8.0

This command was introduced.


Usage Guidelines

Use the show ephone socket command to verify if IPv4 only, IPv6 only, or dual-stack (IPv4/IPv6) is configured on Cisco Unified CME. In the following example, skinny_tcp_listen_socket fd = 0 and skinny_tcp_listen_socket fd = 1 verify that dual-stack configuration. When IPv6 only is configured show ephone socket command displays skinny_tcp_listen_socket fd = -1 and skinny_tcp_listen_socket fd = 0 values. When IPv4 only is configured the show ephone socket command displays skinny_tcp_listen_socket fd = 0 and skinny_tcp_listen_socket (ipv6) fd = -1 values.

Examples

The following is sample output from the show ephone socket command:

Router# show ephone ssocket

skinny_tcp_listen_socket fd = 0

skinny_tcp_listen_socket (ipv6) fd = 1

skinny_secure_tcp_listen_socket fd = -1

skinny_secure_tcp_listen_socket (ipv6) fd = -1

skinny_open_sockets = 3:

Phone 3,

skinny_sockets[0] fd = 1

read_buffer 0x480061E8, read_offset 0, read_header N, read_length 0

resend_queue 0x47CE8178, resend_offset 0, resend_flag N, resend_Q_depth 0

Phone 2,

skinny_sockets[1] fd = 2

read_buffer 0x48006A24, read_offset 0, read_header N, read_length 0

resend_queue 0x47CE8104, resend_offset 0, resend_flag N, resend_Q_depth 0

Phone 1,

skinny_sockets[2] fd = 3

read_buffer 0x48007260, read_offset 0, read_header N, read_length 0

resend_queue 0x47CE8090, resend_offset 0, resend_flag N, resend_Q_depth 0

Related Commands

Command
Description

show ephone summary

Displays information about Cisco IP phones.


show ephone summary

To display brief information about Cisco IP phones, use the show ephone summary command in privileged EXEC mode.

show ephone summary

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC (#)

Command History

Cisco IOS Release
Cisco Product
Modification

12.1(5)YD

Cisco CME 1.0
Cisco SRST 1.0

This command was introduced.

12.2(8)T

Cisco CME 2.0
Cisco SRST 2.0

This command was integrated into Cisco IOS Release 12.2(8)T .

15.0(1)XA

Cisco Unified CME 8.0
Cisco Unified SRST 8.0

This command was modified. The output was enhanced to show IPv6 or IPv4 addresses configured on ephones.


Examples

The following is sample output from the show ephone summary command:

Router# show ephone summary 

ephone-1 Mac:0030.94C3.37CB TCP socket:[-1] activeLine:0 REGISTERED
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 debug:0
IP:10.1.1.1 Telecaster 7910  keepalive 45  1:1 
sp1:5002 sp2:5003 

ephone-2 Mac:0030.94C3.F96A TCP socket:[-1] activeLine:0 REGISTERED
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 debug:0
IP:10.1.1.2 Telecaster 7960  keepalive 45  1:2 2:3 3:4 
sp1:5004 sp2:5001 

ephone-3 Mac:0030.94C3.F946 TCP socket:[-1] activeLine:0 REGISTERED
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 debug:0
IP:10.2.1.2 Telecaster 7960  keepalive 59 

ephone-4 Mac:0030.94C3.F43A TCP socket:[-1] activeLine:0 REGISTERED
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 debug:0
IP:10.2.1.1 Telecaster 7960  keepalive 59 

Max 48, Registered 1, Unregistered 0, Deceased 0, Sockets 1

Max Conferences 4 with 0 active (4 allowed)
Skinny Music On Hold Status
Active MOH clients 0 (max 72), Media Clients 0
No MOH file loaded

The show ephone command describes significant fields in this output.

Related Commands

Command
Description

show ephone

Displays statistical information about registered Cisco IP phones.


show ephone tapiclients

To display status of ephone Telephony Application Programming Interface (TAPI) clients, use the show ephone tapiclients command in privileged EXEC mode.

show ephone tapiclients

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(15)ZJ

Cisco CME 3.0
Cisco SRST 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0
Cisco SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.


Examples

The following is sample output from the show ephone tapiclients command:

Router# show ephone tapiclients

ephone-4 Mac:0007.0EA6.39F8 TCP socket:[2] activeLine:0 REGISTERED
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0
IP:192.168.1.18 50291 Telecaster 7960  sub=3 keepalive 728 max_line 20
button 1:dn 6  number 1004 CH1 IDLE      CH2 IDLE
button 2:dn 1  number 1000 CH1 IDLE      shared
button 3:dn 2  number 1000 CH1 IDLE      shared
button 7:dn 3  number 1001 CH1 IDLE      CH2 IDLE      monitor-ring shared
button 8:dn 4  number 1002 CH1 IDLE      CH2 IDLE      monitor-ring shared
button 9:dn 5  number 1003 CH1 IDLE      CH2 IDLE      monitor-ring
button 10:dn 91 number A00  auto dial A01 CH1 IDLE
speed dial 1:2000 PAGE-STAFF
speed dial 2:2001 HUNT-STAFF
paging-dn 90
Username:userB Password:ge30qe
Tapi client information

Username:userB status:REGISTERED Socket :[5]
 Tapi Client IP address: 192.168.1.5  Port:2295

The show ephone command describes significant fields in this output.

Related Commands

 
Description

show ephone

Displays statistical information about registered Cisco IP phones.


show ephone telephone-number

To display information for the phone associated with a specified number, use the show ephone telephone-number command in privileged EXEC mode.

show ephone telephone-number number

Syntax Description

number

Telephone number that is associated with an ephone.


Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(15)ZJ

Cisco CME 3.0
Cisco SRST 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0
Cisco SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.


Usage Guidelines

Use this command to find the phone on which a particular telephone number appears.

Examples

The following is sample output from the show ephone telephone-number:

Router# show ephone telephone-number 91400

DP tag: 0, primary
Tag 1, Normal or Intercom dn
  ephone 1, mac-address 000A.0E51.19F0, line 1

The show ephone command describes significant fields in this output.

Related Commands

 
Description

show ephone

Displays statistical information about registered Cisco IP phones.


show ephone unregistered

To display information about unregistered phones, use the show ephone unregistered command in privileged EXEC mode.

show ephone unregistered

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(15)ZJ

Cisco CME 3.0
Cisco SRST 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0
Cisco SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.


Usage Guidelines

There are two ways that an ephone can become unregistered. The first way is when an ephone is listed in the running configuration but no physical device has been registered for that ephone. The second way is when an unknown device was registered at some time after the last router reboot but has since unregistered.

Examples

The following is sample output from the show ephone unregistered:

Router# show ephone unregistered

ephone-1 Mac:0007.0E81.10F0 TCP socket:[-1] activeLine:0 UNREGISTERED
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0
IP:0.0.0.0 0 Unknown 0  keepalive 0 max_line 0

The show ephone command describes significant fields in this output.

Related Commands

 
Description

show ephone

Displays statistical information about registered Cisco IP phones.


show ephone-dn

To display status and information for a Cisco IP phone destination number or for extensions (ephone-dns) in a Cisco Unified CallManager Express (Cisco Unified CME) or Cisco Unified Survivable Remote Site Telephony (SRST) environment, use the show ephone-dn command in privileged EXEC mode.

show ephone-dn [dn-tag]

Syntax Description

dn-tag

(Optional) For Cisco Unified CME, a unique sequence number that is used during configuration to identify a particular extension (ephone-dn).

(Optional) For Cisco Unified SRST, a destination number tag. The destination number can be from 1 to 288.


Command Modes

Privileged EXEC (#)

Command History

Cisco IOS Release
Cisco Product
Modification

12.1(5)YD

Cisco CME 1.0
Cisco SRST 1.0

This command was introduced.

12.2(8)T

Cisco CME 2.0
Cisco SRST 2.0

This command was integrated into Cisco IOS Release 12.2(8)T command.


Examples

Cisco Unified CME

The following Cisco Unified CME sample output displays status and information for all ephone-dns:

Router# show ephone-dn

50/0/1 CH1 DOWN 
EFXS 50/0/1 Slot is 50, Sub-unit is 0, Port is 1
 Type of VoicePort is EFXS
 Operation State is UP
 Administrative State is UP
 No Interface Down Failure
 Description is not set
 Noise Regeneration is enabled
 Non Linear Processing is enabled
 Non Linear Mute is disabled
 Non Linear Threshold is -21 dB
 Music On Hold Threshold is Set to -38 dBm
 In Gain is Set to 0 dB
 Out Attenuation is Set to 0 dB
 Echo Cancellation is enabled
 Echo Cancellation NLP mute is disabled
 Echo Cancellation NLP threshold is -21 dB
 Echo Cancel Coverage is set to 8 ms
 Playout-delay Mode is set to adaptive
 Playout-delay Nominal is set to 60 ms
 Playout-delay Maximum is set to 200 ms
 Playout-delay Minimum mode is set to default, value 40 ms 
 Playout-delay Fax is set to 300 ms
 Connection Mode is normal
 Connection Number is not set
 Initial Time Out is set to 10 s
 Interdigit Time Out is set to 10 s
 Call Disconnect Time Out is set to 60 s
 Ringing Time Out is set to 180 s
 Wait Release Time Out is set to 30 s
 Companding Type is u-law
 Region Tone is set for US
 Station name None, Station number 91400

 Caller ID Info Follows:
 Standard BELLCORE
 Translation profile (Incoming): 
 Translation profile (Outgoing): 

 Digit Duration Timing is set to 100 ms

50/0/2 CH1 IDLE      CH2 IDLE        

EFXS 50/0/2 Slot is 50, Sub-unit is 0, Port is 2
 Type of VoicePort is EFXS
 Operation State is DORMANT
 Administrative State is UP
 No Interface Down Failure
 Description is not set
 Noise Regeneration is enabled
 Non Linear Processing is enabled
 Non Linear Mute is disabled
 Non Linear Threshold is -21 dB
 Music On Hold Threshold is Set to -38 dBm
 In Gain is Set to 0 dB
 Out Attenuation is Set to 0 dB
 Echo Cancellation is enabled
 Echo Cancellation NLP mute is disabled
 Echo Cancellation NLP threshold is -21 dB
 Echo Cancel Coverage is set to 8 ms
 Playout-delay Mode is set to adaptive
 Playout-delay Nominal is set to 60 ms
 Playout-delay Maximum is set to 200 ms
 Playout-delay Minimum mode is set to default, value 40 ms 
 Playout-delay Fax is set to 300 ms
 Connection Mode is normal
 Connection Number is not set
 Initial Time Out is set to 10 s
 Interdigit Time Out is set to 10 s
 Call Disconnect Time Out is set to 60 s
 Ringing Time Out is set to 180 s
 Wait Release Time Out is set to 30 s
 Companding Type is u-law
 Region Tone is set for US
 Station name None, Station number 91450

 Caller ID Info Follows:
 Standard BELLCORE
 Translation profile (Incoming): 
 Translation profile (Outgoing): 
 Digit Duration Timing is set to 100 ms

Cisco Unified SRST

The following SRST sample output displays status and information for all ephone-dns:

Router# show ephone-dn 7

50/0/7 INVALID     

EFXS 50/0/7 Slot is 50, Sub-unit is 0, Port is 7
 Type of VoicePort is EFXS
 Operation State is UP
 Administrative State is UP
 No Interface Down Failure
 Description is not set
 Noise Regeneration is enabled
 Non Linear Processing is enabled
 Non Linear Mute is disabled
 Non Linear Threshold is -21 dB
 Music On Hold Threshold is Set to -38 dBm
 In Gain is Set to 0 dB
 Out Attenuation is Set to 0 dB
 Echo Cancellation is enabled
 Echo Cancellation NLP mute is disabled
 Echo Cancellation NLP threshold is -21 dB
 Echo Cancel Coverage is set to 8 ms
 Playout-delay Mode is set to default
 Playout-delay Nominal is set to 60 ms
 Playout-delay Maximum is set to 200 ms
 Playout-delay Minimum mode is set to default, value 4 ms 
 Playout-delay Fax is set to 300 ms
 Connection Mode is normal
 Connection Number is not set
 Initial Time Out is set to 10 s
 Interdigit Time Out is set to 10 s
 Call Disconnect Time Out is set to 60 s
 Ringing Time Out is set to 8 s
 Wait Release Time Out is set to 30 s
 Companding Type is u-law
 Region Tone is set for US
 Station name None, Station number None

 Caller ID Info Follows:
 Standard BELLCORE

 Voice card specific Info Follows:
 Digit Duration Timing is set to 100 ms

Table 27 describes significant fields in the output from this command.

Table 27 show ephone-dn Field Descriptions  

Field
Description

Administrative State

Administrative (configured) state of the voice port.

alert

The number of calls that were disconnected by the far-end device when the local IP phone was in the call alerting state (for example, because the far-end phone rang but was not answered and the far-end system decided to drop the call rather than let the phone ring for too long).

answered (incoming)

The number of incoming calls that were actually answered (the phone goes off hook when ringing).

answered (outgoing)

The number of outgoing call attempts that were answered by the far end.

busy

The number of outgoing call attempts that got a busy response.

Call Disconnect Time Out

Not applicable to the Cisco IP phone.

called, calling

Extension numbers of called and calling parties.

Caller ID Info Follows

Information about the caller ID.

Call Ref

A unique per-call identifier used by the SCCP protocol. The Call Ref values are assigned sequentially within the Cisco CME-SCCP interface, so this value also indicates the total number of SCCP calls since the router was last rebooted.

chan

Channel number of an ephone-dn.

CODEC

Codec type.

Companding Type

Not applicable to the Cisco IP phone.

connect

The number of calls that were disconnected by the far-end device when the local IP phone was in the call connected state.

Connection Mode

Not applicable to the Cisco IP phone.

Connection Number

Not applicable to the Cisco IP phone.

Description

Not applicable to the Cisco IP phone.

Digit Duration Timing

Not applicable to the Cisco IP phone.

DN STATE

Ephone-dn tag number and state of the phone line associated with an extension.

Echo Cancellation...

Not applicable to the Cisco IP phone.

Echo Cancel Coverage

Not applicable to the Cisco IP phone.

EFXS

Voice port type.

Far-end disconnect at...

See connect, alert, hold, and ring.

Final Jitter

The final voice packet receive jitter reported by the IP phone at the end of the call.

hold

The number of calls that were disconnected by the far-end device when the local IP phone was in the call hold state (for example, if the caller was left on hold for too long and got tired of waiting).

incoming

The number of incoming calls presented (the phone rings).

In Gain

Not applicable to the Cisco IP phone.

Initial Time Out

Amount of time the system waits for an initial input digit from the caller.

Interdigit Time Out

Amount of time the system waits for a subsequent input digit from the caller.

Last 64 far-end disconnect cause codes

See the Mappings of PSTN Cause Codes to SIP Event table for a list of public switch telephone network (PSTN) cause codes that can be sent as an ISDN cause information element (IE) and the corresponding Session Interface Protocol (SIP) event.

Latency

The final voice packet receive latency reported by the IP phone at the end of the call.

Lost

Number of lost packets.

Music On Hold Threshold

Not applicable to the Cisco IP phone.

No Interface Down Failure

State of the interface.

Noise Regeneration

Not applicable to the Cisco IP phone.

Non Linear...

Not applicable to the Cisco IP phone.

Operation State

Operational state of the voice port.

Out Attenuation

Not applicable to the Cisco IP phone.

outgoing

The number of outgoing call attempts.

Playout-delay Maximum

Not applicable to the Cisco IP phone.

Playout-delay...

Not applicable to the Cisco IP phone.

Port

Port number for the interface associated with the voice interface card.

Region Tone

Not applicable to the Cisco IP phone.

ring

The number of calls that were disconnected by the far-end device when the local IP phone was in the ringing state (for example, if the call was not answered and the caller hung up).

Ringing Time Out

Duration, in seconds, for which ringing is to continue if a call is not answered. Set with the timeouts ringing command.

Rx Pkts, bytes

Number of packets and bytes received during the current or last call.

Signal Level to phone, peak

For G.711 calls only, this parameter indicates the most recent voice signal level in the voice IP packets sent from the router to the IP phone. This parameter is valid only for VoIP or PSTN G.711 calls to the IP phones. This parameter is not valid for calls between local IP phones, or calls that use codecs other than G.711. The peak field indicates the peak signal level seen during the entire call.

Slot

Slot used in the voice interface card for this port.

Station name

Station name.

Station number

Station number.

Sub-unit

Subunit used in the voice interface card for this port.

Tx Pkts, bytes

Number of packets and bytes transmitted during the current call or last call.

Type of VoicePort

Voice port type.

VAD

Voice activity detection.

Voice card specific info

Information specific to the voice card.

VPM STATE

State indication for the VPM software component.

VTSP STATE

State indication for the VTSP software component.

Wait Release Time Out

Time that a voice port stays in the call-failure state while the router sends a busy tone, reorder tone, or out-of-service tone to the port.


The following table lists the PSTN cause codes that can be sent as an ISDN cause information element (IE) and the corresponding SIP event for each. These are the far-end disconnect cause codes listed in the output for the show ephone-dn statistics command.

Table 28 Mappings of PSTN Cause Codes to SIP Events  

PSTN Cause Code
Description
SIP Event

1

Unallocated number

410 Gone

3

No route to destination

404 Not found

16

Normal call clearing

BYE

17

User busy

486 Busy here

18

No user responding

480 Temporarily unavailable

19

No answer from the user

21

Call rejected

603 Decline

22

Number changed

302 Moved temporarily

27

Destination out of order

404 Not found

28

Address incomplete

484 Address incomplete

29

Facility rejected

501 Not implemented

31

Normal unspecified

404 Not found

34

No circuit available

503 Service unavailable

38

Network out of order

41

Temporary failure

42

Switching equipment congestion

44

Requested channel not available

47

Resource unavailable

55

Incoming class barred within CUG

603 Decline

57

Bearer capability not authorized

501 Not implemented

58

Bearer capability not presently available

63

Service or option unavailable

503 Service unavailable

65

Bearer cap not implemented

501 Not implemented

79

Service or option not implemented

87

User not member of CUG

603 Decline

88

Incompatible destination

400 Bad Request

95

Invalid message

102

Recover on timer expiry

408 Request timeout

111

Protocol error

400 Bad request

127

Interworking unspecified

500 Internal server error

Any code other than those listed above

500 Internal server error


Related Commands

 
Description

show ephone-dn callback

Displays information about pending callbacks in a Cisco Unified CME or a Cisco Unified SRST environment.

show ephone-dn loopback

Displays information about loopback ephone-dns that have been created in a Cisco Unified CME or a Cisco Unified SRST environment.

show ephone-dn statistics

Displays display call statistics for a Cisco IP destination or for extensions (ephone-dns) in a Cisco Unified CME or a Cisco Unified SRST environment.

show ephone-dn summary

Displays brief information about Cisco IP phone destination numbers or for extensions (ephone-dns) in a Cisco Unified CME or a Cisco Unified SRST environment.


show ephone-dn callback

To display information about pending callbacks in a Cisco Unified CallManager Express (Cisco Unified CME) or a Cisco Unified Survivable Remote Site Telephony (Cisco Unified SRST) environment, use the show ephone-dn callback command in privileged EXEC mode.

show ephone-dn callback

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(15)ZJ

Cisco CME 3.0
Cisco SRST 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0
Cisco SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.


Examples

The following sample output shows a callback placed by ephone-dn 1 against ephone-dn 3. Ephone-dn 3 has its channel 1 on hold and has just seized dial tone on its channel 2.

Router# show ephone-dn callback

DN 3 (95021) CallBack pending to DN 1 (95021) for ephone-1 age 7 seconds
State for DN 3 is CH1 HOLD      CH2 SIEZE

The following sample output shows a callback placed by ephone-dn 1 against ephone-dn 3. Ephone-dn 3 has a call in progress on channel 1.

Router# show ephone-dn callback

DN 3 (95021) CallBack pending to DN 1 (95021) for ephone-1 age 8 seconds
State for DN 3 is CH1 CONNECTED

Significant fields in the output from this command are described in Table 29.

Table 29 show ephone-dn callback Field Descriptions 

Field
Description

DN 3 (95021) CallBack pending to DN 1 (95021)

Callback originator is the extension with the dn-tag 1 (in this example), and the callback has been placed on the extension with the dn-tag 3 and the number 95021.

age

Number of seconds since the callback was placed.

State for DN 3 is CH1... CH2...

Call states for channel 1 and channel 2, if any, of the extension that the callback is for.


Related Commands

 
Description

show ephone-dn

Displays status and information for a Cisco IP phone destination number or for extensions (ephone-dns) in a Cisco Unified CME or a Cisco Unified SRST environment.


show ephone-dn conference

To display information about ad hoc and meet-me conferences in a Cisco Unified CallManager Express (Cisco Unified CME) environment, use the show ephone-dn conference command in privileged EXEC mode.

show ephone-dn conference [ad-hoc | meetme | number number]

Syntax Description

ad-hoc

(Optional) Ad hoc conferences.

meetme

(Optional) Meet-me conferences.

number number

(Optional) Conference telephone or extension number.


Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(11)XJ2

Cisco Unified CME 4.1

This command was introduced.

12.4(15)T

Cisco Unified CME 4.1

This command was integrated into Cisco IOS Release 12.4(15)T.

15.0(1)XA

Cisco Unified CME 8.0

This command was modified. The command output was enhanced to display the unlocked meet-me conference setting.


Examples

The following sample output displays information for the 1234 conference number. There are three directory numbers and six inactive parties.

Router# show ephone-dn conference number 1397

type   active inactive  numbers
==================================
Meetme    0       6      1397
DN tags: 10, 11, 12
Unlocked DN tags: 2/3

Meetme    0       4      2486
DN tags: 13, 14
All DN tags unlocked.

Meetme    0       4      1111
DN tags: 15, 16

Ad-hoc    0       4      7777
DN tags: 20, 21

Table 30 describes the significant fields shown in the display.

Table 30 show ephone-dn conference Field Descriptions 

Field
Description

active

Number of active parties in the conference.

DN tags

Directory numbers (DNs) in the conference.

inactive

Number of inactive parties in the conference.

number

Conference telephone or extension number.

type

Type of conference: meet-me or ad hoc.


Related Commands

Command
Description

show ephone-dn

Displays status and information for a Cisco IP phone destination number or for extensions (ephone-dns) in a Cisco Unified CME or a Cisco Unified SRST environment.


show ephone-dn loopback

To display information about loopback ephone-dns that have been created in a Cisco Unified CallManager Express (Cisco Unified CME) or a Cisco Unified Survivable Remote Site Telephony (Cisco Unified SRST) environment, use the show ephone-dn loopback command in privileged EXEC mode.

show ephone-dn loopback

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.1(5)YD

Cisco CME 1.0
Cisco SRST 1.0

This command was introduced.

12.2(8)T

Cisco CME 2.0
Cisco SRST 2.0

This command was integrated into Cisco IOS Release 12.2(8)T.


Examples

The following example displays information for a loopback using ephone-dn 21 and ephone-dn 22:

Router# show ephone-dn loopback

LOOPBACK DN status (min 21, max 22):
DN 21 51...  Loopback to DN 22 CH1 IDLE
CallingDn -1 CalledDn -1 Called   Calling   G711Ulaw64k
Strip NONE, Forward 2, prefix 10 retry 10 Media 0.0.0.0 0
callID 0 srcCallID 0 ssrc 0 vector 0
DN 22 11...  Loopback to DN 21 CH1 IDLE
CallingDn -1 CalledDn -1 Called   Calling   G711Ulaw64k
Strip NONE, Forward 2, prefix 50 retry 10 Media 0.0.0.0 0
callID 0 srcCallID 0 ssrc 0 vector 0

Significant fields in the output from this command are described in Table 31, in alphabetical order.

Table 31 show ephone-dn loopback Field Descriptions 

Field
Description

Called, Calling

Called number and calling number when there is a call present.

CalledDn, CallingDn

Ephone-dn tag numbers of the called and calling ephone-dn. Set to -1 if the call is not to or from an ephone-dn, or if there is no active call.

callID

Internal call reference. This usage is the same as in other Cisco IOS voice gateway commands.

DN

Ephone-dn tag (sequence number).

Forward

Number of digits in the original called number to forward to the other ephone-dn in the loopback-dn pair.

G711...

G711Ulaw64k indicates G.711 codec, mu-law, 64000-bit stream. G711alaw64k indicates G.711 codec, A-law, 64000-bit stream.

Loopback to command...

Indicates the opposite ephone-dn in the loopback pair and the status of that ephone-dn.

Media

IP destination address, if any, for any voice packets that are passing through the loopback DN.

min, max

Lowest and highest dn-tag numbers of ephone-dns that are configured as loopback-dns.

prefix

Digit string to add to the beginning of forwarded called numbers.

retry

Number of seconds to wait before retrying the loopback target when is it busy.

srcCallID

Internal call reference for the destination.

ssrc

Real-time transport protocol (RTP) synchronization source (SSRC) of the most recent RTP packet.

Strip

Number of leading digits to strip before forwarding to the other extension in the loopback-dn pair.

vector

The following values describe the media path for voice packets that pass through the loopback-dn:

0—No media path or not a loopback-dn path (inactive).

1—Normal path. Loopback-dn has identified the final media destination as a local IP phone. The media IP address field shows a valid, non-zero value.

2—Hairpin. Media packets are routed back through paired loopback-dns. The final destination is not known. For example, this can be a VoIP-to-VoIP call path by a loopback-dn.

3—Hairpin. The final destination is an ephone-dn in a special mode such as paging.

4—Loopback-dn chain has been detected, in which two loopback-dn pairs have been connected together.

5—Loopback-dn chain has been detected in which more than two loopback-dn pairs are connected in series.


Related Commands

 
Description

loopback-dn

Creates a virtual loopback voice port (loopback-dn) to establish a demarcation point for VoIP voice calls and supplementary services.

show ephone-dn

Displays status and information for a Cisco IP phone destination number or for extensions (ephone-dns) in a Cisco Unified CME or a Cisco Unified SRST environment.


show ephone-dn park

To display information about call-park slots in the system, use the show ephone-dn park command in privileged EXEC mode.

show ephone-dn park

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.3(7)T

This command was introduced.


Examples

The following example shows information for a single call-park slot that uses an ephone-dn identifier of 50 and an extension number of 1560.

Router# show ephone-dn park

DN 50 (1560) park-slot state IDLE
Notify to () timeout 15 limit 20

Table 32 describes the significant fields shown in the display.

Table 32 show ephone-dn park Field Descriptions 

Field
Description

DN

Ephone-dn tag (identifier) number for the call-park slot.

(1560)

Extension number associated with the call-park slot.

park-slot state

Whether the call-park slot is in use or idle.

Notify to ( )

Extension that has been specified for notification. Empty parentheses indicate that no extension was specified in the configuration.

timeout

Number of seconds between reminder rings, in seconds.

limit

Number of reminder rings before a call parked at this slot is disconnected.


Related Commands

 
Description

park-slot

Creates a floating extension (ephone-dn) at which calls can be temporarily held (parked).


show ephone-dn statistics

To display call statistics for a Cisco IP destination or for extensions (ephone-dns) in a Cisco Unified CallManager Express (Cisco Unified CME) or a Cisco Unified Survivable Remote Site Telephony (Cisco Unified SRST) environment, use the show ephone-dn command in privileged EXEC mode.

show ephone-dn [dn-tag] statistics

Syntax Description

dn-tag

(Optional) Unique sequence number that is used during configuration to identify a particular extension (ephone-dn).

statistics

Displays voice quality statistics on calls for a specified extension or for all extensions.


Command Modes

Privileged EXEC

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(15)ZJ1

Cisco CME 3.0
Cisco SRST 3.0

This command was introduced.

12.3(4)T

Cisco CME 3.0
Cisco SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.


Examples

The following sample output displays statistics for all extensions (ephone-dns) in a Cisco Unified CME system. There are two ephone-dns (DN1 and DN3) in this example.

Router# show ephone-dn statistics

Total Calls 103
Stats may appear to be inconsistent for conference or shared line cases

DN 1 chan 1 incoming 36 answered 21 outgoing 60 answered 30 busy 6
Far-end disconnect at:connect 29 alert 18 hold 7 ring 15
Last 64 far-end disconnect cause codes
17 17 17 17 17 17 16 16 16 16 16 16 16 16 16 16
16 16 16 16 65 16 65 65 65 65 16 65 65 65 16 16
16 16 16 16 16 16 16 16 16 16 16 16 16 65 47 65
47 47 16 16 16 16 16 16 16 16 16 16 16 16 16 16
local phone on-hook

DN 1 chan 1 (95011) voice quality statistics for last call
Call Ref 103 called 91500 calling 95011
Total Tx Pkts 0 bytes 0 Rx Pkts 0 bytes 0 Lost 0
Final Jitter 30 Latency 0 Lost 0
Signal Level to phone 0 (-78 dB) peak 0 (-78 dB)
Packets counted by router 0

DN 1 chan 2 incoming 0 answered 0 outgoing 1 answered 0 busy 0
Far-end disconnect at:connect 0 alert 0 hold 0 ring 0
Last 64 far-end disconnect cause codes
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
local phone on-hook

DN 1 chan 2 (95011) voice quality statistics for last call
Call Ref 86 called  calling
Total Tx Pkts 0 bytes 0 Rx Pkts 0 bytes 0 Lost 0
Final Jitter 0 Latency 0 Lost 0
Signal Level to phone 0 (-78 dB) peak 0 (-78 dB)
Packets counted by router 0

DN 3 chan 1 incoming 0 answered 0 outgoing 1 answered 1 busy 0
Far-end disconnect at:connect 0 alert 0 hold 0 ring 0
Last 64 far-end disconnect cause codes
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

DN 3 chan 1 (95021) voice quality statistics for current call
Call Ref 102 called 94011 calling 95021
Current Tx Pkts 241 bytes 3133 Rx Pkts 3304 bytes 515023 Lost 0
Jitter 30 Latency 0
Worst Jitter 30 Worst Latency 0
Signal Level to phone 201 (-39 dB) peak 5628 (-12 dB)
Packets counted by router 3305

The following sample output displays voice quality statistics for the ephone-dn with dn-tag 2:

Router# show ephone-dn 2 statistics

DN 2 chan 1 incoming 0 answered 0 outgoing 2 answered 0 busy 0
Far-end disconnect at: connect 0 alert 0 hold 0 ring 0
Last 64 far-end disconnect cause codes
28 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 
local phone on-hook

DN 2 chan 1 (91450) voice quality statistics for last call
Call Ref 2 called  calling 
Total Tx Pkts 0 bytes 0 Rx Pkts 0 bytes 0 Lost 0
Final Jitter 0 Latency 0 Lost 0
Signal Level to phone 0 (-78 dB) peak 0 (-78 dB)
Packets counted by router 0

The show ephone-dn command describes significant fields in the output from this command.

Related Commands

 
Description

show ephone-dn

Displays status and information for a Cisco IP phone destination number or for extensions (ephone-dns) in a Cisco Unified CME or a Cisco Unified SRST environment.


show ephone-dn summary

To display brief information about Cisco IP phone destination numbers or for extensions (ephone-dns) in a Cisco Unified CallManager Express (Cisco Unified CME) or a Cisco Unified Survivable Remote Site Telephony (Cisco Unified SRST) environment, use the show ephone-dn summary command in privileged EXEC mode.

show ephone-dn summary

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC (#)

Command History

Cisco IOS Release
Cisco Product
Modification

12.1(5)YD

Cisco CME 1.0
Cisco SRST 1.0

This command was introduced.

12.2(8)T

Cisco CME 2.0
Cisco SRST 2.0

This command was integrated into Cisco IOS Release 12.2(8)T.


Examples

The following is example output from the show ephone-dn summary:

Router# show ephone-dn summary

PORT     DN STATE    CODEC    VAD VTSP STATE            VPM STATE
======== ==========  ======== === ===================== =========
50/0/1   DOWN        -         -  -                     EFXS_ONHOOK             
50/0/2   DOWN        -         -  -                     EFXS_ONHOOK             
50/0/3   DOWN        -         -  -                     EFXS_ONHOOK             
50/0/4   INVALID     -         -  -                     EFXS_INIT               
50/0/5   INVALID     -         -  -                     EFXS_INIT               
50/0/6   INVALID     -         -  -                     EFXS_INIT 

Table 33 describes significant fields in the output from this command.

Table 33 show ephone-dn summary Field Descriptions  

Field
Description

CODEC

Type of codec.

DN STATE

Status of the ephone-dn.

EFXS

Voice port type.

PORT

Port number (virtual) for this interface. The number that follows the last slash in the port number is the ephone-dn tag. For example, if the port number is 50/0/1, the dn-tag is 1.

VAD

Voice activity detection status.

VPM STATE

State indication for the voice port module (VPM) software component.

VTSP STATE

State indication for the voice telephony service provider (VTSP) software component.


Related Commands

 
Description

show ephone-dn

Displays status and information for a Cisco IP phone destination number or for extensions (ephone-dns) in a Cisco Unified CME or a Cisco Unified SRST environment.


show ephone-dn whisper

To display information about whisper intercom ephone-dns that have been created in Cisco Unified CME, use the show ephone-dn whisper command in privileged EXEC mode.

show ephone-dn whisper

Syntax Description

This command has no arguments or keywords.

Command Modes

User EXEC (>)
Privileged EXEC (#)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(22)YB

Cisco Unified CME 7.1

This command was introduced.

12.4(24)T

Cisco Unified CME 7.1

This command was integrated into Cisco IOS Release 12.4(24)T.


Examples

The following is sample output from the show ephone-dn whisper command showing an active whisper intercom call between extension 6001 and 6002:

Router# show ephone-dn whisper

 

DN DN NUMBER LABEL SPEED DIAL DN STATE PHONE

== ========= ===== ========== ======== =====

101 8881 wi_8881 - IDLE 35 w36

102 8882 - - IDLE 36

103 8883 wi_8883 - IDLE m35 38

104 8884 wi_8884 - IDLE 38

105 8885 wi_8885_sd_8888882 IDLE

106 8886 wi_8886_sd_8888883 IDLE 36

107 8887 - 8888 IDLE 35

108 8888 Mary_sd_Peter 8887 IDLE 36

109 8889 - - IDLE

110 8890 wi_8890 - IDLE

111 4441 4441_wi_sd_4444442 IDLE

112 4442 wi_4442 - IDLE

113 4443 - - IDLE

114 4444 4444_sd-8882 8882 IDLE

141 5551 -