TOC PREV NEXT INDEX

CorporateTime Server

Reference Manual

View in pdf format
Go to Administrator's Guide


Utilities


This appendix contains full instructions on the usage and syntax of all utilities shipped with your calendar server. Note that the installation script does not install UNIX-only utilities on Windows NT platforms. All utilities are installed in the /users/unison/bin directory.

The following table lists all utilities in alphabetical order.
Table C.1 · Calendar server utilities
Script Function Page
UNIADDNODE Create a new calendar server node or re-initialize an existing one 121
UNIADMRIGHTS Manage the administration rights of users. 124
UNIARCH (UNIX ONLY) Create a tar archive of the calendar server. 128
UNICHECK (UNIX ONLY) Verify the calendar server file system. 130
UNICKSUM Generate a checksum for a file. 132
UNICLEAN (UNIX ONLY) Clean up the calendar server file system (remove transient files and set permissions). 133
UNICLR_IPC (UNIX ONLY) Clear IPC resources consumed by the calendar server. 134
UNICPINR Copy resource data from a file created by unicpoutr to a calendar server node. 135
UNICPINU Copy the contents of a file of user data created by unicpoutu to a calendar server node. 141
UNICPOUTR Copy resource data from a calendar server node into a file. 148
UNICPOUTU Copy user data from a calendar server node to a file. 153
UNICPR Format of the file created by unicpoutr and read by unicpinr. 158
UNICPU Format of the file created by unicpoutu and read by unicpinu. 141
UNIDBBACKUP Create an archive of the calendar server. 166
UNIDBCONV Convert a version 2.50 or 2.60 CorporateTime node database to a 2.61 CorporateTime node database. 169
UNIDBFIX Check, repair, defragment and maintain a calendar server node database. 170
UNIDBRESTORE Restore the contents of a calendar server from a backup created by unidbbackup. 178
UNIDOMAIN Create a calendar domain. 181
UNIDSACISETUP Set the access control information in the directory server for the calendar server ADMIN group. (external directory only) 186
UNIDSDIFF Find and delete differences between a calendar server node and a directory server. (external directory only) 188
UNIDSSEARCH List all users in a directory server who are not calendar server users. (external directory only) 190
UNIDSSYNC Synchronize the information in a calendar server node with that in a directory server. (external directory only) 193
UNIDSUP Report the status of the directory server. (external directory only) 195
UNIGRPLS Display both the public and administrative groups in a calendar server database. 196
UNILOGONS Display calendar server SIGNON/SIGNOFF statistics. 198
UNIMVUSER Move a user from one calendar server node to another. 203
UNINODE Administer a calendar server node network. 209
UNIPASSWD Change a user password on a calendar server database. 216
UNIPING Ping a calendar server node or nodes. 220
UNIREQDUMP View, and optionally delete, requests in the queue of the Corporate-Wide Services (CWS) daemon. 223
UNIRES List, add, or delete calendar server resources, or modify the information associated with them. 227
UNIRMOLD Remove old events and tasks from agendas in a calendar server database. 236
UNIRNDEL Delete a remote node from a local calendar server node database. 240
UNIRNSYNCH Propagate deletions in the local information of one node to another node in the network. 241
UNISIZEOF Compute the size of the calendar server installation. 243
UNISLICE (UNIX ONLY) Extract information from calendar server log files. 245
UNISNADD Add serial numbers to a calendar server node 247
UNISNAPSHOT Compile calendar server information for diagnostic purposes. 249
UNISNCDUMP Retrieve statistics from the calendar server's Synchronous Network Connection daemon/service. 252
UNISTART Start up the calendar server. 254
UNISTAT Produce a report on a calendar server node. 256
UNISTATS Display summary statistics of the data in a calendar server stats file. 258
UNISTATUS Determine the status of the calendar server. 264
UNISTOP Shut down the calendar server. 267
UNISYNCREFRESH Refresh synchronization records. 270
UNITZINFO Print information about a calendar server time zone. 272
UNIUSER List, add, or delete calendar users; modify the information associated with them. 274
UNIVERSION Verify the version of the calendar server. 285
UNIWHATOS (UNIX ONLY) Determine whether the the calendar server package runs under the current operating system. 287
UNIWHO Display information on signed-on calendar users. 288

