cme_cr

Cisco Unified Communications Manager Express Command ReferenceLast Modified: July 31, 2014

Americas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706USAhttp://www.cisco.comTel: 408 526-4000 800 553-NETS (6387)Fax: 408 527-0883

Text Part Number: OL-10894-03

C O N T E N T S

C H A P T E R 1 Cisco Unified CME Commands: A 1

accept 3

access-digit 6

addons 8

address (voice emergency response location) 10

addons 12

after-hour exempt 14

after-hour login http 16

after-hours block pattern 18

after-hours date 21

after-hours day 23

after-hours override-code 25

after-hours pstn-prefix 27

allow watch 29

anonymous block 31

application (telephony-service) 32

application (voice register global) 33

application (voice register pool) 35

apply-config 37

ata-ivr-pwd 38

attempted-registrations size 39

attendant-console 41

audible-tone 43

authen-method 44

authenticate (voice register global) 46

authentication credential 49

auto assign 51

auto logout 58

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

auto-answer 62

auto-line 64

auto-network-detect 66

auto-reg-ephone 68

C H A P T E R 2 Cisco Unified CME Commands: B 71

b2bua 72

background save interval 74

bandwidth video tias-modifier 75

blf-speed-dial 77

bnea 80

bpa 82

bulk 84

bulk-speed-dial prefix 86

busy-trigger-per-button 88

busy-trigger-per-button (voice register pool) 90

button 92

button-layout (voice register template) 100

button-layout 102

C H A P T E R 3 Cisco Unified CME Commands: C 105

call application voice aa-hunt 108

call application voice aa-name 111

call application voice aa-pilot 113

call application voice call-retry-timer 115

call application voice dial-by-extension-option 117

call application voice drop-through-option 119

call application voice drop-through-prompt 120

call application voice handoff-string 121

call application voice max-extension-length 122

call application voice max-time-call-retry 123

call application voice max-time-vm-retry 126

call application voice number-of-hunt-grps 127

call application voice queue-len 129

call application voice queue-manager-debugs 132

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

Contents

call application voice second-greeting-time 134

call application voice service-name 136

call application voice voice-mail 137

call application voice welcome-prompt 139

callback (voice emergency response settings) 141

caller-id 143

caller-id block (ephone-dn and ephone-dn-template) 145

caller-id block (voice register template) 147

caller-id block code (telephony-service) 149

call-feature-uri 150

call-forward 152

call-forward (voice register) 154

call-forward all 156

call-forward b2bua all 158

call-forward b2bua busy 160

call-forward b2bua mailbox 162

call-forward b2bua noan 165

call-forward b2bua unreachable 167

call-forward busy 169

call-forward max-length 172

call-forward night-service 174

call-forward noan 176

call-forward pattern 179

calling-number local 181

call-park system 184

call-waiting (voice register pool) 186

call-waiting beep 187

call-waiting ring 189

camera 191

capf-auth-str 193

capf-server 195

cert-enroll-trustpoint 196

clear cti session 198

clear telephony-service conference hardware number 200

clear telephony-service ephone-attempted-registrations 201

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

Contents

clear telephony-service xml-event-log 202

clear voice fac statistics 203

clear voice lpcor statistics 204

clear voice moh-group statistics 205

clear voice register attempted-registrations 206

cnf-file 208

cnf-file location 210

codec (ephone) 212

codec (telephony-service) 215

conference (ephone-dn) 217

conference (voice register template) 219

conference add-mode 221

conference add-mode (voice register) 223

conference admin 225

conference admin (voice register) 227

conference drop-mode 229

conference drop-mode (voice register) 231

conference hardware 233

conference hardware (voice register global) 235

conference max-length 237

conference-pattern blocked 239

conference transfer-pattern 241

cor (ephone-dn) 242

cor (voice register pool) 243

corlist 246

create cnf-files 248

create cnf-files (voice-gateway) 250

create profile (voice register global) 252

credentials 254

cti csta mode basic 257

cti message device-id suppress-conversion 258

cti notify 260

cti watch 262

cti-aware 264

ctl-client 266

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

Contents

ctl-service admin 267

C H A P T E R 4 Cisco Unified CME Commands: D 269

date-format (telephony-service) 272

date-format (voice register global) 273

debug callmonitor 275

debug capf-server 278

debug cch323 video 280

debug credentials 282

debug cti 285

debug ctl-client 287

debug ephone alarm 288

debug ephone blf 290

debug ephone ccm-compatible 292

debug ephone detail 294

debug ephone error 298

debug ephone extension-assigner 300

debug ephone hfs 302

debug ephone keepalive 304

debug ephone loopback 306

debug ephone lpcor 311

debug ephone message 313

debug ephone mlpp 315

debug ephone moh 317

debug ephone mwi 320

debug ephone paging 322

debug ephone pak 324

debug ephone qov 327

debug ephone raw 330

debug ephone register 332

debug ephone sccp-state 334

debug ephone shared-line-mixed 336

debug ephone state 339

debug ephone statistics 342

debug ephone video 344

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

Contents

debug ephone vm-integration 346

debug ephone whisper-intercom 348

debug mwi relay errors 350

debug mwi relay events 352

debug shared-line 354

debug voice register errors 357

debug voice register events 359

default (voice hunt-group) 363

description (ephone) 365

description (ephone-dn and ephone-dn-template) 366

description (ephone-hunt) 368

description (voice hunt-group) 369

description (voice moh-group) 370

description (voice register pool) 372

description (voice register pool-type)description (voice register pool-type) 374

device-id (ephone-type) 375

device-name 377

device-security-mode 378

device-type 380

dial-peer no-match isdn disconnect-cause 383

dialplan 384

dialplan-pattern 386

dialplan-pattern (call-manager-fallback) 390

dialplan-pattern (voice register) 394

digit collect kpml 397

direct-inward-dial isdn 399

directory 401

directory entry 403

display-logout 405

dnd (voice register pool) 406

dnd feature-ring 407

dnd-control (voice register template) 409

dn-webedit 410

dst (voice register global) 412

dst auto-adjust (voice register global) 414

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

Contents

dtmf-relay (voice register pool) 416

C H A P T E R 5 Cisco Unified CME Commands: E 419

elin 421

elin (voice emergency response settings) 423

em external 425

em keep-history 427

em logout 428

emadmin login 430

emadmin logout 432

emergency response callback 433

emergency response location 435

emergency response zone 437

ephone 439

ephone-dn 441

ephone-dn-template 444

ephone-dn-template (ephone-dn) 446

ephone-hunt 448

ephone-hunt login 452

ephone-hunt statistics write-all 454

ephone-template 456

