Table Of Contents

A - B - C - D - E - F - G - H - I - J - L - M - N - O - P - Q - R - S - T - U - V -

Index

A

activating services

BPS 51-1

Unified CM Auto-Register Phone Tool 52-6

adding lines

field descriptions for BAT spreadsheet 10-9, 41-3

field descriptions for template 3-20

to existing phones 10-7, 41-1

to existing phones using BAT spreadsheet 10-8, 41-2

to existing user device profiles 10-7, 41-1

to phone template 3-4

associating file format for text-based CSV file 4-5, 23-1, 35-1

auto-registration, enabled for Cisco Unified CallManager

enable auto-registration for Unified CM Auto-Register Phone Tool 52-2

auto-registration options, configuring 52-7

B

BAT

application overview 1-1

browser requirements 1-10

configuration process overview 1-2

data input files 1-2

error messages 54-3

installation 1-2

log files location 54-3

online help 1-10

scheduling jobs 51-1

troubleshooting 54-3

troubleshooting performance 54-6

version 1-11

BAT.xlt, see BAT spreadsheet

BAT spreadsheet

adding lines to existing phones 10-8, 41-2

Catalyst 6000 FXS ports 44-3

field descriptions

adding lines 10-9, 41-3

updating users 17-2

user device profile 32-4

IP telephony devices 3-28

manager assistant associations 26-9

overview 1-8

phones 3-28

phones with users 22-1

UnifiedCMAssistant custom manager assistant for proxy mode 26-11

UnifiedCMAssistant default manager assistant 26-10

user device profile 32-2

users 14-2

using for CSV data file 1-8

VG200 gateway for T1 CAS or T1/E1 PRI 44-1

browser requirements 1-10

Bulk Provisioning Service

activating BPS 51-1

deactivating BPS 51-2

C

Call Pickup Groups

BAT considerations 49-1

BAT settings for inserting CSV file (table) 49-5

creating a CSV file (BAT.xlt) 49-2

creating custom CSV file (text-based) A-19

CSV file settings (table) 49-4

inserting CSV file in BAT 49-4

updating existing CSV file 49-3

using query to delete call pickup groups 50-1

Catalyst 6000 FXS ports

creating CSV data file 44-3

text-based CSV file, creating A-15

text-based CSV file format A-16

Cisco CRS

configuring Unified CM Auto-Register Phone Tool 52-5

required for Unified CM Auto-Register Phone Tool 52-2

troubleshooting Unified CM Auto-Register Phone Tool 54-8

Cisco Customer Response Solutions, see Cisco CRS

Cisco Unified CallManager

enable auto-registration for Unified CM Auto-Register Phone Tool 52-2

inserting

CTI ports 6-1, 16-1, 37-1, 44-1

H.323 clients 6-1, 16-1, 37-1, 44-1

phones 6-1, 16-1, 37-1, 44-1

phones with users 25-1

UnifiedCMAssistant manager-assistant associations 27-1

users 16-1

VG200 gateway (FXS or FXO) 44-4

VG200 gateway (T1 CAS or T1/E1 PRI) 44-4

overview of inserting records 1-9

CiscoUnifiedCallManager Assistant, see UnifiedCM Assistant

CiscoUnifiedCMAssistant Configuration Wizard 26-2

CiscoUnified IP-IVR

required for Unified CM Auto-Register Phone Tool 52-2

Client Matter Codes

BAT considerations 47-2

BAT settings for inserting CSV file (table) 47-7

configuration checklist (table) 47-1

creating a CSV file (BAT.xlt) 47-3

creating custom CSV file (text-based) A-16

CSV file settings (table) 47-5

deleting code settings (BAT) 48-1

inserting CSV file in BAT 47-6

updating existing CSV file 47-4

CMC

text-based CSV file, updating A-18

configuring Cisco Unified CallManager records, process 1-2

copying

file format for text-based CSV 34-3

file format for text-based CSV file 4-3

phone template 3-8

template 33-4

user template 15-3

CPG

text-based CSV file, updating A-20

