Cisco Unity Express 2.3 Command Reference
G

Table Of Contents

G

gateway address (ccn subsystem sip)

gateway port (ccn subsystem sip)

groupname

groupname profile (phone-device)

groupname profile email

groupname profile num-pager

groupname profile text-pager


G


Last Updated: July 25, 2006

gateway address (ccn subsystem sip)

gateway port (ccn subsystem sip)

groupname

groupname profile (phone-device)

groupname profile email

groupname profile num-pager

groupname profile text-pager

gateway address (ccn subsystem sip)

To configure the IP address of the SIP proxy server, use the gateway address command in Cisco Unity Express SIP configuration mode. To remove the address, use the no form of this command.

gateway address ip-address

no gateway address

Syntax Description

ip-address

IP address of the SIP proxy server. The default value is 0.0.0.0.


Defaults

IP address 0.0.0.0

Command Modes

Cisco Unity Express SIP configuration

Command History

Cisco Unity Express Release
Modification

1.0

This command was introduced on the Cisco Unity Express network module and in Cisco Unified Communications Manager Express 3.0.

1.1

This command was implemented on the advanced integration module (AIM) and in Cisco Unified Communications Manager 3.3(3).

1.1.2

This command was implemented on the Cisco 2800 series and Cisco 3800 series routers.


Examples

The following example configures a SIP proxy server address of 10.2.34.1:

se-10-0-0-0> enable
se-10-0-0-0# config t
se-10-0-0-0(config)# ccn subsystem sip
se-10-0-0-0(config-sip)# gateway address 10.2.34.1
se-10-0-0-0(config-sip)# end
se-10-0-0-0(config)#

Related Commands

Command
Description

show ccn subsystem sip

Displays details for the SIP subsystem.


gateway port (ccn subsystem sip)

To configure the UDP or TCP port on the SIP proxy server, use the gateway port command in Cisco Unity Express SIP configuration mode. To remove the port, use the no form of this command.

gateway port port-number

no gateway port

Syntax Description

port-number

UDP or TCP port on the SIP proxy server. The default value is 5060.


Defaults

Port 5060

Command Modes

Cisco Unity Express SIP configuration

Command History

Cisco Unity Express Release
Modification

1.0

This command was introduced on the Cisco Unity Express network module and in Cisco Unified Communications Manager Express 3.0.

1.1

This command was implemented on the advanced integration module (AIM) and in Cisco Unified Communications Manager 3.3(3).

1.1.2

This command was implemented on the Cisco 2800 series and Cisco 3800 series routers.


Examples

The following example configures the SIP proxy server port to 23:

se-10-0-0-0> enable
se-10-0-0-0# config t
se-10-0-0-0(config)# ccn subsystem sip
se-10-0-0-0(config-sip)# gateway port 23
se-10-0-0-0(config-sip)# end
se-10-0-0-0(config)#

Related Commands

Command
Description

show ccn subsystem sip

Displays details for the SIP subsystem.


groupname

To configure a Cisco Unity Express group, use the groupname command in either Cisco Unity Express EXEC mode or configuration mode.

EXEC Mode

groupname name [create | delete | description "description" | fullname display "full-name"]

Configuration Mode

groupname name [create | member username | owner ownername | phonenumber phone-number | phonenumberE164 full-number | privilege privilege-name]

Syntax Description

name

The name of the group.

create

(Optional) Creates a group with no other information.

delete

(Optional) Deletes the group.

description "description"

(Optional) Specifies a description of the group. The description must be enclosed in double quotes ("").

fullname display "full-name"

(Optional) Specifies a long name of the group as it should appear on other telephone displays. The name must be entered in double quotes ("").

member username

(Optional) Associates an existing subscriber as a member of this group. If the username value does not exist, this command will create it with no other information.

owner ownername

(Optional) Specifies the subscriber who owns this group.

phonenumber phone-number

(Optional) Associates an extension or number with this group.

phonenumberE164 full-number

(Optional) Associates a full telephone number and area code with this group.

privilege privilege-name

(Optional) Assigns a privilege to the group.


Command Modes

Cisco Unity Express EXEC
Cisco Unity Express configuration

Command History

Cisco Unity Express Release
Modification

1.0

