Bulk Administration Tool User Guide, Release 4.2(1)
Working with Gateways and Ports

Table Of Contents

Working with Gateways and Ports

Cisco VG200 Gateways and Ports

Adding Cisco VG200 Gateways and Ports

Creating a Cisco VG200 Gateway Template

Updating the Endpoint Identifiers for Cisco VG200 Gateway

Creating CSV Files for Cisco VG200 FXS or FXO Gateways

Creating CSV Files for Cisco VG200 T1-CAS, T1-PRI, or E1-PRI Gateways

Creating a Text-Based CSV Text File

FXO or FXS Trunks

T1-CAS, T1-PRI, or E1-PRI Trunks

Adding Cisco VG200 Gateways to Cisco CallManager

Copying a Cisco VG200 BAT Template

Deleting Cisco VG200 Gateways

Cisco Catalyst 6000 24 Port FXS Analog Interface Module Ports

Adding or Updating Ports to Cisco Catalyst 6000 24 Port FXS Analog Interface Module Gateways

Creating a Cisco Catalyst 6000 (FXS) Ports Template

Creating CSV Files for Cisco Catalyst 6000 (FXS) ports

Using the Cisco Catalyst 6000 (FXS) Ports tab in BAT.xlt

Creating a Text-Based CSV Text File

Adding Cisco Catalyst 6000 (FXS) Ports to Cisco CallManager

Copying a Cisco Catalyst 6000 FXS Ports BAT Template

Updating Cisco Catalyst 6000 24 Port FXS Analog Interface Module Ports in Cisco CallManager

Deleting All Ports for Cisco Catalyst 6000 24 Port FXS Analog Interface Module Gateway

Gateway Directory Number

Creating a Gateway Directory Number Template

Copying a Gateway Directory Number BAT Template

Deleting Templates

Field Descriptions

Field Descriptions for FXS Trunks on a Cisco VG200 Gateway

Field Descriptions for FXO Trunks on a Cisco VG200 Gateway

Field Descriptions for T1-CAS Trunks on a Cisco VG200 Gateway

Fields Descriptions for T1-CAS Ports

Field Descriptions for T1-PRI or E1-PRI Trunks on a Cisco VG200 Gateway

Field Descriptions for FXS Ports on a Cisco Catalyst 6000 24 Port Analog Interface Module

Field Descriptions for Gateway Directory Number Template


Working with Gateways and Ports


You can use BAT to add or delete Cisco VG200 gateways and ports, and to add, update, and delete FXS ports on Cisco Catalyst 6000 analog interface modules. A Gateway Directory Number template is also provided, allowing you to specify directory numbers for POTS port types on Cisco VG200 gateways or Cisco Catalyst 6000 24 port analog interface modules.

To add gateway models other than Cisco VG200, you must use Cisco CallManager Administration. You can click Configure > Gateways > Catalyst 6000 (FXS) and then click the link to Add Gateways in the upper, right corner. This action takes you to the Add Gateways window in Cisco CallManager Administration.


Note Before using BAT to add Cisco VG200 gateways to the Cisco CallManager database, you must have first configured the gateway using the Cisco IOS software command line interface (CLI), For procedures and commands required to perform this configuration, refer to the configuration documentation supplied with the gateway.


Cisco VG200 Gateways and Ports

BAT allows you to bulk-add or bulk-delete Cisco VG200 gateways and ports.

Related Topics

Adding Cisco VG200 Gateways and Ports

Creating a Gateway Directory Number Template

Deleting Cisco VG200 Gateways

Adding Cisco VG200 Gateways and Ports

You can use BAT to add Cisco VG200 gateways and their ports to the Cisco CallManager database in batches, rather than add each gateway and port individually.

To add Cisco VG200 gateways to Cisco CallManager, you must perform the following steps:

1. Configure the gateway using Cisco IOS software command line interface. See documentation supplied with your gateway for configuration instructions.

2. Create a VG200 Gateway template to define common values for a set of gateways and ports.

3. Create a CSV file to define individual values for each gateway and port you want to add.

4. Use BAT to insert gateways and ports in the Cisco CallManager database.

Related Topics

Creating a Cisco VG200 Gateway Template

Creating CSV Files for Cisco VG200 FXS or FXO Gateways

Adding Cisco VG200 Gateways to Cisco CallManager

Deleting Cisco VG200 Gateways

Creating a Cisco VG200 Gateway Template

The BAT VG200 template and comma separated values (CSV) file work together in bulk transactions. You can create a template that has the common settings for all the gateways to be added in that batch, such as the module in slot, type of endpoint identifier, and so on. BAT stores these templates, so they are reusable for other batches. You can configure a template with some basic attributes and use it for batches later.


Note Before using BAT to add Cisco VG200 gateways to the Cisco CallManager database, you must have first configured the gateway using the Cisco IOS software command line interface (CLI), For procedures and commands required to perform this configuration, refer to the configuration documentation supplied with the gateway.


The CSV file stores the details for each individual port, such as directory number, description of port, and partition. See Creating CSV Files for Cisco VG200 FXS or FXO Gateways, for more details about CSV files. For POTS port types, you can also specify a Gateway Directory Number template.

To create the Cisco VG200 template and then add endpoint identifiers, perform the following steps. If you have already created the template but did not add endpoint identifiers, skip to Updating the Endpoint Identifiers for Cisco VG200 Gateway.

Procedure


Step 1 Start BAT. (See Starting BAT, for complete information about how to start BAT.)

Step 2 Click Configure > Template > VG200 Gateway.

The VG200 Gateway Template Configuration window displays.

Step 3 Enter values for the following fields:

VG200 Gateway Template Name—Enter a name for this BAT template, up to 50 alphanumeric characters. This name identifies the unique Cisco VG200 gateway template used only in BAT.

Cisco CallManager Group—Choose the Cisco CallManager Group to which this gateway should belong.

Step 4 In the Module in Slot 1 field in the Installed Voice Interface Cards area, choose the type of module that is installed in slot 1:

NM-1V—Network Module-1Voice has one voice interface card (VIC) in Sub-Unit 0 for FXS or FXO.

NM-2V—Network Module-2Voice has two VICs, one in Sub-Unit 0 and one in Sub-Unit 1 for either FXS or FXO.

NM-HDV—Network Module-High Density Voice has one VIC in Sub-Unit 0 for either T1-CAS or T1-PRI, or E1-PRI.

None—No network modules are installed.

Step 5 In the Product Specific Configuration area, enter values for the following fields:

Global ISDN Switch Type—This is an optional field. Choose the ISDN switch type.

Switchback Timing—Choose the timing mechanism used to switch back to a primary Cisco CallManager.

Switchback uptime-delay—This is an optional field. Choose the delay, in minutes, when using delayed switchback. You must make an entry in this field if you chose "Delayed" in the Switchback Timing field.

Switchback schedule—This is an optional field. The schedule, in hours and minutes, when using scheduled switchback. You must make an entry in this field if you chose "Scheduled" in the Switchback Timing field.

Step 6 Click Insert.

The Status indicates the insert completed, and a new field displays on the pane.

Step 7 In the Sub-Unit field(s), choose the appropriate type for each sub-unit field:

VIC-2FXS—Foreign Exchange Station (FXS) voice interface card

VIC-2FXO—Foreign Exchange Office (FXO) voice interface card

VWIC-1MFT-T1—Voice WAN interface card with one endpoint for T1-CAS or T1-PRI

VWIC-2MFT-T1—Voice WAN interface card with two endpoints for T1-CAS or T1-PRI

VWIC-1MFT-E1—Voice WAN interface card with one endpoint for E1-PRI

VWIC-2MFT-E1—Voice WAN interface card with two endpoints for E1-PRI

Step 8 Click Update.

The Status indicates the update completed, and the endpoint identifiers display on the pane.

Step 9 Click the link for the endpoint identifier. You can tell which endpoint identifiers need to be configured because a small question mark displays above the icon for the endpoint identifier.

The Cisco VG200 Endpoint Configuration window displays with settings for the endpoints.

Step 10 Complete the following step for the trunk type that you are configuring.

If you are configuring FXS trunks, enter the trunk settings. See Field Descriptions for FXS Trunks on a Cisco VG200 Gateway, for more information.

When you finish entering setting for FXS ports, skip to Step 21.

If you are configuring FXO trunks, enter the trunk settings. See Field Descriptions for FXO Trunks on a Cisco VG200 Gateway, for more information.

When you finish entering settings for FXO trunks, skip to Step 21.

If you are configuring T1 trunks, skip to Step 11.

If you are configuring E1 trunks, skip to Step 13.

Step 11 If you are configuring T1 trunks, choose either T1-CAS or T1-PRI signaling protocol.

Step 12 Complete the following step for the protocol you are configuring:

If you are configuring T1-CAS protocol, enter the protocol settings. See Field Descriptions for T1-CAS Trunks on a Cisco VG200 Gateway, for more information. Skip to Step 14 when you finish entering settings.

If you are configuring T1-PRI protocol, enter the protocol settings. See Field Descriptions for T1-PRI or E1-PRI Trunks on a Cisco VG200 Gateway, for more information.

When you finish entering settings for the T1-PRI protocol, skip to Step 21.

If you are configuring E1 trunks, enter the trunk settings. See Field Descriptions for T1-PRI or E1-PRI Trunks on a Cisco VG200 Gateway, for more information.

