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.

Book Contents
Find Matches in This Book
Available Languages
Download Options

Book Title

Cisco Unity Express Command Reference Guide

Chapter Title

Cisco Unity Express Commands: W

Results

Updated:
August 27, 2020

Chapter: Cisco Unity Express Commands: W

Cisco Unity Express Commands: W

Last Updated: November 25, 2019

web admin cme hostname

To configure the Web username and Web password of the local site, use the web admin cme hostname command in Cisco Unity Express EXEC mode.

web admin cme hostname hostname username username password password

 
Syntax Description

hostname

Hostname of the local site to configure.

username

New username for the local site

password

New password for the local site

 
Defaults

No Web username and Web password are configured for the local site.

 
Command Modes

Cisco Unity Express EXEC

 
Command History

Cisco Unity Express Release
Modification

3.2

This command now affects the configuration of the Web username and Web password of the local site.

 
Usage Guidelines

This command now configures the Web username and Web password of the local site.

Examples

The following example allows callers to access their voice mailbox from any phone configured for the mailbox owner without entering a PIN:

se-10-0-0-0# web admin cme hostname host1 username user1 password password1

 
Related Commands

Command
Description

web username password (site)

Configures the Web username and Web password for a site.

web credentials hidden (site)

Configures the Web hidden credentials for a site

web credentials hidden (site)

To configure the hidden Web credentials for the site, use the web credentials hidden command in Cisco Unity Express site-configuration mode.

web credentials hidden username - password-hash

 
Syntax Description

username-password-hash

Encrypted credentials for the Web username and password for the site

 
Defaults

No hidden Web credentials are configured for the site.

 
Command Modes

Cisco Unity Express site-configuration

 
Command History

Cisco Unity Express Release
Modification

3.2

This command was introduced.

Examples

The following example configures the Web hidden credentials for site4:

se-10-0-0-0# config t
se-10-0-0-0(config)# site name site4
se-10-0-0-0 (site)# web hidden credentials "GixGRq8cUmGIZDg9c8oX9EnfGWTYHfmPSd8ZZNgd+
Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmP"
se-10-0-0-0 (site)# exit

 
Related Commands

Command
Description

description (site)

Configures a description for a specific site.

site name

Creates a site.

web username password (site)

Configures the Web username and Web password for a site.

xml username password (site)

Configures the XML username and password for a site.

xml credentials hidden (site)

Configures the XML hidden credentials for a site

web session security

To associate a security key for accessing the Cisco Unity Express GUI using HTTPS, use the web session security command in Cisco Unity Express configuration mode. To disable HTTPS access to the Cisco Unity Express GUI session, use the no or default form of this command.

web session security keylabel labelname

no web session security keylabel labelname

default web session security

 
Syntax Description

keylabel labelname

Associates the certificate-key pair to the HTTPS connection.

 
Defaults

The default value is none.

 
Command Modes

Cisco Unity Express configuration

 
Command History

Cisco Unity Express Version
Modification

3.2

This command was introduced.

10.1

HTTPS is enabled by default. The command no web session security keylabel labelname is disabled.

 
Usage Guidelines

Before configuring the connection type, the system must have a default security certificate and private key. Use the crypto key generate command to generate the pair of values.

Once the crypto key is generated and associated with HTTPS, you use the web session security command to enable HTTPS access to the Cisco Unity Express GUI.

From Cisco Unity Express Virtual Release 10.1 onwards, HTTPS is enabled by default. You need not manually generate a crypto key and pass it to the web session security to enable HTTPS. Cisco Unity Express Virtual Release 10.1 supports only TLS v1.2 for HTTPS. The command no web session security keylabel labelname is disabled. Therefore all the HTTP requests will be redirected to HTTPS. Only the latest connection is retained and the remaining connections are logged out.

Examples

The following example generates a crypto key, and then associates it to HTTPS to enable HTTPS access to the Cisco Unity Express GUI:

se-10-0-0-0#config t
se-10-0-0-0(config)# crypto key generate
Key generation in progress. Please wait
The label name for the key is mainkey.ourcompany
se-10-0-0-0(config)# web session security keylabel mainkey.ourcompany
 

The following example disables HTTPS on the session:

se-10-0-0-0(config)# no web session security keylabel mainkey.ourcompany
 
The following sample output indicates the behavior of Cisco Unity Express Virtual 10.1, when you run the command no web session security keylabel labelname:
 
se-10-1-0-1(config)#no web session security keylabel mainkey.ourcompany
!!! INFO: HTTPS is the only web interface option for this version of vCUE.
Hence, no web session security is disabled.

 
Related Commands