UNIADDNODE

uniaddnode - Create a new calendar server node or re-initialize an existing one.

SYNTAX

Internal Directory

uniaddnode -n <node-ID> [-t <timezone>] [-a <nodealias>] [-r] [-y]

Directory Server

uniaddnode -n <node-ID> -w <DmPsw> [-p <SysOpPsw>] [-t <timezone>] [-a <nodealias>] [-r] [-y]

uniaddnode -v

uniaddnode -h

DESCRIPTION

This utility creates and initializes a new calendar server node for use with either an internal directory or a directory server. It can also re-initialize an existing node.

uniaddnode runs only if the calendar server is down.

OPTIONS

-a

<nodealias>

Specify an alias for the node. <nodealias> is a descriptive word (it cannot contain spaces).

-n

<node-ID>

Specify the node-ID. The node-ID must be unique across all nodes in the network.

-p

<SysOpPsw>

Provide the SYSOP password for the node. This option is only required for directory servers. If the password is not provided on the command line, prompting for it occurs. For internal directories, the SYSOP password can be set after creation of the node using the unipasswd utility.

-r

Re-initialize the node.


WARNING:

All existing node data is lost.


Note that in the case of a directory server, all users and resources must first be removed from the node before it can be re-initialized.

-t

<timezone>

Specify a time zone for the node. The default is the time zone set during installation of the calendar server. Time zones can be obtained from Reference Appendix D, "Time Zone Table," the unitzinfo utility, or the /users/unison/misc/timezone.ini file.

-w

<DmPsw>

Provide the directory server password for unrestricted access (i.e. the password associated with the value of the [LDAP] mgrdn parameter in the unison.ini file). This option is only required for installations using a directory server. If the password is not specified on the command line, prompting for it occurs.

-y

Used with the -r option to auto-confirm the re-initialization.

-v

Print the current version number of uniaddnode.

-h

Print a usage message explaining how to run uniaddnode.

EXAMPLES

FILES

/users/unison/misc/unison.ini

This is the calendar server configuration file. For each new node, a node entry is created in this file by the uniaddnode utility.

EXIT STATUS

Exit values are:
0 Success
Any non-zero value signals an error.

UNIADMRIGHTS

uniadmrights - Manage the administration rights of users.

SYNTAX

uniadmrights [-ls] [[-hday] [-pgrp] [-opgrp] | -all] [-n <node-ID>] [-host <hostname>] [-p <SysOpPsw>]

uniadmrights -e <user> [-add | -del] [[-hday] [-pgrp] [-opgrp] | -all] [-n <node-ID>] [-host <hostname>] [-p <SysOpPsw>]

uniadmrights -default [-add | -del] [[-hday] [-pgrp] [-opgrp] | -all] [-n <node-ID>] [-host <hostname>] [-p <SysOpPsw>]

uniadmrights -v

uniadmrights -h

DESCRIPTION

This utility allows the SYSOP to grant certain administration rights to users as well as to revoke these rights. It can also be used to determine the rights held by each user.

The existing rights are granted on a per-node basis and apply to:

By default, uniadmrights lists ALL rights that have been granted by the SYSOP. Note that the -ls option is mutually exclusive with the -add option, and with the -del option.

The calendar server must be up to run uniadmrights.

NOTE

Use the ManageHolidays, ManageAdmGroups, and CreatePublicGroups keywords in the user.ini file to automatically grant one or more of these administration rights on user creation.

OPTIONS

-add

Grant a right. Used with the -e option.

-all

Add or delete ALL rights held by the user when used with the -e option (and either the -add or -del option). List all users holding rights when used with the -ls option.

-default

Set rights for all users with the default administrative rights profile (applied when the ManageAdmGroups, ManageResources and ManageHolidays parameters are not present in or are commented out of user.ini).

-del

Remove a right. Used with the -e option.

-e

<user>

Specify the user. If more than one match for the user is found in the database, uniadmrights fails. If no action (-add/-del/-all) is specified along with this option, the default behaviour is to grant the specified right(s) to the user; if no rights are specified, ALL rights are granted to the user. See FORMAT OF THE <user> ARGUMENT for details on the <user> argument.

-hday