ephone-template (ephone) 459

ephone-type 462

exclude 464

exclude (voice register) 466

expiry 467

extension-assigner tag-type 469

extension-range 471

external-ring (voice register global) 473

C H A P T E R 6 Cisco Unified CME Commands: F 475

fac 476

fac refer 483

fail-connect-time 484

fastdial 486

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

Contents

feature-button 488

feature-button (voice_register_pool) 490

features blocked 492

feed 494

file text (voice register global) 497

filename 498

final 500

final (voice hunt-group) 502

forward local-calls 504

forward local-calls (voice hunt-group) 506

forwarding local (voice register global) 508

from-ring 509

fwd-final 511

fxo hook-flash 513

C H A P T E R 7 Cisco Unified CME Commands: G 515

gsm-support 516

group (lpcor custom) 517

group (telephony-service) 519

group phone 521

group (voice register global) 523

group (voice register pool) 525

C H A P T E R 8 Cisco Unified CME Commands: H 527

headset auto-answer line 528

hfs enable 530

hfs home-path 532

hold-alert 534

hold-alert (voice register global) 537

hops 539

hops (voice hunt-group) 541

host-id-check 543

hunt-group logout 545

hunt-group report delay hours 548

hunt-group report every hours 550

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

Contents

hunt-group statistics write-all 552

huntstop (ephone-dn and ephone-dn-template) 555

huntstop (voice register dn) 559

C H A P T E R 9 Cisco Unified CME Commands: I 563

ica 564

id (voice register pool) 566

import certificate 568

index (lpcor ip-phone) 570

index (lpcor ip-trunk) 572

intercom (ephone-dn) 574

intercom (voice register dn) 577

internal-call 579

ip address trusted authenticate 581

ip address trusted call-block cause 583

ip address trusted list 585

ip qos dscp (telephony-service and voice register global) 587

ip source-address (credentials) 590

ip source-address (telephony-service) 592

C H A P T E R 1 0 Cisco Unified CME Commands: K 597

keepalive (ephone and ephone-template) 598

keepalive (telephony-service) 600

keepalive (voice register session-server) 601

keepalive (vpn-profile) 603

keep-conference 605

keep-conference (voice register pool) 608

keygen-retry 610

keypad-normalize 612

keyphone 613

C H A P T E R 1 1 Cisco Unified CME Commands: L 615

label 616

label (voice register dn) 618

list (ephone-hunt) 620

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

Contents

list (voice hunt-group) 623

live-record 625

load (telephony-service) 627

load (voice register global) 634

load-cfg-file 639

loc2 641

location (voice emergency response zone) 643

log password 645

log table 647

logging (voice emergency response settings) 649

login (telephony-service) 651

logo (voice register global) 653

logout-profile 654

loopback-dn 656

lpcor incoming 661

lpcor outgoing 664

lpcor type 667

C H A P T E R 1 2 Cisco Unified CME Commands: M 669

mac-address (ephone) 671

mac-address (voice-gateway) 673

mailbox-selection (dial-peer) 675

mailbox-selection (ephone-dn) 677

max-calls-per-button 679

max-conferences 681

max-dn 683

max-dn (voice register global) 686

max-ephones 688

max-idle-time 690

maximum bit-rate (video) 692

max-pool (voice register global) 693

max-presentation 695

max-redirect 697

max-subscription 699

max-timeout 701

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

Contents

media 703

members logout 707

missed-calls 708

mlpp indication 710

mlpp max-precedence 712

mlpp preemption 714

mlpp service-domain 716

mobility (ephone-dn) 718

mobility (voice register dn) 720

mode cme 721

moh (ephone-dn) 723

moh (telephony-service) 726

moh (voice moh-group) 728

moh-file-buffer 730

moh-group (ephone-dn) 732

mtp 734

mtu (vpn-profile) 736

multicast moh 738

mwi (ephone-dn and ephone-dn-template) 741

mwi (voice register dn) 744

mwi expires 745

mwi prefix 746

mwi qsig 748

mwi reg-e164 750

mwi relay 751

mwi sip 752

mwi sip-server 754

mwi stutter (voice register global) 757

mwi-line 758

mwi-type 761

C H A P T E R 1 3 Cisco Unified CME Commands: N 765

name (ephone-dn) 767

name (ephone-hunt) 769

name (voice emergency response location) 771

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

Contents

name (voice hunt-group) 773

name (voice register dn) 775

network-locale (ephone-template) 777

network-locale (telephony-service) 779

network-locale (voice-gateway) 785

night-service bell 788

night-service bell (ephone-dn) 790

night-service code 792

night-service date 794

night-service day 796

night-service everyday 798

night-service weekday 800

night-service weekend 802

no-reg 804

no-reg (voice register dn) 806

nte-end-digit-delay 807

ntp-server 809

number (ephone-dn) 811

number (voice register dn) 814

number (voice register pool) 816

number (voice user-profile and voice logout-profile) 819

num-buttons 823

num-line 825

C H A P T E R 1 4 Cisco Unified CME Commands: O 827

olsontimezone 828

olsontimezone 830

overlap-signal 832

C H A P T E R 1 5 Cisco Unified CME Commands: P 835

paging 838

paging group 841

paging-dn 845

paging-dn (voice register) 848

param 850

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

Contents

param aa-hunt 853

param aa-pilot 855

param call-retry-timer 857

param co-did-max 859

param co-did-min 861

param dial-by-extension-option 863

param did-prefix 865

param drop-through-option 867

param drop-through-prompt 869

param ea-password 871

param handoff-string 873

param max-extension-length 875

param max-time-call-retry 877

param max-time-vm-retry 880

param menu-timeout 882

param number-of-hunt-grps 884

param queue-exit-extension 886

param queue-exit-option 888

param queue-len 890

param queue-manager-debugs 892

param queue-overflow-extension 894

param secondary-prefix 896

param second-greeting-time 898

param send-account true 900

param service-name 902

param store-did-max 904

param store-did-min 906

param voice-mail 908

param welcome-prompt 910

paramspace callsetup after-hours-exempt 913

park reservation-group 915

park-slot 917

password-persistent 923

pattern (voice register dialplan) 925

pattern direct 927

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

Contents

pattern ext-to-ext busy 930

pattern ext-to-ext no-answer 933

pattern trunk-to-ext busy 936

pattern trunk-to-ext no-answer 939

phone-display 942

phone-mode only 943

phone-key-size 944

phoneload 946

phoneload-support 947

phone-redirect-limit (voice register global) 948

phone-ui park-list 949

phone-ui speeddial-fastdial 950

phone-ui voice-hunt-groups 951