When you finish entering settings for E1 trunks, skip to Step 21.

Step 13 To configure the ports for T1-CAS, click Add a New Port.

The Port Configuration popup window displays.

Step 14 Choose values for the following fields:

Port Number—Choose All Ports or individual ports numbered 1 through 24.

End Port Number—Choose All Ports or individual ports numbered 1 through 24.

Step 15 Click Insert and Close.

The popup window closes, and the ports display in the left column on the VG200 Gateway Template Configuration window.

Step 16 You can configure the ports by clicking on the port you want to configure in the list of ports.

The Port Configuration popup window displays.

Step 17 Enter the port settings. See Fields Descriptions for T1-CAS Ports, for more information.

Step 18 Click Update and Close.

The popup window closes, and the port is configured.

Step 19 Repeat Steps 16 through 18 to configure additional ports.

Step 20 Click Insert.

Step 21 In the column on the left, click on the next endpoint in the list. You can tell which endpoints have not been configured because a small question mark symbol displays next to the endpoint identifier icon. When an endpoint identifier has been configured, the icon displays along with the corresponding trunk type.

Repeat Steps 7 and 8 for any additional endpoint identifiers.


Related Topics

Creating CSV Files for Cisco VG200 FXS or FXO Gateways

Adding Cisco VG200 Gateways to Cisco CallManager

Deleting Cisco VG200 Gateways

Updating the Endpoint Identifiers for Cisco VG200 Gateway

If you already created the Cisco VG200 gateway template, but did not add the endpoint identifiers, you can use the following steps to complete the template.

Procedure


Step 1 Start BAT. (See Starting BAT, for complete information about how to start BAT.)

Step 2 Click Configure > Template > VG200 Gateway

Step 3 In the list of VG200 Gateway Templates, click the BAT template to which you want to add endpoint identifier attributes.

Step 4 In the Installed Voice Interface Cards area, choose the appropriate voice interface card for the Sub-Unit(s).

Step 5 Click Update.

Step 6 Click the endpoint identifier that you want to configure. See Step 10 in the "Creating a Cisco VG200 Gateway Template" section for complete instructions.

Step 7 Repeat Step 6 until all endpoint identifiers are configured.


Creating CSV Files for Cisco VG200 FXS or FXO Gateways

BAT includes a Microsoft Excel file (BAT.xlt) that provides data file templates with macros and error checking and exports the values into a CSV file for use when adding Cisco VG200 gateways in BAT. Each record on the CSV file contains information about a Cisco VG200 gateway and its ports. You can open this file by double-clicking BAT.xlt on the Publisher database server in the C:\CiscoWebs\BAT\ExcelTemplate folder. When prompted, be sure to enable macros or the BAT.xlt file will not export the data.


Note For T1-CAS only, the ports you specify here must be the same ports specified in the VG200 template. In the CSV file, you can specify none, some, or all of the ports that were configured in the template, but do not configure any ports in the CSV file that were not also configured in the template. If so, an error will result when you attempt to insert the BAT VG200 template and the CSV file.

For example, if you configured ports 1,2,3, and 4 in the template, then you could configure none of the ports, or ports 1, 2, 3, and 4, or only ports 1 and 2 in the CSV file, and the insertion would be accepted. If in the same example, you configured ports 5 and 6 in the CSV when they had not been configured in the template, an error will result when you try to insert the template and CSV file in BAT.


Once you have created the Cisco VG200 gateway template in BAT and the CSV file as described in this section, you can insert the Cisco VG200 gateways into the Cisco CallManager database. See Adding Cisco VG200 Gateways to Cisco CallManager, for more information.

Procedure


Step 1 The BAT.xlt file resides on the Publisher database server. However, you normally would not have Microsoft Excel running on the Publisher database server. In that case, you must copy the file from the Publisher database server to the local machine on which you plan to work.

Using a floppy disk or a mapped network drive, open the path C:\CiscoWebs\BAT\ExcelTemplate on the Publisher database server, and copy the file BAT.xlt to a local machine where Microsoft Excel is installed.

Step 2 Double-click BAT.xlt.

Step 3 When prompted, click Enable Macros.

Step 4 Click the VG200 FXS FXO tab.

Step 5 In each row, provide the following information.

In the MGCP Domain Name field, enter a name that identifies the gateway, from 1 to 64 characters. Use the Domain Name System (DNS) host name if it is configured to resolve correctly; otherwise, use the host name as defined on the Cisco MGCP gateway. If you are using the host name as it is configured on the Cisco IOS gateway, the name you enter here must match exactly. For example, if the host name is configured on the gateway to resolve to vg200-1 and the IP domain name is not configured, enter the host name in this field (in this case, vg200-1). If the host name is configured on the gateway as vg200-1 and the IP domain name is configured on the gateway as cisco.com, enter vg200-1.cisco.com in this field.

In the Description field, enter a description for the gateway, up to 100 characters. Make the description something that will help you locate the gateway if you should ever need to locate it in a list of gateways.

In the Port 1 Description field, enter a description for port 1, up to 50 characters. Make the description something useful for identifying the port in a list of ports.

In the Port 1 Directory Number field, enter the directory number for this port, up to 50 numerals.

In the Port 1 Partition, enter the name of the route partition to which you want this port to belong, up to 50 characters. Make sure the route partition is already configured in Cisco CallManager Administration.

In the Port 2 Description field, enter a description for port 1, up to 50 characters. Make the description something useful for identifying the port in a list of ports.

In the Port 2 Directory Number field, enter the directory number for this port, up to 50 numerals.

In the Port 2 Partition, enter the name of the route partition to which you want this port to belong, up to 50 characters. Make sure the route partition is already configured in Cisco CallManager Administration.

In the Port 3 Description field, enter a description for port 1, up to 50 characters. Make the description something useful for identifying the port in a list of ports.

In the Port 3 Directory Number field, enter the directory number for this port, up to 50 numerals.

In the Port 3 Partition, enter the name of the route partition to which you want this port to belong, up to 50 characters. Make sure the route partition is already configured in Cisco CallManager Administration.

In the Port 4 Description field, enter a description for port 1, up to 50 characters. Make the description something useful for identifying the port in a list of ports.

In the Port 4 Directory Number field, enter the directory number for this port, up to 50 numerals.

In the Port 4 Partition, enter the name of the route partition to which you want this port to belong, up to 50 characters. Make sure the route partition is already configured in Cisco CallManager Administration.

Step 6 Click Export to BAT Format to transfer the data from the BAT Excel spreadsheet into a CSV file.

The system saves the file to C:\XLSDataFiles (or to your choice of another existing folder) as

VG200Gateways#timestamp.txt

where "timestamp" represents the precise date and time the file was created.

Step 7 To be accessed by BAT, the CSV file must reside on the Publisher database server. However, you normally would not have Microsoft Excel running on the Publisher database server. So this step assumes that you have saved the CSV file to the local machine (not the Publisher database server). In that case, you must copy the file to Publisher database server.

Using a floppy disk or a mapped network drive, copy the CSV file from C:\XLSDataFiles to the C:\BATFiles\VG200Gateways folder on the server running the Publisher database for Cisco CallManager.

Step 8 For information on how to read the exported CSV file, click the link to View Sample File in the Insert Gateways window in BAT (Configure > Gateways >VG200).


Related Topics

Adding Cisco VG200 Gateways to Cisco CallManager

Deleting Cisco VG200 Gateways

Creating CSV Files for Cisco VG200 T1-CAS, T1-PRI, or E1-PRI Gateways

BAT includes a Microsoft Excel file (BAT.xlt) that provides data file templates with macros and error checking and exports the values into a CSV file for use when adding Cisco VG200 gateways in BAT. Each record on the CSV file contains information about a Cisco VG200 gateway and its ports. You can open this file by double-clicking BAT.xlt on the Publisher database server in the C:\CiscoWebs\BAT\ExcelTemplate folder. When prompted, be sure to enable macros or the data will not be exported.

Once you have created the Cisco VG200 gateway template in BAT and the CSV file as described in this section, you can insert the Cisco VG200 gateways into the Cisco CallManager database. See Adding Cisco VG200 Gateways to Cisco CallManager, for more information.

Procedure


Step 1 The BAT.xlt file resides on the Publisher database server. However, you normally would not have Microsoft Excel running on the Publisher database server. In that case, you must copy the file from the Publisher database server to the local machine on which you plan to work.

Using a floppy disk or a mapped network drive, open the path C:\CiscoWebs\BAT\ExcelTemplate on the Publisher database server, and copy the file BAT.xlt to a local machine where Microsoft Excel is installed.

Step 2 Double-click BAT.xlt.

Step 3 When prompted, click Enable Macros.

Step 4 Click the VG200 T1-Pri T1-Cas E1-Pri tab.

Step 5 Scroll to the end of the fields until you see the Number of Port Identifiers field. Enter the number of port identifiers you want to add for each VG200 gateway. If you want only one port identifier, skip this step.

Step 6 In each row, provide the following information:

In the MGCP Domain Name field, enter a name that identifies the gateway, from 1 to 64 characters. Use the Domain Name System (DNS) host name if it is configured to resolve correctly: otherwise, use the host name as defined on the Cisco MGCP gateway. If you are using the host name as it is configured on the Cisco IOS gateway, the name you enter here must match exactly. For example, if the host name is configured on the gateway to resolve to vg200-1 and the IP domain name is not configured, enter the host name in this field (in this case, vg200-1). If the host name is configured on the gateway as vg200-1 and the IP domain name is configured on the gateway as cisco.com, enter vg200-1.cisco.com in this field.

