Cisco Unified Messaging Gateway 1.0 Command Reference
B

Table Of Contents

B

backup category

backup revisions

backup server url

block location-id

broadcast-id

broadcast location


B


Last Updated: April 16, 2010

backup category

backup revisions

backup server url

block location-id

broadcast-id

broadcast location

backup category

To specify the type of data to be backed up and initiate the backup process, use the backup category command in Cisco Unified Messaging Gateway (Cisco UMG) offline-EXEC mode.

backup category { all | configuration | data }

Syntax Description

all

Backup file includes both configuration and data.

configuration

Includes the location ID of the current configuring Cisco UMG, messaging gateway peers, manually provisioned endpoints, registration credentials, and NAT settings.

data

Includes local dynamic endpoints, mailboxes, and System Distribution Lists.


Command Default

All data is backed up.

Command Modes

Cisco UMG offline-EXEC (offline)

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command indicates the content of the backup file to be saved to the FTP server.


Caution We strongly discourage doing the data only type of backup and restore because of its potential to introduce inconsistency between configuration and data files.

The systems assigns a backupid to each backup, and it is this backup ID that you must reference when you restore a file. Use the show backup history command to locate the backup ID of the file you want to restore.

Offline mode terminates message forwarding and directory exchange. We recommend backing up at times when there is little or no messaging activity.

Cisco UMG 1.0 does not support scheduled backups.

Examples

The following examples illustrate the use of all three of the backup category commands:

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)# backup category all
umg-1(offline)# continue
umg-1 en
umg-1#

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)# backup category configuration
umg-1(offline)# continue
umg-1 en
umg-1#

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)# backup category data
umg-1(offline)# continue
umg-1 en
umg-1#

Related Commands

Command
Description

backup revisions

Specifies the number of backup files to store and the server to which they are to be saved.

continue

Enters online mode.

offline

Enters offline mode.

restore id

Restores a backup file.

show backup history

Displays detailed information about backed-up files.

show backup server

Displays detailed information about the backup server.

write

Writes to, erases, copies, or displays the running configuration.


backup revisions

To specify the maximum number of versions of backups to be stored at any one time, use the backup revisions command in Cisco Unified Messaging Gateway (Cisco UMG) configuration mode. To revert to the default setting, five backups, use the no form of this command.

backup revisions nnnn

no backup revisions nnnn

Syntax Description

nnn

Maximum number of backup files to be stored. Values: 1-50.


Command Default

Five backup versions are stored.

Command Modes

Cisco UMG configuration mode (config)

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

Set this parameter when doing your initial configuration. You must do this before you can back up any files.

When setting the maximum number of backup versions, consider the amount of storage space that each backup file requires.

When the system reaches the limit you set, the next backup file overwrites the oldest stored backup file.

The system assigns an identifier to each backup file it makes. This identifier is the backupid. Reference this backup ID value when restoring a file. Use the show backup history command to find out what backup-id the system has assigned to the file you want restored.

You can backup different types of data (dynamically captured data, configuration data or both). The number of backup revisions applies indiscriminately to both types, so that out of a possible total of five backups, you may find three configuration and two data file backups on file. See the backup category command for information about different backup types. See the show backup and show backup history command for information about the backup.

Examples

The following example sets a limit of seven backups.

umg-1# config t
umg-1(config)# backup revisions 7
umg-1(config)# backup server url ftp://branch/umgbackups username ftpusername password 
ftppassword

Related Commands

Command
Description

backup category

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

restore id

Restores a backup file.

show backup

Displays information about the server that is used to store backup files.

show backup history

Displays information about the success or failure of backup and restore procedures.

show backup server

Displays the details of the most recent backup files.


backup server url

To specify the server where backup files are to be stored and its access information, use the backup server url command in Cisco Unified Messaging Gateway (Cisco UMG) configuration mode. To specify no backup server, use the no form of this command.

backup server url backup-ftp-url username backup-ftp-usrname password backup-ftp-password}

no backup {revisions number | server url backup-ftp-url}

Syntax Description

server url backup-ftp-url

URL of the FTP server to which the backup files will be saved.

username ftp_usrname

Username needed to access the FTP server.

password ftp_password

Password needed to access the FTP server.


Command Default

No backup server is set.

Command Modes

Cisco UMG configuration mode (config)

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

Set these parameters when doing your initial configuration. You must do this before you can back up any files.

Consider the amount of storage space available on the FTP server you are specifying. If you have already set the number of backup files to be maintained (using backup revisions), you must choose a server that has space for that quantity of data.

You can back up different types of data (dynamically captured data, configuration data, or both). See the backup category command for information about different backup types. See the show backup history command for information about the backup.

Examples

The following example sets backups to be stored on an FTP server called `ftpinfrastructure' in the umgbackups directory, with the username `ftpusername' and password `ftppassword'.

umg-1# config t
umg-1(config)# backup revisions 7
umg-1(config)# backup server url ftp://ftpinfrastructure/umgbackups username ftpusername 
password ftppassword

Related Commands

Command
Description

backup category

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

backup revisions

Specifies the number of versions of backup files to be stored.

restore id

Restores a backup file.

show backup

Displays information about the server used to store backup files.

show backup history

Displays the success or failure of backup and restore procedures.

show backup server

Displays the details of the most recent backup files.


block location-id

To prevent an endpoint of the type Cisco Unity Express 3.1 and later versions from autoregistering, use the block location-id command in Cisco Unified Messaging Gateway (Cisco UMG) registration-configuration mode. Use the no form of this command to unblock endpoints.

block location-id location-id

no block location-id location-id