CSV, comma separated values text file 1-2, A-1

CSV, text-based

Catalyst 6000 FXS ports, creating A-15

Catalyst 6000 FXS ports format A-16

CMC

options 47-4

updating A-18

CPG

options 49-3

updating A-20

CTI ports format A-3

CTI ports-users format A-3

FAC

options 47-4

updating A-19

FXO or FXS ports format A-14

H.323 clients format A-3

H.323 client-users format A-3

manager assistant associations

creating A-12

custom format A-13

manager assistant default formats A-12

overview A-1

phones

creating A-1

export file, all details A-4

options 4-1

tips for creating A-2

with users format A-2

T1 CAS, T1/E1 PRI format A-14

user device profile format A-9

user device profile options 34-1

user device profiles

creating A-9

export file A-11

two lines format A-10

users

creating A-6

format A-7

updating A-8

VG200 gateways, creating A-13

CSV data file

adding new devices 1-5

overview 1-4

updating existing devices 1-5

using BAT spreadsheet (BAT.xlt) 1-8

CTI ports

deleting 8-1, 13-1, 38-1

dummy MAC address, using 6-2, 25-1, 37-2

text-based CSV format A-3

CTI ports-users

text-based CSV format A-3

custom file

deleting phones 8-3, 38-2

deleting UnifiedCMAssistant managers 29-2, 30-2

deleting users 18-2

updating phones 7-2

using 1-6

using to reset password and PIN 20-3

D

deleting

call pickup groups 50-1

file format for text-based CSV file 4-5, 34-4

manager-assistant associations 28-1

phones using custom files 8-3, 38-2

phones using query 8-1, 13-1

phone template 3-9

template 33-5

UnifiedCMAssistant assistants 30-1

UnifiedCMAssistant managers 29-1

user device profiles 38-1

users 18-1

user template 15-3

VG200 gateway 45-1

dialed number analyzer

trace configuration files 54-1

directory number

finding secure directory numbers from Unified CM Auto-Register Phone Tool 52-9

lifting restrictions 52-10

restricting from Unified CM Auto-Register Phone Tool 52-9

securing from Unified CM Auto-Register Phone Tool 52-8

downloading phone configuration using Unified CM Auto-Register Phone Tool 53-2

dummy MAC address 3-30, 6-2, 25-1, 37-2

generate a list 12-5

E

E1 PRI

creating CSV file for VG200 gateway 44-1

field descriptions for VG200 gateway template 43-19

text-based CSV file format A-14

E1 PRI ports 43-7

error messages, BAT 54-3

exported fields

all phone details 9-2

all user device profile details 39-1

default phone details 9-2

default user device profile details 39-2

exporting

fields

all phone details 9-2

all user device profile details 39-1

default phone details 9-2

default user device profile details 39-2

moving records from one Cisco Unified CallManager to another 9-1

phone records options 9-1

phones with more than one user 9-5

steps for exporting phone records 9-3

user device profile options 39-3

user device profile records format 39-1

user records format 19-1

user records options 19-1

using export files 1-6

F

FAC

text-based CSV file, updating A-19

field descriptions

adding or updating lines 3-20

BAT spreadsheet

adding lines 10-9, 41-3

updating users 17-2

user device profile 32-4

phone template 3-9

updating lines 10-3, 40-3

updating users with BAT spreadsheet 17-2

user device profile template 33-2

user template 15-4

VG200 gateway - T1/E1 PRI template 43-19

VG200 gateway - T1 CAS template 43-16

file format for text-based CSV file

associating 4-5, 23-1, 35-1

copying 4-3, 34-3

creating phone 4-2

creating user device profile 34-2

deleting 4-5, 34-4

finding 4-2, 34-1

modifying 4-4, 34-4

overview 1-6

finding

file 2-1

gateway templates 43-2

jobs 51-3

phone file format 4-2

phone template 3-2

secure directory numbers from Unified CM Auto-Register Phone Tool 52-9

UDP file format for text-based CSV 34-1

UDP template 33-1