In the MGCP Description field, enter a description for the gateway, up to 100 characters. Make the description something that will help you locate the gateway if you should ever need to locate it in a list of gateways.

In the Port Identifier 1 field, enter a description for the port identifier, up to 3 numerals. Make the first digit either 0 or 1 (signifying either sub-unit 0 or sub-unit 1), followed by the port number, 01 to 24. Acceptable values range from 001 through 024 or 101 through 124.

Step 7 Click Export to BAT Format to transfer the data from the BAT Excel spreadsheet into a CSV file.

The system saves the file to C:\XLSDataFiles (or to your choice of another existing folder) as

VG200Gateways#timestamp.txt

where "timestamp" represents the precise date and time the file was created.

Step 8 To be accessed by BAT, the CSV file must reside on the Publisher database server. However, you normally would not have Microsoft Excel running on the Publisher database server. So this step assumes that you have saved the CSV file to the local machine (not the Publisher database server). In that case, you must copy the file to Publisher database server.

Using a floppy disk or a mapped network drive, copy the CSV file from C:\XLSDataFiles to the C:\BATFiles\VG200Gateways folder on the server running the Publisher database for Cisco CallManager.

Step 9 For information on how to read the exported CSV file, click the link to View Sample File in the Insert Gateways window in BAT (Configure > Gateways >VG200).


Related Topics

Adding Cisco VG200 Gateways to Cisco CallManager

Creating a Text-Based CSV Text File

If you do not use the BAT.xlt file for data input when adding VG200 gateways, you must create the CSV file using lines of ASCII text with values separated by commas. You do not need to follow the instructions in this section if you created the CSV file using the BAT.xlt file.

Descriptions and examples are provided in the sections, FXO or FXS Trunks, and T1-CAS, T1-PRI, or E1-PRI Trunks.


Tips Use the BAT.xlt file to input data because data validation is performed on that file.


The comma separated values (CSV) file provides a common textual way of providing tabular information. You can create a data file using any file format, such as Microsoft Notepad, Microsoft Word, and so on. Save the CSV file to C:\BATFiles\VG200Gateways\ on the server running the Publisher database for Cisco CallManager.

To create a CSV text file for VG200 gateways, perform the following steps.

Procedure


Step 1 Open a text editor (such as Notepad) or any application that allows you to export or create a CSV file.

Step 2 Using a separate line for each gateway, enter the values for each gateway and port you want to add to Cisco CallManager. See Creating CSV Files for Cisco VG200 FXS or FXO Gateways or Creating CSV Files for Cisco VG200 T1-CAS, T1-PRI, or E1-PRI Gateways, for detailed information about the formatting you must use in the text-based CSV file.


Note An error occurs if any blank lines exist in the CSV file.


Step 3 Save or copy the file to C:\BATFiles\VG200Gateways on the server running the Publisher database for Cisco CallManager.


Note You cannot use VG200 gateway CSV files saved anywhere except C:\BATFiles\VG200Gateways on the server running the Publisher database for Cisco CallManager for BAT inserts.



FXO or FXS Trunks

The following example format shows the required field length and string types followed by an example of a CSV file for a Cisco VG200 gateway.

MGCP Domain Name(Mandatory, 1 to 64 characters),Description(Optional, up to 100 characters),Port 1 Description(Optional, up to 50 characters),Port 1 Directory Number(Optional, up to 50 numerals),Port 1 Partition(Optional, up to 50 characters),Port 2 Description(Optional, up to 50 characters),Port 2 Directory Number(Optional, up to 50 numerals),Port 2 Partition(Optional, up to 50 characters),Port 3 Description(Optional, up to 50 characters),Port 3 Directory Number(Optional, up to 50 numerals),Port 3 Partition(Optional, up to 50 characters),Port 4 Description(Optional, up to 50 characters),Port 4 Directory Number(Optional, up to 50 numerals),Port 4 Partition(Optional, up to 50 characters)

Example

MGCPTest,VG200 Lab Gateway,Port 1,97255572001,Partition1,
Port 2,97255572002,Partition2,Port 3,97255572003,Partition3,
Port 4,97255572004,Partition4

You must include comma separators even if a field is blank. Specify the directory number and route partition only if the port type in the Cisco VG200 gateway template is POTS.

Refer to the following examples and sample CSV records when creating CSV files.

Examples

If the Description for a Cisco VG200 gateway is blank

MGCPTest,,Port 1,97255572001,Partition1,Port 2,97255572002,Partition2,
Port 3,97255572003,Partition3,Port 4,97255572004,Partition4

If the Cisco VG200 gateway template has only Port 1 and Port 2 as POTS type

MGCPTest,VG200 Lab Gateway,Port 1,97255572001,Partition1,
Port 2,97255572002,Partition2,,,,,,

T1-CAS, T1-PRI, or E1-PRI Trunks

The following example format shows the required field length and string types followed by an example of a CSV file for a Cisco VG200 gateway.

MGCP Domain Name(Mandatory, 1 to 64 characters),MGCP Description(Optional, up to 100 characters),Port Identifier 1(Optional, up to 3 numerals)

Example

MGCPTest,VG200 Lab Gateway,001

You must include comma separators even if a field is blank.

Refer to the following examples and sample CSV records when creating CSV files.

Examples

If the Description for a Cisco VG200 gateway is blank

MGCPTest,,001

If you provide only the mandatory value

MGCPTest,

For port identifiers, the first digit is either 0 or 1 (signifying either sub-unit 0 or sub-unit 1), followed by the port number, 01 to 24. Acceptable values are 001 through 024 or 101 through 124. If the Cisco VG200 gateway template has three port identifiers

MGCPTest,VG200 Lab Gateway,001,002,003

Adding Cisco VG200 Gateways to Cisco CallManager

Follow this procedure to add several Cisco VG200 gateways to Cisco CallManager.

Before You Begin

You must create a Cisco VG200 gateway template and CSV file before you add trunks to Cisco CallManager. If you want to insert directory number details, you need to configure the Gateway Directory Number template. See Creating a Gateway Directory Number Template, for more information.

Procedure


Step 1 Start BAT. (See Starting BAT, for complete information about how to start BAT.)

Step 2 Click Configure > Gateways > VG200.

The Insert Gateways window displays.

Step 3 In the File Name field, choose the name of the CSV file that contains the Cisco VG200 gateways to be added.

Step 4 In the VG200 Gateway Template Name field, choose the name of the VG200 gateway template that you created for this type of bulk transaction.

Step 5 Click Insert.

A message displays indicating the number of records that can be inserted per minute. Use this information to evaluate whether Cisco CallManager performance will be degraded if you perform the bulk transaction.

Step 6 Click OK to start the transaction or Cancel to cancel it.

Step 7 If you clicked OK, a Transaction Status window displays. When the transaction completes, the Transaction windows disappears, and the Insert Gateways window displays the Status of the insert.

If the Status of the insert is anything other than Insert Completed, view the log file for transaction details. If the Status is Insert Completed, the transaction was successful and you do not need to view the log file unless you are interested in statistical information.

Step 8 Click View Latest Log File. BAT generates a log file indicating the number of records added and the number of records failed, including an error code.


Note After the trunks are added to Cisco CallManager, BAT generates a log file indicating the number of records added and the number of records failed, including an error code. For more information on log files, see "Troubleshooting BAT and TAPS".



Related Topics

Creating a Cisco VG200 Gateway Template

Deleting Cisco VG200 Gateways

Creating a Gateway Directory Number Template

Copying a Cisco VG200 BAT Template

You can copy the properties of a VG200 gateway template into a new VG200 gateway template. This is useful when you have similar bulk-add transactions and only a few details need to be changed.

To copy an existing BAT VG200 gateway template, perform the following steps.

Procedure


Step 1 Start BAT. (See Starting BAT, for complete information about how to start BAT.)

Step 2 Choose Configure >Template > VG200 Gateway.

The VG200 Gateway Template Configuration window displays.

Step 3 In the VG200 Gateway Templates column on the left, click on the template you want to copy.

The selected template details display in the VG200 Gateway Template Configuration window.

Step 4 Verify that this is the template you want to copy, and click Copy.

BAT creates a copy of the template. The copy duplicates all the values that were specified in the original template.

Step 5 In the VG200 Gateway Template Name field, enter a new template name.

Step 6 Update the fields as needed for the new template. See Field Descriptions, for more information.

Step 7 Click Insert to save the copied template.

The template is added to BAT and displays in the VG200 Gateway Templates column on the left.


Related Topics

Creating a Cisco VG200 Gateway Template

Deleting Cisco VG200 Gateways

You can delete all Cisco VG200 gateway records from the Cisco CallManager database using the following procedure.


Caution If you do not want to delete all Cisco VG200 gateways from the Cisco CallManager database, be sure to specify a query before clicking the Run button.

To delete all Cisco VG200 gateways, perform the following procedure.

Procedure


Step 1 Start BAT. (See Starting BAT, for complete information about how to start BAT.)

Step 2 Click Configure > Gateways > VG200.

Step 3 Click the Delete VG200 Gateways link.

The Delete Gateways window displays.

Step 4 From the drop-down list box, choose the field that you want to search, such as MGCP Domain Name or Description.

