Cisco Unified Messaging Gateway Command Reference for 8.0 and Later Versions
B Commands (VPIM)

Table Of Contents

B

block location-id

broadcast-id

broadcast location


B


Last Updated: November 17, 2010

block location-id

broadcast-id

broadcast location

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

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

Use the no form of this command to delete 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 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 cannot include spaces.


Command Default

The default broadcast ID is vpim-id.

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 SBMs to all subscribers on a <Abbreviation>Cisco Unity Express or Cisco Unity endpoint, whether local or remote.

endpoint

Enters endpoint configuration mode to provision endpoints manually.

show broadcast location

Displays subscribers who are authorized to send SBMs to a specified endpoint.

show endpoint

Displays endpoint details.


broadcast location

To enable a subscriber to send an SBM to all subscribers on a specified endpoint, whether local or remote, use the broadcast location command in 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

location-id

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

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