PDF - Complete Book (9.47 MB)

Cisco Unified Communications Manager Express Command ReferenceLast Modified: 2018-03-30

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

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-assign (auto-register) 58

Cisco Unified Communications Manager Express Command Reference iii

auto logout 60

auto logout (voice hunt-group) 64

auto-answer 66

auto-line 68

auto-network-detect 70

auto-register 72

auto-reg-ephone 74

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

b2bua 78

background save interval 80

bandwidth video tias-modifier 81

blf-speed-dial 83

bnea 86

bpa 88

bulk 90

bulk-speed-dial prefix 92

busy-trigger-per-button 94

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

button 98

button-layout (voice register template) 106

button-layout 108

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

call application voice aa-hunt 114

call application voice aa-name 117

call application voice aa-pilot 119

call application voice call-retry-timer 121

call application voice dial-by-extension-option 123

call application voice drop-through-option 125

call application voice drop-through-prompt 126

call application voice handoff-string 127

call application voice max-extension-length 128

call application voice max-time-call-retry 129

call application voice max-time-vm-retry 132

Cisco Unified Communications Manager Express Command Referenceiv

Contents

call application voice number-of-hunt-grps 133

call application voice queue-len 135

call application voice queue-manager-debugs 138

call application voice second-greeting-time 140

call application voice service-name 142

call application voice voice-mail 143

call application voice welcome-prompt 145

callback (voice emergency response settings) 147

caller-id 149

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

caller-id block (voice register template) 153

caller-id block code (telephony-service) 155

call-feature-uri 156

call-forward 158

call-forward (voice register) 160

call-forward all 162

call-forward b2bua all 164

call-forward b2bua busy 166

call-forward b2bua mailbox 168

call-forward b2bua night-service 171

call-forward b2bua noan 173

call-forward b2bua unreachable 175

call-forward busy 177

call-forward max-length 180

call-forward night-service 182

call-forward noan 184

call-forward pattern 187

calling-number local 189

calling-number local (voice register global) 192

callqueue-display 193

call-park system 194

call-waiting (voice register pool) 196

call-waiting beep 197

call-waiting ring 199

camera 201

Cisco Unified Communications Manager Express Command Reference v

Contents

capf-auth-str 203

capf-server 205

cert-enroll-trustpoint 206

clear cti session 208

clear telephony-service conference hardware number 210

clear telephony-service ephone-attempted-registrations 211

clear telephony-service xml-event-log 212

clear voice fac statistics 213

clear voice lpcor statistics 214

clear voice moh-group statistics 215

clear voice register attempted-registrations 216

cnf-file 218

cnf-file location 220

codec (ephone) 222

codec (telephony-service) 225

conference (ephone-dn) 227

conference (voice register template) 229

conference add-mode 231

conference add-mode (voice register) 233

conference admin 235

conference admin (voice register) 237

conference drop-mode 239

conference drop-mode (voice register) 241

conference hardware 243

conference hardware (voice register global) 245

conference max-length 247

conference-pattern blocked 249

conference transfer-pattern 251

cor (ephone-dn) 252

cor (voice register) 253

corlist 256

create cnf-files 258

create cnf-files (voice-gateway) 260

create profile (voice register global) 262

credentials 264

Cisco Unified Communications Manager Express Command Referencevi

Contents

cti csta mode basic 267

cti message device-id suppress-conversion 268

cti notify 270

cti watch 272

cti-aware 274

ctl-client 276

ctl-service admin 277

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

date-format (telephony-service) 282

date-format (voice register global) 283

debug callmonitor 285

debug capf-server 288

debug cch323 video 290

debug credentials 292

debug cti 295

debug ctl-client 297

debug ephone alarm 298

debug ephone blf 300

debug ephone ccm-compatible 302

debug ephone detail 304

debug ephone error 308

debug ephone extension-assigner 310

debug ephone hfs 312

debug ephone keepalive 314

debug ephone loopback 316

debug ephone lpcor 321