Step 5 From the drop-down list box, choose the search criteria, such as begins with, contains, is empty, and so on.

Step 6 In the search field, enter the value you want to locate, such as the MGCP domain name or description.

Step 7 Click Add to Query to add the defined filter to the query.

Step 8 Click AND or OR to add multiple filters to the query.

Step 9 Click View Query Results to verify the records that are going to be deleted.

Step 10 Click Run to delete the records.


Caution If you have not specified a query (as described in steps 4 to 7), then clicking the Run button deletes all Cisco VG200 gateways.

After the Cisco VG200 gateways are deleted from Cisco CallManager, BAT generates a log file indicating the number of records deleted and the number of records failed, including an error code. For more information on log files, see "Troubleshooting BAT and TAPS".


Related Topics

Creating a Cisco VG200 Gateway Template

Creating CSV Files for Cisco VG200 FXS or FXO Gateways

Updating the Endpoint Identifiers for Cisco VG200 Gateway

Cisco Catalyst 6000 24 Port FXS Analog Interface Module Ports

BAT allows you to bulk-add, bulk-update, and bulk-delete ports on Cisco Catalyst 6000 24 Port FXS analog interface module gateways.


Note You can add ports for up to 500 Cisco Catalyst 6000 analog interface modules in any one transaction. Do not attempt to add ports for more than 500 modules in a given transaction.


Related Topics

Adding or Updating Ports to Cisco Catalyst 6000 24 Port FXS Analog Interface Module Gateways

Deleting All Ports for Cisco Catalyst 6000 24 Port FXS Analog Interface Module Gateway

Creating a Gateway Directory Number Template

Adding or Updating Ports to Cisco Catalyst 6000 24 Port FXS Analog Interface Module Gateways

You can use BAT to add or update FXS ports of Cisco Catalyst 6000 analog interface modules to the Cisco CallManager database in batches, rather than add each port individually. You can even add or update ports for more than one gateway in one batch.


Note BAT does not add Cisco Catalyst 6000 24 Port FXS analog interface module gateways. You need to add gateways using Cisco CallManager Administration and then use BAT to bulk-add or bulk-update ports for these gateways.


To add or update ports to Cisco CallManager, you must perform the following steps:

1. Create a Catalyst 6000 (FXS) Ports BAT template to define common values for a set of ports.

2. (Optional) Create a Gateway Directory Number BAT template. This is optional for adding ports, but required for adding directory number details to ports.

3. Create a comma separated values (CSV) file to define individual values for each port you want to add.

Related Topics

Creating a Cisco Catalyst 6000 (FXS) Ports Template

Creating CSV Files for Cisco Catalyst 6000 (FXS) ports

Adding Cisco Catalyst 6000 (FXS) Ports to Cisco CallManager

Updating Cisco Catalyst 6000 24 Port FXS Analog Interface Module Ports in Cisco CallManager

Deleting All Ports for Cisco Catalyst 6000 24 Port FXS Analog Interface Module Gateway

Creating a Cisco Catalyst 6000 (FXS) Ports Template

The port template and comma separated values (CSV) files work together in bulk transactions. You can create a template that has the common analog details for all the ports in that batch, such as the port direction, port level, and so on. The system stores these templates, so they are reusable for other batches.

The CSV file stores the details for each individual port, such as its gateway MAC address, port number (which you add in this section), directory number for this port, and its partition. See Creating CSV Files for Cisco Catalyst 6000 (FXS) ports, for more details about CSV files.

Perform the following steps to create a Cisco Catalyst 6000 FXS Ports template. You must complete all fields unless otherwise noted.

Procedure


Step 1 Start BAT. (See Starting BAT, for complete information about how to start BAT.)

Step 2 Click Configure > Template > Catalyst 6000 (FXS) Ports.

The Catalyst 6000 (FXS) Ports Template Configuration window displays.

Enter the settings for the fields. See Field Descriptions for FXS Ports on a Cisco Catalyst 6000 24 Port Analog Interface Module, for more information.

Step 3 Click Insert.

The status shows the insert was completed.

Step 4 Create a CSV file. Go to Creating CSV Files for Cisco Catalyst 6000 (FXS) ports, for more information.


Related Topics

Creating CSV Files for Cisco Catalyst 6000 (FXS) ports

Adding Cisco Catalyst 6000 (FXS) Ports to Cisco CallManager

Updating Cisco Catalyst 6000 24 Port FXS Analog Interface Module Ports in Cisco CallManager

Deleting All Ports for Cisco Catalyst 6000 24 Port FXS Analog Interface Module Gateway

Creating a Gateway Directory Number Template

Creating CSV Files for Cisco Catalyst 6000 (FXS) ports

BAT includes a Microsoft Excel file (BAT.xlt) that provides data file templates with macros and error checking and exports the values into CSV files for Cisco Catalyst 6000 (FXS) Ports. You can open this file by double-clicking BAT.xlt on the Publisher database server in the C:\CiscoWebs\BAT\ExcelTemplate folder. When prompted, be sure to enable macros. See Using the Cisco Catalyst 6000 (FXS) Ports tab in BAT.xlt, to learn how to use this spreadsheet.

The CSV file contains information about each port as a record. Each record specifies the gateway MAC address and port number on that gateway to which you want to add or update the port details.

The following example format shows the required field length and string types followed by an example of a CSV file for Catalyst 6000 (FXS) ports.


Note If values are set for Partition in the CSV file for some record, the value in the CSV file for that record overrides any value that may appear in the BAT template.


If you provide no values for Partition for any record on the CSV file, the system uses values from the BAT template for these fields.

Example 5-1 If Partition is Partition_1 on a template, all records in a CSV file that have no value for Partition use Partition_1.


MAC Address(Mandatory, 12 characters),Port Number(Mandatory, 2 numerals),Directory Number(Optional, up to 50 characters),Partition(Optional, up to 50 characters)

Example

1231123245AB,23,9725557250,Partition1

You must include comma separators even if a field is blank. Do not specify a partition unless you have also specified a directory number.

If you specify a directory number in the CSV file, you must also create a Gateway Directory Number template. See Creating a Gateway Directory Number Template, for more information.

See the following examples and sample CSV records when creating CSV files.

Examples

If the directory number for a port is blank

1231123245AB,23,,

If you want to add only the mandatory values

1231123245AB,23,,


Note For the MAC address, enter MAC address values for an existing Cisco Catalyst 6000 (FXS) gateway. This MAC address comprises the last 12 characters in the Gateway Name. BAT does not add Cisco Catalyst 6000 (FXS) gateways. It simply adds or updates ports to an existing gateway.


Related Topics

Adding Cisco Catalyst 6000 (FXS) Ports to Cisco CallManager

Updating Cisco Catalyst 6000 24 Port FXS Analog Interface Module Ports in Cisco CallManager

Using the Cisco Catalyst 6000 (FXS) Ports tab in BAT.xlt

Perform the following steps to add ports to existing Cisco Catalyst 6000 24 Port FXS analog interface modules.


Note You can add ports for up to 500 Cisco Catalyst 6000 analog interface modules in any one transaction. Do not attempt to add ports for more than 500 modules in a given transaction.


Procedure


Step 1 The BAT.xlt file resides on the Publisher database server. However, you normally would not have Microsoft Excel running on the Publisher database server. In that case, you must copy the file from the Publisher database server to the local machine on which you plan to work.

Using a floppy disk or a mapped network drive, open the path C:\CiscoWebs\BAT\ExcelTemplate on the Publisher database server, and copy the file BAT.xlt to a local machine where Microsoft Excel is installed.

Step 2 Double-click BAT.xlt.

Step 3 When prompted, click Enable Macros.

Step 4 Click the Catalyst 6000 (FXS) Ports tab.

Step 5 Complete all mandatory fields and any relevant optional fields. Each column heading specifies the length of the field.

In the MAC Address field, enter the 12-character MAC address.

In the Port Number field, enter the port number that you want to add to the gateway.

(Optional) In the Directory Number field, enter a directory number for this port, up to 50 numerals. This is mandatory if you have specified a partition.

(Optional) In the Partition field, enter the route partition to which you want this port to belong, up to 50 characters. Do not specify a partition unless you have also specified a directory number.


Caution The system treats blank rows in the spreadsheet as "End of File" and discards subsequent records.

Step 6 Click Export to BAT Format to transfer the data from the BAT Excel spreadsheet into a CSV file.

The system saves the file to C:\XLSDataFiles\Catalyst6000_24PortsFXSGateway (or to your choice of another existing folder) as

Catalyst6000_24PortsFXSGateway#timestamp.txt

where "timestamp" represents the precise date and time the file was created.

Step 7 To be accessed by BAT, the CSV file must reside on the Publisher database server. However, you normally would not have Microsoft Excel running on the Publisher database server. So, this step assumes that you have saved the CSV file to the local machine (not the Publisher database server). In that case, you must copy the file to Publisher database server.

Using a floppy disk or a mapped network drive, copy the CSV file from C:\XLSDataFiles\Catalyst6000_24PortsFXSGateway to the C:\BATFiles\Catalyst6000_24PortsFXSGateway folder on the server running the Publisher database for Cisco CallManager.

Step 8 For information on how to read the exported CSV file, click the link to View Sample File in the Configure Ports window in BAT (Configure > Gateways > Catalyst 6000 (FXS)).


