-
Cisco Unified Messaging Gateway Command Reference for 8.0 and Later Versions
-
Using Commands
-
Common Commands
-
A Commands (Common)
-
B Commands (Common)
-
C Commands (Common)
-
D Commands (Common)
-
E Commands (Common)
-
H Commands (Common)
-
I Commands (Common)
-
K Commands (Common)
-
L Commands (Common)
-
M Commands (Common)
-
N Commands (Common)
-
O Commands (Common)
-
P Commands (Common)
-
R Commands (Common)
-
S Commands (Common)
-
T Commands (Common)
-
U Commands (Common)
-
W Commands (Common)
-
- VPIM Commands
- SRSV and E-SRST Commands
-
Feedback
Table Of Contents
show license status application vpim
S
Last Updated: November 17, 2010show license status application vpim
show broadcast location
To display any subscribers who are authorized to send System Broadcast Messages (SBMs) to a specified endpoint, use the show broadcast location command in Cisco UMG EXEC mode.
show broadcast location location-id privilege
Syntax Description
location-id
Numeric string that functions as a system-wide unique identifier. The range is 1 to 10 digits.
Command Modes
Cisco UMG EXEC
Command History
Usage Guidelines
•
The authorized sender has the privilege of being able to send SBMs to all subscribers on any Cisco Unity or <Abbreviation>Cisco Unity Express endpoint, local or remote.
•
•
•
Examples
The following example illustrates the use of the show broadcast location command:
umg-1# show broadcast location 1234 privilegeA total of 1 Authorized Sender(s) have been found for location 1234:4085550100umg-1# endRelated Commands
show ddr timeout
To display the timeout window whose elapse will result in a delayed delivery receipt (DDR), use the show ddr timeout command in Cisco UMG EXEC mode.
show ddr timeout
Syntax Description
This command has no arguments or keywords.
Command Modes
Cisco UMG EXEC
Command History
Usage Guidelines
Use this command to display the DDR timeout.
Examples
The following example sets a DDR timeout, then displays it:
umg-1# config t
umg-1(config)# DDR timeout 2
umg-1(config)# endumg-1# show DDR timeout
Timeout window for DDR is 2 hours
Related Commands
show endpoint
To display a list of the endpoints in the system and their details or a specific endpoint's details, use the show endpoint command in Cisco UMG EXEC mode.
show endpoint { local [ location-id | filter ] } | { network [ location-id | filter string ] }
Syntax Description
Command Modes
Cisco UMG EXEC
Command History
Usage Guidelines
Use this command to display a list of endpoints on the Cisco UMG network, local or remote, or the details for a single specified endpoint, either local or remote.
If there are more than 50 endpoints on the network, you are prompted to provide a filter string.
Examples
The following is sample output for the show endpoint local command.
umg-1# show endpoint localA total of 7 local endpoint(s) have been found:Location Location Endpoint Endpoint Primary SecondaryID Prefix Type Status Gateway Gateway---------------------------------------------------------------------------40000 CUE Online 50000123 CUE Disabled 50000400001 CUE Disabled 50000400002 Interchange Disabled 50000999 Interchange Disabled 50000400000 Unity Disabled 500005555 6505551010 Unity Disabled 50000umg-1#The following is sample output for the show endpoint local location-id command.
umg-1# show endpoint local 999Location Id: 999Hostname: Interchange9Domain: sj.mycompany.comPrefix: 408NAT: DisabledType: InterchangePrimary Gateway ID: 50000Secondary Gateway ID:Status: Disabledumg-1# show endpoint local 40000Location Id: 40000Hostname: 1.1.1.2Domain: 1.1.1.2Prefix:NAT: DisabledType: CUEBroadcast VPIM ID: vpim-broadcastPrimary Gateway ID: 50000Secondary Gateway ID:Status: Auto-Registered-Onlineumg-1#The following is sample output for the show endpoint network command.
umg-1# show endpoint networkA total of 20 network endpoint(s) have been found:Location Location Endpoint Primary SecondaryID Prefix Type Gateway Gateway-----------------------------------------------------------------1 408101 CUE 5100010 408110 CUE 51000100 408200 CUE 51000101 408201 CUE 51000102 408202 CUE 51000103 408203 CUE 51000104 408204 CUE 51000105 408205 CUE 51000106 408206 CUE 51000107 408207 CUE 51000108 408208 CUE 51000109 408209 CUE 5100011 408111 CUE 51000110 408210 CUE 51000111 408211 CUE 51000112 408212 CUE 51000113 408213 CUE 51000114 408214 CUE 51000115 408215 CUE 51000116 408216 CUE 51000umg-1The following is sample output for the show endpoint network location-id command.
umg-1# show endpoint network 115Location Id: 115Hostname: 1.1.1.2Domain: cuesim1Prefix: 408555Type: CUEBroadcast VPIM ID: vpim-broadcastPrimary Gateway ID: 51000Secondary Gateway ID:umg-1# show endpoints network filter 11113 endpoints have been found.111111121113Table 29 describes the categories of information shown in the display.
Related Commands
show license status application vpim
To display the VPIM license status, use the show license status application vpim command in Cisco UMG EXEC mode.
show license status application vpim
Syntax Description
This command has no arguments or keywords.
Command Modes
Cisco UMG EXEC
Command History
Examples
The following are sample outputs for the show license status application vpim command:
umg-1# show license status application vpimvpim enabled: 50 vpim nodesumg-1# show license status application vpimvpim disabled, no activated vpim node license availableRelated Commands
show list
To display a list of the system distribution lists (SDLs) that are configured, use the show list command in Cisco UMG EXEC mode or list manager mode.
show list { number | filter location_id_prefix | name string }
Syntax Description
Command Modes
Cisco UMG list manager (listmgr)
Cisco UMG EXEC
Command History
Usage Guidelines
If an SDL has been configured with a name, that name is displayed.
SDL synchronization across the Cisco UMG system implements version numbers. Each SDL has a tracking version number. Changes to SDL lists will increment the number and this version number can be used to indicate whether multiple messaging gateways' SDL configurations are synchronized.
If no SDLs are configured, the system indicates that.
Examples
The following is sample output from the show list command in both list manager and EXEC modes:
umg-1# show listThe version of system distribution list is 500_20100322035417.A total of 5 System Distribution List(s) have been found:Extension Name-----------------------------------------------1 my-list2 other_list100 admins111 auditors500 usersumg-1# show list filter 1The version of system distribution list is 500_20100322035417.A total of 3 System Distribution List(s) have been found:Extension Name-----------------------------------------------1 my-list100 admins111 auditorsumg-1# show list filter 11The version of system distribution list is 500_20100322035417.A total of 1 System Distribution List(s) have been found:Extension Name-----------------------------------------------111 auditorsRelated Commands
show list privilege
To display the mailbox number of the authorized sender to a specific SDL, use the show list privilege command in Cisco UMG list manager mode.
show list privilege number
Syntax Description
number
SDL number, which is the number an authorized subscriber dials to address a message to this SDL.
Command Modes
Cisco UMG list manager (listmgr)
Cisco UMG EXEC
Command History
Usage Guidelines
The command displays the list name if applicable, list number, and members, and additionally, type of member, whether subscriber or another list.
An error message appears if the specified list does not exist.
Examples
The following is sample output from the show list privilege command:
umg-1# list-managerumg-1(listmgr)# show list privilege 12341 authorized sender(s) has been found for system distribution list 12344505550111Related Commands
show list tracking version
To display an SDL tracking version, use the show list tracking version command in Cisco UMG EXEC mode.
show list tracking version
Syntax Description
This command has no arguments or keywords.
Command Modes
Cisco UMG EXEC
Command History
Usage Guidelines
Use this command to find out whether two messaging gateways are in synch as regards an SDL.
Examples
The following examples illustrate the use of the show list tracking version command:
umg-1# show list tracking versionTracking version is 100Related Commands
show messaging-gateway
To display details for any or all messaging gateways, including the network peer messaging gateways and the current configuring messaging gateway, use the show messaging-gateway command in Cisco UMG EXEC mode.
show messaging-gateway [ location-id ]
Syntax Description
location-id
This is a numeric string that functions as a system-wide unique identifier. The range is 1 to 10 digits.
Command Modes
Cisco UMG EXEC
Command History
Usage Guidelines
Use this command to display details for all the messaging gateways in the network or for a specified messaging gateway: its location ID, its hostname, and whether NAT is enabled or disabled.
Examples
The following is sample output for the show messaging-gateway command:
umg-1# show messaging-gateway 101Location ID Hostname NAT101 1,100.1.1 disabledLocal Gateway ID: 101umg-1#Related Commands
show nat location
To list out configured NAT entries, use the show nat location command in Cisco UMG EXEC mode.
show nat location location-id
Syntax Description
location-id
A numeric string that functions as a system-wide unique identifier. The range is 1 to 10 digits.
Command Modes
Cisco UMG EXEC
Command History
Examples
The following example illustrates the use of the show nat location command:
umg-1# config tEnter configuration commands, one per line. End with CNTL/Z.umg-1(config)# nat location 777777umg-1(config-nat)# http external 192.0.2.24umg-1(config-nat)# endumg-1(config)# endumg-1# show nat location 777777Protocol Ext-IP Ext-Port----------------------------------------HTTP 192.0.2.24 26umg-1#Related Commands
show ndr timeout
To display the timeout window whose elapse will result in a non-delivery receipt (NDR), use the show ndr timeout command in Cisco UMG EXEC mode.
show ndr timeout
Syntax Description
This command has no arguments or keywords.
Command Modes
Cisco UMG configuration EXEC
Command History
Usage Guidelines
Use this command to display the NDR timeout. If the NDR is not set, the timeout shown is six hours.
Examples
The following example sets an NDR timeout, then displays it:
umg-1# config t
umg-1(config)# NDR timeout 12
umg-1(config)# exitumg-1# show NDR timeout
Timeout window for NDR is 12 hours
Related Commands
show network default-route
To display the default destination for messages that Cisco UMG cannot deliver, use the show network default-route command in Cisco UMG EXEC mode.
show network default-route
Syntax Description
This command has no arguments or keywords.
Command Modes
Cisco UMG EXEC
Command History
Usage Guidelines
Use this command to display the default destination (either an endpoint or a peer messaging gateway) where a message is sent if the system cannot deliver it.
Examples
The following example illustrates the use of the show network default-route command:
umg-1# configumg-1(config)# network default-route 777umg-1(config)# endumg-1# show network default-routeDefault route is location 777.umg-1#Related Commands
show registration
To display the registration configurations and endpoint registration status on the current configuring messaging gateway, use the show registration command in Cisco UMG EXEC mode.
show registration { block | status | users}
Syntax Description
Command Modes
Cisco UMG EXEC
Command History
Examples
The following example illustrates the use of the show registration command:
umg-1# show registration usersumg registration users :username 1234username aaaaumg-1# show registration blockumg registration block list :location-id 34location-id 12umg-1# show registration statusEndpoint registration stats :Auto-registered : 1Offline : 2Total number : 3Auto-registered endpoint :Loc. 23 : cue, registered atTue Aug 21 17:09:08 PDT 2007Offline auto-registered endpoint :Loc. 34 : cue, unreachableLoc. 35 : cue, deregistered
Related Commands
show spoken-name
To display spoken name support on the local Cisco UMG, use the show spoken-name command in Cisco UMG EXEC mode.
show spoken-name
Syntax Description
This command has no arguments or keywords.
Command Modes
Cisco UMG EXEC
Command History
Usage Guidelines
If spoken name support is disabled on Cisco UMG, the spoken names received from <Abbreviation>Cisco Unity Express and/or Cisco Unity will not be stored in the database.
If the network link is slow, we recommend that you disable spoken name support.
We strongly recommend that you set all messaging gateways consistently for spoken name support, either all enabled or all disabled.
Examples
The following is an example of the show spoken-name command:
umg-1# show spoken-nameSpoken-name is enabledRelated Commands
show translation-rule
To display the translation rule for the message or SMTP header for each supported endpoint type, use the show translation-rule command in Cisco UMG EXEC mode.
show translation-rule { smtp | message }
Syntax Description
Command Modes
Cisco UMG EXEC
Command History
Usage Guidelines
<Abbreviation>Cisco Unity Express utilizes the "SMTP Envelope To:" data to route voice messages for delivery. Cisco Unity uses the "Message Header To:" line, and Avaya Interchange uses the "SMTP Envelope From:" and the "Message Envelope From:".
Do not manipulate the translation rules unless Cisco Tech Support instructs you to do so.
Examples
The following example illustrates the use of the show translation-rule command.
umg-1# show translation-rule messageMessage Translation Rules -CUEFrom User: src-userFrom Host: src-hostTo User: dest-userTo Host: dest-hostUNITYFrom User: src-userFrom Host: to-hostTo User: dest-userTo Host: dest-hostINTERCHANGEFrom User: src-userFrom Host: umg-hostTo User: dest-userTo Host: dest-hostUMGFrom User: src-userFrom Host: src-hostTo User: dest-userTo Host: dest-hostumg-1# show translation-rule smtpSMTP Translation Rules -CUEFrom User: src-userFrom Host: src-hostTo User: dest-userTo Host: dest-hostUNITYFrom User: src-userFrom Host: umg-hostTo User: dest-userTo Host: dest-hostINTERCHANGEFrom User: src-userFrom Host: umg-hostTo User: dest-userTo Host: dest-hostUMGFrom User: src-userFrom Host: src-hostTo User: dest-userTo Host: dest-hostTable 31 lists the significant fields shown in the display.
Related Commands
Configures the translation rule for the message or SMTP header for each supported endpoint.
spoken-name
To enable spoken-name support on the gateway, use the spoken-name command in Cisco UMG configuration mode.
spoken-name { enable | disable}
Syntax Description
Command Modes
Cisco UMG configuration
Command History
Usage Guidelines
If spoken name support is disabled on Cisco UMG, the spoken names received from <Abbreviation>Cisco Unity Express and Cisco Unity will not be stored in the database.
If the network link is slow, we recommend you disable spoken name in directory exchange.
We strongly recommend that you set all peer messaging gateways consistently for spoken name support, either all enabled or all disabled.
Examples
The following illustrates the use of the spoken-name command:
umg-1# config tumg-1(config)# spoken-name enableumg-1(config)# exitumg-1# show spoken-nameSpoken-name is enabledRelated Commands
Displays whether spoken name support is enabled or disabled on the local messaging gateway.