Cisco Unified Messaging Gateway Command Reference for 8.0 and Later Versions
R Commands (Common)

Table Of Contents

R

reload

repeat daily (backup-schedule)

repeat daily (kron-schedule)

repeat every (backup-schedule)

repeat every (kron-schedule)

repeat monthly (backup-schedule)

repeat monthly (kron-schedule)

repeat once (backup-schedule)

repeat once (kron-schedule)

repeat weekly (backup-schedule)

repeat weekly (kron-schedule)

repeat yearly (backup-schedule)

repeat yearly (kron-schedule)

restore id

restore factory default


R


Last Updated: November 17, 2010

reload

repeat daily (backup-schedule)

repeat daily (kron-schedule)

repeat every (backup-schedule)

repeat every (kron-schedule)

repeat monthly (backup-schedule)

repeat monthly (kron-schedule)

repeat once (backup-schedule)

repeat once (kron-schedule)

repeat weekly (backup-schedule)

repeat weekly (kron-schedule)

repeat yearly (backup-schedule)

repeat yearly (kron-schedule)

restore factory default

restore id

reload

To reboot 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.


repeat daily (backup-schedule)

To configure a recurring scheduled backup to occur once every day, use the repeat daily command in Cisco UMG scheduled backup configuration mode. Use the no or default form of this command to remove the configuration of the backup job.

repeat daily at time

no repeat daily at time

Syntax Description

time

Specifies the time of day that the recurring scheduled backup job begins. Use 24-hour format.


Command Default

None.

Command Modes

Cisco UMG scheduled backup configuration (backup-schedule)

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

When you enter a new repeat daily command, the previous scheduled daily backup is overwritten.

You can also configure the following parameters for backup jobs:

start date for recurring backup jobs

end date for recurring backup jobs

Examples

The following example configures a scheduled backup to occur once every day at 11:00pm:

umg-1# schedule job 22

umg-1(backup-schedule)# repeat daily at 23:00

Related Commands

Command
Description

backup schedule

Enters backup-schedule submode.


repeat daily (kron-schedule)

To configure a recurring kron job to occur once every day, use the repeat daily command in Cisco UMG kron-schedule configuration mode. There is no no form of this command.

repeat daily at time

Syntax Description

time

Specifies the time of day that the recurring kron job begins. Use 24-hour format.


Command Default

None.

Command Modes

Cisco UMG kron-schedule configuration

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

When you enter a new repeat daily command, the previous scheduled kron job is overwritten.

You can also configure the following parameters for kron jobs:

start date for recurring kron jobs

end date for recurring kron jobs

Examples

The following example configures a scheduled kron job to occur once every day at 11:00pm:

umg-1# kron job krj1

umg-1(kron-schedule)# repeat daily at 23:00

Related Commands

Command
Description

kron schedule

Enters kron-schedule configuration mode.

show kron schedule detail job

Shows details for the specified recurring scheduled kron job.


repeat every (backup-schedule)

To specify how often a recurring scheduled backup occurs, use the repeat every command in Cisco UMG scheduled backup configuration mode. Use the no or default form of this command to remove the configuration of the backup job.

repeat every {number days |number weeks on day | number months on day date | number years on month month} at time

no repeat every {number days |number weeks on day | number months on day date | number years on month month} at time

Syntax Description

number days

Specifies the number of days between recurring scheduled backup jobs that the backup job is done.

number weeks on day

Specifies the number of weeks between recurring scheduled backup jobs and the day of the week that the backup is done.

number months on day date

Specifies the number of months between recurring scheduled backup jobs and the day of the month that the backup is done.

number years on month month

Specifies the number of years between recurring scheduled backup jobs and the month that the backup is done.

at time

Specifies the time of day that the recurring scheduled backup job begins. Use 24-hour format.


Command Default

None.

Command Modes

Cisco UMG scheduled backup configuration (backup-schedule)

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command enters backup-schedule mode and enables you to configure a recurring backup job that repeats:

Every N days at a specific time

Every N weeks on specific day and time

Every N months on a specific day of the month and time

Every N years on a specific month


Note To configure a one-time backup job, use the repeat once command.


You can also configure the following parameters for backup jobs:

start date for recurring backup jobs

end date for recurring backup jobs

Examples

The following example configures a scheduled backup to occur every 7 days at 11:00pm:

umg-1# schedule job 22

umg-1(backup-schedule)# repeat every 7 days at 23:00

Related Commands

Command
Description

backup schedule

Enters backup-schedule submode.


repeat every (kron-schedule)

To specify how often a recurring scheduled kron job occurs, use the repeat every command in Cisco UMG kron-schedule configuration mode. There is no no form of this command.