pickup-call any-group 952

pickup-group 954

pilot 956

pilot (voice hunt-group) 959

pin 961

pin (voice logout-profile and voice user-profile) 963

pin (voice register pool) 965

port (CAPF-server) 966

preemption reserve timer 967

preemption tone timer (voice MLPP) 968

preemption trunkgroup 970

preemption user 971

preference (ephone-dn) 972

preference (ephone-hunt) 974

preference (voice hunt-group) 976

preference (voice register dn) 978

preference (voice register pool) 980

presence 982

presence call-list 984

presence enable 986

present-call 988

privacy (ephone) 990

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

Contents

privacy (telephony-service) 992

privacy (voice register global) 994

privacy (voice register pool) 996

privacy-button 998

privacy-button (voice register pool) 1000

privacy-on-hold 1002

privacy-on-hold (voice register global) 1003

protocol mode 1004

protocol-mode (telephony-service) 1006

provision-tag 1008

C H A P T E R 1 6 Cisco Unified CME Commands: R 1011

refer target dial-peer 1012

refer-ood enable 1014

reference-pooltype 1016

regenerate (ctl-client) 1017

register-id 1018

registrar server (SIP) 1020

reset (ephone) 1022

reset (telephony-service) 1024

reset (voice logout-profile and voice user-profile) 1027

reset (voice register global) 1029

reset (voice register pool) 1030

reset (voice-gateway) 1031

reset tapi 1032

restart (ephone) 1033

restart (telephony-service) 1035

restart (voice register) 1037

restart (voice-gateway) 1039

ring (ephone-dn) 1040

route-code 1042

rule (voice translation-rule) 1043

C H A P T E R 1 7 Cisco Unified CME Commands: S1 1049

sast1 trustpoint 1051

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

Contents

sast2 trustpoint 1053

sdspfarm conference lecture mode on 1055

sdspfarm conference mute-on mute-off 1057

sdspfarm tag 1058

sdspfarm transcode sessions 1060

sdspfarm units 1062

sdspfarm unregister force 1064

secondary dialtone (voice port) 1066

secondary start 1067

secondary-dialtone 1069

secure-signaling trustpoint 1070

semi-attended enable (voice register template) 1071

server (CTL-client) 1073

server (presence) 1075

server-security-mode 1077

service directed-pickup 1079

service dnis dir-lookup 1082

service dnis overlay 1085

service dss 1087

service https (ephone-template) 1089

service https (telephony-service) 1090

service https (voice register global) 1091

service https (voice register template) 1092

service local-directory 1093

service phone 1095

service profile 1107

service-digit 1108

service-domain 1110

service-domain (voice class) 1112

service-domain midcall-mismatch 1114

session-server 1116

session-transport 1118

C H A P T E R 1 8 Cisco Unified CME Commands: S2 1121

shared-line 1126

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

Contents

shared-line sip 1128

show capf-server 1130

show credentials 1132

show cti 1134

show ctl-client 1137

show ephone 1138

show ephone attempted-registrations 1144

show ephone cfa 1146

show ephone dn 1147

show ephone dnd 1148

show ephone login 1149

show ephone moh 1152

show ephone offhook 1154

show ephone overlay 1156

show ephone phone-load 1158

show ephone registered 1160

show ephone registered summary 1162

show ephone remote 1164

show ephone ringing 1165

show ephone rtp connections 1166

show ephone socket 1169

show ephone summary brief 1171

show ephone summary 1173

show ephone summary types 1175

show ephone tapiclients 1176

show ephone telephone-number 1177

show ephone unregistered 1178

show ephone unregistered summary 1179

show ephone-dn 1181

show ephone-dn callback 1189

show ephone-dn conference 1191

show ephone-dn loopback 1193

show ephone-dn paging 1196

show ephone-dn park 1199

show ephone-dn statistics 1201

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

Contents

show ephone-dn summary 1203

show ephone-dn whisper 1205

show ephone-hunt 1207

show ephone-hunt statistics 1215

show fb-its-log 1220

show ip address trusted list 1223

show presence global 1224

show presence subscription 1227

show sdspfarm 1231

show shared-line 1237

show telephony-service admin 1240

show telephony-service all 1242

show telephony-service bulk-speed-dial 1247

show telephony-service conference hardware 1250

show telephony-service directory-entry 1254

show telephony-service ephone 1256

show telephony-service ephone-dn 1259

show telephony-service ephone-dn-template 1261

show telephony-service ephone-template 1262

show telephony-service fac 1266

show telephony-service security-info 1267

show telephony-service tftp-bindings 1268

show telephony-service voice-port 1270

show voice emergency 1272

show voice emergency addresses 1273

show voice emergency all 1275

show voice emergency callers 1277

show voice emergency zone 1279

show voice fac statistics 1281

show voice hunt-group 1282

show voice hunt-group statistics 1288

show voice register all 1293

show voice register credential 1303

show voice register dial-peers 1305

show voice register dialplan 1307

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

Contents

show voice register dn 1310

show voice register global 1313

show voice register hfs 1318

show voice register pool 1320

show voice register pool after-hour-exempt 1328

show voice register pool attempted-registrations 1330

show voice register pool cfa 1332

show voice register pool connected 1334

show voice register pool ip 1337

show voice register pool mac 1339

show voice register pool on-hold 1341

show voice register pool phone-load 1344

show voice register pool registered 1345

show voice register pool remote 1352

show voice register pool ringing 1354

show voice register pool telephone-number 1356

show voice register pool type 1358

show voice register pool type summary 1360

show voice register pool unregistered 1361

show voice register profile 1363

show voice register session-server 1366

show voice register statistics 1368

show voice register template 1372

show voice register tftp-bind 1376

shutdown(telephony-service) 1379

snr 1381

snr (voice register dn) 1383

snr answer-too-soon 1386

snr answer-too-soon (voice register dn) 1387

snr calling-number local 1389

snr calling-number local (voice register dn) 1391

snr mode 1392

snr ring-stop 1394

snr ring-stop (voice register dn) 1395

softkeys alerting 1396

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

Contents

softkeys connected (voice register template) 1398

softkeys connected 1401

softkeys hold 1404

softkeys idle 1406

softkeys idle (voice register template) 1409

softkeys remote-in-use 1411

softkeys remote-in-use (voice register template) 1413

softkeys ringin (voice register template) 1415

softkeys ringing 1417

softkeys seized 1420

softkeys seized (voice register template) 1423

source-addr 1425

source-address (voice register global) 1426

speed-dial 1428

speed-dial (voice logout-profile and voice user-profile) 1431

speed-dial (voice register pool) 1433