debug ephone message 323

debug ephone mlpp 325

debug ephone moh 327

debug ephone mwi 330

debug ephone paging 332

debug ephone pak 334

debug ephone qov 337

debug ephone raw 340

Cisco Unified Communications Manager Express Command Reference vii

Contents

debug ephone register 342

debug ephone sccp-state 344

debug ephone shared-line-mixed 346

debug ephone state 349

debug ephone statistics 352

debug ephone video 354

debug ephone vm-integration 356

debug ephone whisper-intercom 358

debug mwi relay errors 360

debug mwi relay events 362

debug shared-line 364

debug voice register errors 367

debug voice register events 369

default (voice hunt-group) 373

description (ephone) 375

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

description (ephone-hunt) 378

description (voice hunt-group) 379

description (voice moh-group) 380

description (voice register pool) 382

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

device-id (ephone-type) 385

device-name 387

device-security-mode 388

device-type 390

dial-peer no-match isdn disconnect-cause 393

dialplan 394

dialplan-pattern 396

dialplan-pattern (call-manager-fallback) 400

dialplan-pattern (voice register) 404

digit collect kpml 407

direct-inward-dial isdn 409

directory 411

directory entry 413

display-logout 415

Cisco Unified Communications Manager Express Command Referenceviii

Contents

dnd (voice register pool) 416

dnd feature-ring 417

dnd-control (voice register template) 419

dn-webedit 420

dst (voice register global) 422

dst auto-adjust (voice register global) 424

dtmf-relay (voice register pool) 426

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

elin 431

elin (voice emergency response settings) 433

em external 435

em keep-history 437

em logout 438

emadmin login 440

emadmin logout 442

emergency response callback 443

emergency response location 445

emergency response zone 447

ephone 449

ephone-dn 451

ephone-dn-template 454

ephone-dn-template (ephone-dn) 456

ephone-hunt 458

ephone-hunt login 462

ephone-hunt statistics write-all 464

ephone-template 466

ephone-template (ephone) 469

ephone-type 472

exclude 474

exclude (voice register) 476

expiry 477

extension-assigner tag-type 479

extension-range 481

external-ring (voice register global) 483

Cisco Unified Communications Manager Express Command Reference ix

Contents

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

fac 486

fac refer 493

fail-connect-time 494

fastdial 496

feature-button 498

feature-button (voice_register_pool) 500

features blocked 502

feed 504

file text (voice register global) 507

filename 508

final 510

final (voice hunt-group) 512

forward local-calls 514

forward local-calls (voice hunt-group) 516

forwarding local (voice register global) 518

from-ring 519

fwd-final 521

fxo hook-flash 523

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

gsm-support 526

group (lpcor custom) 527

group (telephony-service) 529

group phone 531

group (voice register global) 533

group (voice register pool) 535

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

headset auto-answer line 538

hfs enable 540

hfs home-path 542

hlog-block (voice hunt-group) 544

hold-alert 545

Cisco Unified Communications Manager Express Command Referencex

Contents

hold-alert (voice register global) 548

hops 550

hops (voice hunt-group) 552

host-id-check 554

hunt-group report url 556

hunt-group statistics write-v2 557

hunt-group logout 560

hunt-group report delay hours 563

hunt-group report every hours 565

hunt-group statistics write-all 567

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

huntstop (voice register dn) 574

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

ica 578

id (voice register pool) 580

import certificate 583

index (lpcor ip-phone) 585

index (lpcor ip-trunk) 587

intercom (ephone-dn) 589

intercom (voice register dn) 592

internal-call 594

ip address trusted authenticate 596

ip address trusted call-block cause 598

ip address trusted list 600

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

ip source-address (credentials) 605

ip source-address (telephony-service) 607

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

keepalive (ephone and ephone-template) 612

keepalive (telephony-service) 614

keepalive (voice register global) 615

keepalive (voice register session-server) 616

keepalive (vpn-profile) 618

Cisco Unified Communications Manager Express Command Reference xi

