Table Of Contents
Configuring Users and Groups
Prerequisites
Adding and Modifying a User
Required Data for This Procedure
Examples
Examples
Adding and Modifying a Group
Required Data for This Procedure
Examples
Examples
Configuring Privileges
Configuring Users and Groups
Last Updated: June 21, 2007
All configuration and administration functions for Cisco Unity Express are available through the graphical user interface (GUI). However, you may find using the command-line interface (CLI) is more efficient than using the GUI. For example, you may want to create a script to configure a large number of subscribers for a specific system. In this case, the CLI may be more useful.
This chapter describes the commands that would do the following tasks and contains the following sections:
•
Prerequisites
•Adding and Modifying a User
•Adding and Modifying a Group
•Configuring Privileges
Prerequisites
Verify that the telephones and extensions connected to the Cisco Unified CME router or Cisco Unified Communications Manager server are configured. If you have not completed the configuration, see your Cisco Unified Communications Manager administrator guide or Cisco Unified CME administrator guide for the procedures. For Cisco Unified CME systems, you can use the Cisco Unity Express GUI for these procedures.
Adding and Modifying a User
Users, or subscribers, configured in Cisco Unified CME or Cisco Unified Communications Manager may be imported to the Cisco Unity Express database.
•Cisco Unity Express does not automatically synchronize its database with the Cisco Unified Communications Manager database. If a subscriber defined in Cisco Unity Express must be in the Cisco Unified Communications Manager database, go back to Cisco Unified Communications Manager later and define the subscriber there.
•To synchronize the Cisco Unity Express and Cisco Unified CME databases, use the Cisco Unity Express GUI option Administration > Synchronize Information.
The procedure described in this section allows you to create a new user in the system. Use the same commands to modify an existing user's properties.
Cisco Unity Express supports twice as many users as mailboxes. Some subscribers, such as system administrators, may not be assigned a voice mailbox. The maximum number of users is determined by the license of the module. See "Recording a Greeting or Prompt File" on page 53 for the maximum number of users permitted for your module.
Required Data for This Procedure
The following information is required for adding or modifying a user:
•Username—The user ID. The username must be at least 3 and no more than 32 characters in length. Cisco Unity Express allows only letters, numbers, underscore (_), dot (.), and dash (-) in user IDs. User IDs must start with a letter. Do not use spaces in the username.
•(Optional) Full name—First and last name of the subscriber. Enter this name in quotation marks (" ").
•(Optional) Group—Name of an existing group in which this subscriber is a member.
•(Optional) Password—Password for logging into the Cisco Unity Express GUI. The password must be at least 3 and no more than 32 characters. Spaces are not allowed.
•(Optional) PIN—Personal identification number for logging into the TUI. The PIN must be at least 3 and no more than 16 digits.
SUMMARY STEPS
EXEC mode:
1. username userid [create | delete | fullname [first "first-name" | last "last-name" |
display "full-name"] | group group-name | language "language"| password "password" | pin number]
2. show users
or
show user detail username userid
3. copy running-config startup-config
Configuration mode:
1. config t
2. username userid [create | phonenumber phone-number | phonenumberE164 full-number]
3. exit
4. show users
or
show user detail username userid
5. copy running-config startup-config
DETAILED STEPS
EXEC mode:
| |
Command or Action
|
Purpose
|
Step 1 |
username userid [create | delete |
fullname [first "first-name" | last "last-name" | display "full-name"] | group group-name |
language "language" | password "password" | pin number]
Example:
se-10-0-0-0# username user1 create se-10-0-0-0# username user2 fullname display "User 2" se-10-0-0-0# username user2 group sales se-10-0-0-0# username user2 password "green" se-10-0-0-0# username user2 pin 4444 se-10-0-0-0# username user2 delete |
Creates the subscriber with the specified user ID. The optional parameters configure more information for the subscriber: •userid—User ID of the subscriber. The user ID must be at least 2 and no more than 31 characters in length. Cisco Unity Express allows only letters, numbers, underscore (_), dot (.), and dash (-) in user IDs. Do not use spaces in the username. User IDs must start with a letter. •create—Creates the subscriber with no other information. •delete—Deletes an existing subscriber. •fullname—Specifies a full name for this subscriber. This full name appears on telephone displays. •group—Associates this subscriber with an existing group. •language—Specifies the default language used for the specified user. See the Release Notes for Cisco Unity Express 3.1 for a list of available languages. •password—Specifies a password for this subscriber. The password value must be entered within quotation marks (" "). Spaces are not allowed. Acceptable password characters are lowercase letters a to z, uppercase letters A to Z, digits 0 to 9, and the following symbols: - , . + = _ ! @ # $ ^ * ( ) ? / ~ < > & %. •pin—Specifies a personal identification number (PIN) for this subscriber. The subscriber enters this number from the telephone when accessing the voice-mail system. The PIN may contain a maximum number of 16 digits. The asterisk (*) and pound sign (#) may not be used. |
Step 2 |
show users
or show user detail username userid
Example:
se-10-0-0-0# show user detail username user2 |
Displays a list of user IDs for all subscribers configured configured on the system. or Displays the detailed information configured for the specified subscriber. |
Step 3 |
copy running-config startup-config
Example:
se-10-0-0-0# copy running-config startup-config |
Copies the configuration changes to the startup configuration. |
Examples
The following output illustrates the show users and show user detail username commands:
se-10-0-0-0# show user detail username user2
Configuration mode:
| |
Command or Action
|
Purpose
|
Step 1 |
config t
Example:
se-10-0-0-0# config t |
Enters configuration mode. |
Step 2 |
username userid [create | phonenumber phone-number |
phonenumberE164 full-number]
Example:
se-10-0-0-0(config)# username user3 create se-10-0-0-0(config)# username user3 phonenumber 50180 se-10-0-0-0(config)# username user3 phonenumberE164 13335550180 |
Creates the subscriber with the specified user ID. The optional parameters configure more information for the subscriber: •userid—User ID of the subscriber. The user ID must be at least 2 and no more than 31 characters in length. Cisco Unity Express allows only letters, numbers, underscore (_), dot (.), and dash (-) in user IDs. Do not use spaces in the username. User IDs must start with a letter. •create—Creates the subscriber with no other information. •phonenumber—Specifies a number or extension for this subscriber. Spaces or dashes are not allowed. •phonenumberE164—Specifies a telephone number with area code for this subscriber. Spaces or dashes are not allowed. |
Step 3 |
exit
Example:
se-10-0-0-0(config)# exit |
Exits configuration mode. |
Step 4 |
show users
or show user detail username userid
Example:
se-10-0-0-0# show user detail username user2 |
Displays a list of user IDs for all subscribers configured on the system. or Displays the detailed information configured for the specified subscriber. |
Step 5 |
copy running-config startup-config
Example:
se-10-0-0-0# copy running-config startup-config |
Copies the configuration changes to the startup configuration. |
Examples
The following example illustrates configuring a subscriber and the output from the show commands:
se-10-0-0-0(config)# username user3 create
se-10-0-0-0(config)# username user3 phonenumber 50180
se-10-0-0-0(config)# exit
se-10-0-0-0# show user detail username user3
Adding and Modifying a Group
A group is a collection of subscribers, usually with a common function or purpose, such as sales, main office, customer service, or technicians. A group has the following characteristics:
•Members of the group can be individual subscribers or other groups.
•The group is assigned an extension.
•The group may have a mailbox assigned to it.
•A group may have zero or more subscribers as owners. An owner of a group can add and delete members. Additionally, an owner can add and delete other owners to the group.
•Members may belong to more than one group.
•Members can be added to the group using the configuration mode groupname command or using the EXEC mode username command. See "Adding and Modifying a User" for details about the username command.
Note Subscribers must exist before being added to a group. See "Adding and Modifying a User" to configure the subscriber's detailed information.
•Only members have access to the messages in a group's voice mailbox. The owner is not considered a member of the group. If the owner needs to access the group's mailbox, add the owner as a member of the group. (The owner's name appears twice in the group, once as a member and once as the owner.)
•A group may be assigned a privilege level. The privilege level permits the members of the group to access all or a restricted set of administrative functions. Use the show privileges command to display the privilege levels installed on your system. Use the show groups privileges command to display the privileges assigned to each group. See "Configuring Privileges" for more information about privilege levels.
See "Recording a Greeting or Prompt File" on page 53 for the maximum number of groups, owners, and members permitted on your system.
The following procedure allows you to create a new group in the system.
Required Data for This Procedure
The following information is required to define a group:
•EXEC mode:
–Name of group
–(Optional) Description of group
–(Optional) Full name of group
•Configuration mode:
–Name of group
–(Optional) One or more existing user or group IDs to be added as members
–(Optional) One or more existing user IDs to be added as owners
–(Optional) Extension or telephone number of the group
–(Optional) Full E.164 telephone number of the group
–(Optional) Privilege level for the group
SUMMARY STEPS
EXEC mode:
1. groupname userid [create | delete | description "description" | fullname "full-name"]
2. show groups
or
show group detail groupname groupid
3. copy running-config startup-config
Configuration mode:
1. config t
2. groupname groupid [member username | owner ownername | phonenumber phone-number | phonenumberE164 full-number | privilege privilege-id]
3. exit
4. show groups
or
show group detail groupname groupid
5. copy running-config startup-config
DETAILED STEPS
EXEC mode:
| |
Command or Action
|
Purpose
|
Step 1 |
groupname groupid [create | delete | description "description" | fullname "full-name"]
Example:
se-10-0-0-0# groupname sales fullname "Sales Department" se-10-0-0-0# groupname sales description "Retail Sales Department" se-10-0-0-0# groupname sales delete |
Creates the group with the groupid value. The optional parameters configure more information for the group: •create—Creates the group with no other information. •delete—Deletes an existing group. •description—Specifies a description of the group. •fullname—Specifies a long name for the group. |
Step 2 |
show groups
or show group detail groupname groupid
Example:
se-10-0-0-0# show group detail groupname sales |
Displays a list of group IDs for all configured groups. This command does not display the details for the groups. or Displays the detailed configuration information for the group groupid value. |
Step 3 |
copy running-config startup-config
Example:
se-10-0-0-0# copy running-config startup-config |
Copies the configuration changes to the startup configuration. |
Examples
The following example creates a group and displays the output of the show commands:
se-10-0-0-0# groupname sales fullname "Sales Department"
se-10-0-0-0# groupname sales description "CA office"
se-10-0-0-0# show group detail groupname sales
Full Name: Sales Department
Configuration mode:
| |
Command or Action
|
Purpose
|
Step 1 |
config t
Example:
se-10-0-0-0# config t |
Enters configuration mode. |
Step 2 |
groupname groupid [member username | owner ownername | phonenumber phone-number | phonenumberE164 full-number | privilege privilege-id]
Example:
se-10-0-0-0(config)# groupname sales member user1 se-10-0-0-0(config)# groupname sales owner user2 se-10-0-0-0(config)# groupname sales phonenumber 50163 se-10-0-0-0(config)# groupname sales phonenumberE164 14445550163 se-10-0-0-0(config)# groupname sales privilege ManagePrompts |
Creates the group with the groupid value. The optional parameters configure more information for the user: •member—Associates an existing subscriber as a member of this group. Repeat this command to assign multiple subscribers to the group. •owner—Specifies the owner of the group. The owner is not considered a member. If the owner is to have access to the group's voice mailbox, also assign the owner as a member. •phonenumber—Associates a number or extension with this group. No spaces or dashes are allowed. •phonenumberE164—Associates a telephone number and area code with this group. No spaces or dashes are allowed. •privilege—Specifies the privilege level for the group. Members assigned to this group have the designated privilege rights. |
Step 3 |
exit
Example:
se-10-0-0-0(config)# exit |
Exits configuration mode. |
Step 4 |
show groups
or show group detail groupname groupid
Example:
se-10-0-0-0# show group detail groupname sales |
Displays a list of group IDs for all configured groups. This command does not display the details for the groups. Displays the detailed configuration information for the group groupid value. |
Step 5 |
copy running-config startup-config
Example:
se-10-0-0-0# copy running-config startup-config |
Copies the configuration changes to the startup configuration. |
Examples
The following example adds an owner and two members to the group sales and assigns sales a phone number:
se-10-0-0-0(config)# groupname sales member user1
se-10-0-0-0(config)# groupname sales member user2
se-10-0-0-0(config)# groupname sales owner user1
se-10-0-0-0(config)# groupname sales phonenumber 50163
se-10-0-0-0(config)# groupname sales phonenumberE164 12225550163
se-10-0-0-0(config)# groupname sales privilege ManagePrompts
sse-10-0-0-0(config)# exit
se-10-0-0-0(# show groups
se-10-0-0-0# show group detail groupname sales
Full Name: Sales Department
Phone(E.164): 12225550163
Configuring Privileges
The Cisco Unity Express software recognizes these privileges for subscribers:
•Superuser—The superuser privilege permits subscribers to log in to the Cisco Unity Express GUI as an administrator. Additionally, it permits subscribers to record spoken names for remote subscribers and locations through 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.
•local-broadcast—The local-broadcast privilege permits subscribers to send broadcast messages only to subscribers on the local 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 subscriber cannot modify or delete the private lists.
•vm-imap—The vm-imap privilege gives subscribers access to the IMAP feature.
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 Configure> Users.
To display a list of privileges, use the show privileges command in Cisco Unity Express EXEC mode.
To configure a group with a privilege level, see "Adding and Modifying a Group".
Feedback