The holiday administration right. This right allows the user to set which holidays appear in the agendas of all users in the node. Note that no designates are associated with holiday administration; only those users granted the holiday right by the SYSOP may administer holidays.

-host

<hostname>

Specify the host. Required if the host is remote.

-ls

List all granted rights. This is the default behaviour when no option has been specified.

-n

<node-ID>

Specify the node. Required if more than one node exists on the host.

-opgrp

The public groups right. Allows the user to create public groups. The user, as owner of the public group, can make modifications to the group as well as delete the group itself. Since there are no designates associated with a public group, only its creator (owner) will be able to make modifications to it, or delete it.

-p

<SysOpPsw>

Provide the SYSOP password; required if one is set. If this option is not used and a password is required, uniadmrights prompts the user for it.

-pgrp

The administrative groups right. Allows the user to create, delete, and/or modify administrative groups. Any user holding this right can delete and/or modify an existing administrative group, regardless of whether or not they are its creator. Since there are no designates associated with an administrative group, only those users holding this right will be able to modify or delete an administrative group.

-v

Print the current version number of uniadmrights.

-h

Print a usage message explaining how to run uniadmrights.

FORMATS

FORMAT OF THE <user> ARGUMENT

The <user> argument is a string of the form "key=value/key=value/...", where "key" is one of those listed below, and "value" is any string. Both "key" and "value" are case insensitive. The "value" string may be terminated by a wild card symbol (*). If a forward slash "/" is to be included in a string, it should be escaped with the character "\" to prevent it from being interpreted as a key-value pair delimiter - i.e. "S=Hoopla/OU1=R\/D".