Tips If you specified directory numbers in the CSV file, you must create a Gateway Directory Number template prior to attempting to insert the Gateway Template and this CSV file in BAT. See Creating a Gateway Directory Number Template, for more information.



Creating a Text-Based CSV Text File

If you do not use the BAT.xlt file for data input when adding ports to Cisco Catalyst 6000 FXS analog interface modules, you must create the CSV file using lines of ASCII text with values separated by commas. You do not need to follow the instructions in this section if you created the CSV file using the BAT.xlt file.


Tips Use the BAT.xlt file to input data because data validation is performed on that file.


The comma separated values (CSV) file provides a common textual way of providing tabular information. You can create a data file using any file format, such as Microsoft Notepad, Microsoft Word, and so on. Save the CSV file to C:\BATFiles\Catalyst6000_24PortsFXSGateway on the server running the Publisher database for Cisco CallManager.

Procedure

To create a CSV text file for Cisco Catalyst 6000 FXS ports, perform the following steps:


Step 1 Open a text editor (such as Notepad) or any application that allows you to export or create a CSV file.

Step 2 Using a separate line for each port, enter the values for each port that you want to add to Cisco CallManager. See Creating CSV Files for Cisco Catalyst 6000 (FXS) ports, for detailed information about the formatting you must use in the text-based CSV file.


Note An error occurs if any blank lines exist in the CSV file.


Step 3 Save or copy the file to C:\BATFiles\Catalyst6000_24PortsFXSGateway on the server running the Publisher database for Cisco CallManager.


Note You cannot use CSV files for FXS ports on Cisco Catalyst 6000 modules saved anywhere except C:\BATFiles\Catalyst6000_24PortsFXSGateway on the server running the Publisher database for Cisco CallManager for BAT inserts.



Adding Cisco Catalyst 6000 (FXS) Ports to Cisco CallManager

Follow this procedure to add several ports on Cisco Catalyst 6000 24 Port FXS analog interface modules to Cisco CallManager.


Note BAT can add ports for up to 500 Cisco Catalyst 6000 analog interface modules in any one transaction. Do not attempt to add ports for more than 500 modules in a given transaction.


Before You Begin

You must create a Cisco Catalyst 6000 Ports template and CSV file before you add ports to Cisco CallManager. If you want to add or update Directory Number details, you need to create a Gateway Directory Number template. See Creating a Gateway Directory Number Template, for more information.


Note You must create a Gateway Directory Number template if you specified directory numbers in the CSV file.


Procedure


Step 1 Start BAT. (See Starting BAT, for complete information about how to start BAT.)

Step 2 Click Configure > Gateways > Catalyst 6000 (FXS).

The Configure Ports window displays.

Step 3 In the File Name field, choose the CSV file for Cisco Catalyst 6000 ports that you created for this type of bulk transaction.

Step 4 In the Catalyst 6000 (FXS) Ports Template field, choose the BAT template that you created for adding Cisco Catalyst 6000 FXS ports.

Step 5 This field is optional if you are adding ports but mandatory if you are adding any records that have directory number details on the CSV file.

In the Gateway Directory Number Template Name, choose the BAT template that you created for adding directory numbers to Cisco Catalyst 6000 FXS ports.


Note If you have not specified directory number details on the CSV file, BAT inserts only analog details for that port, but no number will be configured for the port.


Step 6 Click Insert.

A message displays indicating the time it will take to perform the transaction. Performance on the gateways will be impacted, including the termination of all calls on the affected gateways.

After the ports are added to Cisco CallManager, BAT generates a log file indicating the number of records added and the number of records failed, including an error code. You can click View Latest Log File to open the log file for this transaction. BAT adds ports only for existing Cisco Catalyst 6000 (FXS) gateways. If a port with this specified port number and gateway already exists, BAT rejects that record. See "Troubleshooting BAT and TAPS", for more information about errors.


Related Topics

Creating CSV Files for Cisco Catalyst 6000 (FXS) ports

Updating Cisco Catalyst 6000 24 Port FXS Analog Interface Module Ports in Cisco CallManager

Creating a Gateway Directory Number Template

Copying a Cisco Catalyst 6000 FXS Ports BAT Template

Deleting All Ports for Cisco Catalyst 6000 24 Port FXS Analog Interface Module Gateway

Copying a Cisco Catalyst 6000 FXS Ports BAT Template

You can copy the properties of a Cisco Catalyst 6000 FXS ports template into a new Cisco Catalyst 6000 FXS ports template. This is useful when you have similar bulk-add transactions and only a few details need to be changed. Perform the following steps.

Procedure


Step 1 Start BAT. (See Starting BAT, for complete information about how to start BAT.)

Step 2 Choose Configure >Template > Catalyst 6000 (FXS) Ports.

The Catalyst 6000 (FXS) Ports Template Configuration window displays.

Step 3 In the Catalyst 6000 (FXS) Ports Templates column on the left, click on the template you want to copy.

The selected template details display in the Catalyst 6000 (FXS) Ports Template Configuration window.

Step 4 Verify that this is the template you want to copy, and click Copy.

BAT creates a copy of the template. The copy duplicates all the values that were specified in the original template.

Step 5 In the Catalyst 6000 (FXS) Ports Template Name field, enter a new template name.

Step 6 Update the fields as needed for the new template. See Field Descriptions for FXS Ports on a Cisco Catalyst 6000 24 Port Analog Interface Module, for more information.

Step 7 Click Insert.

The template is added to BAT and displays in the Catalyst 6000 (FXS) Ports Templates column on the left.


Related Topics

Creating CSV Files for Cisco Catalyst 6000 (FXS) ports

Creating a Gateway Directory Number Template

Updating Cisco Catalyst 6000 24 Port FXS Analog Interface Module Ports in Cisco CallManager

Perform the following steps to update ports for Cisco Catalyst 6000 24 Port FXS analog interface modules to Cisco CallManager.

Before You Begin

You must create a Cisco Catalyst 6000 (FXS) Ports BAT template and CSV file before you modify ports in Cisco CallManager. If you want to modify Directory Number details, you need to configure a Gateway Directory Number BAT template. See Creating a Gateway Directory Number Template, for more information.

Procedure


Step 1 Start BAT. (See Starting BAT, for complete information about how to start BAT.)

Step 2 Choose Configure > Gateways > Catalyst 6000 (FXS).

The Configure Ports window displays.

Step 3 In the File Name field, choose the CSV file for Cisco Catalyst 6000 ports that you created for this type of bulk transaction.

Step 4 In the Catalyst 6000 (FXS) Ports Template field, choose the BAT template that you created for updating Cisco Catalyst 6000 FXS ports.

Step 5 (Although this field is optional if you are updating ports, it becomes mandatory if you are updating any records that have directory number details on the CSV file.) In the Gateway Directory Number Template Name, choose the BAT template that you created for updating directory numbers to Cisco Catalyst 6000 FXS ports.


Note If you have not specified directory number details on the CSV file, BAT inserts only analog details for that port, but no directory number will be configured for the port.


Step 6 Click Update.

A message displays indicating the time it will take to perform the transaction. Be aware that performance on the gateways will be impacted, including dropped calls if any are active on the affected gateways.

After the ports are updated in Cisco CallManager, BAT generates a log file indicating the number of records updated and the number of records failed, including an error code.


Note If you click Insert instead of Update, the ports you want to update will not be updated.


Step 7 The results of the Update display. You can click View Latest Log File to open the log file for this transaction. BAT updates ports only for existing Cisco Catalyst 6000 (FXS) gateways. If a port with this specified port number and gateway already exists, BAT rejects that record. See "Troubleshooting BAT and TAPS", for more information about errors.


Related Topics

Creating CSV Files for Cisco Catalyst 6000 (FXS) ports

Adding Cisco Catalyst 6000 (FXS) Ports to Cisco CallManager

Creating a Gateway Directory Number Template

Deleting All Ports for Cisco Catalyst 6000 24 Port FXS Analog Interface Module Gateway

Perform the following steps to delete all ports of a Cisco Catalyst 6000 24 Port FXS analog interface module.

Procedure


Step 1 Start BAT. (See Starting BAT, for complete information about how to start BAT.)

Step 2 Click Configure > Gateways > Catalyst 6000 (FXS).

The Configure Ports window displays.

Step 3 Click the Delete All Ports link in the upper, right side of the window.

The Delete Ports window displays.

Step 4 Choose the name of the Cisco Catalyst 6000 Gateway(s) for which you want to delete all ports and click the arrow buttons to move the gateways between the Available Gateways and Selected Gateways lists. BAT deletes all the ports for only gateways shown in the Selected Gateways list box when you click Delete All Ports.

Step 5 Click Delete All Ports.

A message displays indicating the time it will take to perform the transaction.

BAT generates a log file indicating the number of gateways for which the Delete All operation was successful and the number of gateways for which it failed, including an error code.

Step 6 The results of the Delete operation display. You can click View Latest Log File to open the log file for this transaction. See"Troubleshooting BAT and TAPS", for more information about errors.


Related Topics

Adding Cisco Catalyst 6000 (FXS) Ports to Cisco CallManager

Creating CSV Files for Cisco Catalyst 6000 (FXS) ports

Updating Cisco Catalyst 6000 24 Port FXS Analog Interface Module Ports in Cisco CallManager

Gateway Directory Number

