CME Command Reference

Cisco Systems, Inc. www.cisco.com

Cisco has more than 200 offices worldwide. Addresses, phone numbers, and fax numbers are listed on the Cisco website at www.cisco.com/go/offices.

Cisco Unified Communications Manager Express Command ReferenceJuly 25, 2013

Text Part Number: OL-10894-03

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCBs public domain version of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)

Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.

Cisco Unified Communications Manager Express Command Reference OL-10894-03

2005-2013 Cisco Systems, Inc. All rights reserved.

C O N T E N T S

Preface v

Obtaining Documentation, Obtaining Support, and Security Guidelines v

Additional References v

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Later xxv

Cisco Unified CME Commands: A 35

Cisco Unified CME Commands: B 97

Cisco Unified CME Commands: C 131

Cisco Unified CME Commands: D 281

Cisco Unified CME Commands: Debug 333

Cisco Unified Commands: E 417

Cisco Unified CME Commands: F 469

Cisco Unified CME Commands: G 507

Cisco Unified CME Commands: H 515

Cisco Unified CME Commands: I 549

Cisco Unified CME Commands: K 581

Cisco Unified CME Commands: L 599

Cisco Unified CME Commands: M 647iiiCisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: N 731

Cisco Unified CME Commands: O 789

Cisco Unified CME Commands: P 797

Cisco Unified CME Commands: R 961

REVIEW DRAFTCISCO CONF IDENT IALCisco Unified CME Commands: sast1 trustpoint through show ip address trusted list 995

Cisco Unified CME Commands: show presence global through subnet 1141

Cisco Unified CME Commands: T 1355

Cisco Unified CME Commands: U 1441

Cisco Unified CME Commands: V 1481

Cisco Unified CME Commands: W 1561

Cisco Unified CME Commands: X 1569

I N D E XivCisco Unified CME Command Reference

OL-10894-03

Preface

Revised: March 8, 2007

Obtaining Documentation, Obtaining Support, and Security Guidelines

For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation at: http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html.

Additional ReferencesCisco Unified Communications Manager Express:http://www.cisco.com/en/US/products/sw/voicesw/ps4625/tsd_products_support_series_home.html

Cisco Unified IP Phones:http://www.cisco.com/en/US/products/sw/voicesw/ps4625/products_user_guide_list.htmlCisco SIP Configuration Guide:http://www.cisco.com/en/US/docs/ios/voice/sip/configuration/guide/12_4t/sip_12_4t_book.htmlCisco Unified SRST:http://www.cisco.com/en/US/products/sw/voicesw/ps2169/tsd_products_support_series_home.htmlCisco 12.4T Release:http://www.cisco.com/en/US/products/ps6441/tsd_products_support_series_home.htmlvCisco Unified CME Command Reference

OL-10894-03

REVIEW DRAFTCISCO CONF IDENT IAL

Additional ReferencesTHE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCBs public domain version of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)

Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.

Cisco Unified Communications Manager Express Command Reference OL-10894-01

2005-2013 Cisco Systems, Inc. All rights reserved.viCisco Unified CME Command Reference

OL-10894-03

OL-10894-03

param queue-len 852param queue-manager-debug 856param queue-overflow-extension 854param secondary-prefix 858param second-greeting-time 860param send-account true 862param service-name 864

s

s

sast1 trustpoint 996ast2 trustpoint 997erver 1014Revised: July 30, 2013 First Published: October 22, 2009

A

application-parameter configurationparam aa-hunt 813param aa-pilot 815param call-retry-timer 818param co-did-max 821param co-did-min 823param dial-by-extension-option 825param did-prefix 827param drop-through-option 829param drop-through-prompt 831param ea-password 833param hand-off string 835param max-extnsion-length 837param max-time-call-retry 839param max-time-vm-retry 842param menu-timeout 844param number-of-hunt-grps 846param queue-exit-extension 848param queue-exit-option 850Command List by Config Mode

param store-did-max 866param store-did-min 868param voice-mail 870param welcome-prompt 872apply-config 66

B

bandwidth video tias-modifier 100, 101

C

camera 210CAPF-server configuration

auth-mode 74cert-enroll-trustpoint 215keygen-retry 593phone-key-size 899port 917source-addr 1330trustpoint-label 1425

credentials configurationctl-service admin 278ip source-address 575trustpoint 1423

CTL-client configurationregenerate 966IN-viiCisco Unified CME Command Reference

IndexD

dial peer configurationlpcor outgoing 640

dial-peer configurationb2bua 98emergency response callback 427emergency response location 429emergency response zone 431mailbox-selection 651paramspace callsetup after-hours-exempt 876

E

ephonegroup phone 508

ephone configurationafter-hour exempt 43, 45auto-line 89blf-speed-dial 103busy-trigger-per-button 112button 117capf-auth-str 212codec 234conference add-mode 242conference admin 245, 248description 285device-security-mode 298dnd feature-ring 322emergency response location 429ephone-template 453fastdial 478feature-button 480headset auto-answer line 516keepalive 582keep-conference 588keypad-normalize 594keyphone 595IN-viiiCisco Unified CME Command Reference

logout-profile 632lpcor incoming 638lpcor outgoing 640lpcor type 643mac-address 648max-calls-per-button 654missed-calls 678mtp 700multicast-moh 706mwi-line 724night-service bell 751nte-end-digit-delay 770paging-dn 807park reservation-group 878phone-ui speeddial-fastdial 903pin 912presence call-list 935privacy (ephone) 940privacy-button 948provision-tag 958reset 970reset tapi 979restart 980speed-dial 1333trantsfer-park blocked 1400trantsfer-pattern blocked 1404username 1476video 1488vm-device-id 1493

ephone template configurationafter-hours block pattern 47lpcor incoming 638lpcor outgoing 640

ephone-dn configurationallow watch 58caller-id 164caller-id block 166call-forward all 177call-forward busy 189OL-10894-03

call-forward max-length 192

Indexcall-forward night-service 194call-forward noan 196call-waiting beep 206call-waiting ring 208conference 239cor 256corlist 260cti notify 271cti watch 273description 286ehone-dn-template 441ephone-hunt login 446feed 486forward local-calls 494hold-alert 522huntstop 541intercom 560label 600loopback-dn 635mailbox-selection 653mobility 687moh 690moh-group 699mwi 708mwi qsig 714mwi sip 719mwi-type 727name 732night-service bell 753number 773paging 798paging group 803park-slot 881pickup-call any-group 904pickup-group 906preference 923ring 987session-server 1052OL-10894-03

snr 1296snr calling-number local 1300timeouts transfer-recall 1376transfer-mode 1398translate 1411translation-profile 1417trunk 1420whisper-intercom 1567

ephone-dn configuration (config-ephone) 466ephone-dn template configuration

timeouts transfer-recall 1376ephone-dn-template configuration

allow watch 58caller-id block 166call-forward all 177call-forward busy 189call-forward max-length 192call-forward night-service 194call-forward noan 196call-waiting beep 206call-waiting ring 208cti notify 271cti watch 273description 286hold-alert 522huntstop 541mwi 708mwi qsig 714mwi sip 719mwi-type 727pickup-group 906translate 1411translation-profile 1417

ephone-hunt configurationauto logout 83description 288display-logout 320final 491forward local-calls 494IN-ixCisco Unified CME Command Reference

from-ring 499

Indexfwd-final 501hops 526list 604max-timeout 673name 734no-reg 767pilot 908preference 925present-call 938secondary start 1006statistics collect 1348timeout 1367

ephone-templatgroup phone 508

