-
Cisco Unity Express Command Reference for 3.0 and Later Versions
-
Using Cisco Unity Express Software
-
Cisco Unity Express Commands: A
-
Cisco Unity Express Commands: B
-
Cisco Unity Express Commands: C
-
Cisco Unity Express Commands: D
-
Cisco Unity Express Commands: E
-
Cisco Unity Express Commands: F
-
Cisco Unity Express Commands: G
-
Cisco Unity Express Commands: H
-
Cisco Unity Express Commands: I
-
Cisco Unity Express Commands: K
-
Cisco Unity Express Commands: L
-
Cisco Unity Express Commands: M
-
Cisco Unity Express Commands: N
-
Cisco Unity Express Commands: O
-
Cisco Unity Express Commands: P
-
Cisco Unity Express Commands: R
-
Cisco Unity Express Commands: script (ccn application) to show ccn trigger sip
-
Cisco Unity Express Commands: show clock detail to show remote users
-
Cisco Unity Express Commands: show restore history to system shutdown (aaa accounting enable)
-
Cisco Unity Express Commands: T
-
Cisco Unity Express Commands: U
-
Cisco Unity Express Commands: V
-
Cisco Unity Express Commands: W
-
Cisco Unity Express Commands: X
-
Cisco Unity Express Commands: Z
-
Index
-
Feedback
Table Of Contents
calling-number-rule prepend-digits
ccn copy url document-IVR Only
ccn subsystem edbs dbprofile-IVR Only
config-commands (aaa accounting event)
credentials (ccn subsystem edbs dbprofile)-IVR Only
C
Last Updated: August 21, 2009
calling-number-rule prepend-digits
ccn copy url document-IVR Only
ccn subsystem edbs dbprofile-IVR Only
config-commands (aaa accounting event)
credentials (ccn subsystem edbs dbprofile)-IVR Only
calendar biz-schedule
To configure a business-hours schedule, use the calendar biz-schedule command in Cisco Unity Express configuration mode. To delete a schedule, use the no form of this command.
calendar biz-schedule schedule-name
no calendar biz-schedule schedule-name
Syntax Description
Defaults
Open 24 hours a day, 7 days a week (systemschedule file)
Command Modes
Cisco Unity Express configuration
Command History
Usage Guidelines
Cisco Unity Express supports up to four business schedules.
Each 24-hour day is divided into half-hour time slots. Specify the time slots when the company is open or closed.
The system default is "open" for 24 hours each day.
To configure a business-hours schedule using the graphical user interface (GUI), choose the
Voice Mail > Business Hours Settings option.Use the GUI to copy one business schedule to another schedule, which can then be modified.
The Cisco Unity Express system ships with one default schedule called "systemschedule." This schedule treats the business as open 24 hours per day, 7 days per week. Use the GUI Voice Mail > Business Hours Settings option or CLI commands to modify or delete this schedule. If you have created multiple schedules, use the GUI or CLI commands to associate the desired schedule with the auto attendant (AA). You do not have to reboot the system to have the new schedule take effect.
When a caller reaches the AA, the AA plays the welcome prompt and checks if the current day is a holiday. If it is a holiday, the AA plays the holiday greeting to the caller and does not check the business-hours schedule.
If the current day is not a holiday, the system checks if the business is open. If so, the business open prompt plays. In the canned AA, this prompt (AABusinessOpen.wav) is empty. If the business is closed, the system plays the business closed prompt. In the canned AA, this prompt (AABusinessClosed.wav) says "We are currently closed. Please call back later."
You can customize these two prompts by recording more meaningful messages. The prompts must be .wav files with the format G.711 u-law, 8 kHz, 8 bit, Mono. Use the GUI Voice Mail > Prompts option or the CLI commands to upload the customer prompts. Alternatively, you can record these prompts using the Administration via Telephone (AvT) system. After uploading or recording these custom prompts, use the GUI Voice Mail > Auto Attendants option or the CLI commands to associate the new prompts with the AA. The new prompts take effect as soon as they are configured; the system does not need to be restarted.
Examples
The following example creates a business-hours schedule:
se-10-0-0-0# config t
se-10-0-0-0(config)# calendar biz-schedule normal
Adding new schedule
se-10-0-0-0(config-business)# closed day 1 from 00:00 to 24:00
se-10-0-0-0(config-business)# closed day 2 from 00:00 to 08:30
se-10-0-0-0(config-business)# closed day 2 from 17:30 to 24:00
se-10-0-0-0(config-business)# closed day 3 from 00:00 to 08:30
se-10-0-0-0(config-business)# closed day 3 from 17:30 to 24:00
se-10-0-0-0(config-business)# closed day 4 from 00:00 to 08:30
se-10-0-0-0(config-business)# closed day 4 from 17:30 to 24:00
se-10-0-0-0(config-business)# closed day 5 from 00:00 to 08:30
se-10-0-0-0(config-business)# closed day 5 from 20:00 to 24:00
se-10-0-0-0(config-business)# closed day 6 from 00:00 to 08:30
se-10-0-0-0(config-business)# closed day 6 from 18:00 to 24:00
se-10-0-0-0(config-business)# closed day 7 from 00:00 to 09:00
se-10-0-0-0(config-business)# closed day 7 from 13:00 to 24:00
se-10-0-0-0(config-business)# end
se-10-0-0-0(config)# exit
The following example deletes a business-hours schedule:
se-10-0-0-0# config t
se-10-0-0-0(config)# no calendar biz-schedule normal
se-10-0-0-0(config)# exit
Related Commands
calendar holiday
To configure a holiday list, use the calendar holiday command in Cisco Unity Express configuration mode. To delete a holiday, use the no form of this command.
calendar holiday date yyyy mm dd [description holiday-description]
no calendar holiday date yyyy [mm [dd]]
Syntax Description
Defaults
No holiday lists are configured.
Command Modes
Cisco Unity Express configuration
Command History
Usage Guidelines
A holiday list contains administrator-designated calendar dates for a specified year. When a caller reaches the auto attendant (AA), the welcome prompt script checks if the current day is a holiday. If it is a holiday, the AA plays the holiday prompt to the caller. In the canned AA script provided with the Cisco Unity Express package, this prompt (AAHolidayPrompt.wav) is "We are closed today. Please call back later." You can customize this prompt by recording a more meaningful message, such as "We are closed today for a holiday. If this is an emergency, please call 1-222-555-0150 for assistance. Otherwise, please call back later."
The prompt must be a .wav file with the format G.711 u-law, 8 kHz, 8 bit, Mono. Use the GUI Voice Mail > Prompts option or CLI commands to upload the custom prompt. Alternatively, you can record the prompt using the Administration via Telephone (AvT) system. After uploading or recording the custom prompt, use the GUI Voice Mail > Auto Attendant option or the CLI commands to associate the new prompt with the AA. The new prompt takes effect as soon as it is configured; the system does not need to be restarted.
A list can contain a maximum of 26 holidays for the year.
Cisco Unity Express supports up to three holiday lists: the previous year, the current year, and the next year. If a year has no configured entries, the system treats that year as having no holidays.
The administrator can delete entries from a previous year list but cannot add or modify that list in any other way.
The system automatically deletes the "previous year" list when the a new calendar year begins. For example, if the active lists are:
2004—Previous Year2005—Current Year2006—Next YearOn January 1, 2006, the active lists are:
2005—Previous Year2006—Current Year2007—Next YearThe system automatically deletes the holiday list for 2004, changes the designations of the 2005 and 2006 holiday lists, and permits holidays for 2007 to be configured.
To configure the holiday list for the current year and next year using the GUI, choose the Voice Mail > Holiday Settings option.
To copy holidays from one year to the next, choose the GUI option Copy all to next year under Voice Mail > Holiday Settings.
Examples
The following example creates a holiday list for 2005:
se-10-0-0-0# config t
se-10-0-0-0(config)# calendar holiday date 2005 05 30 description "Memorial Day"
se-10-0-0-0(config)# calendar holiday date 2005 07 04 description "Independence Day"
se-10-0-0-0(config)# calendar holiday date 2005 11 24 description "Thanksgiving Day"
se-10-0-0-0(config)# calendar holiday date 2005 11 25 description "Thanksgiving Day"
se-10-0-0-0(config)# exit
The following examples illustrate deleting holidays from the holiday list.
Note
Use this command with caution, as this operation is irreversible and may cause loss of holiday configuration for the entire year.
The following example deletes a holiday from the 2005 holiday list:
se-10-0-0-0# config t
se-10-0-0-0(config)# no calendar holiday date 2005 05 30
se-10-0-0-0(config)# exit
The following example deletes the holidays from a specific month in the 2005 holiday list:
se-10-0-0-0# config t
se-10-0-0-0(config)# no calendar holiday date 2005 11
se-10-0-0-0(config)# exit
The following example deletes all the holidays for a specific year:
se-10-0-0-0# config t
se-10-0-0-0(config)# no calendar holiday date 2005
se-10-0-0-0(config)# exit
Related Commands
calendar holiday fixed
To configure a fixed holiday, use the calendar holiday fixed command in Cisco Unity Express configuration mode.
calendar holiday fixed month day [description description]
Syntax Description
month
Month of the fixed holiday.
day
Day of the month you want to define as a fixed holiday.
description description
(Optional) Specifies a description for the fixed holiday.
Command Default
No fixed holidays are defined.
Command Modes
Cisco Unity Express EXEC
Command History
Usage Guidelines
Use the calendar holiday fixed command in Cisco Unity Express configuration mode to configure a fixed holiday. You must provide the month and day in two-digit format. You can optionally add a description for the fixed holiday.
Examples
The following example configures January 5 as a fixed holiday:
se-10-0-0-0# config tse-10-0-0-0(config)# calendar holiday fixed 01 05
Related Commands
show calendar holiday fixed
Displays a list of the configured fixed holidays.
call-agent
To set the call-agent for the Cisco Unity Express system, use the call-agent command in Cisco Unity Express EXEC mode. Use the no form of this command to remove the configuration of the call agent.
call-agent {cucm | cucme}
no call-agent {cucm | cucme}
Syntax Description
cucm
Sets Cisco Unified Communications Manager (CUCM) as the call agent.
cucme
Sets Cisco Unified Communications Manager Express (CUCME) as the call agent.
Command Default
Cisco Unified Communications Manager (CUCM).
Command Modes
Cisco Unity Express EXEC
Command History
Usage Guidelines
In versions prior to Cisco Unity Express 7.1, the call agent was determined by the purchased license. Beginning with Cisco Unity Express 7.1, this command enables you to choose either Cisco Unified Communications Manager (CUCM) or Cisco Unified Communications Manager Express (CUCME) as the call agent.
You must configure the call agent using one of the two following methods:
•
•
Examples
The following output shows how to configure the call agent for Cisco Unified CME as part of the post-installation process.
Would you like to manually adjust the system time (y,n)? noexecuting app post_installEnter Call Agent1) Cisco Unified Communications Manager (CUCM) -- default2) Cisco Unified Communications Manager Express (CUCME)#? : 1Setting Call Agent to CUCMThe following output shows how to configure the call agent for Cisco Unified Communications Manager after the service module boots up. This operation is not reversible, and you should use this method with caution while configuring the call agent for Cisco Unified Communications Manager:
service-module# call-agent cucm!!!WARNING!!!: This operation willa. permanently delete all non-local site related configurationb. reboot the system automaticallyThis operation is not reversible.Do you wish to continue[n]? : yesRelated Commands
caller-flow caller-input
To specify the call flow for a specified caller input, use the caller-flow caller-input command in Cisco Unity Express mailbox configuration mode. Use the no or default form of this command to remove the configuration of the call flow.
caller-flow caller-input input {ignore | repeat-greeting | say-goodbye | skip-greeting | subscriber-signin | transfer-to E164Phone | transfer-operator}
no caller-flow caller-input input {ignore | repeat-greeting | say-goodbye | skip-greeting | subscriber-signin | transfer-to E164Phone | transfer-operator}
Syntax Description
Command Default
None.
Command Modes
Cisco Unity Express mailbox configuration (config-mailbox)
Command History
Usage Guidelines
This command replaces the zerooutnumber command in releases 7.1 and later.
Examples
The following example configures the call flow for a mailbox to forward a caller to 555-0200 if the caller dials 2:
se-10-0-0-0# config t
se-10-0-0-0(config)# voice mailbox owner user8se-10-0-0-0(config-mailbox)# caller-flow caller-input 2 transfer to 5550200
Related Commands
Enters mailbox configuration submode.
Shows the properties of the voice-mail system
calling-number-rule prepend-digits
To specify additional digits to dial before dialing the E.164 number derived from the calling number rule for the live-reply feature, use the calling-number-rule prepend-digits command in Cisco Unity Express network configuration mode. Use the no or default form of this command to remove the additional digits to dial before dialing the E.164 number.
calling-number-rule prepend-digits digits
no calling-number-rule prepend-digits digits
default calling-number-rule prepend-digits
Syntax Description
Command Default
No prepend-digit string is defined.
Command Modes
Cisco Unity Express network configuration
Command History
Usage Guidelines
Use the calling-number-rule prepend-digits command in Cisco Unity Express network configuration mode to add digits to dial before dialing the E.164 number derived from the calling number rule for a remote subscriber. This E.164 number is derived using the calling number rule defined by the voicemail live-reply calling-number-rule command.
For the local location, this command has no impact.
Use the no form of this command to set the default behavior.
Examples
The following example specifies that the additional digits 91 are dialed before dialing the calling number rule for the live-reply feature:
se-10-0-0-0# config tse-10-0-0-0(config)# calling-number-rule prepend-digits digits 91
Related Commands
Displays the configuration of the live-reply feature.
Displays information about the restriction table associated with the live-reply feature.
ccm-manager address
To configure the IP address or hostname of Cisco Unified Communications Manager servers, use the ccm-manager address command in Cisco Unity Express JTAPI configuration mode. To set a server address to 0.0.0.0, use the no form of this command.
ccm-manager address {primary-server-ip-address | primary-server-hostname} [[secondary-server-ip-address [tertiary-server-ip-address | tertiary-server-hostname] | secondary-server-hostname [tertiary-server-ip-address | tertiary-server-hostname]]
no ccm-manager address {server-ip-address | server-hostname}
Syntax Description
Command Modes
Cisco Unity Express JTAPI configuration
Command History
Usage Guidelines
Use the ccm-manager address command to specify a maximum of three Cisco Unified Communications Manager servers. Enter multiple IP addresses or hostnames on one command line or use separate command lines to enter each IP address or hostname.
The no form of the command sets the server's IP address to 0.0.0.0.
Examples
The following example configures the JTAPI subsystem with three Cisco Unified Communications Manager servers.
se-10-0-0-0# config tse-10-0-0-0(config)# ccn subsystem jtapise-10-0-0-0(config-jtapi)# ccm-manager address 10.100.10.120 10.110.10.120 10.120.10.120se-10-0-0-0(config-jtapi)# endse-10-0-0-0(config)#Related Commands
ccm-manager credentials
To specify the Cisco Unified Communications Manager JTAPI username and password in encrypted form, use the ccm-manager credentials command in Cisco Unity Express JTAPI configuration mode.
ccm-manager credentials hidden credentials
Syntax Description
Command Modes
Cisco Unity Express JTAPI configuration
Command History
Usage Guidelines
Use the ccm-manager credentials command to specify the Cisco Unified Communications Manager JTAPI username and password in encrypted form.
Examples
The following example configures the JTAPI subsystem with an encrypted username and password.
se-10-0-0-0# config tse-10-0-0-0(config)# ccn subsystem jtapise-10-0-0-0(config-jtapi)# ccm-manager credentials hidden +DuGhIBvqsghj6p6aBUoRQ4E0vzCD5YHSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35jwAAAA A=se-10-0-0-0(config-jtapi)# endse-10-0-0-0(config)#Related Commands
ccm-manager username
To specify the Cisco Unified Communications Manager JTAPI user, use the ccm-manager username command in Cisco Unity Express JTAPI configuration mode. To delete the JTAPI user, use the no form of this command.
ccm-manager username jtapi-user-id password jtapi-user-password
no ccm-manager username
Syntax Description
Command Modes
Cisco Unity Express JTAPI configuration
Command History
Usage Guidelines
Use the ccm-manager username command to specify the Cisco Unified Communications Manager JTAPI user.
The no form of the command removes the user ID and password.
Examples
The following example configures the JTAPI subsystem with the JTAPI user jtapiuser with password myjtapi.
se-10-0-0-0# config tse-10-0-0-0(config)# ccn subsystem jtapise-10-0-0-0(config-jtapi)# ccm-manager username jtapiuser password myjtapise-10-0-0-0(config-jtapi)# endse-10-0-0-0(config)#Related Commands
ccn application
To create a CCN application and to enter configuration application mode, use the ccn application command in Cisco Unity Express configuration mode. To delete the application, use the no form of this command.
ccn application full-name
no ccn application full-name
Syntax Description
Command Modes
Cisco Unity Express configuration
Command History
Usage Guidelines
This command specifies the name of the application to configure on the Cisco Unity Express module. The command switches to application configuration mode, which supports several configurable parameters.
Examples
This example creates the application autoattendant.
se-10-0-0-0# config tse-10-0-0-0(config)# ccn application autoattendantse-10-0-0-0(config-application)# endse-10-0-0-0(config)#Related Commands
Displays details for each configured application.
Displays configured script names and descriptions.
ccn call terminate
To terminate an active call, use the ccn call terminate command in Cisco Unity Express EXEC mode.
ccn call terminate {callimplid | portimplid} impli-id
Syntax Description
callimplid
Terminates a call. with a specified call implementation ID.
portimplid
Terminates a call from a specified port implementation ID.
impli-id
Implementation ID of the call to be terminated.
Command Modes
Cisco Unity Express EXEC
Command History
Usage Guidelines
Use this command to terminate active voice calls in the Cisco Unity Express system.
Use the show ccn call route command to display the implementation IDs of the calls.
Examples
The following examples terminate calls with call implementation ID 4085555010 and port implementation ID 1567/1:
se-10-0-0-0# ccn call terminate callimplid 4085555010se-10-0-0-0# ccn call terminate portimplid 1567/1Related Commands
ccn copy document-IVR Only
To copy a document from the Cisco Unity Express IVR system to a specific URL, use the ccn copy document command in Cisco Unity Express IVR user EXEC mode.
ccn copy document {tiff | template | generic} docname url url [language xx_YY] [username userid [password password]]
Syntax Description
Command Default
None
Command Modes
Cisco Unity Express IVR user EXEC
Command History
Usage Guidelines
If you specify a language in the command, only the document written in that language is copied. If you do not specify the language or if the language is not available, the document written in the default language setting is copied. If a username and a password are required to access the URL (typical of an FTP URL), you can specify the username and password within the command.
If a document of the specified type and the specified name already exists in the URL, you are prompted for permission to overwrite the existing document.
Examples
The following example copies a template text document, written in US English, from the Cisco Unity Express system to the specified URL:
se-10-0-0-0> ccn copy document template document.txt url http://localhost:8080/myhttpapp language en_US username James password psswdse-10-0-0-0>
Related Commands
ccn copy prompt
To copy customized prompt files from Cisco Unity Express to another location, use the ccn copy prompt command in Cisco Unity Express EXEC mode.
ccn copy prompt prompt-filename url ftp://destination-ip-address/prompt-filename [language xx_YY] [username name password password]
Syntax Description
prompt-filename
Name of the prompt file to be copied.
ftp://url destination-ip-address
Destination server where the prompt file will be stored.
language xx_YY
(Optional) Language of the prompt. See Release Notes for Cisco Unity Express for a list of supported languages.
username name
(Optional) Specifies the login name for the server. The default is "anonymous".
password password
(Optional) Specifies the login password.
Command Modes
Cisco Unity Express EXEC
Command History
1.1
This command was introduced.
1.1.2
This command was implemented on the Cisco 2800 series and Cisco 3800 series routers.
2.0
The language option was added.
Usage Guidelines
Using the language option copies the prompt in language xx_YY to the specified server. Otherwise, the system copies the prompt in the system default language to the server. The prompts must be previously recorded .wav files. Use the Administration via Telephone (AvT) to record the prompts from the telephone user interface (TUI).
Examples
The following example copies the French prompt file AAHello.wav to an FTP server:
se-10-0-0-0# ccn copy prompt AAHello.wav url ftp://172.16.10.0/AAHello.wav language fr_FRRelated Commands
ccn copy script
To copy customized script files from Cisco Unity Express to another location, use the ccn copy script command in Cisco Unity Express EXEC mode.
ccn copy script script-filename url ftp://destination-ip-address
Syntax Description
script-filename
Name of the script file to be copied.
url ftp://destination-ip-address
Destination URL where the prompt file will be stored.
Command Modes
Cisco Unity Express EXEC
Command History
Usage Guidelines
Use the ccn copy script command to store script files on a server. Use the Cisco Unity Express script editor program to create the scripts, which specify how the incoming auto attendant calls are handled. This includes what prompts the caller hears, when alternate prompts are played, which extensions should be dialed based on the caller's key presses, and other similar call handling characteristics.
Examples
The following example copies the script file AAnight.aef to an FTP server:
se-10-0-0-0# ccn copy script AAnight.aef url ftp://172.16.10.0/ScriptsRelated Commands
ccn copy url document-IVR Only
To copy a document from a specific URL to the Cisco Unity Express IVR system, use the ccn copy url command in Cisco Unity Express IVR user EXEC mode.
ccn copy url url document {tiff | template | generic} docname [language xx_YY] [username userid [password password]]
Syntax Description
Command Default
None
Command Modes
Cisco Unity Express IVR user EXEC
Command History
Usage Guidelines
If the document type is Tagged Image File Format (TIFF), the document to be copied must have a .tif or a .tiff file extension. The document is checked to ensure that it is a properly formatted .tiff image.
Note
If you specify a language in the command syntax, only the document written in that language is copied. If you do not specify the language or if the language is not available, the document written in the default language setting is copied.
If a username and a password are required to access the URL, you can specify the username and password within the command.
If a document of the specified type and having the specified name already exists in the system, you are prompted for permission to overwrite the existing document.
Examples
The following example copies a document, written in US English, from the specified URL to the Cisco Unity Express system:
se-10-0-0-0> ccn copy url http://localhost:8080/myhttpapp document template document.txt language en_US username James password psswdse-10-0-0-0>
Related Commands
ccn copy url prompt
To copy customized script or prompt files to Cisco Unity Express from another location, use the ccn copy url command in Cisco Unity Express EXEC mode.
Prompt File
ccn copy url ftp://source-ip-address/prompt-filename.wav prompt prompt-filename.wav [language language] [username username password password]
Script File
ccn copy url ftp://source-ip-address/script-filename.aef script script-filename.aef [username username password password]
Syntax Description
ftp://source-ip-address
Url of the server where the file is stored.
prompt prompt-filename
Name of the prompt file to be copied.
script script-filename
Name of the script file to be copied.
language language
(Optional) Language of the prompt. See Release Notes for Cisco Unity Express for a list of supported languages.
username username
(Optional) Specifies the login name for the server. The default is "anonymous".
password password
(Optional) Specifies the login password.
Command Modes
Cisco Unity Express EXEC
Command History
1.1
This command was introduced.
1.1.2
This command was implemented on the Cisco 2800 series and Cisco 3800 series routers.
2.0
The language option was added.
Usage Guidelines
Use the ccn copy url command to retrieve prompt and script files from a server.
Examples
The following example copies the script file MyScript.aef from an FTP server:
se-10-0-0-0# ccn copy url ftp://172.168.10.0/MyScript.aef script MyScript.aefRelated Commands
ccn delete prompt
To delete a prompt or script from the Cisco Unity Express module, use the ccn delete command in Cisco Unity Express EXEC mode.
ccn delete {prompt prompt-filename [language xx_YY] | script script-filename}
Syntax Description
prompt prompt-filename
Name of the prompt file.
language xx_YY
(Optional) Language of the prompt. See Release Notes for Cisco Unity Express for a list of supported languages.
script script-filename
Name of the script file.
Command Modes
Cisco Unity Express EXEC
Command History
Usage Guidelines
Use this command to delete auto-attendant .wav greeting prompts or an application .aef script file. Use the show ccn prompts or show ccn scripts command to display configured prompts and scripts before deleting one.
Use the language option to delete a prompt from that language. Otherwise, the system deletes the prompt from the system default language.
Examples
The following example deletes the script vm.aef:
se-10-0-0-0# ccn delete script vm.aefThe following example deletes the French welcome prompt AAHello.wav:
se-10-0-0-0# ccn delete prompt AAHello.wav language fr_FRRelated Commands
Configures an application.
Copies prompt files from Cisco Unity Express to another location.
Displays configured CCN prompt files.
Displays configured CCN script files.
ccn delete document-IVR Only
To delete an existing document from the Cisco Unity Express IVR system, use the ccn delete document command in Cisco Unity Express IVR user EXEC mode.
ccn delete document {generic | template | tiff} docname [language xx_YY]
Syntax Description
Command Default
None
Command Modes
Cisco Unity Express IVR user EXEC
Command History
Usage Guidelines
You can specify the language option in the command to further identify the document to be deleted. If you do not specify the language, the document written in the default language is deleted. A prompt asks you to confirm the deletion.
If a document of the specified type and having the specified name does not exist, an error message is generated and the deletion aborts.
Examples
The following example deletes an existing document from the Cisco Unity Express IVR system:
se-10-0-0-0> ccn delete document template document.txt language en_USse-10-0-0-0>
Related Commands
After deleting the Cisco Unity Express IVR document, use the show ccn document command output to confirm that the document is deleted.
ccn engine
To configure the features shared by all the Cisco Unity Express subsystems and to enter configuration engine mode, use the ccn engine command in Cisco Unity Express configuration mode.
ccn engine
Syntax Description
This command has no options or keywords.
Command Modes
Cisco Unity Express configuration
Command History
Examples
The following example enters configuration engine mode:
se-10-0-0-0> enablese-10-0-0-0# config tse-10-0-0-0(config)# ccn enginese-10-0-0-0(config-engine)# end
se-10-0-0-0(config)#Related Commands
Configures an application.
Configures the subsystems on Cisco Unity Express.
Configures the triggers for handling calls to Cisco Unity Express.
Displays the CCN engine statistics.
ccn rename prompt
To rename an auto-attendant prompt file, use the ccn rename prompt command in Cisco Unity Express EXEC mode.
ccn rename prompt old-name new-name
Syntax Description
Command Modes
Cisco Unity Express EXEC
Command History
Examples
The following example renames the prompt myprompt.wav to mynewprompt.wav:
se-10-0-0-0# ccn rename prompt myprompt.wav mynewprompt.wav
Related Commands
ccn reporting historical
To enter Cisco Unity Express IVR reporting historical configuration mode, use the ccn reporting historical command in global configuration mode.
ccn reporting historical
Syntax Description
This command has no arguments or keywords.
Command Default
None
Command Modes
Global configuration
Command History
Usage Guidelines
Use the Cisco Unity Express IVR reporting historical database set of commands to configure new or to modify existing historical reporting database configurations.
After successfully performing the ccn reporting historical command, the system enters the config-hrdm command mode, in which you can configure parameters of the reporting historical database.
Examples
The following example sets reporting historical configuration mode:
se-10-0-0-0# config t
se-10-0-0-0(config)# ccn reporting historicalse-10-0-0-0(config-hrdm)# endse-10-0-0-0(config)# exit
Related Commands
Displays the Cisco Unity Express IVR reporting historical configuration settings.
ccn subsystem edbs dbprofile-IVR Only
To enter Cisco Unity Express IVR enterprise database subsystem (EDBS) profile configuration mode, use the ccn subsystem edbs dbprofile command in global configuration mode. If an enterprise database profile already exists, use this command to modify the existing database profile parameters. To delete a profile name, use the no form of this command.
ccn subsystem edbs dbprofile dbprofilename
no ccn subsystem edbs dbprofile dbprofilename
Syntax Description
Command Default
No database profile is configured.
Command Modes
Global configuration
Command History
Usage Guidelines
After successfully performing the ccn subsystem edbs dbprofile command, the system enters EDBS profile command mode config-dbprof, in which you can configure parameters of the database profile. The database profile name must be a string variable without spaces or special characters.
If the database profile already exists, the following message displays on the console terminal before you enter the database profile command mode:
Modifying existing Database profileIf you are configuring a new database profile, the following message displays:
Adding new Database profileExamples
The following example creates a new Cisco Unity Express IVR enterprise database profile:
se-10-0-0-0# config t
se-10-0-0-0(config)# ccn subsystem edbs dbprofile mydbprofileAdding new Database profilese-10-0-0-0(config-business)# end
se-10-0-0-0(config)# exit
Related Commands
ccn subsystem email-IVR Only
To configure the Cisco Unity Express IVR e-mail subsystem, use the ccn subsystem email command in global configuration mode.
ccn subsystem email
Syntax Description
This command has no arguments or keywords.
Command Default
There is no default value.
Command Modes
Global configuration
Command History
Usage Guidelines
The Cisco Unity Express IVR e-mail command is used to configure the e-mail default-from e-mail address.
After successfully performing this command, the system enters the config-email command mode, in which you can configure parameters of the IVR e-mail features.
Examples
The following example sets the e-mail default-from e-mail address:
se-10-0-0-0# config t
se-10-0-0-0(config)# ccn subsystem emailse-10-0-0-0(config-email)# default-from localhost@localdomain.comse-10-0-0-0(config-email)# endse-10-0-0-0(config)# exit
Related Commands
ccn subsystem fax-IVR Only
To enter Cisco Unity Express IVR fax configuration mode, use the ccn subsystem fax command in global configuration mode
ccn subsystem fax
Syntax Description
This command has no arguments or keywords.
Command Default
None
Command Modes
Global configuration
Command History
Usage Guidelines
The Cisco Unity Express IVR fax set of commands is used to configure the Cisco Unity Express IVR fax default-from e-mail address.
After successfully completing the ccn subsystem fax command, the system enters the config-fax command mode, in which you can configure parameters of the Cisco Unity Express IVR fax features.
Examples
The following example sets a fax default-from e-mail address:
se-10-0-0-0# config t
se-10-0-0-0(config)# ccn subsystem faxse-10-0-0-0(config-fax)# default-from name@domain.comse-10-0-0-0(config-fax)# endse-10-0-0-0(config)# exit
Related Commands
ccn subsystem jtapi
To enter the Java Telephony Application Programming Interface (JTAPI) configuration mode, use the ccn subsystem jtapi command in Cisco Unity Express configuration mode. This command does not have a no form.
ccn subsystem jtapi
Syntax Description
This command has no arguments or keywords.
Command Modes
Cisco Unity Express configuration
Command History
Examples
The following example enters JTAPI configuration mode:
se-10-0-0-0(config)# ccn subsystem jtapise-10-0-0-0(config-jtapi)# endse-10-0-0-0(config)#Related Commands
ccn subsystem sip
To enter Session Initiation Protocol (SIP) configuration mode, use the ccn subsystem sip command in Cisco Unity Express configuration mode. This command does not have a no form.
ccn subsystem sip
Syntax Description
This command has no arguments or keywords.
Command Modes
Cisco Unity Express configuration
Command History
Examples
The following example enters SIP configuration mode:
se-10-0-0-0> enablese-10-0-0-0# config tse-10-0-0-0(config)# ccn subsystem sipse-10-0-0-0(config-sip)# endse-10-0-0-0(config)#Related Commands
ccn trigger http-IVR Only
To configure a Cisco Unity Express IVR HTTP-based trigger, use the ccn trigger http command in global configuration mode.
An HTTP-based trigger consists of a URL suffix string and an application name, which is added to the URL later by using the application command. An HTTP request starts the HTTP subsystem application and passes HTTP request information to the application.
To delete a URL suffix string, use the no form of this command.
ccn trigger http urlname mwiapp
no ccn trigger http urlname mwiapp
Syntax Description
urlname
HTTP trigger URL.
mwiapp
The Cisco Unity Express IVR HTTP-based trigger syntax form of the URL name.
Command Default
No HTTP-based trigger is configured.
Command Modes
Global configuration
Command History
Usage Guidelines
After successfully performing the ccn trigger http urlname command, the system enters HTTP trigger command mode config-trigger, in which you can configure parameters of the HTTP-based trigger. If an HTTP-based trigger already exists, use this command to modify the existing HTTP-based trigger parameters.
The HTTP trigger request can have additional parameters that are passed to the application that is to be started. Before starting the application, the HTTP subsystem ensures that the maximum number of sessions for the trigger and the application have not been reached or exceeded. The maximum number of sessions for an HTTP-triggered URL and its corresponding application is limited by the number of allowable licensed Cisco Unity Express IVR sessions.
If more requests are received than are allowed, the subsystem rejects the requests and sends an HTTP 503 response for each request. If an HTTP request is received and no trigger is configured for the request suffix, the subsystem sends an HTTP 404 response.
The HTTP trigger name must be a string variable without spaces or special characters, as shown in the following example:
se-10-0-0-0(config)# ccn trigger http urlname mwiappAdding new triggerse-10-0-0-0(config-trigger)#If you add a new HTTP trigger, the following message displays:
Adding new triggerIf the HTTP trigger already exists, the following message displays:
Modifying existing triggerExamples
The following example configures the HTTP-based trigger URL parameter for the localhost hostname and the myhttpapp application name:
se-10-0-0-0# config t
se-10-0-0-0(config)# ccn trigger http urlname mwiapp
Adding new triggerse-10-0-0-0(config-trigger)# end
se-10-0-0-0(config)# exit
Related Commands
Displays the trigger and application settings. Use the show ccn trigger http command option to display the Cisco Unity Express IVR HTTP-based trigger settings.
ccn trigger jtapi phonenumber
To configure the triggers that activate Cisco Unity Express JTAPI application functions and to enter trigger configuration mode, use the ccn trigger jtapi phonenumber command in Cisco Unity Express configuration mode. To delete the trigger, use the no form of this command.
ccn trigger jtapi phonenumber number
no ccn trigger jtapi phonenumber number
Syntax Description
Command Modes
Cisco Unity Express configuration
Command History
Usage Guidelines
The number value should be the last four digits of the full telephone number that callers dial to reach the auto attendant.
Beginning with Cisco Unity Express 8.0, you can configure a trigger to specify a number pattern instead of a single number. Incoming calls targeted to a number that matches the pattern cause the associated script to be invoked. The script determines which number was dialed by inspecting the called number attribute associated with the call. Cisco Unity Express supports a limit of 32 characters in the trigger pattern. Wildcard patterns are supported for both SIP and JTAPI triggers.
Wildcard patterns are based on Cisco Unified Communications Manager route patterns. The rules for choosing between multiple wildcard patterns matching an incoming call are similar to those used by Cisco Unified Communications Manager. For each pattern that is a candidate match for the dial string, Cisco Unity Express calculates the number of other dial strings of the same length as the input dial string that would match each pattern, and then selects the pattern that has the fewest alternative dial string matches.
Table 3 shows the trigger pattern wildcards and special characters supported beginning in Cisco Unity Express 8.0.
Examples
The following example enters configuration mode for the trigger 7800.
se-10-0-0-0# config tse-10-0-0-0(config)# ccn trigger jtapi phonenumber 7800se-10-0-0-0(config-trigger)# endse-10-0-0-0(config)#The following example enters configuration mode and creates a trigger using the pattern wildcard "88[0-6]!".
se-10-0-0-0# config tse-10-0-0-0(config)# ccn trigger jtapi phonenumber 88[0-6]!se-10-0-0-0(config-trigger)# endse-10-0-0-0(config)#Related Commands
ccn trigger sip phonenumber
To configure the triggers that activate Cisco Unity Express SIP application functions and to enter trigger configuration mode, use the ccn trigger sip phonenumber command in Cisco Unity Express configuration mode. To delete the trigger, use the no form of this command.
ccn trigger sip phonenumber number
Syntax Description
Command Modes
Cisco Unity Express configuration
Command History
Usage Guidelines
An application may have several triggers that invoke it, but a trigger must be associated with only one application.
Beginning with Cisco Unity Express 8.0, you can configure a trigger to specify a number pattern instead of a single number. Incoming calls targeted to a number that matches the pattern cause the associated script to be invoked. The script determines which number was dialed by inspecting the called number attribute associated with the call. Cisco Unity Express supports a limit of 32 characters in the trigger pattern. Wildcard patterns are supported for both SIP and JTAPI triggers.
Wildcard patterns are based on Cisco Unified Communications Manager route patterns. The rules for choosing between multiple wildcard patterns matching an incoming call are similar to those used by Cisco Unified Communications Manager. For each pattern that is a candidate match for the dial string, Cisco Unity Express calculates the number of other dial strings of the same length as the input dial string that would match each pattern, and then selects the pattern that has the fewest alternative dial string matches.
Table 3 shows the trigger pattern wildcards and special characters supported beginning in Cisco Unity Express 8.0.
Examples
The following example enters configuration mode for the trigger 7800.
se-10-0-0-0# config tse-10-0-0-0(config)# ccn trigger sip phonenumber 7800se-10-0-0-0(config-trigger)# endse-10-0-0-0(config)#The following example enters configuration mode and creates a trigger using the pattern wildcard "88[0-6]!".
se-10-0-0-0# config tse-10-0-0-0(config)# ccn trigger sip phonenumber 88[0-6]!se-10-0-0-0(config-trigger)# endse-10-0-0-0(config)#Related Commands
clock timezone
To set the time zone for the Cisco Unity Express system, use the clock timezone command in Cisco Unity Express configuration mode.
clock timezone [time-zone]
Syntax Description
Command Modes
Cisco Unity Express configuration
Command History
Usage Guidelines
Cisco Unity Express gets the time from the configured NTP server to date-stamp system and application functions. The clock timezone command specifies the local time zone where Cisco Unity Express is installed.
If you know the phrase for the time-zone, enter it for the time-zone value. If you do not know the time zone phrase, leave the time-zone value blank and a series of menus appear to guide you through the time zone selection process.
Examples
The following example shows how United States Pacific Time is selected using the timezone menu:
se-10-0-0-0# config tse-10-0-0-0(config)# clock timezonePlease 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 Ocean2) Americas 5) Asia 8) Europe3) Antarctica 6) Atlantic Ocean 9) Indian Ocean#? 2Please select a country.1) Anguilla 18) Ecuador 35) Paraguay2) Antigua & Barbuda 19) El Salvador 36) Peru3) Argentina 20) French Guiana 37) Puerto Rico4) Aruba 21) Greenland 38) St Kitts & Nevis5) Bahamas 22) Grenada 39) St Lucia6) Barbados 23) Guadeloupe 40) St Pierre & Miquelon7) Belize 24) Guatemala 41) St Vincent8) Bolivia 25) Guyana 42) Suriname9) Brazil 26) Haiti 43) Trinidad & Tobago10) Canada 27) Honduras 44) Turks & Caicos Is11) Cayman Islands 28) Jamaica 45) United States12) Chile 29) Martinique 46) Uruguay13) Colombia 30) Mexico 47) Venezuela14) Costa Rica 31) Montserrat 48) Virgin Islands (UK)15) Cuba 32) Netherlands Antilles 49) Virgin Islands (US)16) Dominica 33) Nicaragua17) Dominican Republic 34) Panama#? 45Please select one of the following time zone regions.1) Eastern Time2) Eastern Time - Michigan - most locations3) Eastern Time - Kentucky - Louisville area4) Eastern Standard Time - Indiana - most locations5) Central Time6) Central Time - Michigan - Wisconsin border7) Mountain Time8) Mountain Time - south Idaho & east Oregon9) Mountain Time - Navajo10) Mountain Standard Time - Arizona11) Pacific Time12) Alaska Time13) Alaska Time - Alaska panhandle14) Alaska Time - Alaska panhandle neck15) Alaska Time - west Alaska16) Aleutian Islands17) Hawaii#? 11The following information has been given:United StatesPacific TimeTherefore TZ='America/Los_Angeles' will be used.Local time is now: Fri Dec 24 10:41:28 PST 2004.Universal Time is now: Fri Dec 24 18:41:28 UTC 2004.Is the above information OK?1) Yes2) No#? 1se-10-0-0(config)#The following example shows how United States Pacific Time is selected using the timezone name:
se-10-0-0-0# config tse-10-0-0-0(config)# clock timezone Americas/Los_AngelesRelated Commands
closed day
To specify the hours when a business is closed, use the closed day command in Cisco Unity Express business configuration mode. To change a closed time to an open time, use the no form of this command.
closed day day-of-week from hh:mm to hh:mm
no closed day day-of-week from hh:mm to hh:mm
Syntax Description
Defaults
Default business hours are open 24 hours each day, 7 days per week.
Command Modes
Cisco Unity Express business configuration
Command History
Usage Guidelines
Each day is divided into half-hour time slots. By default, all the time slots are open. The closed day command changes an open time slot to a closed time slot.
The closed day command gives the same results as the no open day command.
Examples
The following example creates a business-hours schedule called normal:
se-10-0-0-0# config t
se-10-0-0-0(config)# calendar biz-schedule normal
Adding new schedule
se-10-0-0-0(config-business)# closed day 1 from 00:00 to 24:00
se-10-0-0-0(config-business)# closed day 2 from 00:00 to 08:30
se-10-0-0-0(config-business)# closed day 2 from 17:30 to 24:00
se-10-0-0-0(config-business)# closed day 3 from 00:00 to 08:30
se-10-0-0-0(config-business)# closed day 3 from 17:30 to 24:00
se-10-0-0-0(config-business)# closed day 4 from 00:00 to 08:30
se-10-0-0-0(config-business)# closed day 4 from 17:30 to 24:00
se-10-0-0-0(config-business)# closed day 5 from 00:00 to 08:30
se-10-0-0-0(config-business)# closed day 5 from 20:00 to 24:00
se-10-0-0-0(config-business)# closed day 6 from 00:00 to 08:30
se-10-0-0-0(config-business)# closed day 6 from 18:00 to 24:00
se-10-0-0-0(config-business)# closed day 7 from 00:00 to 09:00
se-10-0-0-0(config-business)# closed day 7 from 13:00 to 24:00
se-10-0-0-0(config-business)# end
se-10-0-0-0(config)# exit
The following example modifies the existing normal business schedule:
se-10-0-0-0(config)# calendar biz-schedule normal
Modifying existing schedule
se-10-0-0-0(config-business)# no closed day 1 from 09:00 to 12:00
se-10-0-0-0(config-business)# end
se-10-0-0-0(config)# exit
Using the command open day 1 from 09:00 to 12:00 gives the same result as the no closed day command above.
Related Commands
Creates a business-hours schedule.
Specifies the times when a business is open.
Displays the business-hours schedules configured on the local system.
commands (kron schedule)
To enter the interactive mode to create the command block for a kron job, use the commands command in kron-schedule configuration mode. To remove the delimiter for the command block, use the no form of this command.
commands delimiter
no commands
delimiter
Specifies the symbol delimiter to be used to delimit the command names in the command block created for the kron job.
Defaults
No defaults.
Command Modes
Cisco Unity Express kron-schedule configuration
Command History
Usage Guidelines
You can schedule the execution of a block of CLI commands. Blocks of commands are entered interactively, using a symbol delimiter character to start and stop the execution. The execution of the block of commands begins in EXEC mode, but mode-changing commands are allowed in the command block.
The following limitations apply in Cisco Unity Express 8.0:
•
•
For example, if the delimiter character entered with the commands command is "#", you cannot use that symbol in the commands in the command block.
•
•
•
Caution
Examples
The following example enters the interactive command mode to enter a command block for a kron job using the percent character "%" as the delimiter:
se-10-0-0-0(kron-schedule)# commands % Enter CLI commands to be executed. End with the character '%'. Maximum text size is 1024 characters, it may not contain symbols '%' or ',' show ver sh run conf t hostname aaa % se-10-0-0-0(kron-schedule)#Related Commands
config-commands (aaa accounting event)
To enable or disable the logging of configuration mode commands, use the config-commands command in Cisco Unity Express AAA accounting event configuration mode. Use the no form of this command to disable the logging of configuration mode commands. Use the default form of this command to restore the default setting (the logging of configuration mode commands is enabled).
config-commands
no config-commands
default config-commands
Syntax Description
This command has no arguments or keywords.
Command Default
The logging of configuration mode commands is enabled.
Command Modes
Cisco Unity Express AAA accounting event configuration (aaa-accounting-event)
Command History
Usage Guidelines
This command enables the logging of any changes made to the Cisco Unity Express configuration using any interface except IMAP (CLI, GUI, TUI, and VVE).
Examples
The following example disables the logging of configuration mode commands:
se-10-0-0-0# config t
se-10-0-0-0(config)# aaa accounting event
se-10-0-0-0(aaa-accounting-event)# no config-commandsRelated Commands
continue
To return the Cisco Unity Express system to online mode, use the continue command in Cisco Unity Express offline mode.
continue
Syntax Description
This command has no arguments or keywords.
Command Modes
Cisco Unity Express offline
Command History
Usage Guidelines
This command returns the Cisco Unity Express system to the previous online mode, such as after a backup procedure or to discontinue a restore to factory defaults. The system begins processing new calls and voice messages.
Examples
The following example illustrates the use of the continue command in the backup procedure:
se-10-0-0-0# offline!!!WARNING!!!: Putting the system offline will terminate all active calls.Do you wish to continue[n]? : yse-10-0-0-0(offline)# backup category datase-10-0-0-0(offline)# continuese-10-0-0-0#Related Commands
copy ftp
To copy a new configuration from an FTP server to another Cisco Unity Express location, use the copy ftp command in Cisco Unity Express EXEC mode.
copy ftp: {nvram:startup-config | running-config | startup-config | system:running-config}
Syntax Description
Command Modes
Cisco Unity Express EXEC
Command History
Usage Guidelines
When you copy from the FTP server, the copy ftp command becomes interactive and prompts you for the necessary information.
You may add a username and password to the server IP address if your server is not configured to accept anonymous FTP input. The format would be: userid:password@ftp-server-address/directory.
If you do not specify a directory value, the software uses the default FTP directory.
Examples
The following example shows copying the configuration file named start from the FTP server in the default directory to the startup configuration in NVRAM:
se-10-0-0-0# copy ftp: nvram:startup-configAddress or name or remote host? admin:voice@10.3.61.16Source filename? startIn the following example, the file named start in the FTP server configs directory is copied to the startup configuration:
se-10-0-0-0# copy ftp: startup-config!!!WARNING!!! This operation will overwrite your startup configuration.Do you wish to continue[y]? yAddress or name or remote host? admin:voice@10.3.61.16/configsSource filename? startRelated Commands
copy hrdb url-IVR Only
Use the copy hrdb url command to export ASCII comma separated values of the reporting historical database on the Cisco Unity Express IVR module to an external database in Cisco Unity Express privileged EXEC mode.
You can export reporting historical call contact detailed records (CCDRs) to an external server from the Cisco Unity Express IVR module for post-processing.
Note
copy hrdb url url
Syntax Description
url
URL of external database to which the Cisco Unity Express IVR module copies and uploads the historical reporting data in ASCII comma-separated value format.
Defaults
No default values are configured.
Command Modes
Cisco Unity Express IVR privileged EXEC
Command History
Usage Guidelines
To view the CCDR comma-separated value sequence and definitions, see the Cisco Unity Express Interactive Voice Response CLI Administrator Guide.
Examples
The following example shows output from the copy hrdb url command as the files are copied from the Cisco Unity Express IVR module and sent to a server for processing:
se-10-0-0-0# copy hrdb url ftp://10.0.0.1/hr.txt
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 3584k 0 0 0 3584k 0 1259k --:--:-- 0:00:02 --:--:-- 1794k
se-10-0-0-0#
Related Commands
copy ldap
To copy the current LDAP information, stored in the CUE database, to an FTP server, use the copy ldap command in Cisco Unity Express EXEC mode.
copy ldap url ftp://[user-id:ftp-password@]ftp-server-address[/directory]/filename
Syntax Description
Command Modes
Cisco Unity Express EXEC
Command History
Usage Guidelines
If you do not specify a directory value, the software uses the default FTP directory.
Examples
The following example shows copying the LDAP data to the default directory on the FTP server and saving the data in the file ldapinfo.
se-10-0-0-0# copy ldap url ftp://admin:cue@10.10.67.163/ldapinfose-10-0-0-0#Related Commands
Copies the running configuration to another location.
Copies the startup configuration to another location.
copy log
To copy the current logging information stored in the CUE database to an FTP server, use the copy log command in Cisco Unity Express EXEC mode.
copy log {install.log | dmesg | syslog.log | atrace.log | klog.log | debug_server.log | messages.log} url ftp://[user-id:ftp-password@]ftp-server-address[/directory]/filename
Syntax Description
Command Modes
Cisco Unity Express EXEC
Command History
Usage Guidelines
If you do not specify a directory value, the software uses the default FTP directory.
Examples
The following example shows copying the install log data to the default directory on the FTP server and saving the data in the file installinfo.
se-10-0-0-0# copy log install.log url ftp://admin:cue@10.10.67.163/lnstallinfose-10-0-0-0#Related Commands
copy running-config
To copy the running configuration to another destination, use the copy running-config command in Cisco Unity Express EXEC mode.
copy running-config {ftp: | nvram:startup-config filename | startup-config | tftp:}
Syntax Description
Command Modes
Cisco Unity Express EXEC
Command History
Usage Guidelines
When you copy to an FTP or TFTP server, the copy running-config command becomes interactive and prompts you for the necessary information. You may add a username and password to the server IP address if your server is not configured to accept anonymous FTP input. The format would be: userid:password@ftp-server-address/directory. If you do not specify a directory value, the software uses the default FTP directory.
Examples
In the following example, the running configuration is copied to the FTP server, which requires a user ID and password and has an IP address of 172.16.231.193. The running configuration is copied to the configs directory as file saved_start.se-10-0-0-0# copy running-config ftp:Address or name of remote host? admin:voice@172.16.231.193/configsSource filename? saved_startThe following example shows the running configuration copied to the NVRAM saved configuration as filename startup:
se-10-0-0-0# copy running-config nvram:startup-config startupThe following example shows the running configuration copied to the startup configuration as filename start:
se-10-0-0-0# copy running-config startup-config startThe following example shows the running configuration copied to the TFTP server as filename temp_start:
se-10-0-0-0# copy running-config tftp:Address or name of remote host? 172.16.231.190Source filename? temp_startRelated Commands
copy startup-config
To copy the startup configuration to another destination, use the copy startup-config command in Cisco Unity Express EXEC mode.
copy startup-config {ftp: | tftp:}
Syntax Description
Command Modes
Cisco Unity Express EXEC
Command History
Usage Guidelines
When you copy to an FTP or TFTP server, the copy startup-config command becomes interactive and prompts you for the necessary information. You may add a username and password to the server IP address if your server is not configured to accept anonymous FTP input. The format would be: userid:password@ftp-server-address/directory. If you do not specify a directory value, the software uses the default FTP directory.
Examples
In the following example, the startup configuration is copied to the FTP server, which requires a user ID and password and has an IP address of 172.16.231.193. The startup configuration is copied to the configs directory as file saved_start.se-10-0-0-0# copy startup-config ftp:Address or name of remote host? admin:voice@172.16.231.193/configsSource filename? saved_startThe following example shows the startup configuration being copied to the TFTP server as filename temp_start:
se-10-0-0-0# copy startup-config tftp:Address or name of remote host? 172.16.231.190Source filename? temp_startRelated Commands
copy tftp
To copy the network TFTP server information to another destination, use the copy tftp command in Cisco Unity Express EXEC mode.
copy tftp: {nvram:startup-config | running-config | startup-config | system:running-config}
Syntax Description
Command Modes
Cisco Unity Express EXEC
Command History
Usage Guidelines
The copy tftp command is an interactive command and prompts you for the necessary information. You may add a username and password to the server IP address if your server is not configured to accept anonymous TFTP input. The format would be: userid:password@ftp-server-address/directory. If you do not specify a directory value, the software uses the default TFTP directory.
Copying a startup configuration from the TFTP server to the startup configuration overwrites the startup configuration. Cisco Unity Express displays a warning that asks you to confirm the overwrite.
Examples
The following example shows a TFTP server with the IP address 10.3.61.16. The TFTP server data in the source filename start is copied to the running configuration.
se-10-0-0-0# copy tftp: running-configAddress or name of remote host? 10.3.61.16Source filename? startIn the following example, the TFTP server has the IP address 10.3.61.16. The file start in directory configs on the TFTP server is copied to the startup configuration.
se-10-0-0-0# copy tftp: startup-config!!!WARNING!!! This operation will overwrite your startup configuration.Do you wish to continue[y]? yAddress or name of remote host? 10.3.61.16/configsSource filename? startRelated Commands
copy url
To copy a default configuration file from a specified server, use the cop-y url command in Cisco Unity Express EXEC mode. Use the no or default form of this command to remove the configuration of the call flow.
copy url ftps://server/filename default-config
no copy url ftps://server/filename default-config
Syntax Description
server
Specifies the DNS name or IP address of the server where the default configuration file is located.
filename
Specifies the name of the default configuration file.
Command Default
None.
Command Modes
Cisco Unity Express EXEC
Command History
Usage Guidelines
This command is used in conjunction with the restore factory-default command.
Examples
The following example copies a default configuration file call default.cfg to the system from a server called server4:
se-10-0-0-0# copy url ftps://server4/deafault.cfg
Related Commands
credentials (ccn subsystem edbs dbprofile)-IVR Only
To specify the username and password in encrypted form for the Cisco Unity Express IVR enterprise database subsystem (EDBS) profile, use the credentials command in Cisco Unity Express IVR EDBS profile configuration mode. To delete the encrypted form of the username and password, use the no form of this command.
credentials hidden credential-string
no credentials hidden credential-string
Syntax Description
Command Default
None
Command Modes
Cisco Unity Express IVR EDBS profile configuration
Command History
Usage Guidelines
After the ccn subsystem edbs dbprofile command is successfully performed, use the credentials hidden credential-string command to specify the credential information in encrypted form for this database connection.
Examples
The following example configures the Cisco Unity Express IVR subsystem with an encrypted username and password:
se-10-0-0-0# config tse-10-0-0-0(config)# ccn subsystem edbs dbprofile mydbprofileAdding new Database profilese-10-0-0-0(config-dbprof)# credentials hidden James_dbpasswdse-10-0-0-0(config-dbprof)# endse-10-0-0-0(config)# exitRelated Commands
crypto key default
To set a certificate and private key pair as the system default, use the crypto key default command in Cisco Unity Express configuration mode. To remove the system default designation from the certificate-key pair, use the no form of this command.
crypto key label label-name default
no crypto key label label-name default
Syntax Description
Defaults
This command has no defaults.
Command Modes
Cisco Unity Express configuration
Command History
Usage Guidelines
Setting the certificate-key pair allows applications such as integrated messaging to use the default certificate for SSL security without knowing the specific label name of the pair.
If several certificate-key pairs exist on the system and none of them are the system default, use this command to designate one of them as the system default.
To change the designation from one pair to another, remove the designation from the original pair using the no form of this command. Then assign the designation to the new pair.
The no form of this command does not delete the certificate or private key. The pair remains on the system but is no longer designated as the system default pair.
The system displays an error message if either of the certificate-key pairs does not exist.Examples
The following example designates the certificate-private key pair with the label mainkey.ourcompany as the system default.
se-10-0-0-0# config tse-10-0-0-0(config)# crypto key label mainkey.ourcompany defaultse-10-0-0-0(config)#The following example changes the system default designation from certificate-key pair alphakey.myoffice to betakey.myoffice:
se-10-0-0-0# config tse-10-0-0-0(config)# no crypto key label alphakey.myoffice defaultse-10-0-0-0(config)# crypto key label betakey.myoffice defaultse-10-0-0-0(config)# endRelated Commands
crypto key delete
To delete a certificate and private key pair from the system, use the crypto key delete command in Cisco Unity Express configuration mode. This command does not have a no or default form.
crypto key delete {all | label label-name}
Syntax Description
all
Deletes all certificate-private key pairs on the system.
label label-name
Deletes the specified certificate-private key pair.
Defaults
This command has no defaults.
Command Modes
Cisco Unity Express configuration
Command History
Usage Guidelines
An error message appears if the specified certificate-private key pair does not exist.
Examples
The following example deletes the certificate and private key with the name mainkey.ourcompany.
se-10-0-0-0# config tse-10-0-0-0(config)# crypto key delete label mainkey.ourcompanyse-10-0-0-0(config)#Related Commands
crypto key generate
To generate a self-signed certificate and private key, use the crypto key generate command in Cisco Unity Express configuration mode. This command does not have a no or default form.
crypto key generate [rsa {label label-name | modulus modulus-size} | default]
Syntax Description
Defaults
The default encryption algorithm is ras.
The default label has the form hostname.domainname.Command Modes
Cisco Unity Express configuration
Command History
Usage Guidelines
Integrated messaging requires a certificate and private key before SSL connections can be enabled. A certificate-key pair must be set as the system default. The system generates an error message if IMAP security mode is set to SSL or mixed before the certificate-key pair is set.
If you do not select any keywords or do not specify a label, the system automatically generates a certificate-key pair with a name in the format hostname.domainname.
Cisco Unity Express 2.3 supports only the rsa encryption algorithm.
Use the crypto key generate command or the crypto key label default command to set a certificate-key pair as the system default.
Examples
The following example generates a certificate and private key with the name mainkey.ourcompany, size 750, and assigns the generated pair as the system default.
se-10-0-0-0# config tse-10-0-0-0(config)# crypto key generate label mainkey.ourcompany modulus 728 defaultse-10-0-0-0(config)#Related Commands
crypto key import
To import a certificate and private key from a console or remote server, use the crypto key import command in Cisco Unity Express configuration mode. This command does not have a no or default form. To delete a certificate and private key, use the crypto key delete command.
crypto key import rsa label label-name {der | pem {terminal | url {ftp: | http:}} [default]
Syntax Description
Defaults
This command has no defaults.
Command Modes
Cisco Unity Express configuration
Command History
Usage Guidelines
The system displays an error message if the certificate-key pair does not exist.
If you import an incorrect certificate-key pair, delete the pair with the crypto key delete command and import the correct one.
Examples
The following example imports a certificate and private key from the console.
Ise-10-0-0-0# config tse-10-0-0-0(config)# crypto key import rsa label newkey.ourcompany der terminalEnter certificate...End with a blank line or "quit" on a line by itselfEnter private key...Private key passphrase?End with a blank line or "quit" on a line by itselfquitImport succeeded.Related Commands
ctiport
To specify one or more Cisco Unified Communications Manager CTI ports, use the ctiport command in Cisco Unity Express JTAPI configuration mode. To delete a CTI port, use the no form of this command.
ctiport cti-port [cti-port2 cti-port3...cti-portN]
no ctiport cti-portN
Syntax Description
Command Modes
Cisco Unity Express JTAPI configuration
Command History
Examples
The following example configures the JTAPI subsystem with eight CTI ports.
se-10-0-0-0# config tse-10-0-0-0(config)# ccn subsystem jtapise-10-0-0-0(config-jtapi)# ctiport 6400 6500 6600 6700 6800 6900 7000 7100se-10-0-0-0(config-jtapi)# endse-10-0-0-0(config)#The following example deletes CTI port 6700.
se-10-0-0-0# config tse-10-0-0-0(config)# ccn subsystem jtapise-10-0-0-0(config-jtapi)# no ctiport 6700se-10-0-0-0(config-jtapi)# endse-10-0-0-0(config)#Related Commands
Specifies the Cisco Unified Communications Manager server.
Specifies the JTAPI user ID and password.
Enters JTAPI configuration mode.
Displays statistics for the JTAPI subsystems.
