- 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: M
- maxactive (ccn subsystem edbs dbprofile)–IVR Only
- maxsessions (ccn application)
- maxsessions (ccn trigger http)–IVR Only
- maxsessions (ccn trigger jtapi)
- maxsessions (ccn trigger sip)
- maxsessions (IMAP)
- maxsteps (ccn engine)
- messaging-gateway
- messaging-gateway directory lookup
- messaging-gateway directory lookup tui-prompt
- messaging-gateway registration
- mwi envelope-info
- mwi refresh
- mwi sip
- mwiport
Cisco Unity Express Commands: M
maxactive (ccn subsystem edbs dbprofile)–IVR Only
To specify the maximum number of concurrent active connections to the Cisco Unity Express IVR enterprise database subsystem (EDBS), use the maxactive command in Cisco Unity Express IVR EDBS profile configuration mode. Use the no form of this command to set the maximum number of active connections to 0.
Syntax Description
Maximum number of concurrent active connections to the external database. |
Command Default
The default maximum number of concurrent active connections is twice the number of licensed Cisco Unity Express IVR sessions.
Command Modes
Cisco Unity Express IVR EDBS profile configuration
Command History
|
|
|
|---|---|
Usage Guidelines
After the ccn subsystem edbs profile command is successfully performed, use the maxactive command to specify the maximum number of concurrent active connections to the Cisco Unity Express IVR EDBS. Connection requests that are made after the maximum limit is reached cause connection failures. The maximum value that you can specify, which is also the default value, is twice the number of licensed Cisco Unity Express IVR sessions.
Examples
The following example sets the maximum number of concurrent active connections to the Cisco Unity Express IVR EDBS to 8:
Related Commands
|
|
|
|---|---|
maxsessions (ccn application)
To specify the maximum number of subscribers who can access an application simultaneously, use the maxsessions command in Cisco Unity Express configuration application mode. To set the number to 0, use the no form of this command.
Syntax Description
Command Modes
Command History
Examples
The following example sets the maximum number of subscribers who can access the autoattendant application simultaneously to 12.
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. |
|
maxsessions (ccn trigger http)–IVR Only
To configure the maximum number of simultaneous incoming Cisco Unity Express IVR HTTP-based sessions, use the maxsessions command in Cisco Unity Express IVR HTTP trigger configuration mode. Use the no form of this command to set the maximum number of simultaneous HTTP requests value to 0.
no maxsessions maximum-sessions
Syntax Description
Maximum number of simultaneous sessions of HTTP-based requests for the Cisco Unity Express IVR licensed port. |
Defaults
The default is the number of licensed Cisco Unity Express IVR sessions.
Command Modes
Cisco Unity Express IVR HTTP trigger configuration
Command History
|
|
|
|---|---|
Usage Guidelines
After the ccn trigger http command is successfully performed, use the maxsessions command to configure the maximum number of simultaneous incoming HTTP sessions for this trigger. The maximum value you can specify is limited by the number of licensed Cisco Unity Express IVR sessions. Use the default form of this command to set the maximum number of simultaneous HTTP requests to the number of licensed Cisco Unity Express IVR sessions.
Examples
The following example sets the maximum number of simultaneous sessions of incoming HTTP-based requests to 8:
se-10-0-0-0(config)# ccn trigger http urlname myhttpapp
se-10-0-0-0(config-trigger)# end
Related Commands
|
|
|
|---|---|
Displays the trigger and application settings. Use the show ccn trigger http command to display the Cisco Unity Express IVR HTTP-based trigger settings. |
maxsessions (ccn trigger jtapi)
To specify the maximum number of subscribers who can access a JTAPI trigger simultaneously, use the maxsessions command in Cisco Unity Express configuration trigger mode. To set the number to 0, use the no form of this command.
Syntax Description
Command Modes
Command History
Examples
The following example sets the maximum number of subscribers who can access the JTAPI phonenumber trigger simultaneously to 12.
se-10-0-0-0(config)# ccn trigger jtapi phonenumber 1234
se-10-0-0-0(config-trigger)# end
Related Commands
|
|
|
|---|---|
maxsessions (ccn trigger sip)
To specify the maximum number of subscribers who can access a SIP trigger simultaneously, use the maxsessions command in Cisco Unity Express configuration trigger mode. To set the number to 0, use the no form of this command.
Syntax Description
Command Modes
Command History
Examples
The following example sets the maximum number of subscribers who can access the SIP phonenumber trigger simultaneously to 12.
se-10-0-0-0(config)# ccn trigger sip phonenumber 1234
se-10-0-0-0(config-trigger)# end
Related Commands
|
|
|
|---|---|
maxsessions (IMAP)
To specify the maximum number of simultaneous IMAP sessions, use the maxsessions command in IMAP configuration mode. To set the number to the default value 50, use the no or default form of this command.
Syntax Description
Number of simultaneous IMAP sessions. Valid values are 1 to 50. The default value is 50. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Beginning with Cisco Unity Express 3.0, this command was supported on the AIM-CUE.
An error message appears if a value for number is greater than 50.
If a subscriber attempts to use the IMAP feature and the IMAP server is at its maximum number of sessions, the subscriber will see an error message.
Note
The IMAP server must be restarted for this value to become active.
Examples
The following example sets the maximum number of simultaneous IMAP sessions to 12.
se-10-0-0-0(config)# service imap
se-10-0-0-0(config-application)# end
Related Commands
|
|
|
|---|---|
maxsteps (ccn engine)
To specify the maximum number of steps that can be executed in an application, use the maxsteps command in Cisco Unity Express configuration engine mode. This command does not have a no form.
Syntax Description
Maximum number of steps that can be executed in an application. The default value is 1000. Maximum number of steps is 10,000. |
Defaults
Command Modes
Command History
Examples
The following example sets the maximum number of steps in an application to 500.
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. |
|
Configures the features shared by all the Cisco Unity Express subsystems. |
|
messaging-gateway
To specify location information for the primary or secondary messaging gateway that is used for registration, use the messaging-gateway command in Cisco Unity Express gateway configuration mode. Use the no form of the command to negate the configuration for the messaging gateway registration.
messaging-gateway {primary | secondary} location-id umg-ip-addr [ port ump-port ]
Syntax Descriptionno messaging-gateway {primary | secondary} location-id umg-ip-addr [port ump-port]
Command Modes
Cisco Unity Express gateway configuration
Command History
|
|
|
|---|---|
Usage Guidelines
This command enters gateway configuration mode and specifies the location ID and IP address ( or domain name) of the primary or secondary messaging gateway to which Cisco Unity Express is attempting to register.
Examples
The following example causes Cisco Unity Express to send a registration message the messaging gateway with an ID of 59000 and an IP address of 192.0.2.24:
Related Commands
|
|
|
|---|---|
Causes the endpoint (Cisco Unity Express) to send a registration message to its messaging gateway. |
|
Displays the details associated with the registration of the messaging gateway |
messaging-gateway directory lookup
To enable the remote directory lookup feature, use the messaging-gateway directory lookup command in Cisco Unity Express gateway configuration mode. Use the no form of the command to disable the remote directory lookup feature.
messaging-gateway directory lookup
no messaging-gateway directory lookup
Syntax Description
Command Modes
Cisco Unity Express gateway configuration
Command History
|
|
|
|---|---|
Usage Guidelines
The remote directory lookup feature is enabled by default when the messaging-gateway register is issued.
Examples
The following example enables the remote directory lookup feature:
Related Commands
|
|
|
|---|---|
Enables confirmation of the remote directory lookup in TUI mode. |
|
Displays the details associated with the registration of the messaging gateway |
messaging-gateway directory lookup tui-prompt
To enable confirmation of the remote directory lookup in TUI mode, use the messaging-gateway directory lookup tui-prompt command in Cisco Unity Express gateway configuration mode. Use the no form of the command to disable the confirmation of remote directory lookup.
messaging-gateway directory lookup tui-prompt
no messaging-gateway directory lookup tui-prompt
Syntax Description
Command Modes
Cisco Unity Express gateway configuration
Command History
|
|
|
|---|---|
Usage Guidelines
This feature is disabled automatically when you disable the directory lookup feature using the no messaging-gateway directory lookup command. However, this feature is not automatically enabled when you enable the directory lookup feature by issuing the messaging-gateway directory lookup.
In addition, when you enable this feature, it also enables the remote directory lookup feature.
Examples
The following example enables the remote directory lookup feature:
Related Commands
|
|
|
|---|---|
Displays the details associated with the registration of the messaging gateway |
messaging-gateway registration
To cause the endpoint (Cisco Unity Express) to automatically send a registration message to its messaging gateway, use the messaging-gateway registration command in Cisco Unity Express configuration mode. Use the no form of the command to disable autoregistration with the massaging gateway.
messaging-gateway registration
no messaging-gateway registration
Syntax Description
Command Modes
Cisco Unity Express configuration
Command History
|
|
|
|---|---|
Usage Guidelines
This command enters gateway configuration mode and first causes the endpoint (Cisco Unity Express) to send a registration message to its primary messaging gateway. If the registration fails, the message is send to the secondary messaging gateway, unless registration with the primary fails due to a configuration error.
Examples
The following example causes Cisco Unity Express to send a registration message the messaging gateway with an ID of 59000 and an IP address of 192.0.2.24:
Related Commands
|
|
|
|---|---|
Specifies the location ID and IP address for the primary or secondary messaging gateway. |
|
Displays the details associated with the registration of the messaging gateway |
mwi envelope-info
To enable the inclusion of envelope information in SIP MWI notifications, use the mwi envelope-info command in Cisco Unity Express SIP configuration mode. Use the no or default form of the command to disable the inclusion of envelope information.
Syntax Description
Command Default
Envelope information is not included in SIP MWI notifications.
Command Modes
Cisco Unity Express SIP configuration
Command History
|
|
|
|---|---|
Usage Guidelines
This command is relevant only when the mwi sip sub-notify command is used.
This command does not effect whether Cisco Unity Express accepts MWI subscriptions that request envelope information. It only determines whether envelope information is not included in SIP MWI notifications and it effects only the content of MWI messages generated by Cisco Unity Express. Disabling the inclusion of envelope information does not terminate existing MWI subscriptions. after it is enabled, subsequent MWI notifications include envelope information for any existing MWI subscription that requested with envelope information
The no or default version of this command disables the inclusion of envelope information in MWI notifications. By default envelope information is disabled.
Examples
The following example enables the inclusion of envelope information:
Related Commands
|
|
|
|---|---|
mwi refresh
To refresh the message-waiting indicator (MWI) lights on one or more telephones, use the mwi refresh command in Cisco Unity Express EXEC mode.
mwi refresh { all | telephonenumber tel-number }
Syntax Description
Command Modes
Command History
Usage Guidelines
Use this command to update the MWI lights when they are not in synchronization with the stored voice messages.
Refreshing an extension that does not require it does not affect that extension.
Examples
The following example refreshes the MWI for extension 2015:
Related Commands
|
|
|
|---|---|
Displays the properties of the configured voice-mail system. |
mwi sip
To set the message waiting indicator (MWI) notification mechanism, use the mwi sip command in Cisco Unity Express SIP configuration mode. To use the outcall mechanism, use the no or default form of this command.
mwi sip { outcall | sub-notify | unsolicited }
Syntax Description
Sends MWI notifications using the Subscribe Notify mechanism. |
|
Sends MWI notifications using the Unsolicited Notify mechanism. |
Defaults
Command Modes
Cisco Unity Express SIP configuration
Command History
|
|
|
|---|---|
Usage Guidelines
Only Cisco Unified CME can use the SIP outcall mechanism for generating MWI notifications. Outcall will not work between Cisco Unity Express and a Cisco Unified Communications Manager system.
Note If the MWI notification option is outcall, configure the MWI on and off extensions. See “Configuring the MWI On and Off Extensions (Cisco Unified CME Only)” in the Cisco Unity Express Voice-Mail and Auto-Attendant CLI Administrator Guide.
The outcall option is available for backward compatibility. It is recommended that you use either sub-notify or unsolicited for the MWi notification option.
To use the outcall option, Cisco Unified CME must configure each ephone-dn that is registered to receive MWI notifications as follows:
Both Cisco Unified CME and Cisco Unified Communications Manager in SRST mode can use the sub-notify and unsolicited mechanisms for generating MWI notifications. With these mechanisms, the MWI notifications will reflect the accurate status of messages in a subscriber’s voice mailbox.
After an ephone-dn is configured with the sub-notify option, Cisco Unified CME sends a Subscribe message to Cisco Unity Express to register the phone for MWI notifications. When a new voice message arrives in the voice mailbox for the ephone-dn, Cisco Unity Express updates the MWI status. If Cisco Unity Express does not receive the Subscribe message for the ephone-dn, Cisco Unity Express will not update the MWI status when a new message arrives.
To use the sub-notify option, Cisco Unified CME must configure each ephone-dn that is registered to receive MWI notifications as follows:
For Cisco IOS Releases Prior to 12.3(11)T07
For Cisco IOS Releases 12.3(11)T07 and Later
The unsolicited option does not require Cisco Unified CME to send a subscription request for each ephone-dn to Cisco Unity Express for MWI notifications. Cisco Unity Express sends Notify messages to Cisco Unified CME whenever the voice mailbox for any ephone-dn receives a new message. In this way, the MWI status reflects the current voice mailbox message status.
To use the unsolicited option, Cisco Unified CME must configure each ephone-dn that is registered to receive MWI notifications as follows:
For Cisco IOS Releases Prior to 12.3(11)T07
For Cisco IOS Release 12.3(11)T07 and Later
The SIP server IP address used in these commands must be the IP address of Cisco Unity Express. In the examples shown above, this is 10.100.9.6.
Examples
The following example configures the MWI notification mechanism as SIP Notify:
Related Commands
|
|
|
|---|---|
Sets the transfer mode used by Cisco Unity Express for SIP calls. |
mwiport
To configure a Cisco Unified Communications Manager CTI port to use for MWI, use the mwiport dn command in Cisco Unity Express JTAPI configuration mode. To remove the configuration, use the no form of this command.
Syntax Description
Command Modes
Cisco Unity Express JTAPI configuration
Command History
|
|
|
|---|---|
Usage Guidelines
The DN that you assign to a CTI port to use for MWI must be different from those used by any of the CTI ports (as configured using the ctiport command).
The Cisco Unified Communications Manager must have a CTI port that is assigned the DN you specify when you configure the CTI port, and the DN must be under the control of Cisco Unity Express JTAPI application user.
If an MWI port is configured on Cisco Unity Express but the DN is not in service, or Cisco Unity Express cannot register the port, no notifications are generated. If no MWI port is configured, Cisco Unity Express uses one of the regular CTI ports.
Examples
The following example configures the CTI port with DN 44 to be used for MWI.
Related Commands
|
|
|
|---|---|
Feedback