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. This is normal practice as the same user should not exist in two different nodes. In the case of a directory server, this step is required if the subsequent unicpinu -add command is to succeed.

    % uniuser -del "G=Sara*/S=Herman" -n 20

  4. Add the user to the destination node:

    % unicpinu -add -f sherman.dat 44
    S=Herman/G=Sarah/OU1=Dallas/OU2=Sales/ID=1234
ADD THE AGENDA OF ONE USER TO THAT OF ANOTHER USER

unicpinu can be used in conjunction with unicpoutu to add one user's agenda to that of another user. This example adds Sarah Herman's agenda to Yannick Olafsen's agenda.

  1. Copy Sarah Herman's user data (from node 20) to a file:

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

  2. Edit the sherman.dat file to modify the X.400 name and address to match that contained in the database for Yannick Olafsen.

    % vi sherman.dat

  3. Copy the file to node 24. Since Yannick Olafsen already exists as a user in node 24, his personal information, password, and agenda preferences are not overwritten.

    % unicpinu -f sherman.dat 24

    The agenda information for Sarah Herman is added to the existing agenda information for Yannick Olafsen.

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, unicpinu 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

unicpoutu, unicpu

UNICPOUTR

unicpoutr - Copy resource data from a calendar server node into a file.

SYNTAX

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

unicpoutr -v

unicpoutr -h

DESCRIPTION

unicpoutr copies a resource's data from a calendar server node to a file. It can be used in conjunction with the unicpinr utility to move a resource from one node to another as well as to copy the resource agenda from one resource to another.

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

The res argument must match a single resource or an error is reported. See FORMAT OF THE res ARGUMENT below for details on how to specify this argument.

unicpoutr copies the following information to the file (see unicpr for more information concerning the format and content of the output file):

The following information is NOT copied to the file:

OPTIONS

-end
<day> <month> <year>

Set the end date of the events to be processed. By default, all events are output; 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 output file name. The file must not exist. By default, the standard output is used.

-host

<hostname>

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

-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 are output; 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 unicpoutr.

-h

Print a message explaining how to run unicpoutr.

FORMATS

FORMAT OF THE res ARGUMENT