Command
Description

crypto key generate

Generates a certificate-private key pair.

show web session security

Displays the HTTPS security key label.

web skipinitwizard

To disable the initialization wizard during the Cisco Unity Express installation process, use the web skipinitwizard command in Cisco Unity Express EXEC mode.

web skipinitwizard

 
Syntax Description

This command has no arguments or keywords.

 
Command Modes

Cisco Unity Express EXEC

 
Command History

Cisco Unity Express Release
Modification

2.1

This command was introduced.

 
Usage Guidelines

This command turns off the initialization wizard. You cannot turn on or return to the initialization wizard unless you reimage the Cisco Unity Express module.

Use this command after installing the Cisco Unity Express software files and before starting the configuration process.

Turning off the initialization wizard allows you to configure Cisco Unity Express using only CLI commands, for example, if you want to run configuration scripts.

See the Cisco Unity Express 2.3 GUI Administrator Guide for the configuration tasks covered by the initialization wizard.

Examples

The following example turns off the initialization wizard:

se-10-0-0-0# web skipinitwizard
se-10-0-0-0#
 

web username password (site)

To configure the Web username and Web password for the site, use the web username password command in Cisco Unity Express site-configuration mode.

web username username password password

 
Syntax Description

username

Web username for the site

password

Web password for the site

 
Defaults

No Web username and Web password are configured for the site.

 
Command Modes

Cisco Unity Express site-configuration

 
Command History

Cisco Unity Express Release
Modification

3.2

This command was introduced.

Examples

The following example sets the Web username and password for site1 to user1 and password1:

se-10-0-0-0# config t
se-10-0-0-0(config)# site name site1
se-10-0-0-0 (site)# web username user1 password password1
se-10-0-0-0 (site)# exit

 
Related Commands

Command
Description

description (site)

Configures a description for a specific site.

site name

Creates a site.

web credentials hidden (site)

Configures the Web hidden credentials for a site

xml username password (site)

Configures the XML username and password for a site.

xml credentials hidden (site)

Configures the XML hidden credentials for a site

webapp delete–IVR Only

Use the webapp delete command in Cisco Unity Express IVR privileged EXEC mode to remove the specified web application from the Cisco Unity Express module.

webapp delete webappname name

 
Syntax Description

webappname name

Name of the web application used to generate the:

  • Name of the web application subdirectory that hosts the application files.
  • URL path matched against incoming URLs to access this web application.

Name must be 8 characters or less in length.

 
Command Default

No web application is configured.

 
Command Modes

Cisco Unity Express IVR privileged EXEC

 
Command History

Cisco Unity Express Version
Modification

3.0

This command was introduced.

 
Usage Guidelines

This command deletes all the resources of the web application from the Cisco Unity Express module.

Examples

The following example deletes all the resources of the web application myapp from the Cisco Unity Express module:

se-10-0-0-0# webapp delete webappname myapp

 
Related Commands

Command
Description

show webapp–IVR Only

Displays the Cisco Unity Express IVR web application status.

webapp deploy–IVR Only

Use the webapp deploy command associated with your web applications to upload and start the web application in Cisco Unity Express IVR privileged EXEC mode.

The webapp deploy command to uploads and starts the web application archive (WAR) file to the Cisco Unity Express system.

webapp deploy url war-url webappname name [ allow-network-connect | username userid [ password password [ allow-network-connect ]]]

 
Syntax Description

url war-url

Installs and starts a web application using the name of the application and the URL of the WAR file to be uploaded.

webappname name

Name of the web application used to generate the:

  • Name of the web application subdirectory that hosts the application files.
  • URL path matched against incoming URLs to access this web application.

Name must be 8 characters or less in length.

allow-network-connect

(Optional) Allows the specified web application to use the network connections.

username userid

(Optional) Username for authenticating connection to the network, if required.

password password

(Optional) Password for authenticating connection to the network, if required.

 
Command Default

No web application is configured.

 
Command Modes

Cisco Unity Express IVR privileged EXEC

 
Command History

Cisco Unity Express Version
Modification

3.0

This command was introduced.

 
Usage Guidelines

The Cisco Unity Express IVR feature allows you to deploy your VoiceXML scripts, which represent the static content of the Cisco Unity Express IVR application, and JSP and Java files, which generate the dynamic content of the Cisco Unity Express IVR application. Cisco Unity Express IVR applications are packaged using the WAR file format, which contain VoiceXML and compiled versions of the JSP and Java files, including their property and configuration files.

