- 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: S: script (ccn application) to show ccn trigger sip
- Cisco Unity Express Commands: S: show clock detail to show remote users
- Cisco Unity Express Commands: S: show restore history to system shutdown (aaa accounting event)
- 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
Cisco Unity Express Command Reference Guide
Bias-Free Language
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
- Updated:
- August 27, 2020
Chapter: Cisco Unity Express Commands: D
- database (ccn reporting historical)
- db-hostname (ccn subsystem edbs dbprofile)–IVR Only
- dbname (ccn subsystem edbs dbprofile)–IVR Only
- db-password (ccn subsystem edbs dbprofile)–IVR Only
- db-port (ccn subsystem edbs dbprofile)–IVR Only
- dbtype (ccn subsystem edbs dbprofile)–IVR Only
- db-username (ccn subsystem edbs dbprofile)–IVR Only
- default (ccn application)
- default (ccn engine)
- default (ccn reporting historical)
- default (ccn subsystem edbs dbprofile)–IVR Only
- default (ccn subsystem fax)–IVR Only
- default (ccn trigger http)–IVR Only
- default (ccn trigger jtapi)
- default (ccn trigger sip)
- default ccm-manager (ccn subsystem jtapi)
- default ctiport (ccn subsystem jtapi)
- default gateway (ccn subsystem sip)
- default security password length min
- default security pin length min
- default-from (ccn subsystem fax)–IVR Only
- description (ccn application)
- description (backup-schedule)
- description (ccn reporting historical)
- description (kron schedule)
- description (site)
- disabled (backup-schedule)
- disabled (kron-schedule)
- dtmf-relay
Cisco Unity Express Commands: D
database (ccn reporting historical)
To configure the Cisco Unity Express IVR reporting historical local database, use the database local command in Cisco Unity Express IVR reporting historical configuration mode. Use the no form of this command to remove the database configuration.
Syntax Description
Command Default
The Cisco Unity Express IVR reporting historical database is set up as a local database by default.
Command Modes
Cisco Unity Express IVR reporting historical configuration
Command History
|
|
|
|---|---|
Examples
The following example configures the Cisco Unity Express IVR reporting historical local database:
Related Commands
|
|
|
|---|---|
Displays the Cisco Unity Express IVR reporting historical database configuration settings. |
db-hostname (ccn subsystem edbs dbprofile)–IVR Only
To configure the hostname for the Cisco Unity Express IVR enterprise database subsystem (EDBS), use the db-hostname command in Cisco Unity Express IVR EDBS configuration mode. To change the hostname to the default hostname, use the no form of this command.
Syntax Description
Defaults
The default is the IP address of the Cisco Unity Express IVR module.
Command Modes
Cisco Unity Express IVR EDBS configuration
Command History
|
|
|
|---|---|
Usage Guidelines
The hostname value identifies the Cisco Unity Express IVR module. The default value is the IP address of the module.
Note
Cisco Unity Express uses the hostname value in the Cisco Unity Express IVR module prompt.
Examples
The following example changes the hostname of the module to myHost and then restores the default hostname:
Related Commands
|
|
|
|---|---|
Displays the Cisco Unity Express IVR Enterprise database profile settings. |
dbname (ccn subsystem edbs dbprofile)–IVR Only
To specify a Cisco Unity Express IVR enterprise database subsystem (EDBS) name, use the dbname command in Cisco Unity Express IVR EDBS profile configuration mode. To delete the database name, use the no form of this command.
Syntax Description
Command Default
Command Modes
Cisco Unity Express IVR EDBS profile configuration
Command History
|
|
|
|---|---|
Usage Guidelines
After the ccn subsystem edbs dbprofile command is successfully performed, the dbname command is used to specify the name of the external database. If this name is not specified, the Java Database Connectivity (JDBC) driver uses the default database to connect. If you specify a name, the JDBC driver connects to the external database of that name.
Examples
The following example configures the optional database name:
Related Commands
|
|
|
|---|---|
Displays the Cisco Unity Express IVR EDBS database configuration settings. |
db-password (ccn subsystem edbs dbprofile)–IVR Only
To configure the password for the Cisco Unity Express IVR enterprise database subsystem (EDBS), use the db-password command in Cisco Unity Express IVR EDBS configuration mode. To remove the password, use the no form of this command.
Syntax Description
Defaults
Command Modes
Cisco Unity Express IVR EDBS configuration
Command History
|
|
|
|---|---|
Usage Guidelines
When you configure a password you must also configure a username by using the db-username command.
Examples
The following example sets the password of the module:
Related Commands
|
|
|
|---|---|
Configures the username for the Cisco Unity Express IVR EDBS. |
|
Displays the Cisco Unity Express IVR Enterprise database profile settings. |
db-port (ccn subsystem edbs dbprofile)–IVR Only
To specify the Cisco Unity Express IVR enterprise database subsystem (EDBS) port number, use the optional db-p ort command in Cisco Unity Express IVR EDBS profile configuration mode. To delete the database port number, use the no form of this command.
Syntax Description
(Optional) Port number other than the default port number for the Cisco Unity Express IVR EDBS. |
Command Default
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 optional db- port command to specify a port number other than the default port number of the database. Although databases are typically started using their default port numbers, the default port number might have been changed to a different port number. If the port number is some number other than the default port number, you must use the db-port command to specify this port number; otherwise, there is no need to use this command.
Examples
The following example configures the Cisco Unity Express IVR EDBS to use port number 10:
Related Commands
|
|
|
|---|---|
Displays the Cisco Unity Express IVR EDBS configuration settings. |
dbtype (ccn subsystem edbs dbprofile)–IVR Only
To configure the Cisco Unity Express IVR enterprise database subsystem (EDBS) type, use the dbtype command to set the database type in Cisco Unity Express IVR EDBS profile configuration mode. To delete a database type, use the no form of this command.
dbtype { DB2 | MSSQL-MSDE | ORACLE | SYBASE }
no dbtype { DB2 | MSSQL-MSDE | ORACLE | SYBASE }
Syntax Description
Command Default
Command Modes
Cisco Unity Express IVR EDBS profile configuration
Command History
|
|
|
|---|---|
Usage Guidelines
After the ccn subsystem edbs dbprofile command is successfully performed, the dbtype command is used to set the database type as DB2, MSSQ–MSDE, Oracle, or Sybase. The dbtype command is required.
Examples
The following example sets the database type to be Sybase:
Related Commands
|
|
|
|---|---|
Displays the Cisco Unity Express IVR Enterprise database profile settings. |
db-username (ccn subsystem edbs dbprofile)–IVR Only
To specify the required username for connecting to the Cisco Unity Express IVR enterprise database subsystem (EDBS), use the db- username command in Cisco Unity Express IVR EDBS profile configuration mode. To delete the specified username and password strings, use the no form of this command.
Syntax Description
Command Default
Command Modes
Cisco Unity Express IVR EDBS profile configuration
Command History
|
|
|
|---|---|
Usage Guidelines
When you configure a username you must also configure a password by using the db-password command.
Examples
The following example configures the database profile username and password:
Related Commands
|
|
|
|---|---|
Configures the password for the Cisco Unity Express IVR EDBS. |
|
default (ccn application)
To reset a CCN application parameter to its default value, use the default command in CCN application configuration mode.
default {description | enabled | maxsessions | parameter name}
Syntax Description
Command Modes
Command History
Usage Guidelines
The default command sets a Cisco Unified Communication Network (CCN) application parameter to its default value.
Examples
The following example sets the maximum number of sessions to the port license number:
se-10-0-0-0(config)# ccn application voicemail
Related Commands
|
|
|
|---|---|
Configures the CCN applications, such as voice mail and auto attendant. |
|
default (ccn engine)
To set the upper limit on the number of steps executed in a CCN application to the default value, use the default command in CCN engine configuration mode.
Syntax Description
Upper limit on the number of steps executed in a CCN application. The default is 1000. |
Command Modes
Command History
Examples
The following example resets the specified parameters to their factory values:
se-10-0-0-0(config)# ccn engine
se-10-0-0-0(config-engine)# end
Related Commands
|
|
|
|---|---|
Configures the CCN applications, such as voice mail and auto attendant. |
|
default (ccn reporting historical)
To reset the values for the Cisco Unity Express IVR reporting historical database to their default values, use the default command in Cisco Unity Express IVR reporting historical configuration mode.
default { database | description | enabled | purge }
Syntax Description
Command Default
The default is the hostname of the Cisco Unity Express system.
Command Modes
Cisco Unity Express IVR reporting historical configuration
Command History
|
|
|
|---|---|
Usage Guidelines
To allow the database server to differentiate data for every Cisco Unity Express IVR system that saves historical data to the same database, create a descriptive name for the Cisco Unity Express IVR historical database.
Examples
The following example resets the Cisco Unity Express IVR reporting historical database parameters to their default values:
Related Commands
|
|
|
|---|---|
Displays the Cisco Unity Express IVR reporting historical database configuration settings. |
default (ccn subsystem edbs dbprofile)–IVR Only
To reset the Cisco Unity Express IVR enterprise database subsystem (EDBS) values to their default values, use the default command in Cisco Unity Express IVR EDBS profile configuration mode.
default { credentials | dbname | dbtype | description | enabled | db- hostname | maxactive | parameter | db- password | db- port | db- username }
Syntax Description
Command Modes
Cisco Unity Express IVR EDBS profile configuration
Command History
|
|
|
|---|---|
Usage Guidelines
After entering the ccn subsystem edbs profile command, use the default command to reset the database values to their default values.
Examples
The following example resets the Cisco Unity Express IVR EDBS values to their default values:
Related Commands
|
|
|
|---|---|
default (ccn subsystem fax)–IVR Only
To delete the fax default-from e-mail address of the Cisco Unity Express IVR fax application, use the default command in Cisco Unity Express IVR fax configuration mode.
default default-from email-address-string
Syntax Description
E-mail address string of the default-from address of the fax application. |
Command Default
Command Modes
Cisco Unity Express IVR fax configuration
Command History
|
|
|
|---|---|
Examples
This example removes the Cisco Unity Express IVR fax default-from e-mail address of the fax application:
Related Commands
|
|
|
|---|---|
Displays the Cisco Unity Express IVR fax subsystem configuration settings. |
default (ccn trigger http)–IVR Only
To reset the Cisco Unity Express IVR HTTP trigger values to their default values, use the default command in Cisco Unity Express IVR HTTP trigger configuration mode.
default { application | enabled | idletimeout | locale | maxsessions }
Syntax Description
Command Modes
Cisco Unity Express IVR HTTP trigger configuration
Command History
|
|
|
|---|---|
Usage Guidelines
After the ccn trigger http command is successfully performed, use the default command to reset the HTTP trigger values to their default values.
Examples
The following example resets the Cisco Unity Express IVR HTTP-based trigger values to their default values:
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. |
default (ccn trigger jtapi)
To reset a CCN JTAPI trigger parameter to its default value, use the default command in CCN trigger JTAPI configuration mode. To disable the trigger or to set the number of maxsessions to 0, use the no form of this command.
default {application | enabled | idletimeout | locale | maxsessions}
no default {enabled | maxsessions}
Syntax Description
Enables the trigger. Use the no form of this command to disable the trigger. |
|
Sets the maximum number of sessions to the port license number. Use the no form of this command to set the number to 0. |
Command Modes
CCN trigger JTAPI configuration
Command History
Examples
The following example sets the maximum number of sessions to the port license number:
se-10-0-0-0(config)# ccn trigger jtapi phonenumber 1234
Related Commands
|
|
|
|---|---|
Configures the CCN applications, such as voice mail and auto attendant. |
|
default (ccn trigger sip)
To reset a CCN SIP trigger parameter to its default value, use the default command in CCN trigger SIP configuration mode. To disable the trigger or to set the number of maxsessions to 0, use the no form of this command.
default {application | enabled | idletimeout | locale | maxsessions}
no default {enabled | maxsessions}
Syntax Description
Enables the trigger. Use the no form of this command to disable the trigger. |
|
Sets the maximum number of sessions to the port license number. Use the no form of this command to set the number to 0. |
Command Modes
Command History
Examples
The following example sets the maximum number of sessions to the port license number:
se-10-0-0-0(config)# ccn trigger sip phonenumber 1234
Related Commands
|
|
|
|---|---|
Configures the CCN applications, such as voice mail and auto attendant. |
|
default ccm-manager (ccn subsystem jtapi)
To reset a Cisco Unified Communications Manager JTAPI subsystem parameter used by Cisco Unity Express to its default value, use the default ccm-manager command in Cisco Unity Express CCN subsystem JTAPI configuration mode.
default ccm-manager {address | username | password }
Syntax Description
Sets the IP address of the Cisco Unified Communications Manager server to 0.0.0.0. |
|
Command Modes
CCN subsystem JTAPI configuration
Command History
Examples
The following example sets the Cisco Unified Communications Manager server address to 0.0.0.0.
se-10-0-0-0(config)# ccn subsystem jtapi
se-10-0-0-0(config-jtapi)# end
Related Commands
|
|
|
|---|---|
Configures the CCN applications, such as voice mail and auto attendant. |
|
default ctiport (ccn subsystem jtapi)
To reset the Cisco Unified Communications Manager CTI port address to its default value (an empty string), use the default ctiport command in Cisco Unity Express CCN subsystem JTAPI configuration mode.
Syntax Description
Command Modes
CCN subsystem JTAPI configuration
Command History
Examples
The following example sets the Cisco Unified Communications Manager CTI port address to an empty string.
se-10-0-0-0(config)# ccn subsystem jtapi
se-10-0-0-0(config-jtapi)# end
Related Commands
|
|
|
|---|---|
Configures the CCN applications, such as voice mail and auto attendant. |
|
default gateway (ccn subsystem sip)
To reset a SIP server parameter to its default value, use the default gateway command in Cisco Unity Express CCN subsystem SIP configuration mode.
default gateway {address | port}
Syntax Description
Command Modes
CCN subsystem SIP configuration
Command History
Examples
The following example sets the SIP server port to 5060.
se-10-0-0-0(config)# ccn subsystem sip
Related Commands
|
|
|
|---|---|
Configures the CCN applications, such as voice mail and auto attendant. |
|
default security password length min
To set the length of the security password to the default minimum, use the default security password length min command in Cisco Unity Express configuration mode.
default security password length min
Syntax Description
Defaults
Command Modes
Cisco Unity Express configuration
Command History
|
|
|
|---|---|
Examples
The following example resets the password length:
Related Commands
|
|
|
|---|---|
default security pin length min
To set the length of the security PIN to the default minimum, use the default security pin length min command in Cisco Unity Express configuration mode.
default security pin length min
Syntax Description
Defaults
Command Modes
Cisco Unity Express configuration
Command History
|
|
|
|---|---|
Examples
The following example resets the PIN length:
Related Commands
|
|
|
|---|---|
default-from (ccn subsystem fax)–IVR Only
To configure the default-from address for the Cisco Unity Express IVR fax application, use the default-from command in Cisco Unity Express IVR fax configuration mode. Use the no form of this command to delete the default-from address.
default-from email-address-string
no default-from email-address-string
Syntax Description
E-mail address string of the default-from address of the fax application. |
Command Modes
Cisco Unity Express IVR fax configuration
Command History
|
|
|
|---|---|
Usage Guidelines
Enter a valid e-mail address string that is capable of receiving e-mail deliveries. This address must also be capable of receiving notifications of delivery failures.
Examples
The following example resets the fax default-from e-mail address:
se-10-0-0-0(config)# ccn subsystem fax
Related Commands
|
|
|
|---|---|
Displays the Cisco Unity Express IVR fax subsystem configuration settings. |
description (ccn application)
To specify an optional description for a CCN application, use the description command in Cisco Unity Express CCN application configuration mode. To remove the description, use the no form of this command.
Syntax Description
Specifies a text description for the application. Use double quotes around the text. |
Defaults
Command Modes
Command History
Examples
The following example adds a description for the CCN autoattendant application:
se-10-0-0-0(config)# ccn application autoattendant
se-10-0-0-0(config-application)# end
Related Commands
|
|
|
|---|---|
Configures the CCN applications, such as voice mail and auto attendant. |
|
description (backup-schedule)
To configure a description for a scheduled backup job, use the description command in Cisco Unity Express scheduled backup configuration mode. Use the no form of this command to remove the description for the backup job.
Syntax Description
Command Default
Command Modes
Cisco Unity Express scheduled backup configuration (config-sched)
Command History
|
|
|
|---|---|
Usage Guidelines
The text of the description must be enclosed in quotes.
The maximum length of the description is 64 characters. If a longer description is entered, it is truncated and a message is displayed indicating that truncation occurred.
Examples
The following example configures a description for a daily scheduled backup:
se-10-0-0-0(config)# backup schedule 22
se-10-0-0-0(backup-schedule)# description “daily midnight backup”
Related Commands
|
|
|
|---|---|
Shows details for the specified recurring scheduled backup job. |
description (ccn reporting historical)
To create a descriptive name for the Cisco Unity Express IVR reporting historical database, use the optional description command in Cisco Unity Express IVR reporting historical configuration mode. Use the no form of this command to set the description to the configured hostname of the system.
Syntax Description
Command Default
Command Modes
Cisco Unity Express IVR reporting historical configuration
Command History
|
|
|
|---|---|
Usage Guidelines
Allows the database server to differentiate data among multiple Cisco Unity Express systems that save historical data to the same database, create a descriptive name for the Cisco Unity Express historical database.
Examples
The following example creates a database description for the Cisco Unity Express IVR reporting historical database:
Related Commands
|
|
|
|---|---|
Displays the Cisco Unity Express IVR reporting historical database configuration settings. |
description (kron schedule)
To configure the description of the kron schedule, use the description command in Cisco Unity Express kron schedule configuration mode. Use the no form of this command to remove the description for the kron job.
Syntax Description
Defaults
Command Modes
Cisco Unity Express kron schedule configuration
Command History
|
|
|
|---|---|
Usage Guidelines
The text of the description must be enclosed in quotes.
The maximum length of the description is 64 characters. If a longer description is entered, it is truncated and a message is displayed indicating that truncation occurred.
Examples
The following example configures the description of the kron schedule to “monday”:
Related Commands
|
|
|
|---|---|
Enters the interactive mode to create the command block for a kron job. |
|
Creates a new kron schedule and enters kron-schedule configuration mode. |
|
description (site)
To configure a description for a specific site, use the description command in Cisco Unity Express site-configuration mode. Use the no form of the command to delete the description.
Syntax Description
Description for a specific site. The description can have a maximum of 64 characters and must be bracketed by quotes. |
Defaults
Command Modes
Cisco Unity Express site-configuration
Command History
|
|
|
|---|---|
Usage Guidelines
The description can have a maximum of 64 characters and must be bracketed by quotes.
Examples
The following example adds a description for a site called site1:
Related Commands
|
|
|
|---|---|
disabled (backup-schedule)
To configure a period time for the scheduled backup activity to be temporarily disabled, use the disabled command in Cisco Unity Express backup-schedule configuration mode. To remove the configured period of time to temporarily disable the backup, use the no form of this command.
Syntax Description
Defaults
Command Modes
Cisco Unity Express backup-schedule configuration
Command History
|
|
|
|---|---|
Usage Guidelines
The format for the date is month, day, and then year (for example: 05/302010).
Examples
The following example specifies to disable the scheduled backup from October 2, 2010 to October 6, 2010.
Related Commands
|
|
|
|---|---|
Shows details for the specified recurring scheduled backup job. |
disabled (kron-schedule)
To configure a period time for the scheduled kron job to be temporarily disabled, use the disabled command in Cisco Unity Express kron-schedule configuration mode. To remove the configured period of time to temporarily disable the kron job, use the no form of this command.
Syntax Description
Specifies the date from which the kron job is temporarily disabled. The format is MM/DD/YYYY. |
|
Specifies the date until which the kron job is temporarily disabled. The format is MM/DD/YYYY. |
Defaults
Command Modes
Cisco Unity Express kron-schedule configuration
Command History
|
|
|
|---|---|
Usage Guidelines
The format for the date is month, day, and then year (for example: 05/302010).
Examples
The following example specifies to disable the scheduled kron job from October 2, 2010 to October 6, 2010:
Related Commands
|
|
|
|---|---|
Shows details for the specified recurring scheduled kron job. |
dtmf-relay
To set the SIP DTMF relay mechanism, use the dtmf-relay command in Cisco Unity Express SIP configuration mode. To use the default values, use the no or default form of this command.
dtmf-relay { rtp-nte | sub-notify | info | sip-notify }
Syntax Description
Defaults
Command Modes
Cisco Unity Express SIP configuration
Command History
|
|
|
|---|---|
Usage Guidelines
To use the rtp-nte option, verify that the Cisco IOS SIP gateway is configured to use Unsolicited NOTIFY for SIP calls, as shown in the following example:
To use the sip-notify option, verify that the Cisco IOS SIP gateway is configured to use Unsolicited NOTIFY for SIP calls, as shown in the following example:
Configure more than one option for transferring DTMF signals. The order in which you configure the options determines their order of preference. To configure more than one signal option, specify them using a single dtmf-relay command.
Table 1 shows the various option combinations, the remote end capability, and the signaling option for incoming and outgoing DTMF signals.
|
|
|
|
|
|---|---|---|---|
sip-notify1 |
|||
no support2 |
|||
|
1.For incoming call. For outgoing call, the remote end decides between rtp-nte and sip-notify. |
Examples
The following example configures the options sip-notify and rtp-nte for handling DTMF signals.
Related Commands
|
|
|
|---|---|
Sets the MWI notification mechanism used by Cisco Unity Express. |
|
Sets the transfer mode used by Cisco Unity Express for SIP calls. |
Feedback