Syntax Description

block location-id location-id

Location ID of Cisco Unity Express 3.1 and later versions endpoint to be prevented from autoregistering.


Command Default

No endpoints are blocked.

Command Modes

Cisco UMG registration-configuration (config-reg)

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

Because Cisco UMG allows all appropriately configured endpoints of the type Cisco Unity Express 3.1 and later versions to autoregister, to prevent an endpoint from doing so, you must block it.

Blocking has no impact on already autoregistered endpoints; the action will only take effect when the endpoint registration period expires. To have an immediate impact on an endpoint, first block it, then deregister it by using the no endpoint command. It will be unable to autoregister again immediately because you have already blocked it.

Only Cisco Unity Express 3.1 and later versions can autoregister. To delete endpoints of the type Cisco Unity Express 3.0 and earlier versions, use the clear endpoint command.

Examples

The following example illustrates the use of the block location-id command:

umg-1# config t
umg-1(config)# registration
umg-1(config-reg)# block location-id 4085550100

umg-1(config-reg)# end

umg-1(config)# end

umg-1# show registration block

UMG registration block list :

        location-id 4085551212

umg-1#


Related Commands

Command
Description

clear endpoint

Deletes an autoregistered endpoint.

endpoint

no form of this command deletes a manually provisioned endpoint.

registration

Enters registration mode to configure autoregistration parameters for <Abbreviation>Cisco Unity Express endpoints.

show endpoint

Displays a list of endpoints on the local Cisco UMG.

show registration

Displays the registration configurations, endpoint registration status, and list of blocked endpoints on the current Cisco UMG.


broadcast-id

To provision a broadcast VPIM ID to local endpoints of the type Cisco Unity Express 3.0 and earlier versions, use the broadcast-id command in Cisco Unified Messaging Gateway (Cisco UMG) endpoint configuration mode. To clear the configuration, use the no form of the command.

broadcast-id broadcast-id

no broadcast-id broadcast-id

Syntax Description

broadcast-id

Endpoint's broadcast VPIM ID. This alphanumeric string of up to 15 characters/digits cannot include spaces.


Command Default

The default is vpim-broadcast.

Command Modes

Cisco UMG endpoint configuration mode (config-endpoint).

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command to configure a broadcast VPIM ID to Cisco Unity Express 3.0 and earlier versions. If you are manually provisioning Cisco Unity Express 3.1 and later versions you must use this command.

For autoregistered Cisco Unity Express 3.1 and later versions, Cisco UMG learns the VPIM ID from registration.

Although this command is available to you when you are provisioning Cisco Unity endpoints, you do not need to specify a broadcast VPIM ID for that type of endpoint.

Avaya Interchange and Cisco Unity do not support the System Broadcast Message (SBM) function.

Examples

The following example illustrates the use of the broadcast-id command:

umg-1# config t

umg-1(config)# endpoint 11 cue

umg-1(config-endpoint)# broadcast-id 0100

umg-1(config-endpoint)# end

umg-1(config)# end

umg-1# show endpoint local 11

Location Id: 11

Hostname: cue-11

Domain: cuesim1

Prefix: 408555

NAT: Disabled

Type: CUE

Broadcast VPIM ID: 0100

Primary Gateway ID: 50000

Secondary Gateway ID:

Status: Auto-Registered-Offline

Related Commands

Command
Description

broadcast location

Grants a subscriber the privilege of being an authorized sender for broadcast messages, or in other words, enables a subscriber to send System Broadcast Messages to all subscribers on a <Abbreviation>Cisco Unity Express or Cisco Unity endpoint, whether local or remote.

default

Sets default value.

endpoint

Enters endpoint configuration mode to provision endpoints manually.

show broadcast location

Displays subscribers who are authorized to send System Broadcast Messages (SBMs) to a specified endpoint.

show endpoint

Displays endpoint details.


broadcast location

To enable a subscriber to send a System Broadcast Message (SBM) to all subscribers on a specified endpoint, whether local or remote, use the broadcast location command in Cisco Unified Messaging Gateway (Cisco UMG) configuration mode. To revoke the privilege, use the no form of the command.

broadcast location location-id privilege number

no broadcast location location-id privilege number

Syntax Description

broadcast location location-id

Location ID of the endpoint where the message is to be broadcast.

number

Telephone number of the authorized sender.


Command Default

There is no authorized sender.

Command Modes

Cisco UMG configuration mode (config)

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

Authorized senders can send SBMs to any endpoint, local or remote, for which they have the privilege. It is not possible to send one SBM to all endpoints simultaneously; however, the same SBM can be sent to all endpoints in succession.

The number the authorized sender dials to send an SBM is the endpoint's location ID.

You can grant this privilege to any number of subscribers.

Avaya Interchange and Cisco Unity do not support the SBM function.

Use the broadcast location command only for local endpoints (those for which the current configuring Cisco UMG is the primary or secondary messaging gateway). The broadcast privilege is not verified from remote messaging gateways.


Note No SBMs can be sent to an endpoint unless you create at least one authorized sender for the endpoint.


Examples

The following example illustrates the use of the broadcast location command:

umg-1# config
umg-1(config)# broadcast location 11 privilege 4085550101
umg-1(config)# end
umg-1# show broadcast location 11 privilege
A total of 1 Authorized Sender(s) have been found for location 11:
4085550101
umg-1# end

Related Commands

Command
Description

broadcast-id

Provisions a broadcast VPIM ID to a local <Abbreviation>Cisco Unity Express endpoint.

show broadcast location

Verifies whether there are any subscribers who are authorized to send broadcast messages to that endpoint.