srst dn line-mode 1436

srst dn template 1438

srst ephone description 1440

srst ephone template 1442

srst mode auto-provision 1444

standby username password 1446

statistics collect 1448

statistics collect (voice hunt-group) 1450

subnet 1451

system message 1453

C H A P T E R 1 9 Cisco Unified CME Commands: T 1455

telephony-service 1457

telnet-support 1463

template (voice register pool) 1464

tftp-path (voice register global) 1466

tftp-server-credentials trustpoint 1468

time-format 1469

time-format (voice register global) 1470

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

Contents

timeout (ephone-hunt) 1471

timeout (voice hunt-group) 1474

timeouts busy 1476

timeouts interdigit (telephony-service) 1477

timeouts night-service-bell 1479

timeouts ringing (telephony-service) 1481

timeouts transfer-recall 1482

time-webedit (telephony-service) 1484

time-zone 1486

timezone (voice register global) 1493

transfer max-length 1497

transfer-attended (voice register template) 1499

transfer-blind (voice register template) 1501

transfer-digit-collect 1503

transfer-mode 1505

transfer-park blocked 1507

transfer-pattern (telephony-service) 1509

transfer-pattern blocked 1511

transfer-system 1513

translate (ephone-dn) 1517

translate callback-number 1519

translate-outgoing (voice register pool) 1521

translation-profile 1523

translation-profile incoming 1525

transport (voice register pool-type) 1527

trunk 1528

trustpoint (credentials) 1531

trustpoint-label 1533

type 1534

type (voice register dialplan) 1541

type (voice register pool) 1543

type (voice-gateway) 1549

C H A P T E R 2 0 Cisco Unified CME Commands: U 1551

upa 1552

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

Contents

upgrade (voice register global) 1554

url (telephony-service) 1556

url (voice register global) 1559

url authentication 1561

url idle 1563

url services (ephone-template) 1565

url-button 1567

url-button (voice-register-template) 1569

user (voice logout-profile) 1571

user (voice user-profile) 1573

user-locale (ephone-template) 1575

user-locale (telephony-service) 1577

user-locale (voice register) 1583

username (ephone) 1587

username (voice register pool) 1589

utf8 1591

C H A P T E R 2 1 Cisco Unified CME Commands: V 1593

vad (voice register pool) 1595

vad (voice register template) 1596

vca 1597

video 1599

video (ephone) 1601

video (telephony-service) 1603

video screening (voice service sip) 1605

video-bitrate (ephone) 1606

vm-device-id (ephone) 1607

vm-integration 1609

voice class mlpp 1611

voice emergency response location 1612

voice emergency response settings 1614

voice emergency response zone 1616

voice hunt-group 1618

voice-hunt-groups login 1622

voice lpcor call-block cause 1624

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

Contents

voice lpcor custom 1629

voice lpcor enable 1631

voice lpcor ip-phone mobility 1633

voice lpcor ip-phone subnet 1635

voice lpcor ip-trunk subnet incoming 1637

voice lpcor policy 1639

voice mlpp 1641

voice moh-group 1642

voice register dialplan 1644

voice register dn 1646

voice register global 1648

voice register pool 1650

voice register pool-type 1652

voice register session-server 1655

voice register template 1657

voice user-profile 1659

voice-class codec (voice register pool) 1661

voice-class mlpp (dial peer) 1663

voice-class stun-usage 1665

voice-gateway system 1667

voicemail (telephony-service) 1669

voicemail (voice register global) 1671

voicemail (voice register template) 1673

voice-port (voice-gateway) 1675

vpn-gateway 1677

vpn-group 1679

vpn-hash-algorithm 1681

vpn-profile 1683

vpn-trustpoint 1685

C H A P T E R 2 2 Cisco Unified CME Commands: W 1687

web admin customer 1688

web admin system 1690

web customize load 1692

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

Contents

C H A P T E R 2 3 Cisco Unified CME Commands: X 1693

xml-config 1694

xmlschema 1696

xmltest 1697

xmlthread 1698

xml user 1699

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

Contents

Cisco Unified CME Commands: A

accept, page 3

access-digit, page 6

addons, page 8

address (voice emergency response location), page 10

addons, page 12

after-hour exempt, page 14

after-hour login http, page 16

after-hours block pattern, page 18

after-hours date, page 21

after-hours day, page 23

after-hours override-code, page 25

after-hours pstn-prefix, page 27

allow watch, page 29

anonymous block, page 31

application (telephony-service), page 32

application (voice register global), page 33

application (voice register pool), page 35

apply-config, page 37

ata-ivr-pwd, page 38

attempted-registrations size, page 39

attendant-console, page 41

audible-tone, page 43

authen-method, page 44

authenticate (voice register global), page 46

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

authentication credential, page 49

auto assign, page 51

auto logout, page 58

auto-answer, page 62

auto-line, page 64

auto-network-detect, page 66

auto-reg-ephone, page 68

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

Cisco Unified CME Commands: A

acceptTo allow a logical partitioning class of restriction (LPCOR) policy to accept calls associated with anotherresource-group, use the accept command in LPCOR policy configuration mode. To reject calls associatedwith a resource group, use the no form of this command.

accept lpcor-group [fac]

no accept lpcor-group

Syntax Description Name of the LPCOR resource group.lpcor-group

Enables forced authorization code for calls from thisresource group.

fac

Command Default Calls from other resource groups are rejected.

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

Command History ModificationCisco ProductCisco IOS Release

This command was introduced.Cisco Unified CME 8.015.0(1)XA

This command was integrated into Cisco IOSRelease 15.1(1)T.

Cisco Unified CME 8.015.1(1)T

This command was modified. The fac keywordwas added to the accept command.


Usage Guidelines Use this command to create a LPCOR policy by specifying the other resource groups fromwhich this resourcegroup can accept calls. If a resource group is not explicitly set to accept with this command, calls associatedwith 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 otherresource groups by using the accept command, that policy blocks all incoming calls associated with anyLPCOR resource group other than its own. The fac keyword in the accept command restricts the caller fromrouting to a destination LPCOR group without entering a valid authorization code.


Cisco Unified CME Commands: Aaccept

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

voice lpcor policy sccp_phone_localaccept analog_phone_localaccept sip_phone_local

The following example shows that sccp_phone_local blocks calls that are associated with any other LPCORpolicy 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 associatedwith itself. SIP phone 1 and SCCP phone 2 both belong to the local_phone resource group and its policyprevents them from accepting calls from each other.