ephone-template configurationafter-hour exempt 43, 45after-hours date 50after-hours day 52after-hours override-code 54busy-trigger-per-button 112button-layout 125codec 234conference add-mode 242conference admin 245, 248emergency response location 429fastdial 478feature-button 480features blocked 484keepalive 582keep-conference 588keypad-normalize 594keyphone 595lpcor type 643max-calls-per-button 654mlpp indication 679mlpp max-precedence 681mlpp preemption 683mlpp service-domain 685IN-xCisco Unified CME Command Reference

mtp 700multicast-moh 706network-locale 741night-service bell 751nte-end-digit-delay 770paging-dn 807park reservation-group 878privacy (ephone) 940privacy-button 948service https 1035service phone 1040softkeys alerting 1307softkeys connected 1309softkeys hold 1313softkeys idle 1315softkeys remote-in-use 1319softkeys ringing 1324softkeys seized 1326speed-dial 1333transfer max-length 1391trantsfer-park blocked 1400trantsfer-pattern blocked 1404url services 1458user-locale 1464

ephone-type configurationdevice-id 293device-name 295device-type 296max-presentation 669num-buttons 784phoneload 900security 1011utf8 1479

G

global configuration 1537call application voice aa-hunt 132call application voice aa-name 134OL-10894-03

call application voice aa-pilot 136

Indexcall application voice call-retry-timer 138call application voice dial-by-extension-option 140call application voice drop-through-prompt 143call application voice handoff-string 144call application voice max-extension-length 145call application voice max-time-call-retry 146call application voice max-time-vm-retry 148call application voice number-of-hunt-grps 149call application voice queue-manager-debugs 153call application voice second-greeting-time 155call application voice voice-mail 158call application voice welcome-prompt 160capf-server 214credentials 267ctl-client 277ephone 435ephone-dn 437ephone-dn-template 439ephone-hunt 443, 677ephone-template 450ephone-type 456integration 1494presence 933telephony-service 1356voice emergency response location 1501voice emergency response settings 1503voice emergency response zone 1505voice hunt-group 1507voice logout-profile 1510voice mlpp 1526voice moh-group 1527voice register dialplan 1529voice register dn 1531voice register global 1533voice register pool 40, 292, 513, 786, 901, 965, 1360, 1378, 1535, 1570voice register session-server 1540voice register template 1542OL-10894-03

voice user-profile 1544group configurationip source-address 577url 1452

L

lpcor custom configurationgroup 510

lpcor ip-phone subnet configurationindex 556

lpcor IP-trunk subnet configurationindex 558

lpcor policy configurationaccept 37

P

presence configurationmax-subscription 672presence call-list 935server 1016

privileged execclear voice fac statistics 218clear voice register attempted-registrations 220

S

SIP configurationregistrar server 968

SIP UA configurationpresence enable 937refer-ood enable 964

standby username password 1347

T

telephony-service configurationafter-hour login http 45IN-xiCisco Unified CME Command Reference

after-hours block pattern 47

Indexafter-hours date 50after-hours day 52after-hours override-code 54after-hours pstn-prefix 56application 61authentication credential 72auto assign 79auto-reg-ephone 93bulk-speed-dial-prefix 110caller-id block code 170call-forward 173call-forward pattern 199calling-number local 201call-park system 204cnf-file 229cnf-file location 232codec 237conference hardware 252create cnf-files 262date-format 282device-security-mode 298dialplan-pattern 303directory 316directory entry 318dn-webedit 325em external 422em keep-history 433em logout 434extension-assigner tag-type 464fac 471fxo hook-flash 503group 511hunt-group logout 531hunt-group report delay hours 534hunt-group report every hours 536internal-call 565ip qos dscp 573ip source-address 577IN-xiiCisco Unified CME Command Reference

keepalive 584live-record 609load 613load-cfg-file 620log password 625log table 626login 629max-conferences 656max-dn 658max-ephones 662max-redirect 671moh 693moh-file-buffer 697multicast moh 704mwi expires 711mwi prefix 712mwi reg-e164 716mwi relay 718mwi sip-server 721network-locale 744night-service code 755night-service date 757night-service day 759night-service everyday 761night-service weekday 763night-service weekend 765privacy 942privacy-on-hold 952protocol-mode 956reset 972restart 982sdspfarm 998, 1001sdspfarm conference mute-on mute-off 1000sdspfarm transcode sessions 1003sdspfarm units 1004sdspfarm unregister force 1005secondary-dialtone 1008secure-signaling trustpoint 1010server-security-mode 1018OL-10894-03

service directed-pickup 1021

Indexservice dnis dir-lookup 1023service dnis overlay 1027service dss 1033service https 1036service local-directory 1039service phone 1040srst dn line-mode 1340srst dn template 1342srst ephone description 1343srst ephone template 1344srst mode auto-provision 1345standby username password 1347system message 1351tftp-server-credentials trustpoint 1364time-format 1365timeouts busy 1371timeouts interdigit 1372timeouts night-service-bell 1374timeouts ringing 1373timeouts transfer-recall 1376time-webedit 1380time-zone 1383transfer-digit-collect 1388transfer-pattern 1402transfer-system 1408url 1452url authentication 1446url idle 1457user-locale 1467, 1473video 1492voicemail 1546web admin custome 1562web admin system 1564web customize load 1566xml user 1572xmlschema 1573xmltest 1574xmlthread 1575OL-10894-03

trunk group configurationlpcor incoming 638lpcor outgoing 640

V

video 1486video configuration

maximum bit-rate 666voice emergency response location configuration

address 41elin 418name 738subnet 1353

voice emergency response settings configurationcallback 162elin 420expiry 462logging 627

voice emergency response zone configurationlocation 623

voice hunt-group configurationdefault 284description 289final 493hops 528list 607name 736pilot 910preference 927timeout 1369

voice logout-profile configurationfeature-button 480number 778pin 914privacy-button 948reset 976speed-dial 1336user 1460IN-xiiiCisco Unified CME Command Reference

voice MLPP configuration

Indexattendant-console 69bnea 105bpa 106ica 550loc2 621preemption reserve timer 918preemption tone timer 919preemption trunkgroup 921preemption user 922

voice moh-group configurationdescription 290extension-range 466moh 695

voice port configurationlpcor incoming 638lpcor outgoing 640

voice register dialplan configurationfilename 489pattern 887type 1433

voice register dn configurationallow watch 58auto-answer 87call-forward b2bua all 179call-forward b2bua busy 181call-forward b2bua mailbox 183call-forward b2bua noan 185call-forward b2bua unreachable 187huntstop 545label 602mwi 710name 740no-reg 769number 776pickup-call any-group 904pickup-group 906preference 929refer target dial-peer 962IN-xivCisco Unified CME Command Reference

session-server 1052shared-line 1056translation-profile incoming 1419

voice register globalbandwidth video tias-modifier 101camera 210privacy-on-hold 953tftp-path 1363

voice register global configurationapplication 62authenticate 70bulk 108call-feature-uri 171call-forward 175conference hardware (voice register global) 254create profile 265date-format 283dialplan-pattern 310dst 326dst auto-adjust 328external-ring 468forwarding local 498hold-alert 525ip qos dscp 573logo 631max-dn 660max-pool 667mode 689mwi reg-e164 717mwi stutter 723ntp-server 772outbound-proxy system 792phone-redirect-limit 902privacy 944reset 977restart 985service https 1037source-address 1331time-format 1366OL-10894-03

timezone 1385

Indexupgrade 1444url 1455voicemail 1547

voice register poolcamera 210

voice register pool configurationapplication 64blf-speed-dial 103busy-trigger-per-button 114call-forward b2bua all 179call-forward b2bua busy 181call-forward b2bua mailbox 183call-forward b2bua noan 185call-forward b2bua unreachable 187call-waiting 205conference add-mode (voice register) 244conference admin (voice register) 247conference drop-mode (voice register) 250cor 257description 291dialplan 301digit collect kpml 313dnd 321dtmf-relay 329emergency response location 429id 552keep-conference 591lpcor incoming 638lpcor outgoing 640lpcor type 643number 782park reservation-group 878preference 931presence call-list 935privacy initial-state 946privacy-button 950reset 978restart 985OL-10894-03