This command was introduced on the Cisco Unity Express network module and in Cisco Unified Communications Manager Express 3.0.

1.1

This command was implemented on the advanced integration module (AIM) and in Cisco Unified Communications Manager 3.3(3).

1.1.2

This command was implemented on the Cisco 2800 series and Cisco 3800 series routers.

2.1

Additional privileges were made available: broadcast, ViewPrivateList, and ManagePublicList.

2.3

The vm-imap and local-broadcast privileges were implemented on the NM-CUE and NM-CUE-EC modules.


Usage Guidelines

The EXEC version of the command stores the permitted information in Cisco Unity Express flash memory. If a problem with the disk occurs, this information is available so that the group members may access the group's voice mailbox.

The configuration version of the command is stored in the Cisco Unity Express system configuration file. If a power outage or a system shutdown occurs, the group information can be retrieved.

Several privileges are available:

Superuser—An administrator, also called a superuser, has the capability, or privilege, of accessing all the configuration and maintenance functions, including the Administration via Telephone (AvT).

ManagePrompts—The prompt management subscriber has access to the AvT but not to any other administrative functions.

Broadcast—The broadcast privilege permits the subscriber to send broadcast messages across the network.

ManagePublicList—The ManagePublicList privilege permits the subscriber to create and modify public distribution lists.

ViewPrivateList—The ViewPrivateList privilege allows the subscriber to view another subscriber's private distribution lists. The ViewPrivateList subscriber can not modify or delete the private lists.

These privilege levels are assigned to a group, and any member of the group is granted the privilege rights. The software initialization process created an Administrator group from the imported subscribers designated as administrators. Other groups can be created with these privileges. Assign subscribers to an existing group using the CLI commands or the GUI option Configuration > Users.

Assign the vm-imap privilege to one or more groups so that the group members can access the integrated messaging feature. Subscribers who are not members of a group with the vm-imap privilege will not be able to access the integrated messaging feature.

To display the current list of privileges, use the show privileges command in Cisco Unity Express EXEC mode. Use the show groups privileges command to display the privileges assigned to each group.

Examples

The following example creates the group Sales with two members, one owner, and two privileges:

se-10-0-0-0> enable
se-10-0-0-0# groupname sales fullname display "Sales New York"
se-10-0-0-0# groupname sales description "Sales group in New York branch"
se-10-0-0-0# config t
se-10-0-0-0(config)# groupname sales phonenumber 50120
se-10-0-0-0(config)# groupname sales phonenumberE164 12225550120
se-10-0-0-0(config)# groupname sales member user4
se-10-0-0-0(config)# groupname sales member user5
se-10-0-0-0(config)# groupname sales owner user6
se-10-0-0-0(config)# groupname sales privilege broadcast
se-10-0-0-0(config)# groupname sales privilege ManagePublicList
se-10-0-0-0(config)# exit

The following example assigns the integrated messaging feature to the sales group:

se-10-0-0-0# config t
se-10-0-0-0(config)# groupname sales privilege vm-imap
se-10-0-0-0(config)# exit

The following example assigns the local broadcast privilege to the engineers group:

se-10-0-0-0# config t
se-10-0-0-0(config)# groupname engineers privilege local-broadcast
se-10-0-0-0(config)# exit

Related Commands

Command
Description

groupname

Configures voice-mail group parameters.

maxsessions (IMAP)

Sets the maximum number of concurrent IMAP sessions.

service imap

Enters IMAP configuration mode.

session idletimeout (IMAP)

Specifies the IMAP session idletimeout value.

session security

Sets the IMAP client connection type.

show group detail groupname

Displays the configuration details for a specific group.

show groups

Displays a list of configured group names.

show groups privileges

Displays the privileges for all configured groups.

show imap configuration

Displays all IMAP configuration parameters.

show imap sessions

Displays all active IMAP sessions.

show privileges

Displays a list of available privileges.

show users

Displays a list of configured usernames.

username

Configures a Cisco Unity Express subscriber.


groupname profile (phone-device)

To configure a group's cell phone for message notification, use the groupname profile (phone device) command in Cisco Unity Express EXEC mode. To remove or deactivate a parameter from the cell phone, use the no or default form of this command.

