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 63-1

Unified CM Auto-Register Phone Tool 61-6

adding lines

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

field descriptions for template 3-22

to existing phones 10-8, 43-1

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

to existing user device profiles 10-8, 43-1

to phone template 3-4

associating file format for text-based CSV file 4-5, 25-1, 37-1, 56-20

auto-registration, enabled for Cisco Unified CallManager

enable auto-registration for Unified CM Auto-Register Phone Tool 61-3

auto-registration options, configuring 61-8

B

BAT

application overview 1-1

browser requirements 1-11

configuration process overview 1-3

data input files 1-2

error messages 64-3

installation 1-2

log files location 64-3

online help 1-11

scheduling jobs 63-1

troubleshooting 64-3

troubleshooting performance 64-6

version 1-11

BAT.xlt, see BAT spreadsheet

BAT Performance B-1

BAT spreadsheet

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

Catalyst 6000 FXS ports 48-3

field descriptions

adding lines 10-9, 43-3

updating users 18-2

user device profile 34-4

IP telephony devices 3-30

manager assistant associations 28-9

overview 1-8

phones 3-30

phones with users 24-1

UnifiedCMAssistant custom manager assistant for proxy mode 28-11

UnifiedCMAssistant default manager assistant 28-10

user device profile 34-2

users 15-2

using for CSV data file 1-8

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

VG224 gateway for FXS or VG224 gateway

creating CSV data file for FXS

creating CSV data file for VG224 gateway     1

browser requirements 1-11

Bulk Provisioning Service

activating BPS 63-1

deactivating BPS 63-2

C

Call Pickup Groups

BAT considerations 52-1

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

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

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

CSV file settings (table) 52-4

inserting CSV file in BAT 52-4

updating existing CSV file 52-3

using query to delete call pickup groups 53-1

Catalyst 6000 FXS ports

creating CSV data file 48-3

text-based CSV file, creating A-16

text-based CSV file format A-17

Cisco CRS

configuring Unified CM Auto-Register Phone Tool 61-6

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

troubleshooting Unified CM Auto-Register Phone Tool 64-8

Cisco Customer Response Solutions, see Cisco CRS

Cisco Unified CallManager

enable auto-registration for Unified CM Auto-Register Phone Tool 61-3

inserting

CTI ports 6-1, 17-1, 39-1, 48-1

H.323 clients 6-1, 17-1, 39-1, 48-1

phones 6-1, 17-1, 39-1, 48-1

phones with users 27-1

UnifiedCMAssistant manager-assistant associations 29-1

users 17-1

VG200 gateway (FXS or FXO) 48-6

VG200 gateway (T1 CAS or T1/E1 PRI) 48-6

overview of inserting records 1-10

CiscoUnifiedCallManager Assistant, see UnifiedCM Assistant

CiscoUnifiedCMAssistant Configuration Wizard 28-2

CiscoUnified IP-IVR

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

Client Matter Codes

BAT considerations 50-2

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

configuration checklist (table) 50-1

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

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

CSV file settings (table) 50-5

deleting code settings (BAT) 51-1

inserting CSV file in BAT 50-6

updating existing CSV file 50-4

CMC

text-based CSV file, updating A-19

configuring Cisco Unified CallManager records, process 1-3

configuring gateway file format 46-2

copying

file format for text-based CSV 36-3

file format for text-based CSV file 4-3, 46-3, 56-18

phone template 3-8

template 35-4

user template 16-3

CPG

text-based CSV file, updating A-22

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

CSV, text-based

Catalyst 6000 FXS ports, creating A-16

Catalyst 6000 FXS ports format A-17

CMC

options 50-4

updating A-19

CPG

options 52-3

updating A-22

CTI ports format A-3

CTI ports-users format A-3

FAC

options 50-4

updating A-20

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

VG224 gateways, creating A-15

CSV data file

adding new devices 1-5

overview 1-5

updating existing devices 1-6

using BAT spreadsheet (BAT.xlt) 1-8

CTI ports

deleting 8-1, 13-1, 40-1

dummy MAC address, using 6-2, 27-1, 39-2

text-based CSV format A-3

CTI ports-users

text-based CSV format A-3

custom file

deleting phones 8-3, 40-2

deleting UnifiedCMAssistant managers 31-2, 32-2

deleting users 19-2

updating phones 7-2

using 1-6

using to reset password and PIN 21-3

D

deleting

call pickup groups 53-1

file format for text-based CSV file 4-5, 36-4, 46-4

manager-assistant associations 30-1

phones using custom files 8-3, 40-2