If, in a UNIX environment, a shell will be processing the string (e.g. the string is provided on the command line or is passed as an argument to the utility), the string should be enclosed in quotation marks. Furthermore, if characters meaningful to the shell are included in the string, they may need to be escaped (i.e. preceded by the escape character "\") to prevent the shell from interpreting them.

NOTE

If the ID key-value pair is specified in the user argument, all other key-value pairs specified along with it are ignored.

Some example specifications are: "S=Kilpi/G=Eeva", "S=B*/G=Nicole/O=Acme", "O=Acme/ID=1111/OU1=authors"
Table C.2 · Accepted keys
Key X.400 Field
S Surname
G Given name
I Initials
ID Identifier
X Generation
OU1 Organizational Unit 1
OU2 Organizational Unit 2
OU3 Organizational Unit 3
OU4 Organizational Unit 4
O Organization
C Country
A Administration domain
P Private domain

EXAMPLES

WARNINGS

Directory Server Warning

It is important to understand the implications of the directory server configuration for calendar server utilities.

In a supplier-consumer configuration, the scheduling of updates between the consumer and supplier may result in temporary differences between the two. This may mean that a calendar server utility is reading from a consumer directory server that has not yet been synchronized with its supplier.

EXIT STATUS

Exit values are:
0 Success
1 Failure
2 Usage error

UNIARCH (UNIX ONLY)

uniarch - Create a tar archive of the calendar server.

SYNTAX

uniarch [-d] [-y] [-t | -f <filename>]

uniarch -v

uniarch -h

DESCRIPTION

uniarch creates a backup of the calendar server. By default, the entire /users/unison directory is archived.

You must invoke uniarch from outside of the directory or directories it is backing up. For example, to back up the entire calendar server, you invoke uniarch from outside of the /users/unison directory.

uniarch can only be run if the calendar server is down.


WARNING:

uniarch backs up the calendar server internal database. If a directory server is being used, its database should also be backed up.


OPTIONS

-d

Back up only the contents of /users/unison/db/nodes, the calendar server database.

-f

<filename>

Specify the name of the archive file. If this option is not used, prompting for the filename occurs.

-t

Force the tar default device to be used for the archive destination file.

-y

By default, uniarch asks for confirmation before proceeding with the creation of the archive. This option tells uniarch to automatically proceed, without prompting for confirmation. Default if there is no tty associated with the calling process.

-v

Print the current version number of uniarch.

-h

Print a usage message explaining how to run uniarch.

EXAMPLES

EXIT STATUS

Exit values are:
0 Success
1 Failure
2 Usage error
3 User interrupt

UNIB2LENDIAN

unib2lendian - Convert a calendar server node database from a format for big-endian UNIX processors to a format for little-endian Windows NT processors. For more details on this utility, contact support@oracle.com.

UNICHECK (UNIX ONLY)

unicheck - Verify the calendar server file system.

SYNTAX

unicheck [-nowarn] [-nodb | -maxdb <n>] [-c]

unicheck -v

unicheck -h

DESCRIPTION

unicheck verifies the calendar server file system. The utility first checks that the version of the calendar server is intended to run on the local operating system. If this is not the case, unicheck prompts the user to determine whether or not they wish to continue. If the version runs on the local operating system, unicheck then verifies:

  1. that all necessary files and directories are present

  2. that the permissions, and owner and group information are correctly set on the files and directories.

Any discrepancies are reported. Unless an entire file or directory is missing, any problems found are fixed running uniclean.

unicheck should be run periodically to ensure that the file system is in good order.

unicheck can be run whether the calendar server is up or down.

OPTIONS

-maxdb
<n>

Specifies the maximum number of node databases unicheck should consider. For example, if <n>=30, unicheck checks the files of only the first 30 databases.

-nowarn

Do not print warning messages (error messages are still printed).

-nodb

Do not check database files.

-c

Computes a system-independent checksum for each static file. If this option is used, output should be redirected to a file for future use.

-v

Print the current version number of unicheck.

-h

Print a usage message explaining how to run unicheck.

EXAMPLES

EXIT STATUS

Exit values are:
0 Success
1 Failure
2 Usage error
3 User interrupt

UNICKSUM

unicksum - Generate a checksum for a file.

SYNTAX

unicksum <filename>

unicksum -v

unicksum -h

DESCRIPTION

unicksum generates a checksum for a file that is used to determine whether or not differences exist between two instances of the same file.

unicksum runs whether the calendar server is up or down.

OPTIONS

-v

Print the version number of unicksum.

-h

Print a usage message explaining how to run unicksum.

EXAMPLES

EXIT STATUS

Exit values are:
0 Success
1 Failure
2 Usage error
3 User interrupt

UNICLEAN (UNIX ONLY)

uniclean - Clean up the calendar server file system.

SYNTAX

uniclean

uniclean -v

uniclean -h

DESCRIPTION

uniclean cleans up the calendar server file system by removing some transient files and ensuring file/directory and owner/group permissions are properly set.

uniclean can be run when the calendar server is up or down.

OPTIONS

-v

Print the current version number of uniclean.

-h

Print a usage message explaining how to run uniclean.

EXIT STATUS


Exit values are:
0 Success
1 Failure
2 Usage error
3 User interrupt

SEE ALSO

unicheck

UNICLR_IPC (UNIX ONLY)

uniclr_ipc - Clear IPC resources consumed by the calendar server.

SYNTAX

uniclr_ipc [-s] [-q]

uniclr_ipc -v

uniclr_ipc -h

DESCRIPTION

uniclr_ipc clears IPC (Inter-Process Communication) resources consumed by the calendar server. By default, all IPC resources are freed. The -s and -q options are available to selectively clear only semaphore or message-queue resources respectively.

uniclr_ipc can only be run if the calendar server is down.

OPTIONS

-s

Clear semaphore-related resources only.

-q

Clear message-queue related resources only.

-v

Print the version number of uniclr_ipc.

-h

Print a usage message explaining how to run uniclr_ipc.

EXAMPLES

In all of the following examples, the calendar server is down.

EXIT STATUS

Exit values are:
0 Success
1 Failure
2 Usage error
3 User interrupt

UNICPINR

unicpinr - Copy resource data from a file created by unicpoutr to a calendar server node.

SYNTAX

unicpinr [-add] [-f <filename>] [-start <day> <month> <year>] [-end <day> <month> <year>] [-host <hostname>] <Node-ID> [-p <SysOpPsw>]

unicpinr -ls [<filename(s)>]

unicpinr -v

unicpinr -h

DESCRIPTION

Copies a file containing resource data (created with the unicpoutr utility) into a calendar server node. The utility can be used in conjunction with unicpoutr to move a resource from one node to another, or to add the agenda of one resource to that of another (see EXAMPLES).

By default, the resource specified in the file must already exist in the destination calendar server node. If this is not the case, the -add option is used to add it.

unicpinr can only be run if the calendar server is up.

It is important to understand how unicpinr handles the information in the file during the copy into the destination node.

NOTE

The unicpinr utility does not consult the resource.ini files when importing resources.

OPTIONS

-add

Add the resource to the database before copying in the file. It is an error to specify this option if the resource already exists in the node. In the case of a directory server, the resource is created under the baseDN.

-end
<day> <month> <year>

Set the end dates of the events to be processed. By default, all events in the file are created; this option and the -start option allow you to exclude certain events. Dates must be expressed in the form "day month year". Years must be specified using four digits. Some legal dates are "12 mar 1995", "15 october 1994", "25 12 1995" (for December 25, 1995). Variations such as "mar 12 1995" or "12 dec" are illegal and produce an error message.

-f

<filename>

Specify the input file name. The file must have been created with the unicpoutr utility. By default, standard input is used.

-host

<hostname>

Specify the host on which the specified node can be found. The default is the local host.

-ls

List the file name followed by the name of the resource it contains for each specified file name. Files not created with the unicpoutr command are not listed. If no file names are specified, the files of the current directory (.) are examined.

-p

<SysOpPsw>

Provide the SYSOP password. If this option is not used, prompting for the password occurs.

-start

<day> <month> <year>

Set the start date of the events to be processed. By default, all events in the file are created; this option and the -end option allow you to exclude certain events. Dates must be expressed in the form "day month year". Years must be specified using four digits. Some legal dates are "12 mar 1995", "15 october 1994", "25 12 1995" (for December 25, 1995). Variations such as "mar 12 1995" or "12 dec" are illegal and produce an error message.

-v

Print the current version number of unicpinr.

-h

Print a usage message explaining how to run unicpinr.

RESOURCE IDENTIFIER KEYS
Table C.3 · Accepted keys
Key Description
R Resource name
N Resource number
CA Capacity
S Contact's surname
G Contact's given name
LOC Location
PHONE Phone number
EXT Phone extension
FAX Fax phone number

EXAMPLES

MOVE A RESOURCE FROM ONE NODE TO ANOTHER

unicpinr is used in conjunction with unicpoutr and unires to move a resource from one node to another. In the following example, the resource "betacam" will be moved from node 30 to 35.

  1. Verify that the resource to be moved exists in node 30:

    % unires -ls "R=Betacam" -n 30
    R=Betacam/CA=1/ID=1234

  2. Copy out the resource data to a file:

    % unicpoutr "R=Betacam" -f betacam.dat 30

  3. Delete the resource from the node. This is normal practice as you do not usually want the same resource to exist in two different nodes.

    % unires -del "R=Betacam" -n 30

  4. Add the resource to the destination node:

    % unicpinr -add -f betacam.dat 35
ADD THE AGENDA OF ONE RESOURCE TO THAT OF ANOTHER RESOURCE

unicpinr can be used in conjunction with unicpoutr to add the agenda of one resource to that of another resource. This example adds the agenda for "PineNook" to the agenda for "OakCranny" and at the same time changes the capacity of "OakCranny" to 5.

  1. Copy out the resource data for PineNook (from node 30) to a file:

    % unicpoutr "R=PineNook" -f pinenook.dat 30

  2. Edit the file and modify the resource identifier to match that for OakCranny

    % vi pinenook.dat

  3. Copy in the file to OakCranny in node 30. Since this resource exists, the password, and agenda-specific preferences are not overwritten.

    % unicpinr -f pinenook.dat 30

    The agenda information for PineNook has been added to the existing agenda information for OakCranny.

EXIT STATUS

Exit values are:
0 Success
1 Failure
2 Usage error
3 User interrupt

WARNINGS

Agenda size and processing time

Depending on the size of the agenda in the file, unicpinr may take some time to complete.

Limitations of this utility

The unicp family of utilities have the following limitations that must be considered.

Directory Server Warning

It is important to understand the implications of the directory server configuration for calendar server utilities. In a supplier-consumer configuration, the scheduling of updates between the consumer and supplier may result in temporary differences between the two. This may mean that a calendar server utility is reading from a consumer directory server that has not yet been synchronized with its supplier.

SEE ALSO

unicpoutr, unicpr

UNICPINU

unicpinu - Copy the contents of a file of user data created by unicpoutu to a calendar server node.

SYNTAX

unicpinu [-add ] [-f <filename>] [-start <day> <month> <year>] [-end <day> <month> <year>] [-host <hostname>] <node-ID> [-p <SysOpPsw>]

unicpinu -ls [<filename(s)>]

unicpinu -v

unicpinu -h

DESCRIPTION

unicpinu copies a file containing user data (created by unicpoutu) into a calendar server node. The utility can be used in conjunction with unicpoutu to add the agenda of one user to that of another user (see EXAMPLES). Although it can also be used, in conjunction with unicpoutu, to move a user from one node to another, unimvuser is the proper utility for moving users. unimvuser prevents the data loss that occurs when moving users with unicpoutu and unicpinu.

By default, the user specified in the file must already exist in the destination calendar server node. If this is not the case, they can be added using the -add option.

unicpinu can only be run if the calendar server is up.

It is important to understand how unicpinu handles the information in the input file during the copy into the destination node:

Holidays are output by unicpoutu as meetings, and therefore input by unicpinu as meetings. Only the existing holidays in the destination node appear as holidays in the user's agenda.

NOTE

The unicpinu utility does not consult the user.ini files when importing users.

OPTIONS

-add

Add the user to the database and then copy in the user's agenda. It is an error to specify this option if the user already exists. Note that for directory servers, the user must already exist in the directory server (all of the X.400 key-value pairs specified in the input file must match), and must not already be a calendar user.

-end
<day> <month> <year>

Set the end date for the events and tasks to be processed. By default, all events and tasks in the file are created; this option and the -start option allow you to exclude certain events and tasks. Dates must be expressed in the form "day month year". Years must be expressed using four digits. Some legal dates are "12 mar 1995", "15 october 1994", "25 12 1995" (for December 25, 1995). Variations such as "mar 12 1995" or "12 dec" are illegal and produce an error message.

-f

<filename>

Specify the input file name. The file must be created with the unicpoutu utility. If this option is not specified, standard input is used.

-host

<hostname>

Specify the host on which the specified node is found. The default is the local host.

-ls

<filename(s)>

Print the filename followed by the X.400 name and address of the user contained in the file, for each specified file name. Files not created by the unicpoutu command are not listed. If no file names are specified, the files in the current directory (.) are examined.

-p

<SysOpPsw>

Provide the SYSOP password. If this option is not used, prompting for the password occurs.

-start

<day> <month> <year>

Set the start date for the events and tasks to be processed. By default, all events and tasks in the file are created; this option and the -end option allow you to exclude certain events and tasks. Dates must be expressed in the form "day month year". Years must be expressed using four digits. Some legal dates are "12 mar 1995", "15 october 1994", "25 12 1995" (for December 25, 1995). Variations such as "mar 12 1995" or "12 dec" are illegal and produce an error message.

-v

Print the current version number of unicpinu.

-h

Print a usage message explaining how to run unicpinu.

X.400 NAME, AND ADDRESS KEYS
Table C.4 · Accepted keys
Key Description
S Surname
G Given name
I Initials
X Generation
OU1 Organizational Unit 1
OU2 Organizational Unit 2
OU3 Organizational Unit 3
OU4 Organizational Unit 4
O Organization
C Country
A Administration domain
P Private domain

EXAMPLES

MOVE A USER FROM ONE NODE TO ANOTHER

unicpinu is used in conjunction with unicpoutu and uniuser to move a user from one node to another. In this example the user "Sarah Herman" will be moved from node 20 to 44, and one of her organizational units changed from "Sales" to "R&D".


WARNING:

Use this procedure ONLY if unimvuser cannot handle the move you need to make. See WARNINGS below for information on the data that is lost during this procedure.


  1. Verify that the user to be moved exists in node 20:

    % uniuser -ls "S=Herman/G=S*" -n 20
    S=Herman/G=Sarah/OU1=Dallas/OU2=Sales/ID=1234

  2. Copy the user's agenda and user information to a file:

    % unicpoutu "G=Sara*/S=Herman -f sherman.dat 20

  3. Delete the user from node 20.