Contents

keep-conference 620

keep-conference (voice register) 623

keygen-retry 625

keypad-normalize 627

keyphone 628

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

label 632

label (voice register dn) 634

list (ephone-hunt) 636

list (voice hunt-group) 639

live-record 641

load (telephony-service) 643

load (voice register global) 650

load-cfg-file 655

loc2 657

location (voice emergency response zone) 659

log password 661

log table 663

logging (voice emergency response settings) 665

login (telephony-service) 667

logo (voice register global) 669

logout-profile 670

loopback-dn 672

lpcor incoming 677

lpcor outgoing 680

lpcor type 683

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

mac-address (ephone) 687

mac-address (voice-gateway) 689

mailbox-selection (dial-peer) 691

mailbox-selection (ephone-dn) 693

max-calls-per-button 695

max-conferences 697

Cisco Unified Communications Manager Express Command Referencexii

Contents

max-dn 699

max-dn (voice register global) 702

max-ephones 704

max-idle-time 706

maximum bit-rate (video) 708

max-pool (voice register global) 709

max-presentation 711

max-redirect 713

max-subscription 715

max-timeout 717

media 719

members logout 723

members logout (voice hunt-group) 724

missed-calls 726

mlpp indication 728

mlpp max-precedence 730

mlpp preemption 732

mlpp service-domain 734

mobility (ephone-dn) 736

mobility (voice register dn) 738

mode cme 739

moh (ephone-dn) 741

moh (telephony-service) 744

moh (voice moh-group) 746

moh-file-buffer 748

moh-group (ephone-dn) 750

mtp 752

mtu (vpn-profile) 754

multicast moh 756

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

mwi (voice register dn) 762

mwi expires 763

mwi prefix 764

mwi qsig 766

mwi reg-e164 768

Cisco Unified Communications Manager Express Command Reference xiii

Contents

mwi relay 769

mwi sip 770

mwi sip-server 772

mwi stutter (voice register global) 775

mwi-line 776

mwi-type 779

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

name (ephone-dn) 785

name (ephone-hunt) 787

name (voice emergency response location) 789

name (voice hunt-group) 791

name (voice register dn) 793

network-locale (ephone-template) 795

network-locale (telephony-service) 797

network-locale (voice-gateway) 803

night-service bell 806

night-service bell (ephone-dn) 808

night-service code 810

night-service date 812

night-service day 814

night-service everyday 816

night-service weekday 818

night-service weekend 820

no-reg 822

no-reg (voice register dn) 824

nte-end-digit-delay 825

ntp-server 827

number (ephone-dn) 829

night-service bell (voice register dn) 832

night-service bell (voice register pool) 834

night-service bell (voice register template) 836

number (voice register dn) 838

number (voice register pool) 840

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

Cisco Unified Communications Manager Express Command Referencexiv

Contents

num-buttons 847

num-line 849

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

olsontimezone 852

olsontimezone 854

overlap-signal 856

overwrite-dyn-stats (voice hunt-group) 858

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

paging 862

paging group 865

paging-dn 869

paging-dn (voice register) 872

param 874

param aa-hunt 877

param aa-pilot 879

param call-retry-timer 881

param co-did-max 883

param co-did-min 885

param dial-by-extension-option 887

param did-prefix 889

param drop-through-option 891

param drop-through-prompt 893

param ea-password 895

param handoff-string 897

param max-extension-length 899

param max-time-call-retry 901

param max-time-vm-retry 904

param menu-timeout 906

param number-of-hunt-grps 908

param queue-exit-extension 910

param queue-exit-option 912

param queue-len 914

param queue-manager-debugs 916

Cisco Unified Communications Manager Express Command Reference xv

Contents

param queue-overflow-extension 918

param secondary-prefix 920

param second-greeting-time 922

param send-account true 924

param service-name 926

param store-did-max 928

param store-did-min 930

param voice-mail 932

param welcome-prompt 934

paramspace callsetup after-hours-exempt 937