session-server 1052session-transport 1054speed-dial 1338template 1361transfer max-length 1392, 1396transfer-pattern blocked 1406translate-outgoing 1415type 1428, 1437username 1478vad 1482voice-class codec 1496

voice register session-server configurationkeepalive 585register-id 967

voice register templatecamera 210

voice register template configurationanonymous block 60button-layout (voice register template) 127caller-id block 168conference 241conference add-mode (voice register) 244conference admin (voice register) 247conference drop-mode (voice register) 250dialplan 301digit collect kpml 313dnd-control 324emergency response location 429lpcor incoming 638lpcor outgoing 640lpcor type 643park reservation-group 878privacy initial-state 946privacy-button 950semi-attended enable 1012session-transport 1054softkeys idle 1317softkeys remote-in-use 1320softkeys ringing 1322IN-xvCisco Unified CME Command Reference

transfer max-length 1392, 1396

Indextransfer-attended 1394transfer-blind 1395transfer-pattern 1406vad 1483voicemail 1548

voice service configurationlpcor incoming 638

voice session-server configurationcti-aware 275

voice user-profile configurationfeature-button 480max-idle-time 664number 778pin 914privacy-button 948reset 976speed-dial 1336user 1462

voice-gateway system configurationcreate cnf-files 263mac-address 650network-locale 749reset 975restart 984type 1432voice-port 1528

voice-mail integration configurationpattern direct 889pattern ext-to-ext busy 891pattern ext-to-ext no-answer 893pattern trunk-to-ext busy 895pattern trunk-to-ext no-answer 897

voice-moh-group configurationmulticast moh 704

voice-port configurationmlpp indication 679mlpp max-precedence 681mlpp preemption 683IN-xviCisco Unified CME Command Reference

mlpp service-domain 685voice-service configurationcti csta mode basic 269cti message device-id suppress-conversion 270OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Later

Revised: February 27, 2009First Published: October 22, 2009

New, modified, replaced, and removed commands for Cisco Unified Communications Manager Express 4.0 (Cisco Unified CME) and later versions are grouped by Cisco IOS release and type, and ordered alphabetically within each group. Use the table of contents to go to a group of commands, or use your web browser's Find function to search for a command. To access the documentation for a command, click the highlighted page number following the command name.xviiCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Later12.4(4)XC

New Commands

auth-mode 63auto-reg-ephone 78bulk-speed-dial list 91bulk-speed-dial prefix 94call-forward night-service 174call-forward system (voice register) command 155call-forward system command 153call-park system 184capf-auth-str 190capf-server 192cert-enroll-trustpoint 193cert-oper (CAPF-server) 195clear telephony-service ephone-attempted-registrations 202clear telephony-service xml-event-log 203cnf-file 205cnf-file location 207codec (ephone) 209codec (telephony-service) 212ctl-client 245ctl-service admin 246description (ephone-hunt) 256device-security-mode 264dialplan-pattern (voice register) 271display-logout 279ephone-dn-template 391ephone-dn-template (ephone-dn) 393ephone-hunt login 398ephone-hunt statistics write-all 400fac 418features blocked 429forward local-calls 439from-ring 442headset auto-answer line 450hunt-group logout 458keygen-retry 507xviiiCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Laterkeypad-normalize 508load-cfg-file 530mailbox-selection (ephone-dn) 561maximum bit-rate (telephony-video) 574max-timeout command 581mtp 601multicast-moh 605mwi-line 623mwi prefix 611mwi qsig 613network-locale (ephone-template) 635param co-did-max 700param co-did-min 702param did-prefix 706param secondary-prefix 737param send-account true 741param store-did-max 745param store-did-min 747phone-key-size 776port (CAPF-server) 792present-call 813regenerate 837ring (ephone-dn) 858sast1 trustpoint 862sast2 trustpoint 863secondary start 870secure-signaling trustpoint 873server (CTL-client) 877server-security-mode 881service directed-pickup 884show capf-server 914show ctl-client 920show ephone attempted-registratrations 926softkeys hold 1080source-addr 1097srst dn line-mode 1107srst dn template 1109srst ephone template 1111srst mode auto-provision 1112xixCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Latertftp-server-credentials trustpoint 1129transfer max-length 1151transfer-park blocked 1156transfer-pattern blocked command 1160trustpoint-label 1177user-locale (ephone-template) 1208video (ephone) 1226video (telephony-service) 1228xml user 1288

Modified Commands

after-hour exempt 36auto assign 65auto-line 76auto logout 70button 100caller-id block (ephone-dn and ephone-dn-template) 146call-forward all 157call-forward busy 169call-forward max-length 172call-forward noan 176call-waiting beep 186call-waiting ring 188create cnf-files 232credentials 235description (ephone-dn and ephone-dn-template) 254ephone-hunt 395ephone-template 402ephone-template (ephone) 405fastdial 423hold-alert 452hops 455hunt-group report url 464huntstop (ephone-dn and ephone-dn-template) 469ip source-address (credentials) 493ip source-address (telephony-service) 495keepalive (ephone and ephone-template) 498keep-conference 502xxCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Laterlist (ephone-hunt) 516load (telephony-service) 523log password 535mwi (ephone-dn and ephone-dn-template) 607mwi sip 618mwi sip-server 620network-locale (telephony service) 637night-service bell 645paging-dn 689park-slot 759pickup-group 782show credentials 916show ephone 921softkeys connected 1076softkeys idle 1082softkeys seized 1093speed-dial 1100timeout (ephone-hunt) 1132transfer-system 1162translate (ephone-dn) 1165translation-profile 1169trunk 1172trustpoint (credentials) 1175type 1178user-locale (telephony-service) 1210

Obsolete Commands

xmlschema 1290xmltest 1291xmlthread 1292

12.4(4)XC4

New Commands

button-layout 108extension-assigner tag-type 412mwi-type 626xxiCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Laterparam ea-password 712provision-tag 831service dss 896

Modified Commands

auto assign 65load (telephony-service) 523show ephone 921type 1178

12.4(6)XE

New Commands

button-layout 108mwi-type 626service dss 896

Modified Commands

auto assign 65load (telephony-service) 523show ephone 921type 1178

12.4(11)XJ

New Commands

allow watch command 50call-feature-uri 151dialplan 266digit collect kpml 274extension-assigner tag-type 412fastdial (voice register pool) 425filename 434max-subscription 580param ea-password 712pattern (voice register dialplan) 764presence 808xxiiCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Laterpresence call-list 810presence enable 812provision-tag 831refer-ood enable 836restart (voice register) 856server (presence) 879session-transport 910show presence global 984show presence subscription 986softkeys seized (voice register template) 1095translation-profile incoming 1171type (voice register dialplan) 1184

Modified Commands

authenticate (voice register global) 59call-forward b2bua all 159call-forward b2bua busy 161call-forward b2bua mailbox 163call-forward b2bua noan 165load (voice register global) 527number (voice register pool) 676type (voice register pool) 1186voice register template 1271

Removed Commands

caller-id block (voice register template) 148call-forward b2bua unreachable 167

12.4(11)XJ2

New Commands

clear telephony-service conference hardware number 201conference (ephone-dn) 215conference add-mode 218conference admin 220conference drop-mode 222conference hardware 224xxiiiCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Latersdspfarm conference mute-on mute-off command 864

Modified Commands

auto assign 65button 100load (telephony-service) 523login (telephony-service) 539show ephone 921show telephony-service ephone-template 1013softkeys connected 1076softkeys hold 1080softkeys idle 1082softkeys seized 1093type 1178

