Cisco Unified Messaging Gateway 1.0 Command Reference
R

Table Of Contents

R

registration

reload

restore id

restore factory default


R


Last Updated: April 16, 2010

registration

reload

restore factory default

restore id

registration

To enter registration configuration mode in order to configure autoregistration parameters for endpoints of the type Cisco Unity Express 3.1 and later versions on Cisco Unified Messaging Gateway (Cisco UMG), use the registration command in Cisco UMG configuration mode.

registration

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG configuration (config)

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

After you use the registration command to enter the registration configuration mode, in addition to setting endpoint registration credentials (username and password), you can set the endpoint registration lifetime and block endpoints to prevent them from registering.


Note On the <Abbreviation>Cisco Unity Express side, you must configure the matching connection parameters.


Examples

The following example illustrates the use of the registration command:

umg-1# config t
umg-1(config)# registration
umg-1(config-reg)# username ny password text cue1
umg-1(config-reg)# username dc password text cue2
Leave sub menu to commit the changes

umg-1(config-reg)# expiration 2000

Currently registered endpoint expiration will be unaffected.

umg-1(config-reg)# end

umg-1(config)# end

umg-1# show registration users
UMG registration users :
        username umg-ny password cue1
        username umg-dc password cue2
umg-1#

Related Commands

Command
Description

block location-id

Specifies a Cisco Unity Express 3.1 and later versions endpoint that will be prevented from registering with Cisco UMG.

expiration

Specifies the registration lifetime of autoregistered <Abbreviation>Cisco Unity Express endpoints.

show endpoint

Displays a list of endpoints and their details or a specific endpoint.

show registration

Displays the registration configurations and endpoint registration status on the current configuring messaging gateway.

username

Specifies the registration credentials for autoregistering <Abbreviation>Cisco Unity Express endpoints.


reload

To reboot Cisco Unified Messaging Gateway (Cisco UMG), use the reload command in Cisco UMG EXEC mode or offline mode.

reload [ bootloader ]

Syntax Description

bootloader

Warm boot to the bootloader prompt


Command Default

None

Command Modes

Cisco UMG EXEC

Cisco UMG offline

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command to:

Reboot Cisco UMG after a shutdown command.

Activate the uploaded file information after a restore command or after changing certain configurations.

Cisco UMG is marked `offline' to all locally registered endpoints (that is, those for which the current messaging gateway is the primary messaging gateway) during the reboot process, and it will be necessary for them to reregister when the messaging gateway comes back online.


Caution Doing a reload causes any unsaved configuration data to be lost.

Examples

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

umg# offline
umg(offline)# restore id data3 category data
umg(offline)# reload
Reloading the system will terminate all end user sessions. 
Doing a reload will cause any unsaved configuration data to be lost.
Are you sure you want to reload [y/n] : y

The following example illustrates the use of the reload command to do a warm boot.

umg-1# offline
!!!WARNING!!!: If you are going offline to do a backup, it is recommended
that you save the current running configuration using the 'write' command,
prior to going to the offline state.

Putting the system offline will terminate all end user sessions.

Are you sure you want to go offline[n]? : y
umg-1(offline)# reload ?
  <cr>
  bootloader 

Related Commands

Command
Description

backup category

Backs up system and application data to a backup server.

continue

Exits offline mode and returns to Cisco UMG EXEC mode.

offline

Switches Cisco UMG to offline mode.

restore id

Restores backup files from the backup server.

shutdown

Shuts down Cisco UMG.


restore id

To restore a backup file or factory defaults, use the restore command in Cisco Unified Messaging Gateway (Cisco UMG) offline mode.

restore id backupid category {all | configuration | data}

Syntax Description

backupid

Specifies the backup ID of the file to be restored.

category

Indicates that a data type must be specified.

all

A file of this type contains both configurations and data.

configuration

A file of this type contains local gateway id, gateway peers, manually configured endpoints, credentials, and NAT settings.

data

A file of this type contains local dynamic endpoints, mailboxes and system distribution lists (SDLs).


Command Modes

Cisco UMG offline (offline)

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

Offline mode terminates message forwarding and directory exchange. Consider restoring files when traffic is lightest.

Cisco UMG does not support scheduled restores.

After the restore procedure is complete, use the reload command to reset Cisco UMG so that the restored values take effect.

Use the show backup server command to locate the backup-id value of the file to be restored. The Show backup server command lists all available back copies on the remote backup server.

Examples

The following example restores the file with the backup ID all5, whose file-type is "all".

umg# enable
umg# offline
!!!WARNING!!!: If you are going offline to do a backup, it is recommended that you save 
the current running configuration using the `write' command, prior to going to the offline 
state. Putting the system offline will terminate all end user sessions. Are you sure you 
want to go offline[n]? : y
umg(offline)# restore id all5 category all
umg(offline)# reload

Related Commands

Command
Description

backup category

Specifies the type of data to be backed up and initiates the backup process.

backup revisions

Specifies the maximum number of backup files to be stored at any time.

continue

Takes Cisco UMG from offline mode to online EXEC mode.

offline

Enters offline administration mode.

reload

Reboots Cisco UMG so that restored values take effect.

show backup

Displays backup utility configurations.

show backup history

Displays backup IDs and the status of backup procedures.

show backup server

Displays the details of the most recent backup files.


restore factory default

To restore the system to the factory defaults, use the restore factory default command in Cisco Unified Messaging Gateway (Cisco UMG) offline mode.

restore factory default

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG offline

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines


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

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

Replaces the current database with an empty database.

Initializes the directory table to an empty state.

Erases the startup configuration.

Erases all postinstallation configuration data.

When the system is clean, it displays a message saying that the system will reload, and the system begins to reload. When the reload is complete, the system prompts you to go through the postinstallation process.

Examples

The following example illustrates restoring the system to factory defaults.

umg# offline
umg(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)
umg# y
umg# continue
umg# 

Related Commands

Command
Description

continue

Enters Cisco UMG online mode.

offline

Enters Cisco UMG offline mode.