The Bulk Administration Tool (BAT) is mainly used to insert users,
phones, gateways, Forced Authorization Code (FAC), Client Matter Code (CMC),
and others, but it can also be used to update devices, users, phones, etc. BAT
is usually used to bulk import certain devices, such as phones and users,
especially during big phone deployments.
The information in this document is based on these software and
Cisco CallManager 5.x and later
Bulk Administration Tool
The information in this document was created from the devices in a
specific lab environment. All of the devices used in this document started with
a cleared (default) configuration. If your network is live, make sure that you
understand the potential impact of any command.
In order to export the CSV data file and update CONTROLLED DEVICES of
existing users, complete these steps:
From Cisco Unified Call Manager Administration main page, choose
Bulk Administration > Users >
The Export Users Query window displays.
Click Find but do not enter any search text in
order to find all the users that are registered in the
Configure these settings in the Export Users Configuration window:
In the File Name text box, enter users as the
Choose All User Format from the File Format
In the Job Information area, enter Export Users
as the job description.
Click the Run Immediately radio button to export
user records immediately
Click Submit in order to create a job to export
Use the Job Scheduler option in the Bulk
Administration main menu in order to activate this job.
You can now search and download the exported file with the
Upload/Download Files option in the Bulk Administration
Open the downloaded users.csv file with Microsoft
Excel. The exported users.csv file has these columns:
FIRST NAME,MIDDLE NAME,LAST NAME,USER ID,PASSWORD,MANAGER USER ID,DEPARTMENT,PIN,DEFAULT PROFILE,USER LOCALE,TELEPHONE NUMBER,PRIMARY EXTENSION,ASSOCIATED PC,IPCC EXTENSION,MAIL ID,PRESENCE GROUP,SUBSCRIBE CALLING SEARCH SPACE,ALLOW CONTROL OF DEVICE FROM CTI,DIGEST CREDENTIALS,USER GROUP,CONTROLLED PROFILE,CONTROLLED DEVICE,PASSWORD LOCKED BY ADMIN,PASSWORD CANT CHANGE,PASSWORD MUST CHANGE AT NEXT LOGIN,PASSWORD DOES NOT EXPIRE,PASSWORD AUTHENTICATION RULE,PIN LOCKED BY ADMIN,PIN CANT CHANGE,PIN MUST CHANGE AT NEXT LOGIN,PIN DOES NOT EXPIRE,PIN AUTHENTICATION RULE,ENABLE MOBILITY,ENABLE MOBILE VOICE ACCESS,REMOTE DESTINATION LIMIT,MAXIMUM WAIT TIME FOR DESK PICKUP,PASSWORD IMSINFO,PIN IMSINFO,USER PKID
Modify the CONTROLLED DEVICE column, and add the
phone that must be related to the
Note: When you update user records, you can keep values or settings for
a user that were previously stored in the Cisco CallManager directory. You can
use a symbol such as “#” for fields where the value must be retained. In the
example users.csv file, under the DIGEST CREDENTIALS, PIN, PASSWORD use the #
sign, which tells BAT to keep these fields the same as entered in the DC
Choose Bulk Administrator >
Users > Update Users. The User Update
Configuration window displays.
In the User Update Configuration window, complete these
From the File Name drop-down list, choose the
From the User Template Name drop-down list,
choose the Bat-user template you created for this bulk
In the Value for fields to be ignored box, enter
the # symbol. This symbol is used to retain the values stored
in the DC directory.
In the Job Information area, enter the job
Click the Run Immediately radio button to update
the user records immediately.
Click Submit in order to create a job to update
the user records.
You can now use the Job Scheduler option in the
Bulk Administration main menu in order to verify the