repeat every {number days | number weeks on day | number months on day date | number years on month month} at time

Syntax Description

number days

Specifies the number of days between recurring scheduled kron jobs that the backup job is done.

number weeks on day

Specifies the number of weeks between recurring scheduled kron jobs and the day of the week that the backup is done.

number months on day date

Specifies the number of months between recurring scheduled kron jobs and the day of the month that the backup is done.

number years on month month

Specifies the number of years between recurring scheduled kron jobs and the month that the backup is done.

at time

Specifies the time of day that the recurring scheduled kron job begins. Use 24-hour format.


Command Default

None.

Command Modes

Cisco UMG kron-schedule configuration

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command enables you to configure a recurring scheduled kron job that repeats:

Every N days at a specific time

Every N weeks on specific day and time

Every N months on a specific day of the month and time

Every N years on a specific month


Note To configure a one-time kron job, use the repeat once command.


You can also configure the following parameters for kron jobs:

start date for recurring kron jobs

end date for recurring kron jobs

Examples

The following example configures a scheduled kron job to occur every 7 days at 11:00 pm:

umg-1# kron schedule krj1

umg-1(kron-schedule)# repeat every 7 days at 23:00

Related Commands

Command
Description

kron schedule

Enters kron-schedule configuration mode.

show kron schedule detail job

Shows details for the specified recurring scheduled kron job.


repeat monthly (backup-schedule)

To configure a recurring scheduled backup to occur once every month, use the repeat monthly command in Cisco UMG scheduled backup configuration mode. Use the no or default form of this command to remove the configuration of the backup job.

repeat monthly on day date at time

no repeat monthly on day date at time

Syntax Description

date

Specifies the day of the month that the backup is done.

time

Specifies the time of day that the recurring scheduled backup job begins. Use 24-hour format.


Command Default

None.

Command Modes

Cisco UMG scheduled backup configuration (backup-schedule)

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

When you enter a new repeat monthly command, the previous scheduled monthly backup is overwritten.

You can also configure the following parameters for backup jobs:

start date for recurring backup jobs

end date for recurring backup jobs

Examples

The following example configures a scheduled backup to occur once every month on the 23rd day at 11:00 pm:

umg-1# schedule job 22

umg-1(backup-schedule)# repeat monthly on day 23 at 23:00

Related Commands

Command
Description

backup categories

Enters backup-schedule submode.


repeat monthly (kron-schedule)

To configure a recurring scheduled kron job to occur once every month, use the repeat monthly command in Cisco UMG kron-schedule configuration mode. There is no no form of this command.

repeat monthly on day date at time

Syntax Description

date

Specifies the day of the month that the kron job is done.

time

Specifies the time of day that the recurring scheduled kron job begins. Use 24-hour format.


Command Default

None.

Command Modes

Cisco UMG kron-schedule configuration

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

When you enter a new repeat monthly command, the previous scheduled kron job is overwritten.

You can also configure the following parameters for kron jobs:

start date for recurring kron jobs

end date for recurring kron jobs

Examples

The following example configures a scheduled backup to occur once every month on the 23rd day at 11:00 pm:

umg-1# kron schedule krj1

umg-1(kron-schedule)# repeat monthly on day 23 at 23:00

Related Commands

Command
Description

kron schedule

Enters kron-schedule configuration mode.

show kron schedule detail job

Shows details for the specified recurring scheduled kron job.


repeat once (backup-schedule)

To specify that a scheduled backup occurs once, use the schedule once command in Cisco UMG scheduled backup configuration mode. Use the no or default form of this command to remove the configuration of the backup job.

repeat once on date at time

no repeat once on date at time

default repeat once on date at time

Syntax Description

date

Specifies the date that the recurring scheduled backup job begins.

time

Specifies the time of day that the recurring scheduled backup job begins. Use 24-hour format.


Command Default

None.

Command Modes

Cisco UMG scheduled backup configuration (backup-schedule)

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command enters backup-schedule mode and enables you to configure a one-time backup job.

Examples

The following example configures a one-time scheduled backup:

umg-1# schedule job 22

umg-1(backup-schedule)# repeat once on October 10, 2009 at 22:20

Related Commands

Command
Description

backup schedule

Enters backup-schedule submode.


repeat once (kron-schedule)

To specify that a scheduled kron job occurs once, use the schedule once command in Cisco UMG kron-schedule configuration mode. There is no no form of this command.

repeat once on date at time

default repeat once on date at time

Syntax Description

date

Specifies the date that the recurring scheduled kron job is done.

time

Specifies the time of day that the recurring scheduled kron job begins. Use 24-hour format.


Command Default

None.

Command Modes