12.4(11)XW

New Commands

logout-profile 542reset (voice logout-profile and voice user-profile) 847session-server 908softkeys ringing 1091speed-dial (voice rlogout-profile and voice user-profile) 1103url services 1202user (voice logout-profile) 1204user (voice user-profile) 1206voice logout-profile 1243voice user-profile 1273

Modified Commands

device-security-mode 264

12.4(11)XW2

New Commands

keepalive (voice register session-server) 501pin (voice logout-profile and voice user-proifle) 790xxivCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Laterrefer target dial-peer 834register-id 838voice register session-server 1269

12.4(11)XW3

Modified Commands

auto assign 65load (telephony-service) 523show ephone 921

12.4(11)XW5

New Commands

11xw5a timeouts night-service-bell 1138

12.4(15)XY

New Commands

address (voice emergency response location) 34after-hours override-code 46after-hours pstn-prefix 48callback (voice emergency response settings) 142elin (voice emergency response settings) 372expiry 410keepalive (voice register session-server) 501location (voice emergency response zone) 533logging (voice emergency response settings) 537logout-profile 542name (voice emergency response location) 632pin (voice logout-profile and voice user-profile) 790refer target dial-peer 834register-id 838reset (voice logout-profile and voice user-profile) 847session-serverr 908xxvCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Latershow voice emergency 1022show voice emergency addresses 1023show voice emergency all 1025show voice emergency zone 1028softkeys ringing 1091speed-dial (voice rlogout-profile and voice user-profile) 1103standby username password 1114url service 1202user (voice logout-profile) 1204user (voice user-profile) 1206voice emergency response settings 1236voice emergency response zone 1238voice logout-profile 1243voice register session-server 1269voice user-profile 1273

Modified Commands

after-hours block pattern 40after-hours date 42after-hours day 44device-security-mode 264emergency response callback 379emergency response location 381emergency response zone 383show telephony-service ephone-template 1013show voice emergency callers 1027show voice register pool 1055show voice register template 1063subnet 1118voice emergency response location 1234

12.4(15)XZ

New Commands

addon 33authentication credential 61busy-trigger-per-button 96device-id 259xxviCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Laterdevice-name 261device-type 262em keep-history 385em logout 386ephone-type 408keepalive (voice register session-server) 501live-record 521logout-profile 542max-calls-per-button 562max-idle-time 572max-presentation 577missed-calls all 582num-buttons 678outbound-proxy system 682phoneload 777phone-ui speeddial-fastdial 779pin (voice logout-profile and voice user-profile) 790privacy (ephone) 815privacy (telephony-service) 817privacy-button 823privacy-on-hold 827refer target dial-peer 834register-id 838reset (voice logout-profile and voice user-profile) 847security 874session-server 908softkeys remote-in-use 1086softkeys ringing 1091speed-dial (voice rlogout-profile and voice user-profile) 1103timeouts transfer-recall 1140transfer-digit-collect 1149url authentication 1193url services 1202user (voice logout-profile) 1204user (voice user-profile) 1206utf8 1219voice logout-profile 1243voice register session-server 1269voice user-profile 1273xxviiCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and LaterModified Commands

codec (ephone) 209codec (telephony-service) 212codec (voice register pool) 213device-security-mode 264ephone-dn 389, 427ephone-template (ephone) 405fac 418huntstop (ephone-dn and ephone-dn-template) 469list (voice hunt-group) 519load (telephony-service) 523load (voice register global) 527max-ephones 570service phone 899softkeys connected 1076srst dn line-mode 1107type 1178type (voice register dialplan) 1184type (voice register pool) 1186voice hunt-group 1240

12.4(15)T

New Commands

type 1178

12.4(15)T1

Modified Commands

elin 370emergency response callback 379emergency response location 381emergency response zone 383show voice emergency callers 1027subnet 1118voice emergency response location 1234xxviiiCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Later12.4(20)YA

New Commands

reset tapi 850

Modified Commands

load (telephony-service) 523param max-time-call-retry 718user-locale (telephony-service) 1210

12.4(20)T

New Commands

nte-end-digit-delay 664

Modified Commands

auto assign 65

12.4(20)T1

Modified Commands

type 1178

12.4(22)YA

New Commands

param queue-exit-extension 727param queue-exit-option 729param queue-overflow-extension 731

Modified Commands

param menu-timeout 723xxixCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Later12.4(22)T

New Commands

server-security-mode 881url (telephony service) 1195

12.4(22)YB

New Commands

debug ephone whisper-intercom 355create cnf-files (voice-gateway) 233debug ephone mlpp 329debug shared-line 361ip qos dscp (telephony-service and voice regoster global) 490mac-address (voice-gateway) 558mobility (ephone-dn) 591netwrok-locale (voice-gateway) 643park reservation-group 757pickup-call any-group 780privacy (voice register global) 819privacy (voice register pool) 821privacy-button (voice register pool) 825privacy-on-hold (voice register global) 828reset (voice-gateway) 846restart (voice-gateway) 855shared-line 912show ephone-dn whisper 950show shared-line 996snr 1071softkeys remote-in-use (voice register template) 1087softkeys ringin (voice register template) 1089type (voice-gateway) 1183voice-gateway system 1239voice-port (voice-gateway) 1260whisper-intercom 1285bnea 86bpa 87xxxCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Latermlpp indication 583mlpp max-precedence 585mlpp preemption 587preemption reserve timer 793preemption tone timer (voice MLPP) 794preemption trunkgroup 796preemption user 797voice mlpp 125824YFa clear cti session 198

Modified Commands

busy-trigger-per-button (voice register pool) 98call-feature-uri 151call-park system 184fac 418huntstop (voice register dn) 473max-dn (voice register global) 568max-pool (voice register pool) 575park-slot 759pickup-group 782service directed-pickup 884show presence subscription 986softkeys connected 1076softkeys idle 1082

12.4(24)T

New Commands

access-digit 32attendant-console 58

12.4(24)T1

Modified Commands

max-redirect 579xxxiCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and Later15.0(1)XA

New Commands

accept 30after-hour login http 38clear voice lpcor statistics 199, 204clear voice moh-group statistics 200cti-aware 244cti csta mode basic 197, 237cti message device-id suppress-conversion 238cti notify 239cti shutdown 241cti watch 242debug cti 302debug ephone lpcor 326description (voice moh-group) 257emadmin login 376emadmin logout 378em external 374extension-range 414feature-button 427ica 478index (lpcor ip-phone) 481index (lpcor ip-trunk) 483internal-call 488loc2 531lpcor outgoing 550lpcor type 553lpor incoming 548mlpp service-domain 589moh-file-buffer 598moh-group (ephone-dn) 600protocol-mode (telephony-service) 829show cti 918show voice moh-group 1032show voice moh-group statistics 1034voice moh-group 1259xxxiiCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and LaterModified Commands

fac 418multicast moh 603show ephone summary 945url (telephony-service) 1195xxxiiiCisco Unified CME Command Reference

OL-10894-03

New, Modified, Replaced, and Removed Commands for Cisco Unified CME 4.0 and LaterxxxivCisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: A

Revised: July 25, 2013

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.35Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aata-ivr-pwdata-ivr-pwdTo define a password to access interactive voice response (IVR) and change the default phone settings on Cisco Analog Telephone Adaptors, use the ata-ivr-pwd command in voice register pool configuration mode. To return to the default, use the no form of the command.

ata-ivr-pwd password

no ata-ivr-pwd

Syntax Description

Command Default No valid password is set.

Command Modes Voice register pool configuration (config-register-pool)

Command History

Examples The following example shows how 1234 is defined as the password to access IVR on Cisco ATA-187:voice service voip allow-connections sip to sip fax protocol t38 version 0 ls-redundancy 0 hs-redundancy 0 fallback pass-through g711ulaw