You use the Gateway Directory Number template when adding directory numbers to FXS ports on Cisco VG200 gateways or Cisco Catalyst 6000 analog interface modules. If you have specified directory numbers in the CSV file for either of these devices, then you must create a Gateway Directory Number template to use when you insert the gateways or ports in BAT.

Creating a Gateway Directory Number Template

You need to create a Gateway Directory Number template if you want to assign directory numbers to POTS ports. If you are working with POTS ports on Cisco VG200 gateways, or with Cisco Catalyst 6000 (FXS) 24 Port analog interface modules, and you specified directory numbers in the CSV file for either of these devices, you must create a Gateway Directory Number template.

The BAT templates and comma separated values (CSV) files work together in bulk transactions. You can create a template that has common directory number details such as partition, calling search space, and so on, for POTS port types. The system stores these templates, so they are reusable for other batches.

The CSV file stores the details for each individual port, such as the gateway MAC address, Port Number (which you are adding in this section), Directory Number for this Port, and its Partition. See Creating CSV Files for Cisco VG200 FXS or FXO Gateways, or Creating CSV Files for Cisco Catalyst 6000 (FXS) ports, for more details about CSV files.

Perform the following steps to create a Gateway Directory Number template. All fields are optional unless otherwise noted.

Procedure


Step 1 Start BAT. (See Starting BAT, for complete information about how to start BAT.)

Step 2 Click Configure > Template > Gateway Directory Number.

The Gateway Directory Number Template Configuration window displays.

Step 3 In the Gateway Directory Number Template Name field, enter a unique name for this template, up to 50 alphanumeric characters.

Step 4 Enter settings for the fields. See Field Descriptions for Gateway Directory Number Template, for more information.

Step 5 Click Insert.

The new template is added.

Step 6 Create a CSV file. Go to Creating CSV Files for Cisco VG200 FXS or FXO Gateways, or Creating CSV Files for Cisco Catalyst 6000 (FXS) ports, for more information.


Related Topics

Creating a Cisco VG200 Gateway Template

Creating a Cisco Catalyst 6000 (FXS) Ports Template

Creating CSV Files for Cisco VG200 FXS or FXO Gateways

Creating CSV Files for Cisco Catalyst 6000 (FXS) ports

Adding Cisco VG200 Gateways to Cisco CallManager

Adding Cisco Catalyst 6000 (FXS) Ports to Cisco CallManager

Copying a Gateway Directory Number BAT Template

Copying a Gateway Directory Number BAT Template

You can copy the properties of a Gateway Directory Number template into a new Gateway Directory Number template. This is useful when you have similar bulk-add transactions, and you need to change only a few details.

To copy an existing BAT Gateway Directory Number template, perform the following steps.

Procedure


Step 1 Start BAT. (See Starting BAT, for complete information about how to start BAT.)

Step 2 Choose Configure >Template > Gateway Directory Number.

The Gateway Directory Number Template Configuration window displays.

Step 3 In the Gateway Directory Number Templates column on the left, click the template you want to copy.

The selected template details display in the Gateway Directory Number Template Configuration window.

Step 4 Verify that this is the template that you want to copy, and click Copy.

BAT creates a copy of the template. The copy duplicates all the values that were specified in the original template.

Step 5 In the Gateway Directory Number Template Name field, enter a new template name.

Step 6 Update the fields as needed for the new template. See Field Descriptions for Gateway Directory Number Template, for more information.

Step 7 Click Insert.

The template is added to BAT and displays in the Gateway Directory Number Templates column on the left.


Related Topics

Creating a Gateway Directory Number Template

Deleting Templates

You can delete BAT templates when you no longer require them.

To delete a template, perform the following steps.

Procedure


Step 1 Start BAT. (See Starting BAT, for complete information about how to start BAT.)

Step 2 Choose Configure >Template > the type of template you want to delete, such as Phone or VG200 Gateway.

The Template Configuration window displays.

Step 3 In the Templates column on the left, click on the template you want to delete.

The selected template details display in the Template Configuration window.

Step 4 Verify that this is the template you want to delete and click Delete.

A message displays asking you to confirm the delete operation.

Step 5 Click OK to delete the template or click Cancel to cancel the delete operation without deleting the template.

BAT deletes the template and you can no longer use it in bulk transactions.


Field Descriptions

This section provides descriptions of the fields used in the various BAT templates.

Related Topics

Field Descriptions for FXS Trunks on a Cisco VG200 Gateway

Field Descriptions for FXO Trunks on a Cisco VG200 Gateway

Field Descriptions for T1-CAS Trunks on a Cisco VG200 Gateway

Fields Descriptions for T1-CAS Ports

Field Descriptions for T1-PRI or E1-PRI Trunks on a Cisco VG200 Gateway

Field Descriptions for FXS Ports on a Cisco Catalyst 6000 24 Port Analog Interface Module

Field Descriptions for Gateway Directory Number Template

Field Descriptions for FXS Trunks on a Cisco VG200 Gateway

Use the following field descriptions when adding or updating values for FXS trunks on a Cisco VG200 gateway.

Fields are mandatory unless otherwise noted.

Table 5-1 Field Descriptions for FXS Trunks on Cisco VG200 Gateways 

Field
Description

Gateway Information

Device Pool

The values that appear in this field were configured in Cisco CallManager Administration. Choose the device pool to which this group of gateways/ports should belong.

A device pool defines sets of common characteristics for devices, such as region, date/time group, Cisco CallManager group, and calling search space for auto-registration.

Calling Search Space

This is an optional field. Choose the calling search space to which this group of gateways/ports should belong.

A calling search space specifies the collection of route partitions that are searched to determine how a dialed number should be routed.

Media Resource Group List

This is an optional field. Choose the media resource group list (MRGL) to which this group of gateways/ports should belong.

An MRGL specifies a list of prioritized media resource groups. An application can select required media resources among the available ones according to the priority order defined in the MRGL.

Network Hold Audio Source

This is an optional field. Choose the music on hold audio source to be played when the system places a call on hold (such as when user transfers a call or initiates a conference or call park).

User Hold Audio Source

This is an optional field. Choose the music on hold audio source to be played when the user places a call on hold (presses the Hold button or soft key).

Location

This is an optional field. Choose the location to which this group of gateways/ports should belong.

A location indicates the remote location that is accessed using restricted bandwidth connections.

Gateway Directory Number Template Name

This is an optional field unless you have specified directory numbers for FXS ports.

If you are adding a POTS port type and want to assign a directory number to that port, you must have already configured a Gateway Directory Number template.

Choose the Gateway Directory Number template to be used for these ports.

Port Information

Prefix DN

This is an optional field. Specify the prefix digits that are appended to the digits received on incoming calls.

Num Digits

Specify the number of digits to collect, from 0 to 32. Significant digits are counted from the right (last digit) of the number called.

Expected Digits

Specify the number of digits expected on the inbound side of the trunk. Use the default value (zero) if you are unsure.


Field Descriptions for FXO Trunks on a Cisco VG200 Gateway

Use the following field descriptions when adding or updating values for FXO trunks on a Cisco VG200 gateway.

Fields are mandatory unless otherwise noted.

Table 5-2 Field Descriptions for FXO Trunks on Cisco VG200 Gateways 

Field
Description

Gateway Information

Port Type

Choose the type of port, either Ground Start or Loop Start.

Device Pool

The values that appear in this field were configured in Cisco CallManager Administration. Choose the device pool to which this group of gateways/ports should belong.

A device pool defines sets of common characteristics for devices, such as region, date/time group, Cisco CallManager group, and calling search space for auto-registration.

Calling Search Space

This is an optional field. Choose the calling search space to which this group of gateways/ports should belong.

A calling search space specifies the collection of route partitions searched to determine how a dialed number should be routed.

Media Resource Group List

This is an optional field. Choose the media resource group list (MRGL) to which this group of gateways/ports should belong.

An MRGL specifies a list of prioritized media resource groups. An application can select required media resources among the available ones according to the priority order defined in the MRGL.

Network Hold Audio Source

This is an optional field. Choose the music on hold audio source to be played when the system places a call on hold (such as when user transfers a call or initiates a conference or call park).

User Hold Audio Source

This is an optional field. Choose the music on hold audio source to be played when the user places a call on hold (presses the Hold button or soft key).

Location

This is an optional field. Choose the location to which this group of gateways/ports should belong.

A location indicates the remote location that is accessed using restricted bandwidth connections.

Port Information

Port Direction

Specify the direction of calls passing through this port.

Inbound—Use for incoming calls only.

Outbound—Use for outgoing calls.

Both Ways—Use for inbound and outbound calls. This is the default value.

Attendant DN

This is an optional field. Enter the directory number to which you want incoming calls routed; for example, zero for an attendant.

Product Specific Configuration for Loop Start or Ground Start trunks

The gateway manufacturer defines the model-specific fields under Product Specific Configuration. Because the fields are dynamically configured, they can change without notice. To view field descriptions and help for product-specific configuration items, click the "i" information icon to the right of the Product Specific Configuration heading to display help in a popup window. In some cases, the displayed information may not be enough to help you understand the field. If you need more information, refer to the documentation for the specific gateway that you are configuring.


Field Descriptions for T1-CAS Trunks on a Cisco VG200 Gateway

Use the following field descriptions when adding or updating values for the T1-CAS signaling protocol on a Cisco VG200 gateway.

Fields are mandatory unless otherwise noted.

Table 5-3 Field Descriptions for T1-CAS Trunks on Cisco VG200 Gateways 