Cisco UMG kron-schedule configuration

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command enables you to configure a one-time scheduled kron job.

Examples

The following example configures a one-time scheduled kron job:

umg-1# kron-schedule krj1

umg-1(kron-schedule)# repeat once on October 10, 2009 at 22:20

Related Commands

Command
Description

kron schedule

Enters kron-schedule configuration mode.

show kron schedule detail job

Shows details for the specified recurring scheduled kron job.


repeat weekly (backup-schedule)

To configure a recurring scheduled backup to occur once every week, use the repeat weekly command in Cisco UMG scheduled backup configuration mode. Use the no or default form of this command to remove the configuration of the backup job.

repeat weekly on day at time

no repeat weekly on day at time

Syntax Description

day

Specifies the day of the week that the backup is done.

time

Specifies the time of day that the recurring scheduled backup job begins. Use 24-hour format.


Command Default

None.

Command Modes

Cisco UMG scheduled backup configuration (backup-schedule)

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

When you enter a new repeat weekly command, the previous scheduled weekly backup is overwritten.

You can also configure the following parameters for backup jobs:

start date for recurring backup jobs

end date for recurring backup jobs

Examples

The following example configures a scheduled backup to occur once every week on Tuesday at 11:00 pm:

umg-1# schedule job 22

umg-1(backup-schedule)# repeat weekly on tuesday at 23:00

Related Commands

Command
Description

backup schedule

Enters backup-schedule submode.


repeat weekly (kron-schedule)

To configure a recurring scheduled kron job to occur once every week, use the repeat weekly command in Cisco UMG kron-schedule configuration mode. There is no no form of this command.

repeat weekly on day at time

Syntax Description

day

Specifies the day of the week that the backup is done.

time

Specifies the time of day that the recurring scheduled backup job begins. Use 24-hour format.


Command Default

None.

Command Modes

Cisco UMG kron-schedule configuration

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

When you enter a new repeat weekly command, the previous scheduled weekly kron job is overwritten.

You can also configure the following parameters for backup jobs:

start date for recurring backup jobs

end date for recurring backup jobs

Examples

The following example configures a scheduled backup to occur once every week on Tuesday at 11:00 pm:

umg-1# kron schedule krj1

umg-1(backup-schedule)# repeat weekly on tuesday at 23:00

Related Commands

Command
Description

kron schedule

Enters kron-schedule configuration mode.

show kron schedule detail job

Shows details for the specified recurring scheduled kron job.


repeat yearly (backup-schedule)

To configure a recurring scheduled backup to occur once every year, use the repeat yearly command in Cisco UMG scheduled backup configuration mode. Use the no or default form of this command to remove the configuration of the backup job.

repeat yearly on month month on day day at time

no repeat yearly on month month on day day at time

Syntax Description

month

Specifies the month that the backup is done.

day

Specifies the day of the month the scheduled backup is done.

time

Specifies the time of day that the recurring scheduled backup job begins. Use 24-hour format.


Command Default

None.

Command Modes

Cisco UMG scheduled backup configuration (backup-schedule)

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

When you enter a new repeat yearly command, the previous scheduled yearly backup is overwritten.

You can also configure the following parameters for backup jobs:

start date for recurring backup jobs

end date for recurring backup jobs

Examples

The following example configures a scheduled backup to occur once a year on February 28 at 11:00 pm

umg-1# schedule job 22

umg-1(backup-schedule)# repeat yearly on month february on day 28 at 23:00

Related Commands

Command
Description

backup schedule

Enters backup-schedule submode.


repeat yearly (kron-schedule)

To configure a recurring scheduled kron job to occur once every year, use the repeat yearly command in Cisco UMG kron-schedule configuration mode. There is no no form of this command.

repeat yearly on month month on day day at time

Syntax Description

month

Specifies the month that the kron job is done.

day

Specifies the day of the month the kron job is done.

time

Specifies the time of day that the recurring scheduled kron job begins. Use 24-hour format.


Command Default

None.

Command Modes

Cisco UMG kron-schedule configuration

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

When you enter a new repeat yearly command, the previous scheduled yearly kron job is overwritten.

You can also configure the following parameters for backup jobs:

start date for recurring backup jobs

end date for recurring backup jobs

Examples

The following example configures a scheduled kron job to occur once a year on February 28 at 11:00 pm:

umg-1# kron schedule krj1

umg-1(kron-schedule)# repeat yearly on month february on day 28 at 23:00

Related Commands

Command
Description

kron schedule

Enters kron-schedule configuration mode.

show kron schedule detail job

Shows details for the specified recurring scheduled kron job.


restore id

To restore a backup file or factory defaults, use the restore command in 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 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

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 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.