voice register pool 11 ata-ivr-pwd 1234 id mac 93FE.12D8.2301 session-transport tcp type ATA-187number 1 dn 33 username ata112 password cisco codec g711ulaw

Related Commands

password Four-digit string to be used as password to access IVR. Password string must contain numbers 0 to 9.

Release Modification

15.2(2)T This command was introduced.

Command Description

voice register pool Enters voice register pool configuration mode and creates a pool configuration for Cisco Unified SIP IP phones in Cisco Unified CME.36Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: AacceptacceptTo allow a logical partitioning class of restriction (LPCOR) policy to accept calls associated with another resource-group, use the accept command in LPCOR policy configuration mode. To reject calls associated with a resource group, use the no form of this command.

accept lpcor-group [fac]

no accept lpcor-group

Syntax Description

Command Default Calls from other resource groups are rejected.

Command Modes LPCOR policy configuration (cfg-lpcor-policy)

Command History

Usage Guidelines Use this command to create a LPCOR policy by specifying the other resource groups from which this resource group can accept calls. If a resource group is not explicitly set to accept with this command, calls associated with that resource-group policy are rejected. You can create one LPCOR policy for each resource group.

If you create a LPCOR policy using the voice lpcor policy command and do not explicitly accept any other resource groups by using the accept command, that policy blocks all incoming calls associated with any LPCOR resource group other than its own.The fac keyword in the accept command restricts the caller from routing to a destination LPCOR group without entering a valid authorization code.

Examples The following example shows the LPCOR policy for the resource group named sccp_phone_local. It accepts calls from the resource groups analog_phone_local and sip_phone_local but rejects calls from the group named analog_phone_remote because it is not included in the policy.voice lpcor policy sccp_phone_local accept analog_phone_local accept sip_phone_local

lpcor-group Name of the LPCOR resource group.fac Enables forced authorization code for calls from this resource group.

Cisco IOS Release Cisco Product Modification

15.0(1)XA Cisco Unified CME 8.0 This command was introduced.15.1(1)T Cisco Unified CME 8.0 This command was integrated into Cisco IOS

Release 15.1(1)T.15.1(3)T Cisco Unified CME 8.5 This command was modified. The fac keyword

was added to the accept command.37Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: AacceptThe following example shows that sccp_phone_local blocks calls that are associated with any other LPCOR policy because its policy does not accept other resource groups.voice lpcor policy sccp_phone_local

The following example shows that the policy local_phone is configured to not accept any calls associated with itself. SIP phone 1 and SCCP phone 2 both belong to the local_phone resource group and its policy prevents them from accepting calls from each other.voice register pool 1 lpcor type local lpcor incoming local_phone lpcor outgoing local_phone id mac 0021.A02D.B360 type 7960 number 1 dn 1!voice lpcor custom group 1 local_phone group 2 remote_phone group 3 analog_phone!voice lpcor policy local_phone no accept local_phone accept analog_phone!ephone 2 lpcor type local lpcor incoming local_phone lpcor outgoing local_phone mac-address 0021.A02D.B580 type 7960 button 1:10

The following example shows that the authorization code is requried by callers who belong to the LocalUser group and RemoteUser group.!voice lpcor policy PSTNTrunk service fac accept Manager accept LocalUser fac accept RemoteUser fac no accept PSTNTrunk no accept IPTrunk

Related Commands Command Description

show voice lpcor policy Displays the LPCOR policy for the specified resource group.voice lpcor custom Defines the LPCOR resource groups on the Cisco Unified CME router.voice lpcor policy Creates a LPCOR policy for a resource group.38Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aaccess-digitaccess-digitTo define the access digit that phone users dial to request a precedence call, use the access-digit command in voice MLPP configuration mode. To reset to the default, use the no form of this command.

access-digit digit

no access-digit

Syntax Description

Command Default Access digit is 0.

Command Modes Voice MLPP configuration (config-voice-mlpp)

Command History

Usage Guidelines This command defines the MLPP access digit that a user must dial when making a precedence call. Phone users request a precedence call by dialing the prefix NP, where N is the preconfigured MLPP access digit and P is the requested precedence level, followed by the phone number.

Note Your domain type must support the access digit that you select. For example, the valid range for the DSN is 2 to 9.

Examples The following example shows the MLPP access digit set to 6:Router(config)# voice mlppRouter(config-voice-mlpp)# access-digit 6

Related Commands

digit Single-digit number users dial. Range: 0 to 9. Default: 0.

Cisco IOS Release Modification

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

Command Description

mlpp preemption Enables preemption capability on an SCCP phone or analog FXS port.preemption trunkgroup Enables preemption capability on a trunk group.preemption user Enables preemption capability for all supported phones.39Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: AaddonsaddonsTo define the maximum number of add-on modules supported by the new Cisco Unified SIP IP phone on Cisco Unified CME, use the the addons command in voice register pool-type mode. To remove the support for the add-on modules for this new SIP phone type, use the no form of this command.

addons max-addons

no addons max-addons

Syntax Description

Command Default The default value is 0.

Note When the reference-pooltype command is configured, the add-on module value of the reference phone is inherited.

Command Modes Voice register pool-type configuration (config-register-pooltype)

Command History

Usage Guidelines When you use the no form of this command, the inherited properties of the reference phone takes precedence over the default value.

Examples The following example shows how to enter the voice register pool-type configuration mode, and define the maximum number of add-on modules for a Cisco Unified SIP IP phone on Cisco Unified CME:Router(config)# voice register pool 1Router(config-register-pool-type)# type 9900 addon 1 CKEM 2 CKEM 3 CKEM Router(config-register-pool-type)# id mac 1234.4567.7891

Related Commands

max-addons Maximum number of add-on modules that can be configured while defining the pool for the phone. The fange is from1 to 3.


15.3(3)M Cisco Unified CME 10.0 This command was introduced.

Command Description

type Defines a phone type for a SIP phone.voice register pool-type

Adds a new Cisco Unified SIP IP phone to Cisco Unified CME.40Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aaddress (voice emergency response location)address (voice emergency response location)To define the civic address for an ERL that is used for the ALI database upload, use the address command in voice emergency response location mode. To remove this definition, use the no form of the command. This command is optional.

address string

no address

Syntax Description

Command Default The civic address is not defined.

Command Modes Voice emergency response location configuration (cfg-emrgncy-resp-location)

Command History

Usage Guidelines Use this command to create a comma separated text entry of the ERLs civic address. The address information must be entered to conform with the NENA-2 Data Record specifications or the recommendations by the service provider.

Examples In this example, a civic address is displayed for ERL 60.voice emergency response location 60subnet 1 209.165.200.224 255.255.0.0elin 1 4085550100name Cookies and More Incorporated,address I,408,5550100,,11902,,,Main Street,Emerald City,CA,Idina Menzel,1,,,,,,

Related Commands

string String (1-247 characters) used to identify an ERLs civic address.


12.4(15)XY Cisco Unified CME 4.2(1) Cisco Unified SRST 4.2(1) Cisco Unified SIP SRST 4.2(1)

This command was introduced.

12.4(20)T Cisco Unified CME 7.0 Cisco Unified SRST 7.0 Cisco Unified SIP SRST 7.0

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

Command Description

elin Specifies a PSTN number that will replace the callers extension.41Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aaddress (voice emergency response location)name Specifies a string (up to 30 characters) used internally to identify or describe the emergency response location.

subnet Defines which IP phones are part of this ERL.

Command Description42Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aafter-hour exemptafter-hour exemptTo specify that an individual IP phone in Cisco Unified CME does not have any of its outgoing calls blocked even though after-hour call blocking has been enabled, use the after-hour exempt command in ephone or ephone-template configuration mode. To remove the exemption, use the no form of this command.