park reservation-group 939

park-slot 941

password (auto-register) 947

password-persistent 949

pattern (voice register dialplan) 951

pattern direct 953

pattern ext-to-ext busy 956

pattern ext-to-ext no-answer 959

pattern trunk-to-ext busy 962

pattern trunk-to-ext no-answer 965

phone-display 968

phone-mode only 969

phone-key-size 970

phoneload 972

phoneload-support 973

phone-redirect-limit (voice register global) 974

phone-ui park-list 975

phone-ui speeddial-fastdial 976

phone-ui voice-hunt-groups 977

pickup-call any-group 978

pickup-group 980

pilot 982

pilot (voice hunt-group) 985

pin 987

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

Cisco Unified Communications Manager Express Command Referencexvi

Contents

pin (voice register pool) 991

port (CAPF-server) 992

preemption reserve timer 993

preemption tone timer (voice MLPP) 994

preemption trunkgroup 996

preemption user 997

preference (ephone-dn) 998

preference (ephone-hunt) 1000

preference (voice hunt-group) 1002

preference (voice register dn) 1004

preference (voice register pool) 1006

presence 1008

presence call-list 1010

presence enable 1012

present-call 1014

present-call (voice hunt-group) 1016

privacy (ephone) 1018

privacy (telephony-service) 1020

privacy (voice register global) 1022

privacy (voice register pool) 1024

privacy-button 1026

privacy-button (voice register pool) 1028

privacy-on-hold 1030

privacy-on-hold (voice register global) 1031

protocol mode 1032

protocol-mode (telephony-service) 1034

provision-tag 1036

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

refer target dial-peer 1040

refer-ood enable 1042

reference-pooltype 1044

regenerate (ctl-client) 1045

register-id 1046

registrar server (SIP) 1048

Cisco Unified Communications Manager Express Command Reference xvii

Contents

reset (ephone) 1050

reset (telephony-service) 1052

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

reset (voice register global) 1057

reset (voice register pool) 1058

reset (voice-gateway) 1059

reset tapi 1060

restart (ephone) 1061

restart (telephony-service) 1063

restart (voice register) 1065

restart (voice-gateway) 1067

ring (ephone-dn) 1068

route-code 1070

rule (voice translation-rule) 1071

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

sast1 trustpoint 1079

sast2 trustpoint 1081

sdspfarm conference lecture mode on 1083

sdspfarm conference mute-on mute-off 1085

sdspfarm tag 1086

sdspfarm transcode sessions 1088

sdspfarm units 1090

sdspfarm unregister force 1092

secondary dialtone (voice port) 1094

secondary start 1095

secondary-dialtone 1097

secure-signaling trustpoint 1099

semi-attended enable (voice register template) 1100

server (CTL-client) 1102

server (presence) 1104

server-security-mode 1106

service directed-pickup 1108

service dnis dir-lookup 1111

service dnis overlay 1114

Cisco Unified Communications Manager Express Command Referencexviii

Contents

service dss 1116

service https (ephone-template) 1118

service https (telephony-service) 1119

service https (voice register global) 1120

service https (voice register template) 1121

service local-directory 1122

service phone 1125

service profile 1137

service-digit 1138

service-enable (auto-register) 1140

service-domain 1142

service-domain (voice class) 1144

service-domain midcall-mismatch 1146

session-server 1148

session-transport 1150

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

shared-line 1158

shared-line sip 1160

show capf-server 1162

show credentials 1164

show cti 1166

show ctl-client 1169

show ephone 1170

show ephone attempted-registrations 1176

show ephone cfa 1178

show ephone dn 1179

show ephone dnd 1180

show ephone login 1181

show ephone moh 1184

show ephone offhook 1186

show ephone overlay 1188

show ephone phone-load 1190

show ephone registered 1192

show ephone registered summary 1194

Cisco Unified Communications Manager Express Command Reference xix

Contents

show ephone remote 1196

show ephone ringing 1197

show ephone rtp connections 1198