groupname group-id profile vm-notif-profile {cell-phone | home-phone | work-phone}
{
enable
extra-digits
digits
phonenumber phonenumber
preference {all | urgent}
schedule day day-of-week active from hh:mm to hh:mm}

no groupname group-id profile vm-notif-profile {cell-phone | home-phone | work-phone}
{enable
extra-digits
digits
phonenumber phonenumber
preference {all | urgent}
schedule day day-of-week active from hh:mm to hh:mm}

default groupname group-id profile vm-notif-profile {cell-phone | home-phone | work-phone} preference {all | urgent}

Syntax Description

group-id

ID for the voice-mail group that owns the cell phone.

cell-phone | home-phone | work-phone

Phone device that should receive message notifications.

enable

Enables the device in the group's profile.

extra-digits digits

Extra digits to be sent as DTMF digits. Valid values include numbers 0 to 9, pound or hash mark (#), star (*), and plus (+) for a 1-second pause.

phonenumber phonenumber

Phone number of the group's phone. Valid values include digits 0 to 9.

preference {all | urgent}

Enables the message notification type for the device. all sends all voice messages to the device. urgent sends only urgent messages to the device.

schedule day day-of-week active from hh:mm to hh:mm

Sets a time slot when the device can receive notifications. Valid values for day-of-week are 1 to 7, where 1 is Sunday, 2 is Monday, and so forth. Use the hour and half-hour on the 24-hour clock for the time. Valid values for hh are 00 to 24 and for mm either 00 or 30.


Defaults

Cell phone notifications are disabled.
Default preference is urgent.

Command Modes

Cisco Unity Express EXEC

Command History

Cisco Unity Express Release
Modification

2.3

This command was introduced.


Usage Guidelines

The system creates one default notification profile with the filename vm-notif-profile per group. This filename cannot be changed.

Repeat the command with the schedule parameter to configure more than one time slot. This parameter changes only the specified time slots; the configuration for the other time slots is not changed.

An error message appears for the following conditions:

The group does not exist in the system.

The group does not have a mailbox.

phonenumber is a restricted number.

More than 64 digits are entered for digits.

A valid phone number is not assigned to the device.

The administrator has disabled message notification on a system-wide basis.

The system-wide notification preference is set to urgent and an attempt is made to set this group's preference to all.

The schedule start time is later than the schedule end time.

Using the no or default form of this command results in the following conditions:

no groupname group-id profile vm-notif-profile {cell-phone | home-phone | work-phone} enable disables the sending of notifications to the device.

no groupname group-id profile vm-notif-profile {cell-phone | home-phone | work-phone} extra-digits removes the extra digits assigned to the device.

no groupname group-id profile vm-notif-profile {cell-phone | home-phone | work-phone} phonenumber removes the phone number from the device and automatically disables the device.

no (or default) groupname group-id profile vm-notif-profile {cell-phone | home-phone | work-phone} preference sets the notification preference to urgent.

no groupname group-id profile vm-notif-profile {cell-phone | home-phone | work-phone} schedule day day-of-week active from hh:mm to hh:mm deactivates the sending of notifications for the specified time slot.

Examples

The following example configures the cell phone for group sales:

se-10-0-0-0# groupname sales profile vm-notif-profile cell-phone phonenumber 12225550150
se-10-0-0-0# groupname sales profile vm-notif-profile cell-phone enable
se-10-0-0-0# groupname sales profile vm-notif-profile cell-phone extra-digits 9
se-10-0-0-0# groupname sales profile vm-notif-profile cell-phone all
se-10-0-0-0# groupname sales profile vm-notif-profile cell-phone schedule day 2 active 
from 08:00 to 17:00
se-10-0-0-0# groupname sales profile vm-notif-profile cell-phone schedule day 3 active 
from 08:00 to 12:00
se-10-0-0-0# groupname sales profile vm-notif-profile cell-phone schedule day 4 active 
from 13:00 to 16:00
se-10-0-0-0# groupname sales profile vm-notif-profile cell-phone schedule day 5 active 
from 08:00 to 14:00
se-10-0-0-0# groupname sales profile vm-notif-profile cell-phone schedule day 6 active 
from 08:00 to 17:00

Related Commands

Command
Description

groupname profile email

Configures notification parameters for a group's e-mail.

groupname profile num-pager

Configures notification parameters for a group's numeric pager.

groupname profile text-pager

Configures notification parameters for a group's text pager.

show voicemail notification owner

Displays the voicemail notification configuration for a specified subscriber or group.


groupname profile email

To configure a group's e-mail for message notification, use the groupname profile email command in Cisco Unity Express EXEC mode. To remove or deactivate a parameter from the e-mail device, use the no or default form of this command.

groupname group-id profile vm-notif-profile email
{address email-address
attach
enable
preference {all | urgent}
schedule day day-of-week active from hh:mm to hh:mm
text email-text}

no groupname group-id profile vm-notif-profile email
{address email-address
attach
enable
preference {all | urgent}
schedule day day-of-week active from hh:mm to hh:mm
text email-text}

default groupname group-id profile vm-notif-profile email attach

default groupname group-id profile vm-notif-profile email preference {all | urgent}

Syntax Description

groupname

ID for the voice-mail group who owns the e-mail.

address email-address

E-mail address to which an outgoing text notification will be sent.

attach

Enables a voice message to be attached to the outgoing e-mail notification. The default is disabled.

enable

Enables the device in the group's profile.

preference {all | urgent}

Enables the message notification type for the device. all sends all voice messages to the device. urgent sends only urgent messages to the device.

schedule day day-of-week active from hh:mm to hh:mm

Sets a time slot when the device can receive notifications. Valid values for day-of-week are 1 to 7, where 1 is Sunday, 2 is Monday, and so forth. Use the hour and half-hour on the 24-hour clock for the time. Valid values for hh are 00 to 24 and for mm either 00 or 30.

text email-text

Text of the message that will be appended to the outgoing e-mail notification. The message can contain all alphanumeric characters except question mark (?). The maximum message length is 128 characters.


Defaults

E-mail notifications are disabled.
E-mail attachments are disabled.
Default preference is urgent.

Command Modes

Cisco Unity Express EXEC

Command History

Cisco Unity Express Release
Modification

2.3

This command was introduced.


Usage Guidelines

The system creates one default notification profile with the filename vm-notif-profile per group. This filename cannot be changed.

Repeat the command with the schedule parameter to configure more than one time slot. This parameter changes only the specified time slots; the configuration for the other time slots is not changed.

An error message appears for the following conditions:

The group does not exist in the system.

The group does not have a mailbox.

The administrator has disabled message notification on a system-wide basis.

The administrator has disabled e-mail attachments on a system-wide basis.

E-mail is enabled before the e-mail address is defined.

E-mail is enabled and an SMTP server is not configured.

The system-wide notification preference is set to urgent and an attempt is made to set this group's preference to all.

The schedule start time is later than the schedule end time.

E-mail text contains a question mark (?).

E-mail text is longer than 128 characters.

Using the no or default form of this command results in the following conditions:

no groupname group-id profile vm-notif-profile email enable disables the sending of notifications to the device.

no groupname group-id profile vm-notif-profile email address email-address removes the e-mail address assigned to the device and automatically disables the device.

no (or default) groupname group-id profile vm-notif-profile email attach disables attaching voice messages to outgoing e-mail notifications for this device.

no (or default) groupname group-id profile vm-notif-profile email preference sets the notification preference to urgent.

no groupname group-id profile vm-notif-profile email schedule day day-of-week active from hh:mm to hh:mm deactivates the sending of notifications for the specified time slot.

no groupname group-id profile vm-notif-profile email text removes the text associated with this device.

Examples

The following example configures the cell phone for group sales:

se-10-0-0-0# groupname sales profile vm-notif-profile email address group1@company.com
se-10-0-0-0# groupname sales profile vm-notif-profile email enable
se-10-0-0-0# groupname sales profile vm-notif-profile email attach
se-10-0-0-0# groupname sales profile vm-notif-profile email all
se-10-0-0-0# groupname sales profile vm-notif-profile email schedule day 3 active from 
08:00 to 10:00
se-10-0-0-0# groupname sales profile vm-notif-profile email text "Sales meeting scheduled 
in main office conference room C 1:00-3:00 p.m. 4/19/06"

Related Commands

Command
Description

groupname profile (phone-device)

Configures notification parameters for a group's cell phone.

groupname profile num-pager

Configures notification parameters for a group's numeric pager.

groupname profile text-pager

Configures notification parameters for a group's text pager.

show voicemail notification owner

Displays the voicemail notification configuration for a specified subscriber or group.


groupname profile num-pager

To configure a group's numeric pager for message notification, use the groupname profile num-pager command in Cisco Unity Express EXEC mode. To remove or deactivate a parameter from the home phone, use the no or default form of this command.

groupname group-id profile vm-notif-profile num-pager
{enable
extra-digits
digits
phonenumber phonenumber
preference {all | urgent}
schedule day day-of-week active from hh:mm to hh:mm}

no groupname group-id profile vm-notif-profile num-pager
{enable
extra-digits
digits
phonenumber phonenumber
preference {all | urgent}
schedule day day-of-week active from hh:mm to hh:mm}

default groupname group-id profile vm-notif-profile num-pager preference {all | urgent}

Syntax Description

group-id

ID for the voice-mail group who owns the numeric pager.

enable

Enables the device in the group's profile.

extra-digits digits

Extra digits to be sent as DTMF digits. Valid values include numbers 0 to 9, pound or hash mark (#), star (*), and plus (+) for a 1-second pause.

phonenumber phonenumber

Phone number of the group's numeric pager. Valid values include digits 0 to 9.

preference {all | urgent}

Enables the message notification type for the device. all sends all voice messages to the device. urgent sends only urgent messages to the device.

schedule day day-of-week active from hh:mm to hh:mm

Sets a time slot when the device can receive notifications. Valid values for day-of-week are 1 to 7, where 1 is Sunday, 2 is Monday, and so forth. Use the hour and half-hour on the 24-hour clock for the time. Valid values for hh are 00 to 24 and for mm either 00 or 30.


Defaults

Numeric pager notifications are disabled.
Default preference is urgent.

Command Modes

Cisco Unity Express EXEC

Command History

Cisco Unity Express Release
Modification

2.3

This command was introduced.


Usage Guidelines

The system creates one default notification profile with the filename vm-notif-profile per group. This filename cannot be changed.

Repeat the command with the schedule parameter to configure more than one time slot. This parameter changes only the specified time slots; the configuration for the other time slots is not changed.

An error message appears for the following conditions:

The group does not exist in the system.

The group does not have a mailbox.

phonenumber is a restricted number.

More than 64 digits are entered for digits.

A valid phone number is not assigned to the device.

The administrator has disabled message notification on a system-wide basis.

The system-wide notification preference is set to urgent and an attempt is made to set this group's preference to all.

The schedule start time is later than the schedule end time.

Using the no or default form of this command results in the following conditions:

no groupname group-id profile vm-notif-profile num-pager enable disables the sending of notifications to the device.

no groupname group-id profile vm-notif-profile num-pager extra-digits removes the extra digits assigned to the device.

no groupname group-id profile vm-notif-profile num-pager phonenumber removes the phone number from the device and automatically disables the device.

no (or default) groupname group-id profile vm-notif-profile num-pager preference sets the notification preference to urgent.

no groupname group-id profile vm-notif-profile num-pager schedule day day-of-week active from hh:mm to hh:mm deactivates the sending of notifications for the specified time slot.

Examples

The following example configures the cell phone for group sales:

se-10-0-0-0# groupname sales profile vm-notif-profile num-pager phonenumber 12225550150
se-10-0-0-0# groupname sales profile vm-notif-profile num-pager enable
se-10-0-0-0# groupname sales profile vm-notif-profile num-pager extra-digits 9
se-10-0-0-0# groupname sales profile vm-notif-profile num-pager all
se-10-0-0-0# groupname sales profile vm-notif-profile num-pager schedule day 2 active from 
08:00 to 17:00
se-10-0-0-0# groupname sales profile vm-notif-profile num-pager schedule day 3 active from 
08:00 to 12:00
se-10-0-0-0# groupname sales profile vm-notif-profile num-pager schedule day 4 active from 
13:00 to 16:00
se-10-0-0-0# groupname sales profile vm-notif-profile num-pager schedule day 5 active from 
08:00 to 14:00
se-10-0-0-0# groupname sales profile vm-notif-profile num-pager schedule day 6 active from 
08:00 to 17:00

Related Commands

Command
Description

groupname profile (phone-device)

Configures notification parameters for a group's cell phone.

groupname profile email

Configures notification parameters for a group's e-mail.

groupname profile text-pager

Configures notification parameters for a group's text pager.

show voicemail notification owner

Displays the voicemail notification configuration for a specified subscriber or group.


groupname profile text-pager

To configure a group's text pager for message notification, use the groupname profile text-pager command in Cisco Unity Express EXEC mode. To remove or deactivate a parameter from the text pager device, use the no or default form of this command.

groupname group-id profile vm-notif-profile text-pager
{address email-address
enable
preference {all | urgent}
schedule day day-of-week active from hh:mm to hh:mm
text email-text}

no groupname group-id profile vm-notif-profile text-pager
{address email-address
enable
preference {all | urgent}
schedule day day-of-week active from hh:mm to hh:mm
text message-text}

default groupname group-id profile vm-notif-profile text-pager preference {all | urgent}

Syntax Description

group-id

ID for the voice-mail group who owns the text pager.

address email-address

E-mail address to which an outgoing text notification will be sent.

enable

Enables the device in the group's profile.

preference {all | urgent}

Enables the message notification type for the device. all sends all voice messages to the device. urgent sends only urgent messages to the device.

schedule day day-of-week active from hh:mm to hh:mm

Sets a time slot when the device can receive notifications. Valid values for day-of-week are 1 to 7, where 1 is Sunday, 2 is Monday, and so forth. Use the hour and half-hour on the 24-hour clock for the time. Valid values for hh are 00 to 24 and for mm either 00 or 30.

text message-text

Text of the message that will be appended to the outgoing text pager notification. The message can contain all alphanumeric characters except question mark (?). The maximum message length is 128 characters.


Defaults

Text pager notifications are disabled.
Default preference is urgent.

Command Modes

Cisco Unity Express EXEC

Command History

Cisco Unity Express Release
Modification

2.3

This command was introduced.


Usage Guidelines

The system creates one default notification profile with the filename vm-notif-profile per group. This filename cannot be changed.

Repeat the command with the schedule parameter to configure more than one time slot. This parameter changes only the specified time slots; the configuration for the other time slots is not changed.

An error message appears for the following conditions:

The group does not exist in the system.

The group does not have a mailbox.

The administrator has disabled message notification on a system-wide basis.

Text paging is enabled before the e-mail address is defined.

Text paging is enabled and an SMTP server is not configured.

The system-wide notification preference is set to urgent and an attempt is made to set this group's preference to all.

The schedule start time is later than the schedule end time.

Message text contains a question mark (?).

Message text is longer than 128 characters.

Using the no or default form of this command results in the following conditions:

no groupname group-id profile vm-notif-profile text-pager enable disables the sending of notifications to the device.

no groupname group-id profile vm-notif-profile text-pager address email-address removes the e-mail address assigned to the device and automatically disables the device.

no (or default) groupname group-id profile vm-notif-profile text-pager preference sets the notification preference to urgent.

no groupname group-id profile vm-notif-profile text-pager schedule day day-of-week active from hh:mm to hh:mm deactivates the sending of notifications for the specified time slot.

no groupname group-id profile vm-notif-profile text-pager text removes the text associated with this device.

Examples

The following example configures the cell phone for group sales:

se-10-0-0-0# groupname sales profile vm-notif-profile text-pager address sales@company.com
se-10-0-0-0# groupname sales profile vm-notif-profile text-pager enable
se-10-0-0-0# groupname sales profile vm-notif-profile text-pager all
se-10-0-0-0# groupname sales profile vm-notif-profile text-pager schedule day 3 active 
from 08:00 to 10:00
se-10-0-0-0# groupname sales profile vm-notif-profile text-pager text "Sales meeting 
scheduled in main office conference room C 1:00-3:00 p.m. 4/19/06"

Related Commands

Command
Description

groupname profile (phone-device)

Configures notification parameters for a group's cell phone.

groupname profile email

Configures notification parameters for a group's e-mail.

groupname profile num-pager

Configures notification parameters for a group's numeric pager.

show voicemail notification owner

Displays the voicemail notification configuration for a specified subscriber or group.