Cisco Unity Express CLI Administrator Guide for Cisco CallManager Express, Release 2.1

Advanced Configuration

This chapter describes advanced configuration procedures for modifying application parameters after the initial installation and configuration process described in the section, "Configuring System Components". That earlier chapter includes commands not described in this chapter.

The advanced configuration procedures include:

•Configuring System Engine Parameters

•Configuring Application Parameters

•Configuring Multiple Triggers for an Application

•Configuring the Hostname

•Configuring the DNS Server

•Configuring NTP Servers

•Configuring an External Syslog Server

•Configuring the Clock Time Zone

Configuring System Engine Parameters

Use this procedure to configure parameters that are used across all systems and subsystems in Cisco Unity Express. This set of parameters affects the underlying software programs, or engine, that comprise Cisco Unity Express.

Only the parameter maxsteps is available. A script uses this value to limit the number of steps that can execute for an application script. For example, if a script has an error such that a customer is returned to the same menu choice in an infinite loop, the system stops the loop when the maxstep value is reached. Similarly, if a script has procedures with nested steps that exceed the maxstep value when the script executes, the system stops the script. When this happens, the caller hears a system message that the system is not available.

Note Script steps are described in detail in the Cisco Unity Express Script Editor Guide.

Prerequisites

The following information is required to configure system engine parameters.

•Maximum number of times a script step can execute before an alternate path is invoked.

SUMMARY STEPS

1. config t

2. ccn engine

3. default parameter

4. maxsteps steps-limit

5. end

6. exit

7. show ccn engine

8. copy running-config startup-config

DETAILED STEPS

se-10-0-0-0(config-engine)# default maxsteps

se-10-0-0-0(config-engine)# maxsteps 200

Examples

The following example illustrates the show ccn engine output:

se-10-0-0-0# show ccn engine

Maximum number of Tasks:                0

Maximum number of Steps:                200

se-10-0-0-0#

Configuring Application Parameters

The section, "Configuring System Components" described how to configure parameters for the applications that shipped with Cisco Unity Express. This procedure describes how to configure parameters for your custom auto-attendant application script.

Prerequisites

•Application name.

•Script name for the application.

•Maxsessions value. See the section "Sharing Ports Among Applications and Triggers".

•Name and value for each parameter that the script requires. These may vary, depending on the script that you have created.

Note For more information about creating scripts, refer to the Cisco Unity Express Script Editor Guide.

SUMMARY STEPS

1. config t

2. ccn application full-name

3. default parameter

4. description "text"

5. maxsessions number

6. no parameter

7. parameter name "value"

8. script name [description "description"]

9. enabled

10. end

11. exit

12. show ccn scripts

13. show ccn application

14. copy running-config startup-config

DETAILED STEPS

se-10-0-0-0(config-application)# default maxsessions

se-10-0-0-0# show ccn scripts

se-10-0-0-0# show ccn application

Examples

The following example illustrates the show ccn scripts output:

se-10-0-0-0# show ccn scripts

Name:                                   myscript.aef

Description:                            My New Script

se-10-0-0-0#

The following example illustrates the show ccn application output:

se-10-0-0-0# show ccn application

Name:                                   myscript

Description:                            my application

Script:                                 myscript.aef

ID number:                              2

Enabled:                                yes

Maximum number of sessions:             5

Retries:                                4

WelcomePrompt:                          Welcome.wav

se-10-0-0-0# 

Configuring Multiple Triggers for an Application

Your network may require additional triggers for one or more Cisco Unity Express applications. For example, customers may be able to dial more than one telephone number to contact your company. These telephone numbers would activate the auto-attendant application.

Use this procedure to configure the additional triggers. The trigger must match a dial peer configured on Cisco CME. If you configure a trigger on Cisco Unity Express, verify that the dial peer exists in Cisco CME.

Cisco Unity Express supports a maximum of 8 triggers for all applications combined. This applies to both the NM and the AIM.

Port Sharing Among Multiple Triggers

Each trigger is assigned a maxsessions value. In addition to the guidelines described in "Port Sharing Among Multiple Triggers", one other consideration is needed.

The maximum number of callers that can access an application concurrently is determined by the application's maxsession value if the total maxsessions values from all its triggers exceeds the application's maxsessions value.

For example, suppose your module has 8 ports and you assigned the auto-attendant application a maxsessions value of 5. Your auto-attendant application has 2 triggers. You configure one trigger with a maxsessions value of 2 and the other trigger with a maxsessions value of 4. The maximum number of callers that can access the auto-attendant application simultaneously is 5, not 6.