phones using query 8-1, 13-1

phone template 3-9

remote destination file format for text-based CSV file 56-19

Remote Destination Profiles using query 56-21

template 35-5

UnifiedCMAssistant assistants 32-1

UnifiedCMAssistant managers 31-1

user device profiles 40-1

users 19-1

user template 16-3

VG200 gateway 47-1

dialed number analyzer

trace configuration files 64-1

directory number

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

lifting restrictions 61-10

restricting from Unified CM Auto-Register Phone Tool 61-10

securing from Unified CM Auto-Register Phone Tool 61-9

downloading phone configuration using Unified CM Auto-Register Phone Tool 62-3

dummy MAC address 3-32, 6-2, 27-1, 39-2

generate a list 12-5

E

E1 PRI

creating CSV file for VG200 gateway 48-1

field descriptions for VG200 gateway template 45-22

text-based CSV file format A-14

E1 PRI ports 45-8

error messages, BAT 64-3

exported fields 56-24

all phone details 9-2

all user device profile details 41-1

default phone details 9-2

default user device profile details 41-2

exporting

fields

all phone details 9-2

all user device profile details 41-1

default phone details 9-2

Default Remote Destination Profile file format details 56-24

default user device profile details 41-2

line appearance 23-1

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

phone records options 9-1

phones with more than one user 9-5

remote destination profile records options 56-22

steps for exporting phone records 9-3

user device profile options 41-3

user device profile records format 41-1

user records format 20-1

user records options 20-1

using export files 1-6

F

FAC

text-based CSV file, updating A-20

field descriptions

adding or updating lines 3-22

BAT spreadsheet

adding lines 10-9, 43-3

updating users 18-2

user device profile 34-4

phone template 3-9

updating lines 10-3, 42-3

updating users with BAT spreadsheet 18-2

user device profile template 35-2

user template 16-4

VG200 gateway - T1/E1 PRI template 45-22

VG200 gateway - T1 CAS template 45-19

file format for gateway

finding 46-1

file format for text-based CSV file

associating 4-5, 25-1, 37-1, 56-20

copying 4-3, 36-3, 46-3, 56-18

creating phone 4-2, 46-2

creating remote desination profile 56-17

creating user device profile 36-2

deleting 4-5, 36-4, 46-4

finding 4-2, 36-1, 56-16

modifying 4-4, 36-4, 46-3

overview 1-7

file format for text-based CSV file gateway

associating 46-5

finding

file 2-1

gateway file format 46-1

gateway templates 45-3

gatway file format 46-1

jobs 63-3

phone file format 4-2

phone template 3-2

remote destination file format 56-16

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

UDP file format for text-based CSV 36-1

UDP template 35-1

user template 16-1

Forced Authorization Codes

BAT considerations 50-2

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

configuration checklist (table) 50-1

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

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

CSV file settings (table) 50-5

deleting code settings (BAT) 51-1

inserting CSV file in BAT 50-6

updating existing CSV file 50-4

FXO

inserting VG200 gateway to Cisco Unified CallManager 48-6

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

FXO ports 45-7

FXS

Catalyst 6000 ports

creating CSV data file 48-3

text-based CSV format A-17

creating template for Catalyst 6000 ports 45-8

VG200 gateways

inserting to Cisco Unified CallManager 48-6

text-based CSV file format A-14

G

gateway

associating file format for text-based CSV file 46-5

gateway file format

configuring 46-2

finding 46-1

gateway template

adding or editing 45-4

Catalyst 6000 FXS ports

creating template 45-8

configuration settings 45-11

finding 45-3

port configuration settings (table) 45-35

POTS port configuration settings (table) 45-36

VG200 gateway template

creating template 45-4, 45-9

FXO ports, adding 45-7

T1-CAS ports, adding 45-8

T1 PRI or E1 PRI ports, adding 45-8

H

H.323 clients

deleting 8-1, 13-1, 40-1

text-based CSV format A-3

H.323 client-users

text-based CSV format A-3

help, online 1-11

I

inserting records to Cisco Unified CallManager, overview 1-10

installing

Unified CM Auto-Register Phone Tooloverview 61-5

Unified CM Auto-Register Phone Tool prerequisites 61-5

instructions, Unified CM Auto-Register Phone Tool for end-users 62-3

Intercom DNs

Add 45-2

intercom DNs

update 45-1

IP telephony devices

supported with BAT 16-1

IP telephony devices, see phones

J

jobs

activating BPS 63-1

deactivating BPS 63-2

finding 63-3

scheduling 63-4

viewing log files 63-6

L

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

line appearance