show ephone socket 1201

show ephone summary brief 1203

show ephone summary 1205

show ephone summary types 1207

show ephone tapiclients 1208

show ephone telephone-number 1209

show ephone unregistered 1210

show ephone unregistered summary 1211

show ephone-dn 1213

show ephone-dn callback 1221

show ephone-dn conference 1223

show ephone-dn loopback 1225

show ephone-dn paging 1228

show ephone-dn park 1231

show ephone-dn statistics 1233

show ephone-dn summary 1235

show ephone-dn whisper 1237

show ephone-hunt 1239

show ephone-hunt statistics 1247

show fb-its-log 1252

show ip address trusted list 1255

show presence global 1256

show presence subscription 1259

show sdspfarm 1263

show shared-line 1269

show telephony-service admin 1272

show telephony-service all 1274

show telephony-service bulk-speed-dial 1279

show telephony-service conference hardware 1282

show telephony-service directory-entry 1286

show telephony-service ephone 1288

show telephony-service ephone-dn 1291

Cisco Unified Communications Manager Express Command Referencexx

Contents

show telephony-service ephone-dn-template 1293

show telephony-service ephone-template 1294

show telephony-service fac 1298

show telephony-service security-info 1299

show telephony-service tftp-bindings 1300

show telephony-service voice-port 1302

show voice emergency 1304

show voice emergency addresses 1305

show voice emergency all 1307

show voice emergency callers 1309

show voice emergency zone 1311

show voice fac statistics 1313

show voice hunt-group 1314

show voice hunt-group statistics 1320

show voice register all 1325

show voice register credential 1335

show voice register dial-peers 1337

show voice register dialplan 1339

show voice register dn 1342

show voice register global 1345

show voice register hfs 1350

show voice register pool 1352

show voice register pool after-hour-exempt 1360

show voice register pool attempted-registrations 1362

show voice register pool cfa 1364

show voice register pool connected 1366

show voice register pool ip 1369

show voice register pool mac 1371

show voice register pool on-hold 1373

show voice register pool phone-load 1376

show voice register pool registered 1377

show voice register pool remote 1384

show voice register pool ringing 1386

show voice register pool telephone-number 1388

show voice register pool type 1390

Cisco Unified Communications Manager Express Command Reference xxi

Contents

show voice register pool type summary 1393

show voice register pool unregistered 1394

show voice register profile 1396

show voice register session-server 1399

show voice register statistics 1401

show voice register template 1405

show voice register tftp-bind 1409

shutdown(telephony-service) 1412

sip-prefix 1414

snr 1415

snr (voice register dn) 1417

snr answer-too-soon 1420

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

snr calling-number local 1423

snr calling-number local (voice register dn) 1425

snr mode 1426

snr ring-stop 1428

snr ring-stop (voice register dn) 1429

softkeys alerting 1430

softkeys connected (voice register template) 1432

softkeys connected 1435

softkeys hold 1438

softkeys idle 1440

softkeys idle (voice register template) 1443

softkeys remote-in-use 1445

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

softkeys ringin (voice register template) 1449

softkeys ringing 1451

softkeys seized 1454

softkeys seized (voice register template) 1457

source-addr 1459

source-address (voice register global) 1460

speed-dial 1462

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

speed-dial (voice register pool) 1467

Cisco Unified Communications Manager Express Command Referencexxii

Contents

srst dn line-mode 1470

srst dn template 1472

srst ephone description 1474

srst ephone template 1476

srst mode auto-provision 1478

standby username password 1480

statistics collect 1482

statistics collect (voice hunt-group) 1484

subnet 1485

system message 1487

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

telephony-service 1491

telnet-support 1497

template (auto-register) 1498

template (voice register pool) 1500

tftp-path (voice register global) 1502

tftp-server-credentials trustpoint 1504

time-format 1505

time-format (voice register global) 1506

timeout (ephone-hunt) 1507

timeout (voice hunt-group) 1510

timeouts busy 1512