Field
Description

Device Pool

The values that appear in this field were configured in Cisco CallManager Administration. Choose the device pool to which this group of gateways/ports should belong.

A device pool defines sets of common characteristics for devices, such as region, date/time group, Cisco CallManager group, and calling search space for auto-registration.

Calling Search Space

This is an optional field. Choose the calling search space to which this group of gateways/ports should belong.

A calling search space specifies the collection of route partitions that are searched to determine how a dialed number should be routed.

Media Resource Group List

This is an optional field. Choose the media resource group list (MRGL) to which this group of gateways/ports should belong.

An MRGL specifies a list of prioritized media resource groups. An application can select required media resources among the available ones according to the priority order defined in the MRGL.

Network Hold Audio Source

This is an optional field. Choose the music on hold audio source to be played when the system places a call on hold (such as when user transfers a call or initiates a conference or call park).

User Hold Audio Source

This is an optional field. Choose the music on hold audio source to be played when the user places a call on hold (presses the Hold button or soft key).

Location

This is an optional field. Choose the location to which this group of gateways/ports should belong.

a location indicates the remote location that is accessed using restricted bandwidth connections.

Load Information

This is an optional field. Enter the appropriate load information for the custom software for gateway. The values you enter here override the default values for this gateway.

Leave this field blank to use the default load.

Port Selection Order

Choose the order in which ports are chosen. If you are not sure which port order to use, choose TOP_DOWN:

TOP_DOWN—selects ports in descending order, from first port (port 1) to the last port.

BOTTOM_UP—selects ports in ascending order, from the last port to the first port (port 1).

Product Specific Configuration

The gateway manufacturer defines the model-specific fields under Product Specific Configuration. Because the fields are dynamically configured, they can change without notice. To view field descriptions and help for product-specific configuration items, click the "i" information icon to the right of the Product Specific Configuration heading to display help in a popup window. In some cases, the displayed information may not be enough to help you understand the field. If you need more information, refer to the documentation for the specific gateway that you are configuring.


Fields Descriptions for T1-CAS Ports

Use the following field descriptions when adding or updating values for ports for the T1-CAS signaling protocol on a Cisco VG200 gateway.

Fields are mandatory unless otherwise noted.

Table 5-4 Field Descriptions for T1-CAS Ports 

Field
Description

Port Direction

Choose the direction of calls passing through this port:

Inbound—Use for incoming calls only.

Outbound—Use for outgoing calls.

Both Ways—Use for inbound and outbound calls. This is the default value.

Calling Party Selection

Because any outbound call on a gateway can send directory number information, choose which directory number to send:

Originator—Send the directory number of the calling device. This is the default value.

First Redirect Number—Send the directory number of the redirecting device.

Last Redirect Number—Send the directory number of the last device to redirect the call.

Digit Sending

Choose one of the following digit sending types for out-dialing:

DTMF—Dual-tone multifrequency. Normal touchtone dialing. This is the default value.

MF—Multifrequency

Caller ID Type

Choose the type of caller ID that displays to the called party:

ANI—Automatic number identification displays the number of the calling party. This is the default value.

DNIS—Dialed number identification service displays the number that the caller dialed.

Caller ID DN

This is an optional field. Enter the pattern you want to use for caller ID, from 0 to 24 digits.

For example, in North America

555XXXX = Variable caller ID, where X equals an extension number. The CO appends the number with the area code if you do not specify it.

5555000 = Fixed caller ID, for when you want the Corporate number to be sent instead of the exact extension from which the call is placed. The CO appends the number with the area code if you do not specify it.

Prefix DN

This is an optional field. Enter the prefix digits that are appended to the called party number on incoming calls.

The Cisco CallManager adds prefix digits after first truncating the number in accordance with the Num Digits setting.

Num Digits

Enter the number of significant digits to collect, from 0 to 32. Cisco CallManager counts significant digits from the right (last digit) of the number called. The default is 4.

Expected Digits

Enter the number of digits expected on the inbound side of the trunk. Use zero if you are unsure. The default is 4.

Product Specific Configuration

The gateway manufacturer defines the model-specific fields under Product Specific Configuration. Because the fields are dynamically configured, they can change without notice. To view field descriptions and help for product-specific configuration items, click the "i" information icon to the right of the Product Specific Configuration heading to display help in a popup window. In some cases, the displayed information may not be enough to help you understand the field. If you need more information, refer to the documentation for the specific gateway that you are configuring.


Field Descriptions for T1-PRI or E1-PRI Trunks on a Cisco VG200 Gateway

Use the following field descriptions when adding or updating values for T1-PRI or E1-PRI trunks on a Cisco VG200 gateway.

Fields are mandatory unless otherwise noted.

Table 5-5 Field Descriptions for T1-PRI or E1-PRI Trunks on Cisco VG200 Gateways 

Field
Description

Device Pool

The values that appear in this field were configured in Cisco CallManager Administration. Choose the device pool to which this group of gateways/ports should belong.

A device pool defines sets of common characteristics for devices, such as region, date/time group, Cisco CallManager group, and calling search space for auto-registration.

Calling Search Space

This is an optional field. Choose the calling search space to which this group of gateways/ports should belong.

A calling search space specifies the collection of route partitions that are searched to determine how a dialed number should be routed.

Media Resource Group List

This is an optional field. Choose the media resource group list (MRGL) to which this group of gateways/ports should belong.

An MRGL specifies a list of prioritized media resource groups. An application can select required media resources among the available ones according to the priority order defined in the MRGL.

Network Hold Audio Source

This is an optional field. Choose the music on hold audio source to be played when the system places a call on hold (such as when user transfers a call or initiates a conference or call park).

User Hold Audio Source

This is an optional field. Choose the music on hold audio source to be played when the user places a call on hold (presses the Hold button or soft key).

Location

This is an optional field. Choose the location to which this group of gateways/ports should belong.

A location indicates the remote location that is accessed using restricted bandwidth connections.

Load Information

This is an optional field. Enter the appropriate load information for the custom software for gateway. The values you enter here override the default values for this gateway.

Leave this field blank to use the default load.

Channel Selection Order

Choose the order in which channels or ports are enabled from first (lowest number port) to last (highest number port), or from last to first.

Valid entries are TOP_DOWN (last to first) or BOTTOM_UP (first to last). If you are not sure which port order to use, choose TOP_DOWN. The default is BOTTOM_UP.

Protocol Side

Choose the appropriate protocol side. This setting specifies whether the gateway connects to a Central Office/Network device or to a User device. The default is User.

Make sure the two ends of the PRI connection use opposite settings. For example, if you connect to a PBX and the PBX uses User as its protocol side, choose Network for this device. Typically, use User for Central Office (CO) connections.

Caller ID DN

This is an optional field. Enter the pattern you want to use for caller ID, from 0 to 24 digits.

For example, in North America

555XXXX = Variable caller ID, where X equals an extension number. The CO appends the number with the area code if you do not specify it.

5555000 = Fixed caller ID, where you want the Corporate number to be sent instead of the exact extension from which the call is placed. The CO appends the number with the area code if you do not specify it.

Calling Party Selection—

Any outbound call on a gateway can send directory number information. Choose which directory number is sent:

Originator—Send the directory number of the calling device. This is the default value.

First Redirect Number—Send the directory number of the redirecting device.

Last Redirect Number—Send the directory number of the last device to redirect the call.

Channel IE Type

Choose one of the following values to specify whether channel selection is presented as a channel map or a slot map:

Number—B-channel usage is always a channel map format.

Slotmap—B-channel usage is always a slotmap format.

Use Number When 1B—Channel usage is a channel map for one B-channel but is a slotmap if more than one B-channel exists. This is the default value.

Interface Identifier Present

This field applies to DMS-100 protocol only. Check the box to indicate that an Interface Identifier is present. By default, the box is unchecked.

Interface Identifier Value

This field applies to DMS-100 protocol only. Enter the value obtained from the PBX provider. Valid values range from 0 to 255.

Display IE Delivery

This is an optional field. Check the box to enable delivery of the display information element (IE) in SETUP and CONNECT messages for the calling and called party name delivery service. By default, the box is unchecked.

Redirecting Number IE Delivery

This is an optional field. Check the box to include the Redirecting Number IE in the SETUP message to indicate the first redirecting number and the redirecting reason of the call when a call is forwarded. By default, the box is unchecked.

This setting applies to the SETUP message only on all protocols for digital access gateways.

Delay for First Restart

This is an optional field. Enter the rate, in 1/8 second increments, at which the spans are brought in service. The delay occurs when many PRI spans are enabled on a system and the Inhibit Restarts at PRI Initialization check box is unchecked. The default value is 32.

For example, set the first five cards to 0, and set the next five cards to 16. (Wait 2 seconds before bringing them in service.)

Delay Between Restarts

This is an optional field. Enter the time, in 1/8 second increments, between restarts. The delay occurs when a PRI RESTART is sent if the Inhibit Restarts check box is unchecked. The default value is 4.

Num Digits

Choose the number of significant digits to collect, from 0 to 32. Cisco CallManager counts significant digits from the right (last digit) of the number called. The default value is 23.

Use this field if you check the Sig Digits check box. Use for the processing of incoming calls and to indicate the number of digits, starting from the last digit of the called number, used to route calls coming into the PRI span. See Prefix DN and Sig Digits.

Sig Digits