voice register pool 1lpcor type locallpcor incoming local_phonelpcor outgoing local_phoneid mac 0021.A02D.B360type 7960number 1 dn 1!voice lpcor customgroup 1 local_phonegroup 2 remote_phonegroup 3 analog_phone!voice lpcor policy local_phoneno accept local_phoneaccept analog_phone!ephone 2lpcor type locallpcor incoming local_phonelpcor outgoing local_phonemac-address 0021.A02D.B580type 7960button 1:10

The following example shows that the authorization code is required by callers who belong to the LocalUsergroup and RemoteUser group.

!voice lpcor policy PSTNTrunkservice facaccept Manageraccept LocalUser facaccept RemoteUser facno accept PSTNTrunkno accept IPTrunk

Related Commands DescriptionCommand

Displays the LPCOR policy for the specified resourcegroup.

show voice lpcor policy



DescriptionCommand

Defines the LPCOR resource groups on the CiscoUnified CME router.

voice lpcor custom

Creates a LPCOR policy for a resource group.voice lpcor policy



access-digitTo define the access digit that phone users dial to request a precedence call, use the access-digit commandin voice MLPP configuration mode. To reset to the default, use the no form of this command.

access-digit digit

no access-digit

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

digit

Command Default Access digit is 0.

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

Command History ModificationCisco IOS Release

This command was introduced.12.4(22)YB

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

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

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

Note

Examples The following example shows the MLPP access digit set to 6:

Router(config)# voice mlppRouter(config-voice-mlpp)# access-digit 6


Enables preemption capability on an SCCP phone oranalog FXS port.

mlpp preemption


Cisco Unified CME Commands: Aaccess-digit

DescriptionCommand

Enables preemption capability on a trunk group.preemption trunkgroup

Enables preemption capability for all supportedphones.

preemption user


Cisco Unified CME Commands: Aaccess-digit

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

addons max-addons

no addons max-addons

Syntax Description Defines themaximum number of addonmodules thatcan be configured while defining the pool for thephone. Range is 1 to 3.

max-addons

Command Default The default value of the addons is 0.When the reference-pooltype command is configured, the add-on modulevalue of the reference phone is inherited.

Command Modes Voice Register Pool-type Configuration (config-register-pooltype)


This command was introduced.Cisco SIP CME 10.015.3(3)M

Use this command to define the maximum number of addon modules for a Cisco Unified SIP IP phone onCisco Unified CME. When you use the no form of this command, the inherited properties of the referencephone takes precedence over the default value.

Examples The following example shows how to enter voice register pool configuration mode and define the maximumnumber of addon 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 CKEMRouter(config-register-pool-type)# id mac 1234.4567.7891


Adds a new Cisco Unified SIP IP phone to CiscoUnified CME.

voice register pool-type


Cisco Unified CME Commands: Aaddons

DescriptionCommand

Defines a phone type for a SIP phone.type



address (voice emergency response location)To define the civic address for an ERL that is used for the ALI database upload, use the address commandin voice emergency response location mode. To remove this definition, use the no form of the command. Thiscommand is optional.

address string

no address

Syntax Description String (1-247 characters) used to identify an ERLscivic address.

string

Command Default The civic address is not defined.

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


This command was introduced.Cisco Unified CME 4.2(1) Cisco UnifiedSRST 4.2(1) Cisco Unified SIP SRST 4.2(1)

12.4(15)XY

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

Cisco Unified CME 7.0 Cisco Unified SRST7.0 Cisco Unified SIP SRST 7.0

12.4(20)T

Usage Guidelines Use this command to create a comma separated text entry of the ERLs civic address. The address informationmust be entered to conform with the NENA-2 Data Record specifications or the recommendations by theservice 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,,,,,,


Specifies a PSTN number that will replace the callersextension.

elin


Cisco Unified CME Commands: Aaddress (voice emergency response location)

DescriptionCommand

Specifies a string (up to 30 characters) used internallyto identify or describe the emergency responselocation.

name

Defines which IP phones are part of this ERL.subnet


Cisco Unified CME Commands: Aaddress (voice emergency response location)

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

addons max-addons

no addons max-addons

Syntax Description Defines themaximum number of addonmodules thatcan be configured while defining the pool for thephone. Range is 1 to 3.

max-addons

Command Default The default value of the addons is 0.When the reference-pooltype command is configured, the add-on modulevalue of the reference phone is inherited.

Command Modes Voice Register Pool-type Configuration (config-register-pooltype)


This command was introduced.Cisco SIP CME 10.015.3(3)M

Use this command to define the maximum number of addon modules for a Cisco Unified SIP IP phone onCisco Unified CME. When you use the no form of this command, the inherited properties of the referencephone takes precedence over the default value.

Examples The following example shows how to enter voice register pool configuration mode and define the maximumnumber of addon 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 CKEMRouter(config-register-pool-type)# id mac 1234.4567.7891


Adds a new Cisco Unified SIP IP phone to CiscoUnified CME.

voice register pool-type



DescriptionCommand

Defines a phone type for a SIP phone.type



after-hour exemptTo specify that an individual IP phone in Cisco Unified CME does not have any of its outgoing calls blockedeven though after-hour call blocking has been enabled, use the after-hour exempt command in ephone orephone-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)


This command was introduced.Cisco CME 3.012.2(15)ZJ


Cisco CME 3.012.3(4)T

This command was made available inephone-template configuration mode.

Cisco Unified CME 4.012.4(4)XC

This command in the ephone-template configurationmode was integrated into Cisco IOS 12.4(9)T.


Usage Guidelines Use this command to exempt an individual SCCP phone from call blocking and enable the phone user to placeoutgoing calls regardless of whether the outgoing called number matches the defined pattern of digits duringthe call blocking periods.

By default, all IP phones in a Cisco Unified CME system are subject to call blocking if the Call Blockingfeature is configured.

If you use an ephone template to apply a command to a phone and you also use the same command in ephoneconfiguration 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


Cisco Unified CME Commands: Aafter-hour exempt


Defines a pattern of digits for blocking outgoing callsfrom IP phones.

after-hours block pattern

Defines a recurring period based on date during whichoutgoing calls that match defined block patterns areblocked on IP phones.

after-hours date

Defines a recurring period based on day of the weekduring which outgoing calls that match defined blockpatterns are blocked on IP phones.

after-hours day


Cisco Unified CME Commands: Aafter-hour exempt

after-hour login httpTo unblock an individual IP phone in Cisco Unified CME that is configured for after-hour call blocking, usethe 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)


This command was introduced.Cisco Unified CME 8.015.0(1)XA

This command was integrated into CiscoIOS Release 15.1(1)T.


Usage Guidelines Use this command to log in to a phone to unblock the after hour block and enable the phone user to placeoutgoing calls regardless of whether the outgoing called number matches the defined pattern of digits duringthe call blocking periods.