timeouts interdigit (telephony-service) 1513

timeouts interdigit (voice register global) 1515

timeouts night-service-bell 1516

timeouts ringing (telephony-service) 1518

timeouts transfer-recall 1519

timeouts transfer-recall (voice register global) 1521

timeouts transfer-recall (voice register dn) 1523

time-webedit (telephony-service) 1525

time-zone 1527

timezone (voice register global) 1534

transfer max-length 1538

transfer-attended (voice register template) 1540

Cisco Unified Communications Manager Express Command Reference xxiii

Contents

transfer-blind (voice register template) 1542

transfer-digit-collect 1544

transfer-mode 1546

transfer-park blocked 1548

transfer-pattern (telephony-service) 1550

transfer-pattern blocked 1552

transfer-system 1554

translate (ephone-dn) 1558

translate callback-number 1560

translate-outgoing (voice register pool) 1562

translation-profile 1564

translation-profile incoming 1566

transport (voice register pool-type) 1568

trunk 1569

trustpoint (credentials) 1572

trustpoint-label 1574

type 1575

type (voice register dialplan) 1582

type (voice register pool) 1584

type (voice-gateway) 1590

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

upa 1594

upgrade (voice register global) 1596

url (telephony-service) 1598

url (voice register global) 1601

url (voice register template) 1603

url authentication 1605

url idle 1607

url services (ephone-template) 1609

url-button 1611

url-button (voice-register-template) 1613

user (voice logout-profile) 1615

user (voice user-profile) 1617

user-locale (ephone-template) 1619

Cisco Unified Communications Manager Express Command Referencexxiv

Contents

user-locale (telephony-service) 1621

user-locale (voice register) 1627

username (ephone) 1631

username (voice register pool) 1633

utf8 1635

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

vad (voice register pool) 1639

vad (voice register template) 1640

vca 1641

video 1643

video (ephone) 1645

video (telephony-service) 1647

video screening (voice service sip) 1649

video-bitrate (ephone) 1650

vm-device-id (ephone) 1651

vm-integration 1653

voice class mlpp 1655

voice emergency response location 1656

voice emergency response settings 1658

voice emergency response zone 1660

voice hunt-group 1662

voice-hunt-groups login 1666

voice lpcor call-block cause 1668

voice lpcor custom 1673

voice lpcor enable 1675

voice lpcor ip-phone mobility 1677

voice lpcor ip-phone subnet 1679

voice lpcor ip-trunk subnet incoming 1681

voice lpcor policy 1683

voice mlpp 1685

voice moh-group 1686

voice register dialplan 1688

voice register dn 1690

voice register global 1692

Cisco Unified Communications Manager Express Command Reference xxv

Contents

voice register pool 1694

voice register pool-type 1696

voice register session-server 1699

voice register template 1701

voice user-profile 1703

voice-class codec (voice register pool) 1705

voice-class mlpp (dial peer) 1707

voice-class stun-usage 1709

voice-gateway system 1711

voicemail (telephony-service) 1713

voicemail (voice register global) 1715

voicemail (voice register template) 1717

voice-port (voice-gateway) 1719

vpn-gateway 1721

vpn-group 1723

vpn-hash-algorithm 1725

vpn-profile 1727

vpn-trustpoint 1729

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

web admin customer 1732

web admin system 1734

web customize load 1736

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

xml-config 1738

xmlschema 1740

xmltest 1741

xmlthread 1742

xml user 1743

Cisco Unified Communications Manager Express Command Referencexxvi

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 1

authentication credential, page 49

auto assign, page 51

auto-assign (auto-register), page 58

auto logout, page 60

auto logout (voice hunt-group), page 64

auto-answer, page 66

auto-line, page 68

auto-network-detect, page 70

auto-register, page 72

auto-reg-ephone, page 74

Cisco Unified Communications Manager Express Command Reference2

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-reg

PDF - Complete Book (9.47 MB)

Documents

Transcript of PDF - Complete Book (9.47 MB)