after-hour exempt

no after-hour exempt

Syntax Description This command has no arguments or keywords.

Command Default The SCCP phone is not exempt from call blocking.

Command Modes Ephone configuration (config-ephone) Ephone-template configuration (config-ephone-template)

Command History

Usage Guidelines Use this command to exempt an individual SCCP phone from call blocking and enable the phone user to place outgoing calls regardless of whether the outgoing called number matches the defined pattern of digits during the call blocking periods.By default, all IP phones in a Cisco Unified CME system are subject to call blocking if the Call Blocking feature is configured. If you use an ephone template to apply a command to a phone and you also use the same command in ephone configuration mode for the same phone, the value that you set in ephone configuration mode has priority.

Examples The following example shows how to configure this phone so that outgoing calls are not blocked:Router(config)# ephone 23Router(config-ephone)# mac 00e0.8646.9242Router(config-ephone)# button 1:33Router(config-ephone)# after-hour exempt


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.12.4(4)XC Cisco Unified CME 4.0 This command was made available in

ephone-template configuration mode.12.4(9)T Cisco Unified CME 4.0 This command in the ephone-template

configuration mode was integrated into Cisco IOS 12.4(9)T.43Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aafter-hour exemptRelated Commands Command Description

after-hours block pattern

Defines a pattern of digits for blocking outgoing calls from IP phones.

after-hours date Defines a recurring period based on date during which outgoing calls that match defined block patterns are blocked on IP phones.

after-hours day Defines a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones.44Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aafter-hour login httpafter-hour login httpTo unblock an individual IP phone in Cisco Unified CME that is configured for after-hour call blocking, use the after-hour login http command in ephone, telephony-service or ephone-template configuration mode. To disable after-hour login http feature, use the no form of the command.

after-hour login htpp

no after-hour login htpp


Command Default The after-hour login http feature is not enabled.

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

Command History

Usage Guidelines Use this command to log in to a phone to unblock the after hour block and enable the phone user to place outgoing calls regardless of whether the outgoing called number matches the defined pattern of digits during the call blocking periods.When you configure after-hours login http command, you will experience slightly different login behavior compare to the current one. This difference is because the after hours login mechanism is enhanced due to some UI limitation in the current model. By default, after-hours login http is not applied, which mean user will be using the existing after hours login mechanism.By default, all IP phones in a Cisco Unified CME system are subject to call blocking if the Call Blocking feature is configured. If you use an ephone template to apply a command to a phone and you also use the same command in ephone configuration mode for the same phone, the value that you set in ephone configuration mode has priority.

Examples The following example shows how to configure this phone with pin login so that outgoing calls are not blocked:Router(config)# ephone 6Router(config-ephone)# mac 00e0.8646.242Router(config-ephone)# button 1:33Router(config-ephone)# Pin 123


15.0(1)XA Cisco Unified CME 8.0 This command was introduced.15.1(1)T Cisco Unified CME 8.0 This command was integrated into Cisco IOS

Release 15.1(1)T.45Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aafter-hour login httpRouter(config-ephone)# after-hour login http



Defines a pattern of digits for blocking outgoing calls from IP phones.


after-hours day Defines a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones.46Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aafter-hours block patternafter-hours block patternTo define a pattern of outgoing digits for Call Blocking from IP phones, use the after-hours block pattern command in telephony-service or ephone-template configuration mode. To delete a call-blocking pattern, use the no form of this command.

after-hours block pattern pattern-tag pattern [7-24]

no after-hours block pattern pattern-tag

Syntax Description

Command Default No pattern is defined.

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

Command History

pattern-tag Identifier for a call-blocking pattern. Up to 100 call-blocking patterns can be defined in separate commands.

pattern Outgoing call digits to be matched for blocking, including specific digit patterns and general regular expressions.

7-24 (Optional) If the 7-24 keyword is specified, the pattern is always blocked, 7 days a week, 24 hours a day. If the 7-24 keyword is not specified, the pattern is blocked during the days and dates that are defined with the after-hours day and after-hours date commands.



Release 12.3(4)T.12.4(4)T Cisco CME 3.4 Support for this command was extended to all

SCCP, H.323, SIP, and POTS calls that go through the Cisco Unified CME router, including all incoming calls to the router, except calls from an exempt phone.

12.4(15)XY Cisco Unified CME 4.2(1) This command was added to ephone-template configuration mode.

12.4(15)XZ Cisco Unified CME 4.3 This command was added to ephone-template configuration mode.

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

15.3(2)T Cisco Unified CME 9.5 This command was modified to include regular expressions as a value for the pattern argument.47Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aafter-hours block patternUsage Guidelines Call Blocking on IP phones is defined in the following way. First, one or more patterns of outgoing digits (0-9) are defined using the after-hours block pattern command. Next, one or more time periods during which calls that match those patterns are to be blocked are defined using the after-hours date or after-hours day command or both. By default, all IP phones in a Cisco Unified CME system are restricted during the specified time if at least one pattern and at least one time period are defined.Before Cisco CME 3.4, Call Blocking is supported on IP phones and on analog phones connected to SCCP-controlled analog telephone adaptors (Cisco ATA) or SCCP-controlled foreign exchange station (FXS) ports. In Cisco CME 3.4 and later, the call-blocking configuration applies to all SCCP, H.323, SIP and POTS calls that go through the Cisco Unified CME router. All incoming calls to the router, except calls from an exempt phone, are also checked against the after-hours configuration.Individual phones can be exempted from call blocking using the after-hour exempt or the after-hours override-code command.Blocked calls return a fast-busy tone to the user for approximately 10 seconds before the call is terminated and the line is returned to on-hook status.In Cisco Unified CME 9.5 and Cisco Unified SRST 9.5, support for afterhours pattern blocking is extended to regular expression patterns for dial plans on Cisco Unified SIP and Cisco Unified SCCP IP phones. With this support, users can add a combination of fixed dial plans and regular expression-based dial plans.When a call is initiated after hours, the dialed number is matched against a combination of dial plans. If a match is found, the call is blocked.To enable regular expression patterns to be included when configuring afterhours pattern blocking, the after-hours block pattern command is modified to include regular expressions as a value for the pattern argument.

Note The maximum length of a regular expression pattern is 32 for both Cisco Unified SIP and Cisco Unified SCCP IP phones.

For a summary of the basic Cisco IOS regular expression characters and their functions, see the Cisco Regular Expression Pattern Matching Characters section of Terminal Services Configuration Guide.

Examples The following example defines pattern 1, which blocks international calls after hours for a Cisco Unified CME system that requires dialing 9 for external calls:Router(config)# telephony-serviceRouter(config-telephony)# after-hours block pattern 1 9011 48Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aafter-hours block patternThe following example shows how to configure several afterhours block patterns of regular expressions:Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.

Router(config)# telephony-service

Router(config-telephony)# after-hours block pattern 1 ? WORD Specific block pattern or a regular expression for after-hour block pattern

Router(config-telephony)# after-hours block pattern 1 1234Router(config-telephony)# after-hours block pattern 2 .TRouter(config-telephony)# after-hours block pattern 3 987654([1-3])+Router(config-telephony)# after-hours block pattern 4 98765432[1-9]Router(config-telephony)# after-hours block pattern 5 98765(432|422|456)


after-hour exempt Specifies that an IP phone does not have any of its outgoing calls blocked although call blocking is defined.


after-hours day Defines a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones.

after-hours override-code

Specifies that call blocking on an IP phone can be overridden by entering a defined code.

after-hours pstn-prefix

Specifies that trunk lines on an IP phone are blocked similarly to that configured for nonPSTN lines.

ephone-template (ephone)