Before a web application is deployed, prompts must be loaded onto the Cisco Unity Express system by using the following command:

ccn copy url xxx://xxx/xxx.wav prompt xxx.wav language xx_YY
 

Databases to be used by the web application must be first configured. Also, fax or e-mail resources used by the application must be configured. The WAR file must be located in a directory that can be accessed by using FTP, TFTP, or SFTP.

After the web application is defined, one or more triggers can be defined to trigger operation of the application. For details on defining the web application, see the Cisco Unity Express 3.0 Interactive Voice Response CLI Administrator Guide.

Examples

The following example uploads the web application myapp file using the username and password options to authenticate a network connection:

se-10-0-0-0# webapp deploy url ftp://10.0.0.1/hr.war webappname myapp username tbdonald password ******* allow-network-connect

 
Related Commands

Command
Description

show webapp–IVR Only

Displays the Cisco Unity Express IVR web application status.

webapp reload–IVR Only

Use the webapp reload command to reload the specified web application in Cisco Unity Express IVR privileged EXEC mode.

webapp reload webappname name

 
Syntax Description

webappname name

Name of the web application used to generate the:

  • Name of the web application subdirectory that hosts the application files.
  • URL path matched against incoming URLs to access this web application.

Name must be 8 characters or less in length.

 
Command Default

No web application is configured.

 
Command Modes

Cisco Unity Express IVR privileged EXEC

 
Command History

Cisco Unity Express Version
Modification

3.0

This command was introduced.

 
Usage Guidelines

This command is equivalent to the webapp stop command immediately followed by the webapp start command, and is used to reload misbehaving web applications, and its status becomes running.

Examples

The following example reloads the web application myapp :

se-10-0-0-0# webapp reload webappname myapp

 
Related Commands

Command
Description

show webapp–IVR Only

Displays the Cisco Unity Express IVR web application status.

webapp start–IVR Only

Use the webapp start command to start the specified web application in Cisco Unity Express IVR privileged EXEC mode.

webapp start webappname name

 
Syntax Description

webappname name

Name of the web application used to generate the:

  • Name of the web application subdirectory that hosts the application files.
  • URL path matched against incoming URLs to access this web application.

Name must be 8 characters or less in length.

 
Command Default

No web application is configured.

 
Command Modes

Cisco Unity Express IVR privileged EXEC

 
Command History

Cisco Unity Express Version
Modification

3.0

This command was introduced.

 
Usage Guidelines

The webapp deploy command actually uploads and starts the web application, so the webapp start command is only used to restart the web application after it is stopped.

Examples

The following example starts the web application myapp :

se-10-0-0-0# webapp start webappname myapp

 
Related Commands

Command
Description

show webapp–IVR Only

Displays the Cisco Unity Express IVR web application status.

webapp stop–IVR Only

Use the webapp stop command to stop the specified web application in Cisco Unity Express IVR privileged EXEC mode.

webapp stop webappname name

 
Syntax Description

webappname name

Name of the web application used to generate the:

  • Name of the web application subdirectory that hosts the application files.
  • URL path matched against incoming URLs to access this web application.

Name must be 8 characters or less in length.

 
Command Default

No web application is configured.

 
Command Modes

Cisco Unity Express IVR privileged EXEC

 
Command History

Cisco Unity Express Version
Modification

3.0

This command was introduced.

Examples

The following example stops the web application myapp :

se-10-0-0-0# webapp stop webappname myapp

 
Related Commands

Command
Description

show webapp–IVR Only

Displays the Cisco Unity Express IVR web application status.

write

To erase, copy, or display the running configuration, use the write command in Cisco Unity Express EXEC mode.

write [ erase | memory | terminal ]

 
Syntax Description

erase

(Optional) Erases the running configuration.

memory

(Optional) Writes the running configuration to the startup configuration. This is the default.

terminal

(Optional) Displays the running configuration.

 
Command Modes

Cisco Unity Express EXEC

 
Command History

Cisco Unity Express Release
Modification

1.0

This command was introduced on the Cisco Unity Express network module and in Cisco Unified Communications Manager Express 3.0.

1.1

This command was implemented on the advanced integration module (AIM) and in Cisco Unified Communications Manager 3.3(3).

1.1.2

This command was implemented on the Cisco 2800 series and Cisco 3800 series routers.

 
Usage Guidelines

Use the write or write memory command as a shortcut for the copy running-config startup-config command.

 
Related Commands

Command
Description

erase startup-config

Deletes the current startup configuration.

Was this Document Helpful?

FeedbackFeedback

Contact Cisco