Cisco Unity Express 2.3 Command Reference
R

Table Of Contents

R

reload

remote cache enable

remote copy spokenname

remote username fullname

remote username location

remote username phonenumber

restore

restore factory default

restriction msg-notification dial-string

restriction msg-notification max-digits

restriction msg-notification min-digits


R


Last Updated: May 1, 2006

reload

remote cache enable

remote copy spokenname

remote username fullname

remote username location

remote username phonenumber

restore

restore factory default

restriction msg-notification dial-string

restriction msg-notification max-digits

restriction msg-notification min-digits

reload

To restart the Cisco Unity Express system, use the reload command in Cisco Unity Express offline mode.

reload

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco Unity Express offline

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 Comco 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 this command in the following situations:

After a shutdown command to restart the Cisco Unity Express system.

After a restore command to activate the uploaded file information.

Examples

The following example illustrates the use of the reload command after a restore procedure:

se-10-0-0-0# offline
se-10-0-0-0(offline)# restore id data3 category data
se-10-0-0-0(offline)# reload

Related Commands

Command
Description

backup

Backs up system and application data to a backup server.

continue

Exits offline mode and returns to Cisco Unity Express EXEC mode.

offline

Switches the Cisco Unity Express system to offline mode.

restore

Restores backup files from the backup server.

shutdown

Shuts down the Cisco Unity Express system.


remote cache enable

To enable the least recent used (LRU) cache on the local system, use the remote cache enable command in Cisco Unity Express configuration mode. To disable the LRU cache, use the no form of this command.

remote cache enable

no remote cache enable

Syntax Description

This command has no arguments or keywords.

Defaults

Enabled

Command Modes

Cisco Unity Express configuration

Command History

Cisco Unity Express Release
Modification

2.1

This command was introduced.


Usage Guidelines

An LRU cache is a database of remote subscribers' first names, last names, and spoken names. These remote subscribers are not configured in the Remote User Directory. The subscribers contained in the cache are referred to as cached subscribers.

Network messages update the contents of the LRU cache. When a local sender addresses a voice-mail message to a remote subscriber, the system accesses this information to send a spoken name confirmation about the remote subscriber to the local sender. Each time a network message arrives from a cached subscriber or each time a local sender sends a voice message to a cached subscriber, the system updates the time stamp of the cached subscriber's entry in the LRU cache.

The maximum capacity of the LRU cache is 50 subscribers on the network module (NM) and 20 subscribers on the advanced integration module (AIM). When the LRU cache reaches its maximum capacity, a new entry erases the existing entry with the oldest time stamp. This means that the next time a local sender calls a remote subscriber, the sender will not receive a spoken name confirmation if the remote subscriber is no longer in the LRU cache.

Do one or both of the following to avoid the inconsistent confirmation response:

To ensure that a sender always receives a spoken name confirmation for a remote subscriber, configure the remote subscriber in to the Remote User Directory.

Disable the LRU cache.

The LRU cache contents are saved after system reloads.

The GUI Defaults > Voice Mail option also permits changing the status of the LRU cache.

Examples

The following example illustrates enabling the LRU cache on the local system:

se-10-0-0-0# config t
se-10-0-0-0(config)# remote cache enable
se-10-0-0-0(config)# exit

The following example illustrates disabling the LRU cache on the local system:

se-10-0-0-0# config t
se-10-0-0-0(config)# no remote cache enable
se-10-0-0-0(config)# exit

Related Commands

Command
Description

show remote cache

Displays the local system's LRU cache.


remote copy spokenname

To upload or download a spoken name for a remote subscriber, use the remote copy spokenname command in Cisco Unity Express EXEC mode.

Uploading the Spoken Name

remote copy spokenname username username url url loginname server-login password server-password

Downloading the Spoken Name

remote copy spokenname url url username username loginname server-login password server-password

Syntax Description

username username

Remote subscriber ID.

url url

URL to the spoken name file on the server.

loginname server-login

Server login.

password server-password

Server password.


Command Modes

Cisco Unity Express EXEC

Command History

Cisco Unity Express Release
Modification

2.1

This command was introduced.


Usage Guidelines

Use the Administration via Telephone (AvT) options to record the spoken names. Those name files are stored in the Lightweight Directory Access Protocol (LDAP) on the Cisco Unity Express module. If you download the files to a server other than the Cisco Unity Express module, you can upload those files to another Cisco Unity Express module in the network.