export 23-1

update 23-3

lines

adding or updating on template 3-4

field descriptions in template for adding or updating 3-22

master phone template 1-5

maximum number 3-5

updating to user device profiles 42-1

log files

BAT 64-3

file naming convention 64-3

report log files 12-6, 22-2, 33-2, 49-2

viewing job log files 63-6

M

master phone template 1-5

MGCP

T1-CAS ports 45-8

T1 PRI or E1 PRI ports, adding 45-8

modifying

file format for text-based CSV 36-4

file format for text-based CSV file 4-4, 46-3

phone template 3-7

remote destination file format for text-based CSV file 56-18

user template 16-3

N

NM-1V 45-12

NM-2V 45-12

NM-HDV 45-12

O

overriding template values 1-5

overview

BAT application 1-1

BAT spreadsheet 1-8

CiscoUnifiedCMAssistant 28-1

CSV data file 1-5

data input files 1-2

file formats for text-based CSV files 1-7

inserting records to Cisco Unified CallManager 1-10

installation 1-2

reports 12-1, 22-1, 44-1

templates 1-4

text-based CSV files A-1

Unified CM Auto-Register Phone Tool tool 61-1

user device profiles 34-1

users 15-1

validating 1-10

P

passwords

resetting 21-1

phones

adding

IP services 3-5

lines 3-4

lines to existing 10-8, 43-1

speed dial settings 3-6, 3-7

with users 24-1

configuring CAPF 3-44, 16-6

creating text-based CSV file A-1

deleting 8-1, 13-1, 40-1

dummy MAC address, using 3-32, 6-2, 27-1, 39-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, 17-1, 39-1, 48-1

proxy mode for UnifiedCMAssistant 28-2

reloading configurations 61-3

report options 12-3

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 28-5

UnifiedCMAssistant manager configuration 28-4

updating 7-1, 18-1, 19-1

updating with custom file 7-2

updating with query 7-1

using Unified CM Auto-Register Phone Tool to configure 61-3

enable auto-registration 61-3

validating records 5-1, 38-1

phones with users

inserting to Cisco Unified CallManager 27-1

text-based CSV format A-2

using BAT spreadsheet 24-1

validating records 26-1

PINs

resetting 21-1

prerequisites

Unified CM Auto-Register Phone Tool 61-5

Q

query

customizing a filter 1-6

deleting call pickup groups 53-1

deleting phones 8-1, 13-1

deleting Remote Destination Profiles 56-21

deleting UnifiedCMAssistant managers 31-1, 32-1

deleting users 19-1

updating lines 42-1

updating phones 7-1

using to reset password and PIN 21-1

R

remote destination file format for text-based CSV file

deleting 56-19

modifying 56-18

remote destination profile

exporting records options 56-22

Remote Destination Profile template 56-1

reports

dummy MAC addresses 12-5

overview 12-1, 22-1, 44-1

phone options 12-3

phones 12-1

UnifiedCMAssistant manager assistant 33-1

user device profile 44-1

users 22-1

VG200 gateway 49-1

resetting password and PIN

using custom file 21-3

using query 21-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 18-1

S

securing directory numbers from Unified CM Auto-Register Phone Tool 61-4, 61-9

services, adding or updating 3-5

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

sub-unit 45-5, 45-10

T

T1 CAS

creating CSV data file for VG200 gateway 48-1

field descriptions for VG200 template 45-19

text-based CSV file format A-14

T1-CAS ports, adding 45-8

T1 PRI

creating CSV file for VG200 gateway 48-1

field descriptions for VG200 gateway template 45-22

text-based CSV file format A-14

T1 PRI ports 45-8

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 35-4

copying phone 3-8

copying users 16-3

deleting 35-5

deleting phone 3-9

deleting users 16-3

field descriptions

adding or updating lines 3-22

phone 3-9

user device profiles 35-2

users 16-4

VG200 gateway - T1 CAS gateway 45-19

finding 35-1

master phone 1-5

modifying 35-4

modifying phone 3-7

modifying users 16-3

overriding values 1-5

template type

Catalyst 6000 FXS ports 45-8

IP telephony devices 3-4

phones 3-4

UnifiedCMAssistant assistant for proxy mode 28-3

UnifiedCMAssistant manager for proxy mode 28-3

user device profiles 35-2

users 16-2

VG200 gateway template 45-4, 45-9

trace configuration files

viewing 64-1

troubleshooting

BAT 64-3

BAT log files 64-3

BAT performance 64-6

Unified CM Auto-Register Phone Tool 64-7

troubleshooting message

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