When you configure after-hours login http command, you will experience slightly different login behaviorcompare to the current one. This difference is because the after hours login mechanism is enhanced due tosome UI limitation in the current model. By default, after-hours login http is not applied, which mean userwill 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 Blockingfeature is configured.

If you use an ephone template to apply a command to a phone and you also use the same command in ephoneconfiguration 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 123Router(config-ephone)# after-hour login http


Cisco Unified CME Commands: Aafter-hour login http


Defines a pattern of digits for blocking outgoing callsfrom IP phones.



after-hours date


after-hours day


Cisco Unified CME Commands: Aafter-hour login http

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

after-hours block pattern pattern-tag

no after-hours block pattern pattern-tag

Syntax Description Identifier for a call-blocking pattern. Up to 100call-blocking patterns can be defined in separatecommands.

pattern-tag

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

pattern

(Optional) If the 7-24 keyword is specified, the patternis always blocked, 7 days a week, 24 hours a day. Ifthe 7-24 keyword is not specified, the pattern isblocked during the days and dates that are definedwith the after-hours day and after-hours datecommands.

7-24

Command Default No pattern is defined.

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

Telephony-service configuration (config-telephony)



This command was integrated into Cisco IOS Release12.3(4)T.


Support for this command was extended to all SCCP,H.323, SIP, and POTS calls that go through the CiscoUnified CME router, including all incoming calls tothe router, except calls from an exempt phone.


This command was added to ephone-templateconfiguration mode.

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


Cisco Unified CME Commands: Aafter-hours block pattern

ModificationCisco ProductCisco IOS Release


Cisco Unified CME 4.312.4(15)XZ

This command was integrated into Cisco IOS Release12.4(20)T.


This command was modified to include regularexpressions as a value for the pattern argument.


Usage 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 whichcalls that match those patterns are to be blocked are defined using the after-hours date or after-hours daycommand or both. By default, all IP phones in a Cisco Unified CME system are restricted during the specifiedtime 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 toSCCP-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 POTScalls that go through the Cisco Unified CME router. All incoming calls to the router, except calls from anexempt phone, are also checked against the after-hours configuration.

Individual phones can be exempted from call blocking using the after-hour exemptor the after-hoursoverride-code command.

Blocked calls return a fast-busy tone to the user for approximately 10 seconds before the call is terminatedand the line is returned to on-hook status.

In Cisco Unified CME 9.5 and Cisco Unified SRST 9.5, support for after-hours pattern blocking is extendedto regular expression patterns for dial plans on Cisco Unified SIP and Cisco Unified SCCP IP phones. Withthis 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 amatch is found, the call is blocked.

To enable regular expression patterns to be included when configuring after-hours pattern blocking, theafter-hours block pattern command is modified to include regular expressions as a value for the patternargument.

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

Note

For a summary of the basic Cisco IOS regular expression characters and their functions, see the Cisco RegularExpression 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 UnifiedCME system that requires dialing 9 for external calls:

Router(config)# telephony-service



http://www.cisco.com/en/us/partner/docs/ios/termserv/configuration/guide/tsv_reg_express_ps11746_tsd_products_configuration_guide_chapter.htmlhttp://www.cisco.com/en/us/partner/docs/ios/termserv/configuration/guide/tsv_reg_express_ps11746_tsd_products_configuration_guide_chapter.html

Router(config-telephony)# after-hours block pattern 1 9011

The following example shows how to configure several after-hours block patterns of regular expressions:

Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# telephony-serviceRouter(config-telephony)# after-hours block pattern 1 ?WORD Specific block pattern or a regular expression for after-hour block

patternRouter(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)


Specifies that an IP phone does not have any of itsoutgoing calls blocked although call blocking isdefined.

after-hour exempt


after-hours date


after-hours day

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

after-hours override-code

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

after-hours pstn-prefix

Applies template to a SCCP phone.ephone-template (ephone)



after-hours dateTo define a recurring period based on date during which outgoing calls that match defined block patterns areblocked on IP phones, use the after-hours date command in ephone-template or telephony-service configurationmode. 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 Abbreviated month. The following abbreviations formonth are valid: jan, feb, mar, apr, may, jun, jul,aug, sep, oct, nov, dec.

month

Date of the month. Range is from 1 to 31.date

Beginning and ending times for call blocking, in anHH:MM format using a 24-hour clock. The stop timethat is entered will be the next available time thatfollows the start time. The value 24:00 is not valid.If 00:00 is entered as a stop time, it is changed to23:59. If 00:00 is entered for both start time and stoptime, calls are blocked for the entire 24-hour periodon the specified date.

start-time stop-time

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)










Cisco Unified CME Commands: Aafter-hours date

ModificationCisco ProductCisco IOS Release



Usage Guidelines Use this command to define call blocking that recurs annually on the date specified in the command. Callblocking on IP phones is defined as follows:

First, one or more patterns of outgoing digits (0-9) are defined using the after-hours block patterncommand.

Next, one or more time periods during which calls that match those patterns are to be blocked are definedusing 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 leastone pattern and at least one time period are defined. Individual IP phones can be exempted from call blockingusing 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 inthe after-hours block pattern command are blocked:

Router(config)# telephony-serviceRouter(config-telephony)# after-hours date jan 1 00:00 00:00



after-hour exempt

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



after-hours day

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




Applies template to SCCP phone.ephone-template (ephone)


Cisco Unified CME Commands: Aafter-hours date

after-hours dayTo define a recurring period based on day of the week during which outgoing calls that match defined blockpatterns are blocked on IP phones, use the after-hours day command in ephone-template or telephony-serviceconfiguration 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 Abbreviated day of the week. The followingabbreviations for day of the week are valid: sun,mon,tue, wed, thu, fri, sat.

day

Beginning and ending times for call blocking, in anHH:MM format using a 24-hour clock. The stop timethat is entered will be the next available time thatfollows the start time. The value 24:00 is not valid.If 00:00 is entered as a stop time, it is changed to23:59. If 00:00 is entered for both start time and stoptime, calls are blocked for the entire 24-hour periodon the specified day.

start-time stop-time

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)












Cisco Unified CME Commands: Aafter-hours day

Usage Guidelines Use this command to define call blocking during the hours between the start time and stop time on the dayof the week that is specified in this command. This time period recurs weekly unless it is removed using theno form of this command.

Call blocking on IP phones is defined as follows:


Next, one or more time periods during which calls that match those patterns are to be blocked are definedusing 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 leastone pattern and at least one time period are defined. Individual phones can be exempted from call blockingusing 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 anafter-hours call-blocking period:

Router(config)# telephony-serviceRouter(config-telephony)# after-hours day mon 19:00 07:00



after-hour exempt




after-hours date

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




Applies template to SCCP phone.ephone-template (ephone)


Cisco Unified CME Commands: Aafter-hours day

after-hours override-codeTo specify that a defined blocking pattern can be overridden, use the after-hours override-code commandin ephone-template or telephony-service configuration mode. To remove the exemption, use the no form ofthis command.

after-hours override-code pattern

no after-hours override-code pattern

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

pattern

Command Default No override is defined.

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

Telephony-service configuration (config-telephony)


This command was introduced.Cisco Unified CME 4.2(1)12.4(15)XY





Usage Guidelines Use this command to allow a phone user to override call blocking rules and enable the phone user to placeoutgoing calls regardless of whether the outgoing called number matches the defined pattern of digits duringthe call blocking periods.

By default, all IP phones in a Cisco Unified CME system are subject to call blocking if the Call Blockingfeature is configured. By entering the override code as defined by the system administrator, the phone usercan 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 isconfigured, it has priority over the after-hours override-code command.


Cisco Unified CME Commands: Aafter-hours override-code

Examples The following example defines a blocking pattern using telephony-service configuration which can beoverridden 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:00Router(config-telephony)# after-hours date Jan 25 00:00 07:00Router(config-telephony)# after-hours override-code 1234



after-hour exempt




after-hours date


after-hours day

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


Applies a template to an ephone.ephone-template (ephone)


Cisco Unified CME Commands: Aafter-hours override-code

after-hours pstn-prefixTo specify that all configured blocking patterns apply to trunk or PSTN lines, use the after-hours pstn-prefixcommand in telephony-service configuration mode. To delete call blocking configuration for PSTN lines, usethe no form of this command.

after-hours pstn-prefix tag pattern

no after-hours pstn-prefix tag pattern

Syntax Description Identifier for a PSTN call-blocking pattern. Up to 4call-blocking patterns can be defined in separatecommands.

tag

Outgoing call digits (0-9) to be matched for PSTNblocking.

pattern

Command Default No pattern is defined.

Command Modes Telephony-service configuration


This command was introduced.Cisco Unified CME 4.2(1)12.4(15)XY





Usage Guidelines Use the after-hours pstn-prefix command to indicate that the after-hours call blocking patterns are configuredto include one or more PSTN access digits that are normally dialed by phone users using regular ephone-dnlines. For example, the patterns are configured with a leading digit 9 to correspond to the conventional dial9 for outside line. The after-hours pstn-prefix command instructs the system to skip over the PSTN prefixdigits (in the blocking patterns) for calls that are dialed directly to the PSTN on ephone-dns that are configuredusing the trunk feature. These lines do not require the user to dial a PSTN access code (for example, 9) becausethey are configured to directly connect to the PSTN FXO ports. For example, a user of a regular ephone-dnwould dial 9-1-900-xxx-xxxx, whereas a user on a trunk ephone-dn would omit the leading 9 and dial only1-900-xxx-xxxx. The blocking pattern would be configured as 91900 to restrict calls on regular ephone-dnlines, and this pattern would be interpreted as 1900 on ephone-dns configured using the trunk feature. If you


Cisco Unified CME Commands: Aafter-hours pstn-prefix

do not specify the after-hours pstn-prefix command, then no blocking is performed on calls dialed on trunkephone-dn lines.

Call blocking on IP phones is defined as follows:


Next, one or more time periods during which calls that match those patterns are to be blocked are definedusing the after-hours date, the after-hours day, or both commands.

By default, all IP phones in a Cisco Unified CME system are restricted during the specified time if at leastone 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 terminatedand the line is returned to on-hook status.

Examples The following example defines a blocking pattern using telephony-service configuration which is applied toa 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



after-hour exempt




after-hours date


after-hours day

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



Cisco Unified CME Commands: Aafter-hours pstn-prefix

allow 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)


This command was introduced.Cisco Unified CME 4.112.4(11)XJ

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


Usage Guidelines This command controls whether a phone line associated with a directory number can be watched as part of apresence service. The directory number is enabled as a presentity that can be watched by internal and externalwatchers. Presence service must be enabled on Cisco Unified CME. Another phone, acting as a watcher, canmonitor the status of this phone line when the blf-speed-dial or presence call-list command is enabled forthat phone.

If you use an ephone-dn template to apply a command to a directory number and you also use the samecommand in ephone-dn configuration mode, the value that you set in ephone-dn configuration mode haspriority over the ephone-dn template configuration.

Examples The following example shows that the extension associated with voice register dn 2 can be watched by thephone associated with voice register pool 1:

Router(config)# voice register dn 2Router(config-register-dn)# number 2102Router(config-register-dn)# allow watchRouter(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


Cisco Unified CME Commands: Aallow watch


Enables Busy Lamp Field (BLF) monitoring for aspeed-dial number on a phone registered to CiscoUnified CME.

blf-speed-dial

Enables presence service and enters presenceconfiguration mode.

presence

Enables BLF monitoring for call lists and directorieson phones registered to Cisco Unified CME.

presence call-list

Allows the router to accept incoming presencerequests.

presence enable

Displays configuration information about the presenceservice.

show presence global

Displays information about active presencesubscriptions.

show presence subscription


Cisco Unified CME Commands: Aallow watch

anonymous blockTo enable anonymous call blocking in a SIP phone template, use the anonymous block command in voiceregister 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)


This command was introduced.Cisco CME 3.412.4(4)T

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


Enables caller-ID blocking for outbound calls froma SIP phone.

caller-id block (voice register template)

Applies a template to a SIP phone.template (voice register pool)


Cisco Unified CME Commands: Aanonymous block

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

application application-name

no application

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

Command Default No application is selected for all extensions.

Command Modes Telephony-service configuration (config-telephony)


This command was introduced.Cisco ITS 2.112.2(11)YT


Cisco ITS 2.112.2(15)T

Usage Guidelines Use this command to assign a Tool Command Language (Tcl) IVR application to all extensions served bythe 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


Displays information about voice applications.show call application voice summary


Cisco Unified CME Commands: Aapplication (telephony-service)

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 theapplication, use the no form of this command.


no application

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

Command Default Default application on router

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


This command was introduced.Cisco CME 3.4 Cisco SIP SRST 3.412.4(4)T

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 andthat dial peer includes the default session application. The application command allows you to change thedefault 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 commandto display a list of applications.

The application command in voice register pool configuration mode takes precedence over this command invoice register global configuration mode.

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

Note

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