Suppose, instead, that you configure one trigger with a maxsessions value of 2 and the other trigger with a maxsessions value of 2. The maximum number of simultaneous callers to the application is 4, not 5.

Prerequisites

The following information is required to configure the triggers:

•Telephone number that invokes the application. The number must not be the same for voice-mail, auto-attendant, and the greeting management system.

•Number of milliseconds that the system must wait for a caller response before it times out and drops the call.

•Language to use for the prompts. Cisco Unity Express supports only one language installed on the system. This option cannot be changed.

•Maximum number of callers, or sessions, that the application can handle simultaneously. The total for all applications must not exceed the maximum number of ports for the system. (See Table 2 or Table 4 for the maximum number of ports.) The applications need not have the same maximum number; for example, voice mail might need three sessions, while auto attendant needs five sessions.

SUMMARY STEPS

1. config t

2. ccn trigger sip phonenumber number

3. application string

4. default parameter

5. idletimeout time

6. locale language

7. maxsessions number

8. no parameter

9. enabled

10. end

11. Repeat Step 2 to Step 10 to configure additional triggers for this application.

12. exit

13. show ccn trigger

14. copy running-config startup-config

DETAILED STEPS

Examples

The following sample configuration sets two triggers for the voice-mail application:

se-10-0-0-0# config t

se-10-0-0-0(config)# ccn trigger sip phonenumber 50150

se-10-0-0-0(config-trigger)# application voicemail

se-10-0-0-0(config-trigger)# idletimeout 500

se-10-0-0-0(config-trigger)# maxsessions 4

se-10-0-0-0(config-trigger)# enabled

se-10-0-0-0(config-trigger)# end

se-10-0-0-0(config)#

se-10-0-0-0(config)# ccn trigger sip phonenumber 50160

se-10-0-0-0(config-trigger)# application voicemail

se-10-0-0-0(config-trigger)# idletimeout 1000

se-10-0-0-0(config-trigger)# maxsessions 8

se-10-0-0-0(config-trigger)# enabled

se-10-0-0-0(config-trigger)# end

se-10-0-0-0(config)# exit

se-10-0-0-0# 

The output for the show ccn trigger command might look similar to the following:

se-10-0-0-0# show ccn trigger

Name:                         50150

Type:                         SIP

Application:                  voicemail

Locale:                       en_US

Idle Timeout:                 500

Enabled:                      yes

Maximum number of sessions:   4

Name:                         50160

Type:                         SIP

Application:                  voicemail

Locale:                       en_US

Idle Timeout:                 1000

Enabled:                      yes

Maximum number of sessions:   8

se-10-0-0-0#

Configuring the Hostname

During the software postinstallation process, the hostname was configured. Use this procedure to change the hostname.

SUMMARY STEPS

1. config t

2. hostname hostname

3. exit

4. show hosts

5. copy running-config startup-config

DETAILED STEPS

Examples

The following commands configure the hostname:

se-10-0-0-0# config t

se-10-0-0-0(config)# hostname ca-west

ca-west(config)# exit

ca-west#

The output from the show hosts command might look similar to the following:

ca-west# show hosts

Hostname:      ca-west

Domain:        myoffice

DNS Server1:   10.100.10.130

DNS Server2:   10.5.0.0

ca-west#

Configuring the DNS Server

During the software postinstallation process, the DNS server and IP addresses were configured. Use this procedure to change the server name and IP addresses.

SUMMARY STEPS

1. config t

2. ip domain-name dns-server-name

3. ip name-server ip-address [ip-address] [ip-address] [ip-address]

4. exit

5. show ip route

6. copy running-config startup-config

DETAILED STEPS

Examples

The following commands configure the DNS server:

se-10-0-0-0# config t

se-10-0-0-0(config)# ip domain-name myoffice

se-10-0-0-0(config)# ip name-server 10.100.10.130 10.5.0.0

se-10-0-0-0(config)# exit

se-10-0-0-0#

The output from the show ip route command might look similar to the following:

se-10-0-0-0# show ip route 

           DEST            GATE            MASK IFACE

      10.100.6.9         0.0.0.0   255.255.255.0 eth1

      172.16.0.0         0.0.0.0       255.0.0.0 lo

        0.0.0.0       10.100.6.9         0.0.0.0 eth1

se-10-0-0-0#

Configuring NTP Servers