Examples

The following example uploads the spoken name file user5.wav for remote subscriber user5:

se-10-0-0-0# remote copy spokenname username user5 url ftp:/10.4.51.66/tsmith.wav 
loginname admin password test

The following example downloads the spoken name file user5.wav for remote subscriber user5:

se-10-0-0-0# remote copy spokenname url ftp:/10.4.51.66/tsmith.wav username user5 
loginname admin password test

remote username fullname

To associate a full name with a remote subscriber, use the remote username fullname command in Cisco Unity Express EXEC mode. To delete the remote username, use the no form of this command.

remote username username fullname {display display-name | first first-name | last last-name}

no remote username username fullname {display display-name | first first-name | last last-name}

Syntax Description

username

Name of the remote subscriber.

display display-name

Full name of the remote subscriber. Enclose the name in double quotes (" ") if the name is more than one word. The system uses this name for telephone displays.

first first-name

First name of the remote subscriber. Enclose the name in double quotes (" ") if the name is more than one word.

last last-name

Last name of the remote subscriber. Enclose the name in double quotes (" ") if the name is more than one word.


Command Modes

Cisco Unity Express EXEC

Command History

Cisco Unity Express Release
Modification

2.1

This command was introduced.


Usage Guidelines

An error message appears if the username does not exist.

Examples

The following example configures several remote subscribers.

se-10-0-0-0# config t
se-10-0-0-0(config)# remote username user2 location sjc create
se-10-0-0-0(config)# remote username user2 phonenumber 84444
se-10-0-0-0(config)# remote username user5 location sjc create
se-10-0-0-0(config)# remote username user5 phonenumber 81111
se-10-0-0-0(config)# remote username user3 location nyc create
se-10-0-0-0(config)# remote username user3 phonenumber 92222
se-10-0-0-0(config)# remote username user4 location nyc create
se-10-0-0-0(config)# remote username user4 phonenumber 93333
se-10-0-0-0(config)# end
se-10-0-0-0# remote username user5 fullname display "User 5"
se-10-0-0-0# remote username user5 fullname first User
se-10-0-0-0# remote username user5 fullname last 5
se-10-0-0-0# remote username user3 fullname display "User 3"
se-10-0-0-0# remote username user3 fullname first User
se-10-0-0-0# remote username user3 fullname last 3
se-10-0-0-0# remote username user4 fullname display "User 4"
se-10-0-0-0# remote username user4 fullname first User
se-10-0-0-0# remote username user4 fullname last 4


se-10-0-0-0# remote username user1 fullname display "User 1"
se-10-0-0-0# remote username user1 fullname first User
se-10-0-0-0# remote username user1 fullname last 1

The following example deletes the display name for remote subscriber User5:

se-10-0-0-0# no remote username user5 fullname display "User 5"

The following example deletes the first name for remote subscriber User5:

se-10-0-0-0# no remote username user5 fullname first User

The following example deletes the last name for remote subscriber User5:

se-10-0-0-0# no remote username user5 fullname last 5

Related Commands

Command
Description

remote username location

Configures a remote subscriber on the local Cisco Unity Express system.

remote username phonenumber

Configures a remote subscriber's telephone number on the local Cisco Unity Express system.

show remote user detail

Displays configuration details about a specified remote subscriber.

show remote users

Displays remote subscribers configured on the local Cisco Unity Express system.


remote username location

To configure a remote subscriber on the local Cisco Unity Express system, use the remote username location command in Cisco Unity Express EXEC mode or configuration mode. To delete a remote user from the system, use the no form of this command.

remote username username location location-id create

no remote username username

Syntax Description

username

Name of the remote subscriber.

location-id

Location ID of the remote site.

create

Creates the remote subscriber.


Defaults

No remote subscribers are configured.

Command Modes

Cisco Unity Express EXEC
Cisco Unity Express configuration

Command History

Cisco Unity Express Release
Modification

2.1

This command was introduced.


Usage Guidelines

This command creates a remote subscriber on the local system so that a local voice-mail sender can address a remote recipient using dial-by-name. Additionally, the system provides the sender with a spoken name confirmation of the remote recipient so that the sender can verify that the name and location are correct.

Use the remote username location command once to associate the remote subscriber with a network location.