Applies template to a SCCP phone.49Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aafter-hours dateafter-hours dateTo define a recurring period based on date during which outgoing calls that match defined block patterns are blocked on IP phones, use the after-hours date command in ephone-template or telephony-service configuration mode. To delete a defined time period, use the no form of this command.

after-hours date month date start-time stop-time

no after-hours date month date

Syntax Description

Command Default No time period based on date is defined for call blocking.

Command Modes Ephone-template configuration (config-ephone-temp)Telephony-service configuration (config-ephone)

Command History

Usage Guidelines Use this command to define call blocking that recurs annually on the date specified in the command. Call blocking on IP phones is defined as follows: First, one or more patterns of outgoing digits (0-9) are defined using the after-hours block pattern

command. Next, one or more time periods during which calls that match those patterns are to be blocked are

defined using the after-hours date or after-hours day command or both.

month Abbreviated month. The following abbreviations for month are valid: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.

date Date of the month. Range is from 1 to 31.start-time stop-time

Beginning and ending times for call blocking, in an HH:MM format using a 24-hour clock. The stop time that is entered will be the next available time that follows the start time. The value 24:00 is not valid. If 00:00 is entered as a stop time, it is changed to 23:59. If 00:00 is entered for both start time and stop time, calls are blocked for the entire 24-hour period on the specified date.



Release 12.3(4)T.12.4(15)XY Cisco Unified CME 4.2(1) This command was added to ephone-template

configuration mode.12.4(15)XZ Cisco Unified CME 4.3 This command was added to ephone-template

configuration mode.12.4(20)T Cisco Unified CME 7.0 This command was integrated into

Cisco IOS Release 12.4(20)T.50Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aafter-hours dateBy default, all IP phones in a Cisco Unified CME system are restricted during the specified time if at least one pattern and at least one time period are defined. Individual IP phones can be exempted from call blocking using the after-hour exempt or after-hours override-code commands.

Examples The following example defines January 1 as an entire day on which calls that match the pattern specified in the after-hours block pattern command are blocked:Router(config)# telephony-serviceRouter(config-telephony)# after-hours date jan 1 00:00 00:00




Defines a pattern of digits (0-9) for blocking outgoing calls from IP phones.



Specifies that call blocking on an IP phone can be overridden by entering a defined set of digits (0-9).




Applies template to SCCP phone.51Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aafter-hours dayafter-hours dayTo define a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones, use the after-hours day command in ephone-template or telephony-service configuration mode. To delete a defined time period, use the no form of this command.

after-hours day day start-time stop-time

no after-hours day day

Syntax Description

Command Default No time period based on day of the week is defined for call blocking.

Command Modes Ephone-template configuration (config-ephone-template)Telephony-service configuration (config-ephone)

Command History

Usage Guidelines Use this command to define call blocking during the hours between the start time and stop time on the day of the week that is specified in this command. This time period recurs weekly unless it is removed using the no form of this command.Call blocking on IP phones is defined as follows: First, one or more patterns of outgoing digits (0-9) are defined using the after-hours block pattern

command.

day Abbreviated day of the week. The following abbreviations for day of the week are valid: sun, mon, tue, wed, thu, fri, sat.

start-time stop-time

Beginning and ending times for call blocking, in an HH:MM format using a 24-hour clock. The stop time that is entered will be the next available time that follows the start time. The value 24:00 is not valid. If 00:00 is entered as a stop time, it is changed to 23:59. If 00:00 is entered for both start time and stop time, calls are blocked for the entire 24-hour period on the specified day.



Release 12.3(4)T.12.4(15)XY Cisco Unified CME 4.2(1) This command was added to ephone-template

configuration mode.12.4(15)XZ Cisco Unified CME 4.3 This command was added to ephone-template



OL-10894-03

Cisco Unified CME Commands: Aafter-hours day Next, one or more time periods during which calls that match those patterns are to be blocked are defined using the after-hours date or after-hours day command or both.

By default, all IP phones in a Cisco Unified CME system are restricted during the specified time if at least one pattern and at least one time period are defined. Individual phones can be exempted from call blocking using the after-hour exempt or after-hours override-code commands.

Examples The following example defines the period from Monday night at 7 p.m. to Tuesday morning at 7 a.m. as an after-hours call-blocking period:Router(config)# telephony-serviceRouter(config-telephony)# after-hours day mon 19:00 07:00







Specifies that call blocking on an IP phone can be overridden by entering a defined set of digits (0-9).




Applies template to SCCP phone.53Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aafter-hours override-codeafter-hours override-codeTo specify that a defined blocking pattern can be overridden, use the after-hours override-code command in ephone-template or telephony-service configuration mode. To remove the exemption, use the no form of this command.

after-hours override-code pattern

no after-hours override-code pattern

Syntax Description

Command Default No override is defined.

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

Command History

Usage Guidelines Use this command to allow a phone user to override call blocking rules and enable the phone user to place outgoing calls regardless of whether the outgoing called number matches the defined pattern of digits during the call blocking periods. By default, all IP phones in a Cisco Unified CME system are subject to call blocking if the Call Blocking feature is configured. By entering the override code as defined by the system administrator, the phone user can override all call blocking rules.The after-hours override-code command, configured by either ephone-template or telephony-service, overrides any global telephony-service call block configuration. If the after-hour exempt command is configured, it has priority over the after-hours override-code command.

Examples The following example defines a blocking pattern using telephony-service configuration which can be overridden using the override code of 1234:Router(config)# telephony-serviceRouter(config-telephony)# after-hours block pattern 1 91900Router(config-telephony)# after-hours day mon 19:00 07:00

pattern Specifies the pattern of digits (0-9) that must be dialed by the phone user to override the call blocking rules. The override code is provided to the phone user by the system administrator.


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 added to ephone-template



OL-10894-03

Cisco Unified CME Commands: Aafter-hours override-codeRouter(config-telephony)# after-hours date Jan 25 00:00 07:00Router(config-telephony)# after-hours override-code 1234








Specifies that trunk lines on an IP phone are blocked similarly to that configured for non PSTN lines.


Applies a template to an ephone.55Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aafter-hours pstn-prefixafter-hours pstn-prefixTo specify that all configured blocking patterns apply to trunk or PSTN lines, use the after-hours pstn-prefix command in telephony-service configuration mode. To delete call blocking configuration for PSTN lines, use the no form of this command.

after-hours pstn-prefix tag pattern

no after-hours pstn-prefix tag pattern

Syntax Description

Command Default No pattern is defined.

Command Modes Telephony-service configuration

Command History

Usage Guidelines Use the after-hours pstn-prefix command to indicate that the after-hours call blocking patterns are configured to include one or more PSTN access digits that are normally dialed by phone users using regular ephone-dn lines. For example, the patterns are configured with a leading digit 9 to correspond to the conventional dial 9 for outside line. The after-hours pstn-prefix command instructs the system to skip over the PSTN prefix digits (in the blocking patterns) for calls that are dialed directly to the PSTN on ephone-dns that are configured using the trunk feature. These lines do not require the user to dial a PSTN access code (for example, 9) because they are configured to directly connect to the PSTN FXO ports. For example, a user of a regular ephone-dn would dial 9-1-900-xxx-xxxx, whereas a user on a trunk ephone-dn would omit the leading 9 and dial only 1-900-xxx-xxxx. The blocking pattern would be configured as 91900 to restrict calls on regular ephone-dn lines, and this pattern would be interpreted as 1900 on ephone-dns configured using the trunk feature. If you do not specify the after-hours pstn-prefix command, then no blocking is performed on calls dialed on trunk ephone-dn lines.Call blocking on IP phones is defined as follows: First, one or more patterns of outgoing digits (0-9) are defined using the after-hours block pattern

command. Next, one or more time periods during which calls that match those patterns are to be blocked are

defined using the after-hours date, the after-hours day, or both commands.