BAT excel sheet does not respond to actions 64-4

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

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

cannot access complete BAT functionality 64-3

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

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

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

jobs remain in hold state 64-5

jobs remain in pending state 64-5

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

port number not configured in template 64-6

uploaded csv file does not display 64-5

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

when dialing Unified CM Auto-Register Phone Tool number, caller hears busy 64-8

U

UDP, see user device profiles

UnifiedCM Assistant

assistant template for proxy mode 28-3

creating CSV data file 28-9

deleting assistants

described 32-1

using custom file 32-2

deleting manager-assistant associations 30-1

deleting managers

described 31-1

using custom file 31-2

using query 31-1, 32-1

generating reports 33-1

inserting manager-assistant associations 29-1

manager and assistant line configurations, proxy mode 28-3

manager and assistant shared line configurations 28-8

manager template for proxy mode 28-3

overview 28-1

phones

assistant configuration options 28-5

manager configuration options 28-4

proxy line example 28-5

proxy lines on existing 28-6

proxy lines on new 28-6

proxy mode 28-2

shared line example 28-8

shared line mode 28-7

setting up phones and lines 28-1

text-based CSV file, creating A-12

text-based CSV file custom format A-13

UnifiedCMAssistant Configuration Wizard 28-2

Unified CM Auto-Register Phone Tool

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

Cisco CRS required 61-2

CiscoUnifiedIP-IVR required 61-2

configuring auto-registration options 61-8

configuring on Cisco CRS server 61-6

finding secure directory numbers 61-9

installation overview 61-5

instructions for end-users 62-3

language prompts 61-4

removing 62-2

lifting restriction on directory numbers 61-10

log files location 64-7

overview 61-1

reloading configurations 61-3

requirements 61-2

restarting service 61-7

restricting directory numbers 61-10

securing directory numbers 61-4, 61-9

setting options for using 61-8

starting service 61-7

stopping service 61-7

troubleshooting 64-7

uninstalling 61-6

uninstalling

Unified CM Auto-Register Phone Tool 61-6

update

line appearance 23-3

updating

lines to user device profiles 42-1

phone configuration using Unified CM Auto-Register Phone Tool 62-3

updating lines

field descriptions 10-3, 42-3

uploading/downloading file

delete 2-3

download 2-2

finding 2-1

upload 2-3

user device profiles

adding lines to existing 10-8, 43-1

BAT spreadsheet

field descriptions 34-4

using 34-2

creating CSV data file 34-2

deleting 40-1

export file format 41-1

export file with all details A-11

exporting record options 41-3

overview 34-1

removing 40-1

reports, generating 44-1

steps for adding 34-1

template

copying 35-4

creating 35-2

deleting 35-5

finding 35-1

modifying 35-4

text-based CSV file, creating A-9

text-based CSV file format A-9

updating lines 42-1

validating records 38-1

users

adding overview 15-1

adding with phones 24-1

creating CSV data file 15-2

deleting 19-1

using custom file 19-2

using query 19-1

exported records format 20-1

exporting records 20-1

field descriptions for updating with BAT spreadsheet 18-2

generating reports 22-1

inserting to Cisco Unified CallManager 17-1

resetting passwords and PINs 21-1

retaining stored values 18-1

template

copying 16-3

creating new 16-2

deleting 16-3

field descriptions 16-4

finding 16-1

for users 16-2

modifying 16-3

text-based CSV file, creating A-6

text-based CSV file, updating A-8

text-based CSV format A-7

updating 18-1

updating users field descriptions 18-2

users with phones

inserting to Cisco Unified CallManager 27-1

using BAT spreadsheet 24-1

validating records 26-1

V

validating

options 1-10

overview 1-10

phone and user records 26-1

phone records 5-1, 38-1

user device profile records 38-1

version, finding 1-11

VG200 gateway

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

creating template 45-4, 45-9

creating text-based CSV file A-13

deleting gateway 47-1

field descriptions

T1/E1 PRI template 45-22

T1 CAS template 45-19

generating reports 49-1

inserting to Cisco Unified CallManager (FXS or FXO) 48-6

inserting to Cisco Unified CallManager (T1 CAS or T1/E1 PRI) 48-6

VG200 gateway template

FXO ports, adding 45-7

VG224 gateway

creating text-based CSV file A-15

VIC-2FXO 45-5

VIC-2FXS 45-5, 45-10

viewing trace configuration files 64-1

VWIC-1MFT-E1 45-5

VWIC-1MFT-T1 45-5

VWIC-2MFT-E1 45-5

VWIC-2MFT-T1 45-5