In Release 2.1, regardless of the license level, the network module (NM) supports a maximum of 50 remote subscribers and the advanced integration module (AIM) supports a maximum of 20 remote subscribers.

An error message appears if one of the following conditions occurs:

A subscriber, group, or remote subscriber exists with this username.

The maximum number of remote subscribers is already configured on the system.

The location ID does not exist.

The location ID is the local location.

Examples

The following example configures several remote subscribers.

se-10-0-0-0# config t
se-10-0-0-0(config)# remote username user2 location sjc create
se-10-0-0-0(config)# remote username user2 phonenumber 84444
se-10-0-0-0(config)# remote username user5 location sjc create
se-10-0-0-0(config)# remote username user5 phonenumber 81111
se-10-0-0-0(config)# remote username user3 location nyc create
se-10-0-0-0(config)# remote username user3 phonenumber 92222
se-10-0-0-0(config)# remote username user4 location nyc create
se-10-0-0-0(config)# remote username user4 phonenumber 93333
se-10-0-0-0(config)# end
se-10-0-0-0# remote username user5 fullname display "User 5"
se-10-0-0-0# remote username user5 fullname first User
se-10-0-0-0# remote username user5 fullname last 5
se-10-0-0-0# remote username user3 fullname display "User 3"
se-10-0-0-0# remote username user3 fullname first User
se-10-0-0-0# remote username user3 fullname last 3
se-10-0-0-0# remote username user4 fullname display "User 4"
se-10-0-0-0# remote username user4 fullname first User
se-10-0-0-0# remote username user4 fullname last 4
se-10-0-0-0# remote username user2 fullname display "User 2"
se-10-0-0-0# remote username user2 fullname first User
se-10-0-0-0# remote username user2 fullname last 2
se-10-0-0-0# 

The following example deletes the remote subscriber User2:

se-10-0-0-0# config t
se-10-0-0-0(config)# no remote username user2
se-10-0-0-0(config)# end

Related Commands

Command
Description

remote username fullname

Configures a remote subscriber's full name on the local Cisco Unity Express system.

remote username phonenumber

Configures a remote subscriber's telephone number on the local Cisco Unity Express system.

show remote user detail

Displays configuration details about a specified remote subscriber.

show remote users

Displays remote subscribers configured on the local Cisco Unity Express system.


remote username phonenumber

To associate a telephone number with a remote subscriber, use the remote username phonenumber command in Cisco Unity Express configuration mode. To delete the telephone number, use the no form of this command.

remote username username phonenumber extension-number

no remote username username phonenumber extension-number

Syntax Description

username

Name of the remote subscriber.

extension-number

Extension number of the remote site.


Defaults

No phone numbers are configured for the remote subscribers.

Command Modes

Cisco Unity Express configuration

Command History

Cisco Unity Express Release
Modification

2.1

This command was introduced.


Usage Guidelines

The local system does not verify the remote extension number.

An error message appears if one of the following conditions occurs:

The username does not exist.

The length of the extension number does not fall within the maximum and minimum extension lengths for the subscriber's location.

Examples

The following example configures several remote subscribers.

se-10-0-0-0# config t
se-10-0-0-0(config)# remote username user2 location sjc create
se-10-0-0-0(config)# remote username user2 phonenumber 84444
se-10-0-0-0(config)# remote username user5 location sjc create
se-10-0-0-0(config)# remote username user5 phonenumber 81111
se-10-0-0-0(config)# remote username user3 location nyc create
se-10-0-0-0(config)# remote username user3 phonenumber 92222
se-10-0-0-0(config)# remote username user4 location nyc create
se-10-0-0-0(config)# remote username user4 phonenumber 93333
se-10-0-0-0(config)# end
se-10-0-0-0# remote username user2 fullname display "User 2"
se-10-0-0-0# remote username user2 fullname first User
se-10-0-0-0# remote username user2 fullname last 2
se-10-0-0-0# remote username user5 fullname display "User 5"
se-10-0-0-0# remote username user5 fullname first User
se-10-0-0-0# remote username user5 fullname last 5
se-10-0-0-0# remote username user3 fullname display "User 3"
se-10-0-0-0# remote username user3 fullname first User
se-10-0-0-0# remote username user3 fullname last 3
se-10-0-0-0# remote username user4 fullname display "User 4"
se-10-0-0-0# remote username user4 fullname first User
se-10-0-0-0# remote username user4 fullname last 4
se-10-0-0-0# 