This is an optional field. This field represents the number of final digits a PRI span should retain on inbound calls. A trunk with significant digits enabled truncates all but the final few digits of the address provided on an inbound call.

Enable or disable this box depending on whether you want to collect significant digits:

If you do not check the box, Cisco CallManager does not truncate the inbound number.

If you check the box, you also need to choose the number of significant digits to collect. By default, the box is checked.

Prefix DN

This is an optional field. Enter the prefix digits that are appended to the digits that this trunk receives on incoming calls.

Cisco CallManager adds prefix digits after first truncating the number in accordance with the Num Digits setting.

Presentation Bit

Choose whether you want the central office to transmit or block caller ID.

Allowed—The Central Office will send caller ID. This is the default value.

Restricted—The Central Office will not send caller ID.

Called Party IE Number Type Unknown

Choose the format for the type of number in called party directory numbers. Cisco CallManager sets the called directory number (DN) type. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans, such as NANP or the European dialing plan. You may need to change the default in Europe because Cisco CallManager does not recognize European national dialing patterns. You can also change this setting when connecting to PBXs using routing as a non-national type number.

Choose one of the following options:

CallManager—The Cisco CallManager sets the directory number type. This is the default value.

International—Use when you are dialing outside the dialing plan for your country.

National—Use when you are dialing within the dialing plan for your country.

Unknown—The dialing plan is unknown.

Calling Party Number Type IE Unknown

Choose the format for the type of number in calling party directory numbers.

Cisco CallManager sets the calling directory number (DN) type. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans, such as NANP or the European dialing plan. You may need to change the default in Europe because Cisco CallManager does not recognize European national dialing patterns. You can also change this setting when connecting to PBXs using routing as a non-national type number.

Choose one of the following options:

CallManager—The Cisco CallManager sets the directory number type. This is the default value.

International—Use when you are dialing outside the dialing plan for your country.

National—Use when you are dialing within the dialing plan for your country.

Unknown—The dialing plan is unknown.

Called Numbering Plan

Choose the format for the numbering plan in called party directory numbers.

Cisco CallManager sets the called DN numbering plan. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans, such as NANP or the European dialing plan. You may need to change the default in Europe because Cisco CallManager does not recognize European national dialing patterns. You can also change this setting when connecting to PBXs using routing as a non-national type number.

Choose one of the following options:

CallManager—The Cisco CallManager sets the Numbering Plan in the directory number. This is the default value.

ISDN—Use when you are dialing outside the dialing plan for your country.

National Standard—Use when you are dialing within the dialing plan for your country.

Private—Use when you are dialing within a private network.

Unknown—The dialing plan is unknown.

Calling Numbering Plan

Choose the format for the numbering plan in calling party directory numbers.

Cisco CallManager sets the calling DN numbering plan. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans, such as NANP or the European dialing plan. You may need to change the default in Europe because Cisco CallManager does not recognize European national dialing patterns. You can also change this setting when connecting to PBXs using routing as a non-national type number.

Choose one of the following options:

CallManager—The Cisco CallManager sets the Numbering Plan in the directory number. This is the default value.

ISDN—Use when you are dialing outside the dialing plan for your country.

National Standard—Use when you are dialing within the dialing plan for your country.

Private—Use when you are dialing within a private network.

Unknown—The dialing plan is unknown.

PRI Protocol Type

Choose the communications protocol for the span:

For E1 PRI spans have two options:

PRI AUSTRALIAN—Australian ISDN

PRI EURO—European ISDN

T1 PRI spans have several options, depending on the carrier or switch:

4E —AT&T InterExchange carrier

5E8 Custom—Cisco IP Phone

5E9 and NI2—AT&T family local exchange switch or carrier

DMS—MCI family local exchange switch or carrier

ETSI SC—European local exchange carrier on T1; also, Japanese local exchange.

Determine the switch to which you are connecting and the preferred protocol, as follows:

Nortel Meridian—5E8 Custom

Lucent Definity—4ESS or 5E8

Madge (Teleos) box—5E8 Teleos

Intecom PBX—5E8 Intecom

Alternatively, choose the protocol based on the carrier:

MCI—DMS-250

Sprint—DMS-250 or DMS-100

AT&T—4ESS

Inhibit Restarts at PRI Initialization

This is an optional field. A RESTART message confirms the status of the ports on a PRI span. If RESTARTs are not sent, Cisco CallManager assumes the ports are in service. By default, the box is checked.

When the D-Channel successfully connects with another PRI trunk D-Channel, it sends restarts when this box is unchecked.

Enable Status Poll

This is an optional field. Check the box to view the B-channel status in the debug window. By default, the box is unchecked.

Number of Digits to Strip

Choose the number of digits to strip on outbound calls, from 0 to 32. The default value is 0.

For example, 8889725551234 is dialed, and the number of digits to strip is 3. In this example, Cisco CallManager strips 888 from the outbound number.

Setup of Non-ISDN Progress Indicator IE Enable

This is an optional field. You may need to specify a value in this field to force ringback on some PBXs.

The default is unchecked. Check this box only if users are not receiving ringback tones on outbound calls.

When this setting is enabled, Cisco CallManager sends Q.931 setup messages out digital (that is, non-H.323) gateways with the Progress Indicator field set to non-ISDN.

This message notifies the destination device that the Cisco CallManager gateway is non-ISDN and that the destination device should play in-band ringback.

This problem is usually associated with Cisco CallManagers that connect to PBXs through digital gateways.

Product Specific Configuration

The gateway manufacturer defines the model-specific fields under Product Specific Configuration. Because the fields are dynamically configured, they can change without notice. To view field descriptions and help for product-specific configuration items, click the "i" information icon to the right of the Product Specific Configuration heading to display help in a popup window. In some cases, the displayed information may not be enough to help you understand the field. If you need more information, refer to the documentation for the specific gateway that you are configuring.


Field Descriptions for FXS Ports on a Cisco Catalyst 6000 24 Port Analog Interface Module

Use the following field descriptions when adding or updating values for FXS ports on a Cisco Catalyst 6000 analog interface module.

All fields are mandatory unless otherwise noted.

Table 5-6 Field Descriptions for FXS Ports on Cisco Catalyst 6000 Modules 

Field
Description

Catalyst 6000 (FXS) Ports Template Name

Enter a name for the template, up to 50 alphanumeric characters.

Port Direction

Choose the direction of calls passing through this port.

Inbound—Use for incoming calls only.

Outbound—Use for outgoing calls.

Both Ways—Use for inbound and outbound calls. This is the default value.

Prefix DN

This is an optional field. Enter the prefix digits to be appended to the digits received on incoming calls.

Num Digits

Enter the number of digits to collect, from 0 to 32. Significant digits are counted from the right (last digit) of the number called.

Expected Digits

Enter the number of digits expected on the inbound side of the trunk. Use zero if you are unsure.

SMDI Port Number

Enter the SMDI port number. Use the same number as the actual port number on the voice mail system to which the analog access port connects.

Product Specific Configuration

Port Level

Choose the gain of audio entering or leaving the span.

Auto Signal Adjustment into IP Network

Choose the gain or loss that you want applied to the received audio signal.

Auto Signal Adjustment from IP Network

Choose the gain or loss that you want applied to the transmitted audio signal.

Timers

Call Restart Timer

Enter the time that must pass after the far end disconnects and the near end is still off-hook before reorder tone plays. Default is 5000 ms.

Offhook Validation Timer

Enter the time that must pass before Cisco CallManager recognizes a valid off-hook indication. Default is 100 ms.

Onhook Validation Timer

Enter the time that must pass before Cisco CallManager recognizes a valid on-hook indication. Default is 250 ms.

HookFlash Timer

Enter the time that must pass after on-hook is recognized before going back off-hook and have it recognized as hook-flash and not disconnect. Default is 1000 ms.


Field Descriptions for Gateway Directory Number Template

Use the following field descriptions when adding or updating values for a Gateway Directory Number template.

All fields are optional.

Table 5-7 Field Descriptions for Gateway Directory Number Template 

Field
Description

Partition

Choose the partition to which the directory number will be added

Directory Number Settings

Default Voice Message Box to Directory Number

Check this box to default the voice message box field for a directory number to the same value as the directory number. This means that the call will only ring the directory number and not roll to voice mail.

Calling Search Space

Choose the calling search space to which this group of directory numbers should belong.

A calling search space specifies the collection of route partitions that are searched to determine how a dialed number should be routed.

User Hold Audio Source

Choose the music on hold audio source to be played when the user places a call on hold (presses the Hold button or soft key).

Network Hold Audio Source

Choose the music on hold audio source to be played when the system places a call on hold (such as when user transfers a call or initiates a conference or call park).

In the Call Forward and Pickup Settings area, complete the following fields. If you enter a value for any of these fields, you can also choose the Calling Search Space for that field.

Forward All

Enter the directory number to which all calls are sent. If there is a value in this field, then all calls destined for the gateway directory number are automatically forwarded to the specified directory number.

Forward Busy

Enter the directory number to which all calls are sent if the gateway directory number is busy.

Forward No Answer

Enter the directory number to which calls are sent if the gateway directory number does not answer.

Call Pickup Group

Choose the number that can be dialed to answer calls to this directory number (in the specified partition).

Line Settings for this Device

External Phone Number Mask

Enter the phone number (mask) used to send Caller ID information when placing a call from this directory number.