The res 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. "R=betacam\/loaner/S=Khupfer".

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 should be escaped (i.e. preceded by the escape character "\") to prevent the shell from interpreting them.

Note that if the ID key-value pair is specified in the res argument, all other key-value pairs specified along with it are ignored.
Table C.5 · Accepted keys
Key Field
R Resource name
N Resource number
CA Capacity
S Contact's surname
G Contact's given name
ID Identifier
LOC Location
PHONE Phone number
EXT Phone extension
FAX Fax phone number

EXAMPLES

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, unicpoutr 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

unicpinr, unicpr

UNICPOUTU

unicpoutu - Copy user data from a calendar server node to a file.

SYNTAX

unicpoutu user [-f <filename>] [-host <hostname>] [-start <day> <month> <year>] [-end <day> <month> <year>] [-holiday] <node-ID> [-p <SysOpPsw>]

unicpoutu -v

unicpoutu -h

DESCRIPTION

unicpoutu copies a user's data from a calendar server node to a file. It can be used in conjunction with the unicpinu utility to copy an agenda from one user to another. Although it can also be used, in conjunction with unicpinu, 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.

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

The user argument must match a single user or an error is reported. See FORMAT OF THE user ARGUMENT below for details on how to specify this argument.

unicpoutu copies the following information to the file (see unicpu for more information concerning the format and content of the output file):

Also included are all incomplete tasks and, by default, all completed tasks. The -start and -end options may be used to export completed tasks falling within a specified time period.

The following information is NOT copied to the file:

OPTIONS

-end
<day> <month> <year>

Set the end date of the events and tasks to be processed. By default, all events and tasks are output; this option and the -start option allow you to exclude certain events and tasks. Dates must be expressed in "day month year" form. 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 output file name. The file must not exist. By default, standard output is used.

-holiday

Include the holidays from the user's agenda in the output file. Holidays are output as meetings, with all users in the node included as attendees to the meeting. If the user's agenda is subsequently input into a new node using unicpinu, only the existing holidays in the new node appear as holidays in the user's agenda; the holidays from the old node appear as meetings.

-host

<hostname>

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

-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 and tasks to be processed. By default, all events and tasks are output; this option and the -end option allow you to exclude certain events and tasks. Dates must be expressed in "day month year" form. 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 unicpoutu.

-h

Print a usage message explaining how to run unicpoutu.

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 should 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.
Table C.6 · 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

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, unicpoutu 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

unicpinu, unicpu

UNICPR

unicpr - Format of the file the unicpoutr utility creates, and the unicpinr utility reads.

DESCRIPTION

The unicpoutr utility creates, and the unicpinr utility reads, an ASCII file with the following format.

{

<resource identification>
}
K Events:
<event descriptions>

Except for the open brace bracket and close brace bracket which respectively open and close the <resource identification> section of the file, each line of the file begins with a single character code which defines the data stored on that line. A space follows the single character code. The unicpinr utility ignores blank lines and lines beginning with unknown codes.

Codes in the <resource identification> section are not legal in the <event descriptions> section, and vice versa.

The following describes the lines that the <resource identification> section may contain.
Table C.7 · Accepted lines
Code and Arguments Data Type Description
E encrypt_flag boolean File encryption flag; currently only False is available
F file_type string File type; currently this is the string "Unison Export File"
I password string Resource's unencrypted password
N number integer Number of events in the file
P preferences integers Resource's display and notification preferences; the 12 integers, from first to last, are: ShowEventTitles StartDay (in minutes) EndDay (in minutes) StartWeek display Display in time increments Display days Display time format Periodic refresh Refresh frequency Mail notification Reminders Lead time before reminders
R a name string Resource's name
R b number string Resource's number
R c capacity string Resource's capacity
R d phone_number string Resource's phone number
R e extension string Resource's extension number
R f fax_number string Resource's fax number
V version# string Version number; currently this is A.02.53
X contact_data string Contact's X.400 data

The following describes the lines that the <event descriptions> section may contain.
Table C.8 · Accepted lines
Code and Arguments Data Type Description
S date string Event start time in (UNIAPI_TIME) or as a date specification
D duration integer Event duration in minutes
T title string Event title
G location string Event location
I class integer Event class (normal, holiday, ...)
R type&priority string Event type (normal, public,...) followed by priority (1, 2,...)
M creator string Event creator
W owner string Event owner
A attending reminder leadtime string Indicates whether resource is attending (TRUE/FALSE); Visual Reminder (0, 1); Leadtime (in minutes)
C description string Event description; this may span several lines and include a list of attendees. When it does span more than one line, each subsequent line must begin with "C" as well.
O
End of an event instance

EXAMPLES

SEE ALSO

unicpinr(8), unicpoutr(8).

UNICPU

unicpu - File format of the file the unicpoutu utility creates, and the unicpinu utility reads.

DESCRIPTION

The unicpoutu utility creates, and the unicpinu utility reads, an ASCII file with the following format.

{

<user identification>
}
K Events:
<event descriptions>
K Tasks:
<task descriptions>

Except for the open brace bracket and close brace bracket which respectively open and close the <user identification> section of the file, each line of the file begins with a single character code which defines the data stored on that line. A space follows the single character code. The unicpinu utility ignores blank lines and lines beginning with unknown codes.

Codes in the <user identification> are not legal in either of the other two sections, and vice versa.

The following describes the lines that the <user identification> section may contain.
Table C.9 · Accepted lines
Code and Arguments Data Type Description
E encrypt_flag boolean File encryption flag; currently only False is available
F file_type string File type; currently this is the string "Unison Export File"
I password string User's unencrypted password
N events tasks integers Number of events, tasks in the file; events is the number of events, tasks is the number of tasks
P preferences integers User's display and notification preferences; the 12 integers, from first to last, are: ShowEventTitles StartDay (in minutes) EndDay (in minutes) StartWeek display Display in time increments Display days Display time format Periodic refresh Refresh frequency Mail notification Reminders Lead time before reminders
U a address string User's address. This can span multiple lines, and when it does, each additional line must also begin with "U a ".
U b empl_number string User's employee number
U c phone_number string User's phone number
U d fax_number string User's fax number
U e extension string User's extension number
U f job_title string User's job title
V version# string Version number; currently this is A.02.51
X user_data string User's X.400 data


The following describes the lines that the <event descriptions> section may contain.
Table C.10 · Accepted lines
Code and Arguments Data Type Description
S date string Event start time in (UNIAPI_TIME) or as a date specification
D duration integer Event duration in minutes
T title string Event title
G location string Event location
I class integer Event class (normal, holiday, ...)
R type&priority string Event type (normal, public,...) followed by priority (1, 2,...)
M creator string Event creator
W owner string Event owner
A attending reminder leadtime string Indicates whether user is attending (TRUE/FALSE); Visual Reminder (0, 1); Leadtime (in minutes)
C description string Event description; this may span several lines and include a list of attendees. When it does span more than one line, each subsequent line must begin with "C" as well.
O
End of an event instance

The following describes the lines that the <task descriptions> section may contain.
Table C.11 · Accepted lines
Code and Arguments Data Type Description
S starttime string Task start time in (UNIAPI_TIME) or as a date specification
D endtime string Task end time as a date specification
T title string Task title
R priority integer Task priority
L compl_level integer Completion level
M creator string Task creator
W owner string Task owner
C description string Task description; this may span several lines. When it does span more than one line, each subsequent line must begin with "C" as well.
O
End of a task instance

EXAMPLES

The following is an example of a file containing two events and one task from the agenda of James Baker.

{

F Unison Export File

V A.02.51

E FALSE

X S=Baker/G=James/I=T/OU1=Labs/OU2=SysAdmin

U a Calendar Server Corporation,

U a 1234 Software Blvd.,

U a Suite 999,

U a Software Valley, CA 99999.

U b 12

U c (123)-456-7890

U d (123)-456-7891

U e 215

U f System Administrator

I Password

P 4 480 1140 1 15 127 2 0 15 0 0 0

#These define display and notification preferences as follows:

# 4 ShowEventTitles

# 480 StartDay at 8:00am

# 1140 EndDay at 7:00pm

# 1 StartWeek display on Sunday

# 15 Display in time increments of 15 min.

# 127 Display all days Sunday to Saturday

# 2 Display time in am/pm format

# 0 Periodic refresh disabled

# 15 Refresh frequency 15 minutes

# 0 Mail notification disabled

# 0 No reminders

# 0 No lead time before reminders

N 2 1
}
K Events:
S 2262975

D 75

T Friday R&D meeting

G Conference Room

I 0

R N0

M Baker James

W Baker James

A TRUE 1 5

C Discuss next week's activities.

C James Baker

C David Robinson

C Kathy Bates
O
S D=25/Y=2000/M=April/T=00:00/z=EST5EDT

D 1440

T Company Holiday

I 1

R A2

M Robinson David

W Robinson David

A TRUE 0 0
O
K Tasks:
S D=1/Y=2000/M=April/T=8:00/z=EST5EDT

D D=30/Y=2000/M=April/T=17:00/z=EST5EDT

T System Overhaul.

R 3

L 70

M Baker James

W Baker James

C Upgrade OS version from A.02.50 to A.04.51
O

SEE ALSO

unicpinu(8), unicpoutu(8)

UNIDBBACKUP

unidbbackup - Create an archive of a calendar server node and related configuration information.

SYNTAX

unidbbackup -d <dst>

unidbbackup -v

unidbbackup -h

DESCRIPTION

unidbbackup creates a backup of a calendar server node and its related configuration information. More specifically, it creates a backup of the /users/unison/misc directory and the /users/unison/db directory. As the information in these two directories is interrelated, it is important to ensure they are backed up at the same time.

unidbrestore is the complementary utility to unidbbackup. By default, these utilities perform a copy of the source to the destination. If behaviour other than a straight copy is needed, an alternate backup/restore command can be specified using the [UTL] external_backup and external_restore parameters in the unison.ini file. See FILES below for details on how to specify an alternate backup command.


WARNING:

The backup and restore commands are inverse operations so if alternate commands are used, it is of critical importance to ensure they do in fact perform the inverse operation of each other. The integrity of the database is at stake.


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


WARNING:

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


OPTIONS

-d
<dst>

Specify the destination for the archive, where <dst> is a directory name.

-v

Print the current version number of unidbbackup.

-h

Print a usage message explaining how to run unidbbackup.

EXAMPLES

EXIT STATUS

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

FILES

/users/unison/misc/unison.ini

The following keys in the [UTL] section of this file are of relevance to this utility:

SEE ALSO

unidbrestore

UNIDBCONV

unidbconv - Convert a version 2.50, 2.60 or 2.61 node database to version 2.62.

SYNTAX

unidbconv -n <node-ID> | all [-p <pagevalue>]

unidbconv -v

unidbconv -h

DESCRIPTION

unidbconv converts a version 2.50, 2.60 or 2.61 node database to version 2.62. In general you do not invoke this utility directly (a conversion is done automatically during the upgrade to a newer version of the calendar server). The last two digits of the "version" parameter in the [<YOURNODEID>] section of the unison.ini file indicate the version of the node.


WARNING:

You should back up the calendar server before invoking unidbconv as this utility overwrites the existing database.


The calendar server must be down to run unidbconv.

OPTIONS

-n
<node-ID> | all

Perform the conversion on the specified node only (if <node-ID> is used) or on all nodes (if all is used).

-p

<pagevalue>

Specify the number of cache pages to use for scanning and rebuilding key files. If this option is not used, the default value of 256 is used instead.

-v

Print the version number of unidbconv.

-h

Print a usage message explaining how to run unidbconv.

EXAMPLES

EXIT STATUS

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

UNIDBFIX

unidbfix - Check, repair, defragment and maintain a calendar server node database.

SYNTAX

unidbfix -c [-pix] -n <node-ID> | all [-r] [-sfgn] [-kp <pagevalue>]

unidbfix -f [-pix] -n <node-ID> | all [-r] [-y] [-sfgn] [-kp <pagevalue>]

unidbfix -d [-pix] -n <node-ID> | all [-r] [-y] [-sfgn] [-kp <pagevalue>]

unidbfix -export [-pix] -n <node-ID> | all [-r] [-kp <pagevalue>]

unidbfix -import [-pix] -n <node-ID> | all [-r] [-y] [-kp <pagevalue>]

unidbfix -ck -n <node-ID> | all [-r] [-y] [-kp <pagevalue>]

unidbfix -k -n <node-ID> | all [-r] [-y] [-kp <pagevalue>]

unidbfix -i [-pix] -n <node-ID> | all [-r] [-kp <pagevalue>]

unidbfix -v

unidbfix -h

DESCRIPTION

unidbfix checks for and repairs database corruptions and/or inconsistencies, and/or defragments and compresses a node database. You should run unidbfix as part of a regular database maintenance program.


WARNING:

Database corruption may occur if you do not use the version of unidbfix that ships with, or is compatible with, the version of the calendar server you are running. Consult Oracle Support if you have any questions on compatibility.



WARNING:

Before invoking this utility with one of the -f, -d, or -import options it is highly recommended that you make a backup of the database. You only need to back up the data (*.dat) files as unidbfix can reconstruct the key (*.key) files from the data files.


unidbfix carries out checks/repairs on the following parts of the database of the specified node:

unidbfix runs in one of eight different modes as listed below. If, in any mode, unidbfix makes a fix, it reports that fix. The scan phases for each mode appear in the order in which they occur. See the NOTES section for additional information on the Remote Nodes, Bins, and File Fragmentation scan phases.
Table C.12 · unidbfix modes
Mode Option Scan Phases Changes Database
check -c File Sizes Nodes Remote Nodes Records Sets Bins Dchain Key Check Database Info No
fix -f File Sizes Nodes Remote Nodes Records Sets Bins Dchain File Fragmentation Key Build Database Info Yes
defragment -d Files Sizes Nodes Remote Nodes Records Sets Bins Dchain File Fragmentation Key Build Yes
import -import RemoteNodes Key Build Yes
export -export Remote Nodes No
check key -ck Key Build (in check mode) No
fix key -k Key Build (in fix mode) Yes
info -i Database Info No

unidbfix only runs if the calendar server is down.

OPTIONS

-c

Run in check mode. unidbfix reports all database corruptions and inconsistencies but takes no action to correct them (use fix mode to do this). If unidbfix detects an error, it stops the check after the scan phase in which it finds the errors. For instance, if it discovers an error during the File Sizes scan phase, it terminates on completion of this scan phase. It does not proceed to the Nodes scan phase.

-ck

Run in check key mode. Checks only the key files of the database.

-d

Run in defragment mode. In this mode unidbfix frees space occupied by deleted records and then compresses the database. To ensure database consistency, unidbfix checks the database for errors and fixes any it finds before it proceeds with defragmentation.


WARNING:

While it is possible to interrupt unidbfix during the defragmentation phase using a kill -9, this causes irreversible damage to the database.


-export

Run in export mode. In export mode unidbfix writes remote node information from the database to the remotenode.ini file. Note that it writes only the non-null fields for each remote node to the file. See the REMOTE NODES SCAN PHASE note for an example of how to use the -export mode.

-f

Run in fix mode. Fix and clean up the database. This fixes all errors detected in check mode. In some circumstances unidbfix may be forced to delete data (e.g. where corruption to the data is such that unidbfix is unable to repair it, or where orphan data cannot be safely re-integrated).

-i

Run in info mode. In this mode unidbfix outputs various database statistics to the dbfix.log file.

-import

Run in import mode. In import mode unidbfix writes remote node information from the remotenode.ini file to the database. See the REMOTE NODES SCAN PHASE note for an example of how to use the -import mode as well as warnings on its use.

-k

Run in fix key mode. Rebuilds only the key files of the database.

-kp

<pagevalue>

Specifies the number of cache pages to use for scanning and rebuilding key files. If this option is not used, the default value of 256 is used instead.

-n

<node-ID> | all

Specify the node to check/fix/defragment. Use -n all to scan all the nodes on a computer.

-pix

Turn off the progress indicator. By default unidbfix outputs a progress indicator, for each utility it calls, to standard error.

-r

Overwrite the /users/unison/log/dbfix.log log file, rather than append output to it.

-sfgn

Turn on foreign node checking and fixing. Use only if you have foreign nodes and items.


WARNING:

Using this option when you do not have foreign nodes and items may result in changes to the database. These changes may or may not be problematic.


-y

Turn fix and defragmentation confirmation message off.

-v

Print the current version number of unidbfix.

-h

Print a usage message, and a short description of each option.

EXAMPLES

FILES

/users/unison/log/dbfix.log

unidbfix writes any errors it finds and/or any fixes it makes, to this file. It lists each error as a DATABASE ERROR, and each repair as a Fix. unidbfix can repair any database error it finds. Totals of all errors found, fixes made, and records deleted during fixing, appear at the end of the file. Note that the total number of database errors need not equal the total number of fixes. You do not normally need to consult this file.

/users/unison/log/unison.ini

Consult this file for a listing of all local nodes, with their corresponding directory names and node-IDs.

remotenode.ini

unidbfix uses this file in import and export modes. It creates this file in a node's perm directory the first time it runs on the node. The file contains a listing of all the remote node records and their data fields. The information for each remote node is as follows:

[Node-ID]

RN_NUMCONNECT: any number zero and above

RN_ACCESSMETHOD: must be 2

RN_SERVICENAME: must be "unieng"
RN_HOSTNAME: name of the remote host

Node-ID is the remote node identification number. It must be enclosed in square brackets and it must start a line. A field can have a null value. If any field has an invalid value, unidbfix returns an error message, and does not make the change for the remote node with the error.

The following sample remotenode.ini file contains two remote nodes: the first has the node-ID 730 and the name "NewYork"; the second has the node-ID 631 and the name "LosAngeles".

[730]

RN_NUMCONNECT = 2

RN_ACCESSMETHOD = 2

RN_SERVICENAME = "unieng"

RN_HOSTNAME = "NewYork"

[631]

RN_NUMCONNECT = 2

RN_ACCESSMETHOD = 2

RN_SERVICENAME = "unieng"
RN_HOSTNAME = "LosAngeles"

unidbfix.lck

This is a lock file which prevents multiple instances of unidbfix from running on the same node simultaneously. unidbfix creates this in the perm directory of the node on which it is running. In the event that a kill -9 or a system crash prevents unidbfix from running to completion, this file remains in place. It may be manually deleted.

EXIT STATUS

Exit values are:

0 Success
No errors found (check mode)
Errors found but fixed (fix mode)
Successfully defragmented (defragment mode)
Successful import (import mode)
Successful export (export mode)

1 Errors Found
Errors were found (check mode)

2 Usage error

3 User interrupt

4 Aborted
Another instance of unidbfix was running on the node.

5 Stopped
unidbfix either found errors in the remote node records while in fix or check mode, or it could not find the remotenode.ini file. It needed more information to be able to continue checking or fixing.

NOTES

KEY FILES

Note that unidbfix rebuilds the key files of the database in fix, defragment, import, and fix key modes. If unidbfix is interrupted during any of these modes, the key files may have been deleted and not yet rebuilt. For this reason, it is highly recommended that you run unidbfix again after an interruption.

BINS AND FILE FRAGMENTATION SCAN PHASES

In the Bins and the File Fragmentation scan phases, unidbfix rebuilds files without checking for, or reporting, previously existing errors. In all other scan phases all errors reported in check mode are reported in fix mode before being fixed.

REMOTE NODES SCAN PHASE

For this scan phase to run, the node's remotenode.ini must exist, and its contents must agree with the list of remote nodes in the database. When one of these conditions is not met, you can use the -export and -import modes to rectify the situation. The explanations that follow use the node-ID "43".

  1. CONDITION: A remotenode.ini file does not exist for node 43. In this case, generate one from the remote node list in the database:

    % unidbfix -export -n 43

  2. CONDITION: The remote node list in the database does not agree with the information in the remotenode.ini file for node 43. In this case, rectify the discrepancy as follows.

    First write the remote node information from the database to the remotenode.ini file for node 43:

    % unidbfix -export -n 43

    Make any required edits to the resulting remotenode.ini file.


    WARNING:

Edit with care! Errors in this file may lead to unwanted deletion of records when the file is imported. For this reason it is highly recommended that you back up the database before running unidbfix in -import mode.

Update the database with the modified file:

% unidbfix -import -n 43


WARNING:

Use uninode, not unidbfix -import, to administer the node network. Use unidbfix with the -import option only to fix corruptions in the remote node connection information in the database.


SEE ALSO

unistart, unistop, uninode

UNIDBRESTORE

unidbrestore - Restore a calendar server node and configuration information from a backup created by unidbbackup.

SYNTAX

unidbrestore -s <src> [-d <dst>] [-n <node-ID>]

unidbrestore -v

unidbrestore -h

DESCRIPTION

unidbrestore - restores the node and configuration information of a calendar server from a backup created by unidbbackup.


WARNING:

By default, the destination directory for the restore is /users/unison. This means that the restore overwrites the existing files of the calendar server database. Thus, this utility should be used with extreme care to ensure the calendar server database is not inadvertently corrupted. A more careful approach would be to use the -d option to specify a different directory for the restore and then copy the individual files from the restored directory into the /users/unison directory.


unidbbackup is the complementary utility to unidbrestore. By default, these utilities perform a copy of the source to the destination. If behaviour other than a straight copy is needed, an alternate backup/restore command can be specified using the [UTL] external_backup and external_restore parameters in the unison.ini file. See FILES below for details on how to specify an alternate restore command.


WARNING:

The backup and restore commands are inverse operations so if alternate commands are used, it is of critical importance to ensure they do in fact perform the inverse operation of each other. The integrity of the database is at stake.


unidbrestore can only be run when the calendar server is down.


WARNING:

unidbrestore restores the calendar server's internal database. If a directory server is being used, its database is untouched by unidbrestore. Therefore, if you restore a calendar server node after deleting users, you will have to add them back into the directory server. Similarly, if you restore a single node after changing node network information, you will encounter errors due to the conflict between the current network configuration and the restored node's old network information. Contact Oracle support for more details if this occurs to you.


OPTIONS

-d
<dst>

Specify the destination for the restore. By default this is the /users/unison directory.

-n

<node-ID>

Specify a node to restore.

-s

<src>

Specify the backup source, where <src> is a directory name.

-v

Print the current version number of unidbrestore.

-h

Print a usage message explaining how to run unidbrestore.

EXAMPLES

EXIT STATUS

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

FILES

/users/unison/misc/unison.ini

The following parameters in the [UTL] section are of relevance to this utility:

SEE ALSO

unidbbackup

UNIDOMAIN

unidomain - Create a new calendar domain. For Business-to-Business (B2B) deployments only.

SYNTAX

unidomain -add -hostalias <alias> -domainid <id> -domainname <name> -t <timezone> -adminpassword <password> [-cds <hostname>] [-n <node-ID>] [-p <sysOpPassword>] [-disablepasswordmod] [-capacity <num>] [-reldn <dn>] [-resreldn <dn>] [-logo <imagename>] [-sitelogo <imagename>] [-sitename <name>] [-templatedir <dir>] [-supportemail <addr>] [-manageuseroff] [-manageresourceoff] [-manageholidayoff] [-manageeventcaloff] [-disable] [-y]

unidomain -listaliases [-cds <hostname>] [-p <sysOpPassword>]

unidomain -listdomainids [-cds <hostname>] [-p <sysOpPassword>]

unidomain -v

unidomain -h

DESCRIPTION

unidomain is a command-line alternative to the Calendar Administrator for creating calendar domains. A domain is the representation on the calendar server of a single customer account. Each domain is associated with a single calendar server node. For more information on domains and the Calendar Domain Service, consult your calendar server Administrator's Guide.

You must use the -domainid option to specify a Domain ID for the new domain. This Domain ID must be unique in the Calendar Domain Service specified by the -cds option. To obtain a current list of all domain IDs in use on a given Calendar Domain Service, run unidomain with the -listdomainids option.

You must also use the -hostalias option to specify a calendar server alias for the new domain. The required alias is NOT simply the hostname of the calendar server, but one of the parameters listed in the [HOSTS] section of the /users/unison/misc/domain/domain.ini file. To see a list of all available calendar server aliases and the names of their corresponding hosts, run unidomain with the -listaliases option.

By default, unidomain will display the information you have specified for the new domain, and prompt you to continue if that information is correct.

unidomain will write many of the domain properties you specify in the /users/unison/misc/domain/domain.ini file. These parameters may be changed after domain creation. See Chapter 5 of your calendar server's Administrator's Guide for details on the parameters involved.

unidomain will also write a value for the domain.ini [YOURDOMAINID] adm.adminurl parameter. This URL provides an address for the Domain Administrator to manage the new domain through the Calendar Administrator.

unidomain can only be run when the calendar server is up.

OPTIONS

-add

Creates a new calendar domain.

-adminpassword
<password>

Specify an initial password for the Domain Administrator of the domain being created.

-capacity

Specify the maximum number of users and event calendars combined that may be created in the new domain. This value may be changed later using the Calendar Administrator. If this option is not used, the default value of 10 is assumed.

-cds

<hostname>

Specify a Calendar Domain Service host. If this option is not used, the local host is assumed.

-disable

Disable the new calendar domain. The Calendar Administrator will still be able to manage the domain normally, but clients featuring Domain-ID sign-in will be blocked (Outlook Connector 2.0 and greater, native clients 5.1 and greater, Web clients 2.2 and greater).

-disablepasswordmod

Prevent the Domain Administrator of the new domain from changing his or her password through the Calendar Administrator.

-domainid

<id>

Specify a Domain ID for the new domain. This ID is usually a short string representative of the customer account. The value of the <id> argument may be any non-null alphanumeric string beginning with a letter that is unique in the Calendar Domain Service indicated by the -cds option. Domain IDs are case-insensitive; the Domain ID "acme1" cannot be used if the ID "ACME1" already exists. See also the -listdomainids option.

-domainname

<name>

Specify the name of the company represented by the new domain.

-hostalias

<alias>

Specify the Calendar Domain Service alias of the calendar server host on which the new domain is to be created. The value of the <alias> argument must be one of the aliases configured in the [HOSTS] section of the /users/unison/misc/domain/domain.ini file. See also the -listaliases option.

-listaliases

Lists all available Calendar Domain Service aliases and calendar server hostnames currently in use on the Calendar Domain Service host specified by the -cds option.

-listdomainids

Lists all Domain IDs currently in use on the Calendar Domain Service specified by the -cds option.

-logo

<imagename>

Specify an image file to display for this domain in the Calendar Administrator. The value of the <imagename> argument may be a filename within the Calendar Administrator's configured images directory or a fully qualified URL.

-manageeventcaloff

Remove from the Domain Administrator of this domain the right to manage event calendars and their events through the Calendar Administrator.

-manageholidayoff

Remove from the Domain Administrator of this domain the right to manage holidays through the Calendar Administrator.

-manageresourceoff

Remove from the Domain Administrator of this domain the right to manage resources through the Calendar Administrator.

-manageuseroff

Remove from the Domain Administrator of this domain the right to manage users through the Calendar Administrator.

-n

<node-ID>

Specify a node to associate with this domain. If this option is not used, unidomain will use the first empty node it finds. If you use this option, the node you specify must already exist on the host indicated by the -hostalias option, and must not be associated with any other domain. Use of this option is strongly discouraged in most circumstances.

-p

<sysOpPassword>

Specify the SYSOP password; this password should be the same for all calendar server nodes. if you do not supply the password, unidomain will prompt for it.

-reldn

<dn>

Specify a Relative DN for this domain, relative to the calendar server base DN. Required only for installations using an external LDAP directory server.

-resreldn

<dn>

Specify a Resource Relative DN for this domain, relative to the domain's Relative DN (specified by the -reldn option). Only for installations using an external LDAP directory server. If this option is not used, the default value of "ou=Resources" is assumed.

-sitelogo

<imagename>

Specify an image file to display in the Calendar Administrator to represent the provider for this domain. The value of the <imagename> argument may be a filename within the Calendar Administrator's configured images directory or a fully qualified URL.

-sitename

<name>

Specify the name of this domain's provider as it should appear in the Calendar Administrator. The value of the <name> argument will override the Calendar Administrator's default Provider Name for this domain only. Other existing domains and future domains will not be affected.

-supportemail

<addr>

An e-mail address to display in the Calendar Administrator for the Domain Administrator to contact in case of errors or problems.

-t

<timezone>

The time zone of the new domain. Use any of the values listed in Reference Appendix D, "Time Zone Table."

-templatedir

<dir>

Specify a template directory for the Calendar Administrator to use for this domain. The value of the <dir> argument may be either a path relative to the Calendar Administrator CGI or FastCGI file, or it may be a fully qualified URL. The value of the <dir> argument will override the Calendar Administrator's default template directory for this domain only. Other existing domains and future domains will not be affected.

-y

Proceed without asking for confirmation.

-v

Print the current version number of unidomain.

-h

Print a usage message explaining how to run unidomain.

EXAMPLES

FILES

/users/unison/misc/domain/domain.ini

This configuration files is located on the Calendar Domain Service host, and contains most of the information that can be specified in the command-line argument given to this utility. See Chapter 5 of your calendar server's Administrator's Guide for details on the parameters involved.

EXIT STATUS

Exit values are:
0 Success
Any non-zero value signals a failure

UNIDSACISETUP

unidsacisetup - Set the access control information in the directory server for the calendar server ADMIN group.

SYNTAX

unidsacisetup [-w <mgrDnPwd>]

unidsacisetup -info

unidsacisetup -v

unidsacisetup -h

DESCRIPTION

unidsacisetup sets the directory server access control information (ACI) for the calendar server ADMIN group. Although you can use directory server utilities to set ACIs, it is advisable to use unidsacisetup to ensure the ACI for the ADMIN group is properly set. Most calendar server utilities do not run unless the ACI for the ADMIN group is set.

This utility should be run every time a new calendar server ADMIN group is created, i.e. every time the [LDAP] admingroup parameter in the unison.ini file is changed.

unidsacisetup runs whether the calendar server is up or down. The directory server, however, must be running.

NOTE

This utility does not support the ISOCOR Global Directory Server. Set the ISOCOR ACI using the procedure described in the calendar server Readme file.

OPTIONS

-info

Display the list of directory servers for which this utility can create access control information.

-w

<mgrDnPwd>

Provide the directory server manager password (this is the password associated with the [LDAP] mgrdn parameter in unison.ini). If this option is not used, unidsacisetup prompts the user for the password.

-v

Print the version number of unidsacisetup.

-h

Print a usage message explaining how to run unidsacisetup.

EXAMPLES

EXIT STATUS

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

UNIDSDIFF

unidsdiff - Find and delete differences between a calendar server node and a directory server.

SYNTAX

unidsdiff [-d] [-noprompt] [-n <node-ID>] [-host <hostname>] [-p <SysOpPsw>] [-verbose]

unidsdiff -v

unidsdiff -h

DESCRIPTION

This utility finds all users and resources in a calendar server node without a match in the directory server and vice versa. By default, it only reports discrepancies. Use the -d option to delete discrepancies.

The calendar server assigns each user and resource a unique identifier called an xItemId. unidsdiff first checks that each xItemId (for the specified node) in the directory server:

  1. is unique

  2. has a single user or resource associated with it

  3. is expressed in a valid format

If unidsdiff detects an xItemId which does not pass one of these checks, it aborts; directory server utilities must be used to correct the problem. Otherwise unidsdiff proceeds to verify that:

  1. all users and resources in the calendar server node appear in the directory server (if the -d option was used, any users or resources appearing only in the calendar server node are removed)

  2. all calendar users and resources in the directory server appear in the calendar server node (if the -d option was used, any calendar users or resources appearing only in the directory server are removed from the directory server, i.e. they no longer appear as calendar users in the directory server).

The calendar server must be up to run unidsdiff.

OPTIONS

-d

Delete the differences found. The user is prompted to confirm each deletion. Without the -d option, unidsdiff simply lists the differences.

-host
<hostname>

Specify the host to connect to. Required if host is remote.

-n

<node-ID>

Specify a node. Required if more than one exists.

-noprompt

Disable prompting when used with the -d option.

-p

<SysOpPsw>

Provide the SYSOP password.

-verbose

Display all Distinguished Names in the directory associated with the node.

-v

Print the current version number of unidsdiff.

-h

Print a usage message explaining how to run unidsdiff.

EXAMPLES

EXIT STATUS

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

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.

UNIDSSEARCH

unidssearch - List all users in a directory server who are not calendar users.

SYNTAX

unidssearch [-f <LDAPfilter>] [-c <#ofDNs>] [-n <node-ID>]

unidssearch -v

unidssearch -h

DESCRIPTION

unidssearch lists all users in the directory server who are not calendar users. The output of this command may be redirected to a file, modified as needed, and subsequently used as input to uniuser (using the -ex option). See OUTPUT FORMAT for information on the format of the file output by unidssearch.

The calendar server must be up to run unidssearch.

In Business-to-Business (B2B) deployments, unidssearch will produce no output if run on a node that is not part of a calendar domain.

OPTIONS

-f

<LDAPfilter>

Specify a raw LDAP filter to combine ("AND") with the default filter to retrieve users from an LDAP directory. Refer to your directory server documentation for exact attributes that can be specified in the LDAP filter. The values specified in the filter must be in the configured character set of the directory server (e.g. UTF-8, T.61). The default filter is:

[&(objectClass=organizationalPerson)(|(!(ctCalXItemId=*)) (!(ctCalXItemId=*:*)))]

-c

<#ofDNs>

Limit the number of results returned to this number.

-n

<node-ID>

Required for Business-to-Business (B2B) deployments. Returns only users within the relative DN of the domain identified with the specified node.

-v

Print the current version number of unidssearch.

-h

Print a usage message explaining how to run unidssearch.

FORMATS

OUTPUT FORMAT

The content of the file output by unidssearch has the following format:

A did=cn=jdoe, o=Acme, c=US
A did=cn=confroom4, o=Acme, c=US

Each entry has an initial "A" character, followed by a "did". The "A" flags the user as one to add to the directory server as a calendar user. The "did" is the Directory ID or Distinguished Name of the user, uniquely identifying that user in the Directory Server.

The format of this file is the same as that required for the input file to the uniuser -ex command. If this is the intended use of the file, additional user data may be appended to the "did", in X.400 format. For example:

A did=cn=jdoe, o=Acme, c=US/G=John/OU=Sales

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
3 User interrupt

SEE ALSO

uniuser

UNIDSSYNC

unidssync - Synchronize the information in a calendar server node with that in a directory server.

SYNTAX

unidssync [-n <node-ID>] [-host <hostname>] [-p <SysOpPsw>]

unidssync -v

unidssync -h

DESCRIPTION

unidssync is only used when connected to an external directory server. This utility synchronizes the information in a calendar server node with that in the directory server.

unidssync should be run when other applications using the directory server have changed directory server entries without the knowledge of the calendar server, AND when the [ENG] dac_itemget parameter in unison.ini is set to "FALSE" to enhance performance (in this case, the calendar server retrieves its information from the internal store rather than from the directory server).

These conditions might allow discrepancies to arise between the information in the internal store of the calendar server node and that in the directory server. unidssync eliminates discrepancies, using the directory server as the authority. It should be run as part of a regular maintenance program.

The calendar server must be up to run unidssync.

OPTIONS

-host

<host>

Specify the host. Required if connecting to a remote host.

-n

<node-ID>

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

-p

<sysOpPsw>

Provide the SYSOP password. If it is not provided on the command line, prompting for it occurs.

-v

Print the current version number of unidssync.

-h

Print a usage message explaining how to run unidssync.

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
3 User interrupt

UNIDSUP

unidsup - Report the status of the directory server.

SYNTAX

unidsup [-q] [-host <hostname>]

unidsup -v

unidsup -h

DESCRIPTION

unidsup reports whether or not the directory server is running.

The calendar server must be up to run unidsup.

OPTIONS

-host

<hostname>

Provide the name of the calendar server host. If this option is not present, the local host is assumed.

-q

Operate in quiet mode (produces no output when the directory server is up).

-v

Print the version number of unidsup.

-h

Print a usage message explaining how to run unidsup.

EXIT STATUS


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

UNIGRPLS

unigrpls - Display both the public and administrative groups in a calendar server database.

SYNTAX

unigrpls [-grp <groupname>] [-members] [-host <hostname>] [-n <node-ID>] [-p <SysOpPsw>]

unigrpls -v

unigrpls -h

DESCRIPTION

unigrpls prints both the public and administrative groups in the specified calendar server node. By default, all groups are displayed along with the total number of members in each. The -members option is used to display each member in the group.

Note that if a directory server is used, any groups created in the directory server are also included in the output of unigrpls. If members are listed, only the members of the directory server group who are also calendar users are output.

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

OPTIONS

-grp

<groupname>

Specify a group.

-members

Print the individual members for each group output.

-host

<hostname>

Specify the host on which the operation is to be performed. The default is the local host.

-n

<node-ID>

Specify the node on which the group is located. Required if more than one node is configured.

-p

<sysOpPsw>

Specify the SYSOP password. Without this option, prompting for the password occurs.

-v

Print the current version number of unigrpls.

-h

Print a usage message explaining how to run unigrpls.

EXAMPLES

EXIT STATUS

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

UNIL2BENDIAN

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

UNIL2LENDIAN

unil2lendian - Convert a calendar server node database from a format for little-endian Windows NT processors to a format for little-endian UNIX processors (Red Hat Linux or Tru64 UNIX) and vice-versa. For more details on this utility, contact support@oracle.com.


TOC PREV NEXT INDEX
 
Copyright information