user template 15-1

Forced Authorization Codes

BAT considerations 47-2

BAT settings for inserting CSV file (table) 47-7

configuration checklist (table) 47-1

creating a CSV file (BAT.xlt) 47-3

creating custom CSV file (text-based) A-16

CSV file settings (table) 47-5

deleting code settings (BAT) 48-1

inserting CSV file in BAT 47-6

updating existing CSV file 47-4

FXO

inserting VG200 gateway to Cisco Unified CallManager 44-4

text-based CSV file format for VG200 gateway A-14

FXO ports 43-6

FXS

Catalyst 6000 ports

creating CSV data file 44-3

text-based CSV format A-16

creating template for Catalyst 6000 ports 43-8

VG200 gateways

inserting to Cisco Unified CallManager 44-4

text-based CSV file format A-14

G

gateway template

adding or editing 43-3

Catalyst 6000 FXS ports

creating template 43-8

configuration settings 43-9

finding 43-2

port configuration settings (table) 43-32

POTS port configuration settings (table) 43-33

VG200 gateway template

creating template 43-4

FXO ports, adding 43-6

T1-CAS ports, adding 43-7

T1 PRI or E1 PRI ports, adding 43-7

H

H.323 clients

deleting 8-1, 13-1, 38-1

text-based CSV format A-3

H.323 client-users

text-based CSV format A-3

help, online 1-10

I

inserting records to Cisco Unified CallManager, overview 1-9

installing

Unified CM Auto-Register Phone Tooloverview 52-4

Unified CM Auto-Register Phone Tool prerequisites 52-4

instructions, Unified CM Auto-Register Phone Tool for end-users 53-2

IP telephony devices

supported with BAT 15-1

IP telephony devices, see phones

J

jobs

activating BPS 51-1

deactivating BPS 51-2

finding 51-3

scheduling 51-4

viewing log files 51-6

L

language prompts for Unified CM Auto-Register Phone Tool 52-4

lines

adding or updating on template 3-4

field descriptions in template for adding or updating 3-20

master phone template 1-4

maximum number 3-5

updating to user device profiles 40-1

log files

BAT 54-3

file naming convention 54-3

report log files 12-6, 21-2, 31-2, 46-2

viewing job log files 51-6

M

master phone template 1-4

MGCP

T1-CAS ports 43-7

T1 PRI or E1 PRI ports, adding 43-7

modifying

file format for text-based CSV 34-4

file format for text-based CSV file 4-4

phone template 3-7

user template 15-3

N

NM-1V 43-10

NM-2V 43-10

NM-HDV 43-10

O

overriding template values 1-5

overview

BAT application 1-1

BAT spreadsheet 1-8

CiscoUnifiedCMAssistant 26-1

CSV data file 1-4

data input files 1-2

file formats for text-based CSV files 1-6

inserting records to Cisco Unified CallManager 1-9

installation 1-2

reports 12-1, 21-1, 42-1

templates 1-4

text-based CSV files A-1

Unified CM Auto-Register Phone Tool tool 52-1

user device profiles 32-1

users 14-1

validating 1-9

P

passwords

resetting 20-1

phones

adding

IP services 3-5

lines 3-4

lines to existing 10-7, 41-1

new 3-1

speed dial settings 3-6, 3-7

with users 22-1

configuring CAPF 3-41, 15-6

creating text-based CSV file A-1

deleting 8-1, 13-1, 38-1

dummy MAC address, using 3-30, 6-2, 25-1, 37-2

dummy MAC addresses list 12-5

export file with all details A-4

exporting records options 9-1

exporting records steps 9-3

generating reports 12-1

insert to Cisco Unified CallManager 6-1, 16-1, 37-1, 44-1

proxy mode for UnifiedCMAssistant 26-2

reloading configurations 52-3

report options 12-3

steps for adding 3-1

template

copying 3-8

creating new 3-4

deleting 3-9

field descriptions 3-9

finding template 3-2

for IP telephony devices 3-4

modifying 3-7

UnifiedCMAssistant assistant 26-5