You can configure Network Time Protocol (NTP) servers using the GUI options, the CLI commands, or during the software postinstallation process. Cisco Unity Express accepts a maximum of three NTP servers. Use this procedure to add or delete NTP servers.

Adding NTP Servers

You can designate an NTP server using its IP address or its hostname.

•If you use an IP address, you must always refer to the NTP server by that IP address. You cannot use a hostname to refer to that NTP server.

•If you use a hostname, you must always refer to the NTP server by that hostname. You cannot use an IP address to refer to that NTP server.

Cisco Unity Express uses the DNS server to resolve the hostname to an IP address and stores the IP address as an NTP server. If DNS resolves the hostname to more than one IP address, Cisco Unity Express randomly chooses one of the IP addresses that is not already designated as an NTP server.

To configure an NTP server with multiple IP addresses for a hostname, repeat the configuration steps using the same hostname. Each iteration assigns the NTP server to its remaining IP addresses.

SUMMARY STEPS

1. config t

2. ntp server {hostname | ip-address} [prefer]

3. exit

4. show ntp status

5. show ntp configuration

6. copy running-config startup-config

DETAILED STEPS

Examples

The following commands configure the NTP server:

se-10-0-0-0# config t

se-10-0-0-0(config)# ntp server 10.100.6.9

se-10-0-0-0(config)# exit

se-10-0-0-0#

The output from the show ntp status command might look similar to the following:

se-10-0-0-0# show ntp status

NTP reference server 1:       10.100.6.9

Status:                       sys.peer

Time difference (secs):       3.268110099434328E8

Time jitter (secs):           0.1719226837158203

se-10-0-0-0#

The following example configures an NTP server with a hostname that points to two IP addresses 172.16.10.1 and 172.16.10.2:

se-10-0-0-0# config t

se-10-0-0-0(config)# ntp server NTP.mine.com

se-10-0-0-0(config)# exit

se-10-0-0-0# 

se-10-0-0-0# config t

se-10-0-0-0(config)# ntp server NTP.mine.com

se-10-0-0-0(config)# exit

se-10-0-0-0#

The output from the show ntp status command might look similar to the following:

se-10-0-0-0# show ntp status

NTP reference server 1:       172.16.10.1

Status:                       sys.peer

Time difference (secs):       3.268110099434328E8

Time jitter (secs):           0.1719226837158203

NTP reference server 1:       172.16.10.2

Status:                       sys.peer

Time difference (secs):       3.268110099434328E8

Time jitter (secs):           0.1719226837158203

se-10-0-0-0#

Removing an NTP Server

Remove an NTP server using its IP address or hostname.

•If the NTP server was configured using its IP address, use that IP address to remove the server. You cannot remove the server with its hostname.

•If the NTP server was configured using its hostname, use that hostname to remove the server. You cannot remove the server with an IP address.

If the NTP server hostname is associated with more than one IP address, you cannot specify which IP address to remove. Cisco Unity Express deletes the IP address based on a response from the DNS server and cannot guarantee which configured NTP server IP address is deleted.

If you need to remove the NTP server with a specific IP address, repeat the removal steps enough times to delete all the NTP servers, update the DNS server with the correct IP address information, and then add the NTP server enough times to assign the NTP server to its appropriate number of IP addresses.

SUMMARY STEPS

1. config t

2. no ntp server {hostname | ip-address} [prefer]

3. exit

4. show ntp status

5. show ntp configuration

6. copy running-config startup-config

DETAILED STEPS

Displaying NTP Server Information

The following commands are available to display NTP server configuration information and status:

•show ntp associations

•show ntp server

•show ntp source

Configuring an External Syslog Server

Cisco Unity Express captures messages that describe activities in the system. Use CLI commands to display the messages; viewing the messages is not available from the GUI.

The activities are categorized into four different levels of severity with regard to their impact on the system's functioning:

•Information—The message describes normal system activity, including debug, information, and notice messages.

•Warning—The message is an alert that a non-normal activity is occurring. The Cisco Unity Express system continues to function.

•Error—The message indicates that a system error has occurred. The Cisco Unity Express system may or may not have stopped functioning.

•Fatal—The message describes a critical, alert, or emergency situation with the system. The Cisco Unity Express system has stopped functioning.

These messages are collected and directed to three possible destinations:

•Messages.log file—This option is the default. The file contains all system messages and resides on the Cisco Unity Express module hard disk in /var/log/messages.log. You can print the messages, view them on the console, or copy them to a server to review for troubleshooting and error reporting.