Cisco Unified CME Commands: Aapplication (voice register global)


Enables a specific application on a dial peer.application (dial-peer)

Selects the session-level application for the dial peerassociated an individual SIP phone in a Cisco UnifiedCME environment or for a group of phones in a CiscoUnified SIP SRST environment.

application (voice register pool)

Explicitly identifies a locally available individualCisco SIP IP phone, or when running Cisco UnifiedSIP SRST, set of Cisco SIP IP phones.

id (voice register pool)

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

mode (voice register global)


Displays information for dial peers.show dial-peer voice

Enters voice register pool configuration mode for SIPphones.

voice register pool


Cisco Unified CME Commands: Aapplication (voice register global)

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 ofphones in a Cisco Unified SIP Survivable Remote Site Telephony (SRST) environment, use the applicationcommand in voice register pool configuration mode. To disable use of the application, use the no form of thiscommand.


no application

Syntax Description Name of the selected interactive voice response (IVR)application name.

application-name

Command Default Default application on router

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


This command was introduced.Cisco SIP SRST 3.012.2(15)ZJ

This commandwas integrated into Cisco IOSRelease 12.3(4)T.

Cisco SIP SRST 3.012.3(4)T

This command was added to Cisco CME.Cisco CME 3.4 Cisco SIP SRST3.4

12.4(4)T

Usage Guidelines During Cisco Unified CME or Cisco Unified SIP SRST registration, a dial peer is created for each SIP phoneand that dial peer includes the default session application. The application command allows you to changethe default application for all dial peers associated with the Cisco SIP IP phones, if desired. The appliedapplication (or TCL IVR script) must support call redirection. Use the show call application voice summarycommand to display a list of applications.

The application command in voice register pool configuration mode takes precedence over this command invoice register global configuration mode.


Cisco Unified CME Commands: Aapplication (voice register pool)

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

Note

Examples The following example shows how to set the IVR application for the SIP phone specified by the voice registerpool command:

Router(config)# voice register pool 1Router(config-register-pool) application sipapp2

The following partial sample output from the show running-config command shows that voice register pool1 has been set up to use the SIP.app application:

voice register pool 1id network 172.16.0.0 mask 255.255.0.0application SIP.appvoice-class codec 1


Enables a specific application on a dial peer.application (dial-peer)

Selects the session-level application for all dial peersassociated with SIP phones.

application (voice register global)

Explicitly identifies a locally available individualCisco SIP IP phone, or when running Cisco UnifiedSIP SRST, set of Cisco SIP IP phones.

id (voice register pool)

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

mode (voice register global)


Displays information for dial peers.show dial-peer voice


Cisco Unified CME Commands: Aapplication (voice register pool)

apply-configTo dynamically apply the phone configuration on Cisco Unified SIP IP phones 8961, 9951, and 9971, withoutrestarting the phones, use the apply-config command in voice register global and voice register poolconfiguration modes.

apply-config


Command Default Apply-config is not enabled by default.

Command Modes Voice register global Voice register pool


This command was introduced.Cisco Unified CME 8.615.1(4)M

Usage Guidelines Use this command to dynamically apply the phone configuration on Cisco Unified SIP IP phones 8961, 9951,and 9971.Once you configure the apply-config command, you are not required to restart the phone. The phonerestarts by itself or dynamically applies the changes to the phone configuration without restarting.

Examples The following example shows the apply-config command configured in voice register pool 5 :

Router# configure terminal

Router(config)#voice register pool 5

Router(config-register-pool)#apply-config


Enables USB camera capability on Cisco Unified IPPhones 9951 and 9971

camera

Enables video capability on Cisco Unified SIP IPPhones 9951 and 9971

video


Cisco Unified CME Commands: Aapply-config

ata-ivr-pwdTo define a password to access interactive voice response (IVR) and change the default phone settings onCisco 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 Four-digit string to be used as password to accessIVR. Password string must contain numbers 0 to 9.

password

Command Default No valid password is set.

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

Command History ModificationRelease

This command was introduced.15.2(2)T

Examples The following example shows how 1234 is defined as the password to access IVR on Cisco ATA-187:

voice service voipallow-connections sip to sipfax protocol t38 version 0 ls-redundancy 0 hs-redundancy 0 fallback pass-through g711ulawvoice register pool 11ata-ivr-pwd 1234id mac 93FE.12D8.2301session-transport tcptype ATA-187number 1 dn 33username ata112 password ciscocodec g711ulaw


Enters voice register pool configuration mode andcreates a pool configuration for Cisco Unified SIP IPphones in Cisco Unified CME.

voice register pool


Cisco Unified CME Commands: Aata-ivr-pwd

attempted-registrations sizeTo set the size of the table that shows a number of attempted-registrations, use the attempted- registrationscommand in voice register global mode. To set the size of attempted-registrations table to its default value,use the no form of this command.

attempted-registrations size size

no attempted-registrations size

Syntax Description Number of entries in attempted registrations table.Size range from 0 to 50.

size

Command Default The default size for attempted registration table is 10.

Command Modes voice register global


This command was introduced.Cisco Unified CME 8.1 Cisco UnifiedSRST 8.1

15.1(2)T

Usage Guidelines Use this command to define the size of the table that stores information related to SIP phones that attempt toregister with Cisco Unified CME or Cisco Unified SRST and fail. The default size of an attempted registrationtable is 10. The minimum size of attempted registration table is 0. Use the attempted-registration size 0 whenyou do not wish to store any information about phones attempting to register with the Cisco Unified CME orCisco Unified SRST and fail. The maximum size of attempted registration table is 50.

When the current number of entries in the table is more than the new size that is being configured, systemprompts the user for the following confirmation, This will remove x old entries from the table. Proceed?Yes/No ?. The default user confirmation is No. Where x represents the number of entries that will bedeleted. The old entries are classified on basis of the time-stamp of the latest register attempt made by thephone.

During rollback, the user confirmation is not sought and the target configuration is applied. If the currentnumber of entries in the table is more than the default value of the table size, then entries in excess of thedefault table size are cleared before reverting to the target table size.

For example, if the configured table size is 40 and there are currently 35 entries in the table, any change inthe size of the attempted registration table during rollback removes 25 oldest entries leaving only the default(10) entries before making the table size equal to the size in target configuration.


Cisco Unified CME Commands: Aattempted-registrations size

Examples The following example shows attempted-registrations size:

Router# conf tRouter(config)#voice register globalRouter(config-register-global)#attempted-registrations size 15!

Related Commands

cme_cr

Documents

forward voice

application voice voicemail

application voice service

application voice number

application voice dial

application voice drop

contentscall application

application voice maxtime