Sun Java System Calendar Server 6.3 Administration Guide

D.19 csuser

The csuser utility works in Schema version 1 mode only. It manages calendar users' LDAP entries, and the users' default calendars. Commands are:


Note –

This utility does not enable users for Address Book as is required for Communications Express. This will have to be done manually with ldapmodify.


If you are using Directory Server, you can also use the ldapsearch and ldapmodify utilities. For information about these utilities, see the Directory Server documentation on the following Web site:

http://docs.sun.com/coll/1316.2

D.19.1 Requirements

D.19.2 Syntax


csuser [-q|-v]
       [-a aces] 
       [-b basedn]
        -m email address 
       [-d domain]
        -f filename
        -g givenname 
       [-k yes|no] 
       [-l langcode] 
        -s surname 
        -y userpassword
       create userid

csuser [-q|-v] 
       [-b basedn] 
       [-d domain] 
       [-h host] 
       list [userid]

csuser [-q|-v] 
       [-b basedn] 
       [-d domain]
       [check|delete|disable|enable|reset] userid

         

The following table describes the commands available for the csuser utility.

Table D–34 csuser Utility Commands

Command  

Description  

check userid

Check if the specified user ID is enabled for calendaring. 

create userid

Create the specified user ID and enable this user to log into Calendar Server. 

delete userid

Delete the specified user ID. 

disable userid

Disables the specified user ID for calendaring by adding icsAllowedServiceAcess="http" to the user's LDAP entry.

enable userid

Enables the specified user ID for calendaring by removing icsAllowedServiceAcess="http" from the user's LDAP entry.

list [userid]

List the calendar attributes for the specified user ID. If user ID is not specified, list attributes for all enabled users. 

If the -h server-name option is included, list the calendar attributes for the specified user ID (or all enabled users) on that back-end server.

reset userid

Reset all calendar attributes for a user ID to their default settings. 

Note: After the calendar attributes for a user ID have been reset, all of the calendar attributes are removed from the user’s LDAP entry, including icsCalendarUser (object class), icsSubscribed, icsCalendarOwned, icsCalendar, and icsDWPHost (if the user is in an LDAP CLD setup). A Calendar Server administrator then cannot create calendars on the user’s behalf.

These attributes are restored in the user’s LDAP entry when the Calendar Server administrator issues a csuser enable command for the user.

version

Display the version of the utility. 

The following table describes the csuser utility command options.

Table D–35 csuser Utility Command Options

Option  

Description  

-v

Run in verbose mode: Display all available information about the command being performed. Default is off. 

-q

Run in quiet mode: 

  • Display no information if the operation is successful (errors, if they occur, are displayed).

  • Suppress confirmation prompting for dangerous commands.

    Default is off.

-b basedn

The base DN to be used for all LDAP users. The default value is taken from the setting local.ugldapbasedn defined in the ics.conf file.

-d domain

Specifies the name of a domain. Default is taken from the service.defaultdomain parameter in the ics.conf file.

-a [aces]

Access Control Entries (ACE's) for a specified calendar. ACE's determine who can access a calendar for group scheduling and the types of permissions they have, such as create, delete, read, and write privileges. An ACE string or Access Control List (ACL), must be enclosed in quotation marks ("").

Default is: 

"@@o^a^r^g;@@o^c^wdeic^g;
@^a^sf^g;@^c^^g;@^p^r^g"

For details about the ACE format, see E.2.9 Calendar Server Services Configuration.

-f filename

File name to specify a password for options that require a password (-y parameter). If you are running csuser from a script, for added security, specify the password in filename.

-g givenname

The user's LDAP given name (first name). This option is required. There is no default. 

-h host

Specifies the name of a back-end server where the user’s calendar resides. This option applies only to the list command. 

-p port

The port number that LDAP server is listening to. The default value is taken from the setting local.ugldapport defined in the ics.conf file.

-k yes|no

If double booking is allowed for a user’s calendar. If yes, the user’s calendar can have more than one event scheduled for the same time slot.

Default is taken from the setting user.allow.doublebook defined in the ics.conf file.

-l [langcode]

Language code. Default is the value of local.sitelanguage in ics.conf.

-m email address

Specifies the LDAP mail attribute (primary email address) for the user. 

-s surname

The user's LDAP surname (last name). This option is required. There is no default. 

D.19.3 Examples


Note –

This command prevents jsmith@sesta.com from logging into Calendar Server to access calendar data, but it does not delete jsmith’s data from the calendar database. If jsmith is currently logged into Calendar Server, he retains access to calendar data until he logs off.