The following example deletes extension 84444 from remote subscriber User 4:

se-10-0-0-0# config t
se-10-0-0-0(config)# no remote username user4 phonenumber 84444
se-10-0-0-0(config)# end

Related Commands

Command
Description

remote username fullname

Configures a remote subscriber's full name on the local Cisco Unity Express system.

remote username location

Configures a remote subscriber on the local Cisco Unity Express system.

show remote user detail

Displays configuration details about a specified remote subscriber.

show remote users

Displays remote subscribers configured on the local Cisco Unity Express system.


restore

To restore a backup file, use the restore command in Cisco Unity Express offline mode.

restore id backup-id category {all | configuration | data}

Syntax Description

id backup-id

Specifies the ID number of the file to be restored.

category

Precedes the name of the file type to be restored.

all

Specifies that the file to be restored contains system and application settings, application data, and voice messages.

configuration

Specifies that the file to be restored contains only system and application settings.

data

Specifies that the file to be restored contains only application data and voice messages.


Command Modes

Cisco Unity Express offline

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

When the restore procedure begins, all active calls are terminated. Cisco Unity Express does not support scheduled restores. Consider restoring a file when the telephones are least active.

After the restore procedure is complete, use the reload command to activate the file data.

Use the show backup history command to locate the backup-id value of the file to be restored.

Examples

The following example restores the file with the ID data5, which is a data-only file.

se-10-0-0-0> enable
se-10-0-0-0# offline
se-10-0-0-0(offline)# restore id data5 category data
se-10-0-0-0(offline)# reload

Related Commands

Command
Description

continue

Exits offline mode and returns to Cisco Unity Express EXEC mode.

offline

Enters offline mode.

reload

Activates the uploaded file data.

show backup history

Displays the status of backup procedures.

show backup server

Displays the network FTP server designated as the backup server.


restore factory default

To restore the system to the factory defaults, use the restore factory default command in Cisco Unity Express offline mode.

restore factory default


Caution This feature is not reversible. All data and configuration files are erased. Use this feature with caution. It is recommended that you do a full system backup before proceeding with this feature.

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco Unity Express offline

Command History

Cisco Unity Express Release
Modification

2.1

This command was introduced.


Usage Guidelines

Restoring the system to the factory defaults has the following effects:

Replaces the current database with an empty database.

Initializes the Lightweight Directory Access Protocol (LDAP) to an empty state.

Replaces the startup configuration with the template startup configuration that ships with the system.

Erases all postinstallation configuration data.

Deletes all subscriber and custom prompts.

When the system is clean, the administrator sees a message that the system will reload, and the system begins to reload. When the reload is complete, the system prompts the administrator to go through the postinstallation process.

When logging in to the graphical user interface (GUI), the administrator has the option to run the initialization wizard.

Examples

The following example illustrates restoring the system to factory defaults.


Step 1 se-10-0-0-0# offline

This command puts the system into offline mode.

Step 2 (offline)# restore factory default

This operation will cause all the configuration and data on the system to be erased. This 
operation is not reversible. Do you wish to continue? (n)


Step 3 Do one of the following:

Enter n if want to retain the system configuration and data.

The operation is cancelled, but the system remains in offline mode. To return to online mode, enter continue.

Enter y if you want to erase the system configuration and data.

When the system is clean, a message appears indicating that the system will start to reload. When the reload is complete, a prompt appears to start the postinstallation process.


Related Commands

Command
Description

continue

Returns to the Cisco Unity Express online mode.

offline

Enters the Cisco Unity Express offline mode.


restriction msg-notification dial-string

To specify a dial string for a restriction table, use the restriction msg-notification dial-string command in Cisco Unity Express configuration mode. To delete the dial string from the table, use the no form of this command.

restriction msg-notification dial-string preference preference-number pattern pattern-string {allowed | disallowed} [insert]

no restriction msg-notification dial-string preference preference-number

Syntax Description

preference preference-number

Order of this string in the restriction table. The system searches the strings in order of preference, starting with 1. Valid values are 1 to 10.

pattern pattern-string

Call pattern to be matched. Valid characters are digits 0 to 9, asterisk (*), or dot (.). The table accepts duplicate call patterns.

allowed

Permits phone number s with this patter n to be assigned to message notification devices.

disallowed

Prevents phone numbers with this pattern to be assigned to message notification devices.