•Console—Display the messages.log file using the show log name messages.log command. View the system messages as they occur with the log console info command.

•External system log (syslog) server—Cisco Unity Express copies the messages to another server and collects them in a file on that server's hard disk. The syslog daemon configuration on the external server determines which directory will save the messages log.

The external server must be configured to listen for UDP on port 514 from the IP address of the Cisco Unity Express module.

Prerequisites

You need the hostname or IP address of the designated log server.

SUMMARY STEPS

1. config t

2. log server address {hostname | IP-address}

3. exit

4. show running-config

DETAILED STEPS

Examples

The output from the show running-config command might look similar to the following:

se-10-0-0-0# show running-config

clock timezone America/Los_Angeles

hostname se-10-0-0-0

ip domain-name localdomain

ntp server 10.100.60.1

.

.

.

log server address 10.100.10.210

voicemail default mailboxsize 3000

voicemail capacity time 6000

end

Configuring the Clock Time Zone

During the software postinstallation process, the time zone of the local Cisco Unity Express module was configured. Use this procedure to change the module's time zone.

Cisco Unity Express automatically updates the clock for daylight savings time on the basis of the selected time zone.

SUMMARY STEPS

1. config t

2. clock timezone timezone

3. exit

4. show clock detail

5. copy running-config startup-config

DETAILED STEPS

Examples

The following commands configure the clock time zone:

se-10-0-0-0# config t

se-10-0-0-0(config)# clock timezone

Please identify a location so that time zone rules can be set correctly.

Please select a continent or ocean.

1) Africa	     4) Arctic Ocean	 7) Australia	    10) Pacific Ocean

2) Americas	     5) Asia		 8) Europe

3) Antarctica	     6) Atlantic Ocean	 9) Indian Ocean

#? 2

Please select a country.

 1) Anguilla            18) Ecuador          35) Paraguay

 2) Antigua & Barbuda   19) El Salvador      36) Peru

 3) Argentina           20) French Guiana    37) Puerto Rico

 4) Aruba               21) Greenland        38) St Kitts & Nevis

 5) Bahamas             22) Grenada          39) St Lucia

 6) Barbados            23) Guadeloupe       40) St Pierre & Miquelon

 7) Belize	              24) Guatemala             41) St Vincent

 8) Bolivia              25) Guyana                42) Suriname

 9) Brazil	              26) Haiti                 43) Trinidad & Tobago

10) Canada	              27) Honduras              44) Turks & Caicos Is

11) Cayman Islands       28) Jamaica               45) United States

12) Chile                29) Martinique            46) Uruguay

13) Colombia             30) Mexico                47) Venezuela

14) Costa Rica           31) Montserrat            48) Virgin Islands (UK)

15) Cuba                 32) Netherlands Antilles  49) Virgin Islands (US)

16) Dominica             33) Nicaragua

17) Dominican Republi    34) Panama

#? 45

Please select one of the following time zone regions.

 1) Eastern Time

 2) Eastern Time - Michigan - most locations

 3) Eastern Time - Kentucky - Louisville area

 4) Eastern Time - Kentucky - Wayne County

 5) Eastern Standard Time - Indiana - most locations

 6) Eastern Standard Time - Indiana - Crawford County

 7) Eastern Standard Time - Indiana - Starke County

 8) Eastern Standard Time - Indiana - Switzerland County

 9) Central Time

10) Central Time - Michigan - Wisconsin border

11) Central Time - North Dakota - Oliver County

12) Mountain Time

13) Mountain Time - south Idaho & east Oregon

14) Mountain Time - Navajo

15) Mountain Standard Time - Arizona

16) Pacific Time

17) Alaska Time

18) Alaska Time - Alaska panhandle

19) Alaska Time - Alaska panhandle neck

20) Alaska Time - west Alaska

21) Aleutian Islands

22) Hawaii

#? 16

The following information has been given:

	United States

	Pacific Time

Therefore TZ='America/Los_Angeles' will be used.

Is the above information OK?

1) Yes

2) No

#? 1

The output from the show clock detail command might look similar to the following:

se-10-0-0-0# show clock detail

19:20:33.724 PST Wed Feb 4 2004

time zone:                              America/Los_Angeles

clock state:                            unsync

delta from reference (microsec):        0

estimated error (microsec):             175431

time resolution (microsec):             1

clock interrupt period (microsec):      10000

time of day (sec):                      732424833

time of day (microsec):                 760817