tag Identifier for a PSTN call-blocking pattern. Up to 4 call-blocking patterns can be defined in separate commands.

pattern Outgoing call digits (0-9) to be matched for PSTN blocking.


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 added to ephone-template



OL-10894-03

Cisco Unified CME Commands: Aafter-hours pstn-prefixBy default, all IP phones in a Cisco Unified CME system are restricted during the specified time if at least one pattern and at least one time period are defined. Blocked calls return a fast-busy tone to the user for approximately 10 seconds before the call is terminated and the line is returned to on-hook status.

Examples The following example defines a blocking pattern using telephony-service configuration which is applied to a PSTN line:Router(config)# telephony-serviceRouter(config-telephony)# after-hours block pattern 1 91900Router(config-telephony)# after-hours pstn-prefix 1 9Router(config-telephony)# after-hours day mon 19:00 07:00Router(config-telephony)# after-hours date Jan 25 00:00 07:00








Specifies that call blocking on an IP phone can be overridden by entering a defined series of digits (0-9).57Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aallow watchallow watchTo allow a directory number on a phone registered to Cisco Unified CME to be watched in a presence service, use the allow watch command in ephone-dn, ephone-dn-template, or voice register dn configuration mode. To reset to the default condition, use the no form of this command.

allow watch

no allow watch


Command Default Watching of the phone line is disabled.

Command Modes Ephone-dn configuration (config-ephone) Ephone-dn-template configuration (config-ephone-dn-template) Voice register dn configuration (config-register-dn)

Command History

Usage Guidelines This command controls whether a phone line associated with a directory number can be watched as part of a presence service. The directory number is enabled as a presentity that can be watched by internal and external watchers. Presence service must be enabled on Cisco Unified CME. Another phone, acting as a watcher, can monitor the status of this phone line when the blf-speed-dial or presence call-list command is enabled for that phone. If you use an ephone-dn template to apply a command to a directory number and you also use the same command in ephone-dn configuration mode, the value that you set in ephone-dn configuration mode has priority over the ephone-dn template configuration.

Examples The following example shows that the extension associated with voice register dn 2 can be watched by the phone associated with voice register pool 1:Router(config)# voice register dn 2Router(config-register-dn)# number 2102Router(config-register-dn)# allow watch

Router(config)# voice register pool 1Router(config-register-pool)# id mac 0015.6247.EF90Router(config-register-pool)# type 7971Router(config-register-pool)# number 1 dn 2Router(config-register-pool)# blf-speed-dial 1 2102 label 2102


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.58Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aallow watchRelated Commands Command Description

blf-speed-dial Enables Busy Lamp Field (BLF) monitoring for a speed-dial number on a phone registered to Cisco Unified CME.

presence Enables presence service and enters presence configuration mode.presence call-list Enables BLF monitoring for call lists and directories on phones registered to

Cisco Unified CME.presence enable Allows the router to accept incoming presence requests.show presence global Displays configuration information about the presence service.show presence subscription

Displays information about active presence subscriptions.59Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aanonymous blockanonymous blockTo enable anonymous call blocking in a SIP phone template, use the anonymous block command in voice register template configuration mode. To return to the default, use the no form of this command.

anonymous block

no anonymous block


Command Default Disabled

Command Modes Voice register template configuration (config-register-temp)

Command History

Usage Guidelines This command blocks incoming calls in which the caller is not identified. To apply a template to a SIP phone, use the template command in voice register pool configuration mode.

Examples The following example shows how to set anonymous call blocking in template 1:Router(config)# voice register template 1Router(config-register-temp)# anonymous block

Related Commands


12.4(4)T Cisco CME 3.4 This command was introduced.

Command Description

caller-id block (voice register template)

Enables caller-ID blocking for outbound calls from a SIP phone.

template (voice register pool)

Applies a template to a SIP phone.60Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aapplication (telephony-service)application (telephony-service)To select a session-level application for all extensions (ephone-dns) in a Cisco Unified CME, use the application command in telephony-service configuration mode. To disable use of an application for all extensions, use the no form of this command.

application application-name

no application

Syntax Description

Command Default No application is selected for all extensions.

Command Modes Telephony-service configuration (config-telephony)

Command History

Usage Guidelines Use this command to assign a Tool Command Language (Tcl) IVR application to all extensions served by the CME router. Use the show call application voice summary command to display a list of applications.

Examples The following example sets the IVR application for all phones:Router(config)# telephony-serviceRouter(config-telephony) application TCL IVR

Related Commands

application-name Interactive voice response (IVR) application name.


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.

Command Description

show call application voice summary

Displays information about voice applications.61Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aapplication (voice register global)application (voice register global)To select the session-level application for all dial peers associated with Session Initiation Protocol (SIP) phones, use the application command in voice register global configuration mode. To disable use of the application, use the no form of this command.


no application

Syntax Description

Command Default Default application on router

Command Modes Voice register global configuration (config-register-global)

Command History

Usage Guidelines During Cisco Unified CallManager Express (Cisco Unified CME) or Cisco Unified Session Initiation Protocol (SIP) Survivable Remote Site Telephony (SRST) registration, a dial peer is created for each SIP phone and that dial peer includes the default session application. The application command allows you to change the default application for all dial peers associated with the Cisco SIP IP phones, if desired. The applied application (or TCL IVR script) must support call redirection. Use the show call application voice summary command to display a list of applications.The application command in voice register pool configuration mode takes precedence over this command in voice register global configuration mode.

Note Configure the id (voice register pool) command before any other voice register pool commands, including the application command. The id command identifies a locally available individual Cisco SIP IP phone or set of Cisco SIP IP phones.

Examples The following example shows how to set the Tcl IVR application globally for all SIP phones:Router(config)# voice register globalRouter(config-register-global)# mode cmeRouter(config-register-global)# application sipapp2

application-name Interactive voice response (IVR) application name.


12.4(4)T Cisco CME 3.4 Cisco SIP SRST 3.4

This command was introduced.62Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aapplication (voice register global)Related Commands Command Description

application (dial-peer) Enables a specific application on a dial peer.application (voice register pool)

Selects the session-level application for the dial peer associated an individual SIP phone in a Cisco Unified CME environment or for a group of phones in a Cisco Unified SIP SRST environment.

id (voice register pool) Explicitly identifies a locally available individual Cisco SIP IP phone, or when running Cisco Unified SIP SRST, set of Cisco SIP IP phones.

mode (voice register global)

Enables the mode for provisioning SIP phones in a Cisco Unified CME system.

show call application voice summary

Displays information about voice applications.

show dial-peer voice Displays information for dial peers.voice register pool Enters voice register pool configuration mode for SIP phones.63Cisco Unified CME Command Reference

OL-10894-03

Cisco Unified CME Commands: Aapplication (voice register pool)application (voice register pool)To select the session-level application for the dial peer associated with an individual Session Initiation Protocol (SIP) phone in a Cisco Unified CallManager Express (Cisco Unified CME) environment or for a group of phones in a Cisco Unified SIP Survivable Remote Site Telephony (SRST) environment, use the application command in voice register pool configuration mode. To disable use of the application, use the no form of this command.


no application

Syntax Description

Command Default Default application on router

Command Modes Voice register pool configuration (config-register-pool)

Command History

Usage Guidelines During Cisco Unified CME or Cisco Unified SIP SRST registration, a dial peer is created for each SIP phone and that dial peer includes the default session application. The application command allows you to change the default application for all dial peers associated with the Cisco SIP IP phones, if desired. The applied application (or TCL IVR script) must support call redirection. Use the show call application voice summary command to display a list of applications.The application command in voice register pool configuration mode takes precedence over this command in voice register global configuration mode.

Note Configure the id (voice register pool) command before any other voice register pool commands, including

CME Command Reference

Documents

Transcript of CME Command Reference