UnifiedCMAssistant manager configuration 26-4

updating 7-1, 17-1, 18-1

updating with custom file 7-2

updating with query 7-1

using Unified CM Auto-Register Phone Tool to configure 52-2

enable auto-registration 52-2

validating records 5-1, 36-1

phones with users

inserting to Cisco Unified CallManager 25-1

text-based CSV format A-2

using BAT spreadsheet 22-1

validating records 24-1

PINs

resetting 20-1

prerequisites

Unified CM Auto-Register Phone Tool 52-4

Q

query

customizing a filter 1-6

deleting call pickup groups 50-1

deleting phones 8-1, 13-1

deleting UnifiedCMAssistant managers 29-1, 30-1

deleting users 18-1

updating lines 40-1

updating phones 7-1

using to reset password and PIN 20-1

R

reports

dummy MAC addresses 12-5

overview 12-1, 21-1, 42-1

phone options 12-3

phones 12-1

UnifiedCMAssistant manager assistant 31-1

user device profile 42-1

users 21-1

VG200 gateway 46-1

resetting password and PIN

using custom file 20-3

using query 20-1

resetting phones

after update 11-1

using custom file 11-2

using query 11-1

restarting phones

after update 11-1

using custom file 11-2

using query 11-1

retaining user records when updating 17-1

S

securing directory numbers from Unified CM Auto-Register Phone Tool 52-4, 52-8

services, adding or updating 3-5

speed dial settings, adding or updating 3-6, 3-7

sub-unit 43-4

T

T1 CAS

creating CSV data file for VG200 gateway 44-1

field descriptions for VG200 template 43-16

text-based CSV file format A-14

T1-CAS ports, adding 43-7

T1 PRI

creating CSV file for VG200 gateway 44-1

field descriptions for VG200 gateway template 43-19

text-based CSV file format A-14

T1 PRI ports 43-7

templates

adding or updating IP services 3-5

adding or updating lines 3-4

adding or updating speed dial settings 3-6, 3-7

BAT template overview 1-4

copying 33-4

copying phone 3-8

copying users 15-3

deleting 33-5

deleting phone 3-9

deleting users 15-3

field descriptions

adding or updating lines 3-20

phone 3-9

user device profiles 33-2

users 15-4

VG200 gateway - T1 CAS gateway 43-16

finding 33-1

master phone 1-4

modifying 33-4

modifying phone 3-7

modifying users 15-3

overriding values 1-5

template type

Catalyst 6000 FXS ports 43-8

IP telephony devices 3-4

phones 3-4

UnifiedCMAssistant assistant for proxy mode 26-3

UnifiedCMAssistant manager for proxy mode 26-2

user device profiles 33-2

users 15-2

VG200 gateway template 43-4

trace configuration files

viewing 54-1

troubleshooting

BAT 54-3

BAT log files 54-3

BAT performance 54-6

Unified CM Auto-Register Phone Tool 54-7

troubleshooting message

BAT.xlt spreadsheet does not work with Excel XP (Office XP) 54-6

BAT excel sheet does not respond to actions 54-4

BAT menu does not display in Cisco Unified CallManager 54-3

BAT spreadsheet gives a compilation error while exporting data 54-4

cannot access complete BAT functionality 54-3

CSV data files do not match phone template/sample file 54-4

export to BAT does not work in BAT.xlt file 54-4

job does not display in find and list job window 54-5

jobs remain in hold state 54-5

jobs remain in pending state 54-5

MAC address values are not allowed in CSV file if dummy MAC address option selected 54-6

port number not configured in template 54-6

uploaded csv file does not display 54-5

when Cisco CRS starts, JTAPI shows partial service or out of service 54-8

when dialing Unified CM Auto-Register Phone Tool number, caller hears busy 54-7

U

UDP, see user device profiles

UnifiedCM Assistant

assistant template for proxy mode 26-3

creating CSV data file 26-9

deleting assistants

described 30-1

using custom file 30-2

deleting manager-assistant associations 28-1