insert

Inserts the dial string in the proper place in the table.


Defaults

The default preference number is 1.
The default pattern is *.
The default pattern is allowed.

Command Modes

Cisco Unity Express configuration

Command History

Cisco Unity Express Release
Modification

2.3

This command was introduced.


Usage Guidelines

The asterisk (*) in the pattern allows matches of zero or more digits. The dot (.) acts as a placeholder for exactly one digit. Include external and long distance access codes in the dial pattern.

The default pattern * has preference 1 by default. The administrator can modify this setting.

When a subscriber tries to set up or change a phone number assigned to a device, the system verifies that the number has the allowed number of digits. If it does not, the subscriber receives an error message.

If the number of digits is acceptable, the system checks the number against the dial patterns in the restriction table, starting with the first pattern (preference 1). If the number does not match the first pattern, the system checks the next pattern in the table (preference 2), and so forth until a match is found. If a match is found, the system either permits or restricts the call as specified in the dial string. If no match is found, the subscriber receives an error message.The default pattern * cannot be deleted or modified.

The default pattern * is allowed by default. The administrator can modify this setting.

The system displays an error message if the preference number is less than 1 or greater than 10.

If insert is not used, the system replaces any existing dial string with the given preference with this new dial string. The system displays an error message if no existing dial string has the given preference.

Examples

The following example creates a dial-string allowing calls to area code 222.

se-10-0-0-0# config t
se-10-0-0-0(config)#restriction msg-notification dial-string preference 2 pattern 
91222....... allowed insert

Related Commands

Command
Description

restriction msg-notification max-digits

Specifies the maximum number of digits in a restricted number.

restriction msg-notification min-digits

Specifies the minimum number of digits in a restricted number.


restriction msg-notification max-digits

To specify the maximum number of digits for a notification phone number, use the restriction msg-notification max-digits command in Cisco Unity Express configuration mode. To use the default value, use the no or default form of this command.

restriction msg-notification max-digits maximum-digits

no restriction msg-notification max-digits

default restriction msg-notification max-digits

Syntax Description

maximum-digits

Specifies the maximum number of digits for a notification phone number. Valid values are 1 to 30. The default is 1.


Defaults

Maximum number of digits is 1.

Command Modes

Cisco Unity Express configuration

Command History

Cisco Unity Express Release
Modification

2.3

This command was introduced.


Usage Guidelines

This value applies only to phone devices and numeric pagers.

Maximum number of digits applies to phone numbers that a subscriber assigns to devices that will receive message notifications. When a subscriber tries to set up or change a phone number assigned to a device, the system verifies that the number has the allowed number of digits. If it does not, the subscriber receives an error message.

Examples

The following example sets the maximum number of digits in a phone number for message notification to 15.

se-10-0-0-0# config t
se-10-0-0-0(config)#restriction msg-notification max-digits 15

Related Commands

Command
Description

restriction msg-notification dial-string

Specifies the restricted number dial pattern.

restriction msg-notification min-digits

Specifies the minimum number of digits in a restricted number.


restriction msg-notification min-digits

To specify the minimum number of digits for a notification phone number, use the restriction msg-notification min-digits command in Cisco Unity Express configuration mode. To use the default value, use the no or default form of this command.

restriction msg-notification min-digits minimum-digits

no restriction msg-notification min-digits

default restriction msg-notification min-digits

Syntax Description

minimum-digits

Specifies the minimum number of digits for a notification phone number. Valid values are 1 to 30. The default is 1.


Defaults

Minimum number of digits is 1.

Command Modes

Cisco Unity Express configuration

Command History

Cisco Unity Express Release
Modification

2.3

This command was introduced.


Usage Guidelines

This value applies only to phone devices and numeric pagers.

Minimum number of digits applies to phone numbers that a subscriber assigns to devices that will receive message notifications. When a subscriber tries to set up or change a phone number assigned to a device, the system verifies that the number has the allowed number of digits. If it does not, the subscriber receives an error message.

Examples

The following example sets the minimum number of digits in a phone number for message notification to 6.

se-10-0-0-0# config t
se-10-0-0-0(config)#restriction msg-notification min-digits 6

Related Commands

Command
Description

restriction msg-notification dial-string

Specifies the restricted number dial pattern.

restriction msg-notification max-digits

Specifies the maximum number of digits in a restricted number.