deleting managers

described 29-1

using custom file 29-2

using query 29-1, 30-1

generating reports 31-1

inserting manager-assistant associations 27-1

manager and assistant line configurations, proxy mode 26-3

manager and assistant shared line configurations 26-8

manager template for proxy mode 26-2

overview 26-1

phones

assistant configuration options 26-5

manager configuration options 26-4

proxy line example 26-5

proxy lines on existing 26-6

proxy lines on new 26-6

proxy mode 26-2

shared line example 26-8

shared line mode 26-7

setting up phones and lines 26-1

text-based CSV file, creating A-12

text-based CSV file custom format A-13

UnifiedCMAssistant Configuration Wizard 26-2

Unified CM Auto-Register Phone Tool

activating Unified CM Auto-Register Phone Tool service 52-6

Cisco CRS required 52-2

CiscoUnifiedIP-IVR required 52-2

configuring auto-registration options 52-7

configuring on Cisco CRS server 52-5

finding secure directory numbers 52-9

installation overview 52-4

instructions for end-users 53-2

language prompts 52-4

removing 53-2

lifting restriction on directory numbers 52-10

log files location 54-7

overview 52-1

reloading configurations 52-3

requirements 52-2

restarting service 52-6

restricting directory numbers 52-9

securing directory numbers 52-4, 52-8

setting options for using 52-7

starting service 52-6

stopping service 52-6

troubleshooting 54-7

uninstalling 52-5

uninstalling

Unified CM Auto-Register Phone Tool 52-5

updating

lines to user device profiles 40-1

phone configuration using Unified CM Auto-Register Phone Tool 53-2

updating lines

field descriptions 10-3, 40-3

uploading/downloading file

delete 2-3

download 2-2

finding 2-1

upload 2-3

user device profiles

adding lines to existing 10-7, 41-1

BAT spreadsheet

field descriptions 32-4

using 32-2

creating CSV data file 32-2

deleting 38-1

export file format 39-1

export file with all details A-11

exporting record options 39-3

overview 32-1

removing 38-1

reports, generating 42-1

steps for adding 32-1

template

copying 33-4

creating 33-2

deleting 33-5

finding 33-1

modifying 33-4

text-based CSV file, creating A-9

text-based CSV file format A-9

updating lines 40-1

validating records 36-1

users

adding overview 14-1

adding with phones 22-1

creating CSV data file 14-2

deleting 18-1

using custom file 18-2

using query 18-1

exported records format 19-1

exporting records 19-1

field descriptions for updating with BAT spreadsheet 17-2

generating reports 21-1

inserting to Cisco Unified CallManager 16-1

resetting passwords and PINs 20-1

retaining stored values 17-1

template

copying 15-3

creating new 15-2

deleting 15-3

field descriptions 15-4

finding 15-1

for users 15-2

modifying 15-3

text-based CSV file, creating A-6

text-based CSV file, updating A-8

text-based CSV format A-7

updating 17-1

updating users field descriptions 17-2

users with phones

inserting to Cisco Unified CallManager 25-1

using BAT spreadsheet 22-1

validating records 24-1

V

validating

options 1-9

overview 1-9

phone and user records 24-1

phone records 5-1, 36-1

user device profile records 36-1

version, finding 1-11

VG200 gateway

creating CSV data file for T1 CAS or T1/E1 PRI 44-1

creating template 43-4

creating text-based CSV file A-13

deleting gateway 45-1

field descriptions

T1/E1 PRI template 43-19

T1 CAS template 43-16

generating reports 46-1

inserting to Cisco Unified CallManager (FXS or FXO) 44-4

inserting to Cisco Unified CallManager (T1 CAS or T1/E1 PRI) 44-4

VG200 gateway template

FXO ports, adding 43-6

VIC-2FXO 43-5

VIC-2FXS 43-4

viewing trace configuration files 54-1

VWIC-1MFT-E1 43-5

VWIC-1MFT-T1 43-5

VWIC-2MFT-E1 43-5

VWIC-2MFT-T1 43-5