Skip Headers

Oracle Calendar Server Reference Manual
Release 5.5

Part Number B10094-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Feedback

Go to previous page
Previous
Go to next page
Next
View PDF

C
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

UNIADDNODE

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

UNIADMRIGHTS

Manage the administration rights of users.

UNIARCH (UNIX ONLY)

Create a tar archive of the calendar server.

UNICHECK (UNIX ONLY)

Verify the calendar server file system.

UNICKSUM

Generate a checksum for a file.

UNICLEAN (UNIX ONLY)

Clean up the calendar server file system (remove transient files and set permissions).

UNICLR_IPC (UNIX ONLY)

Clear IPC resources consumed by the calendar server.

UNICPINR

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

UNICPINU

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

UNICPOUTR

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

UNICPOUTU

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

UNICPR

Format of the file created by unicpoutr and read by unicpinr.

UNICPU

Format of the file created by unicpoutu and read by unicpinu.

UNIDBBACKUP

Create an archive of the calendar server.

UNIDBCONV

Convert a version 2.50 or 2.60 node database to a 2.61 node database.

UNIDBFIX

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

UNIDBRESTORE

Restore the contents of a calendar server from a backup created by unidbbackup.

UNIDOMAIN

Create a calendar domain.

UNIDSACISETUP

Set the access control information in the directory server for the calendar server ADMIN group. (external directory only)

UNIDSDIFF

Find and delete differences between a calendar server node and a directory server. (external directory only)

UNIDSSEARCH

List all users in a directory server who are not calendar server users. (external directory only)

UNIDSSYNC

Synchronize the information in a calendar server node with that in a directory server. (external directory only)

UNIDSUP

Report the status of the directory server. (external directory only)

UNIENCRYPT

Encrypt a password for inclusion in a calendar server configuration file

UNIGRPLS

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

UNILOGONS

Display calendar server SIGNON/SIGNOFF statistics.

UNIMVUSER

Move a user from one calendar server node to another.

UNINODE

Administer a calendar server node network.

UNIPASSWD

Change a user password on a calendar server database.

UNIPING

Ping a calendar server node or nodes.

UNIREQDUMP

View, and optionally delete, requests in the queue of the Corporate-Wide Services (CWS) daemon.

UNIRES

List, add, or delete calendar server resources, or modify the information associated with them.

UNIRMOLD

Remove old events and tasks from agendas in a calendar server database.

UNIRNDEL

Delete a remote node from a local calendar server node database.

UNISTATS

Propagate deletions in the local information of one node to another node in the network.

UNISIZEOF

Compute the size of the calendar server installation.

UNISLICE (UNIX ONLY)

Extract information from calendar server log files.

UNISNAPSHOT

Compile calendar server information for diagnostic purposes.

UNISNCDUMP

Retrieve statistics from the calendar server's Synchronous Network Connection daemon/service.

UNISTART

Start up the calendar server.

UNISTAT

Produce a report on a calendar server node.

UNISTATS

Display summary statistics of the data in a calendar server stats file.

UNISTATUS

Determine the status of the calendar server.

UNISTOP

Shut down the calendar server.

UNISYNCREFRESH

Refresh synchronization records.

UNITZINFO

Print information about a calendar server time zone.

UNIUSER

List, add, or delete calendar users; modify the information associated with them.

UNIVERSION

Verify the version of the calendar server.

UNIWHATOS (UNIX ONLY)

Determine whether the the calendar server package runs under the current operating system.

UNIWHO

Display information on signed-on calendar users.

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 the unitzinfo utility, the /users/unison/misc/timezone.ini file, or the calendar server Reference Manual, Appendix D, "Time Zone Table".

-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 Oracle support.

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.

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:

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

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 the calendar server Reference Manual, 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.

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

UNIENCRYPT

uniencrypt - Encrypt a password for inclusion in a calendar server configuration file.

SYNTAX

uniencrypt -m <encryption_method> -s <string> 

uniencrypt -v 
uniencrypt -h 

DESCRIPTION

uniencrypt uses the encryption method specified by the -m option to encrypt the password specified by the -p option. Any password supplied in a calendar server configuration file (such as those specified by the [LDAP] bindpwd and writednpassword parameters) must first be encrypted using this utility.

uniencrypt returns the encrypted password preceded by the encryption method used to generate it. For example, {acipher}ruyr84jf. Generally, this entire value, including the encryption method and curly braces, should be enclosed in double quotes and included as the value of the password specified in the calendar server configuration file. For example:

[LDAP]
bindpwd = "{acipher}ruyr84jf"

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

OPTIONS

-m

<encryption_method>

Specifies the encryption method to use. Accepted values currently include only acipher, a proprietary affine cipher encryption method, and encd. If this argument is not used, acipher will be used by default.

-s

<string>

Specifies the string to encrypt. If this is option is not used, uniencrypt will prompt for the string to encrypt.

-v

Print the current version number of uniencrypt.

-h

Print a usage message explaining how to run uniencrypt.

EXAMPLES

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 Oracle support.

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 Oracle support.

UNILOGONS

unilogons - Display calendar server SIGNON/SIGNOFF statistics.

SYNTAX

unilogons [-s <starttime>] [-e <endtime>] [-i <interval>] [-f <filename>]

unilogons -t -s <starttime> -e <endtime> -i <interval> [-f <filename>]

unilogons -t [<time>] [-f <filename>]

unilogons -v 
unilogons -h 

DESCRIPTION

unilogons displays the signon and signoff activity of users on a calendar server at a specific time or during a specific time period. By default it uses the information in the /users/unison/log/act.log file. The -f option may be used to specify another input file.

The -t option displays activity at a precise moment, while the -s and -e options display activity during a defined period. The -i option specifies a regular time interval (e.g. every 15 minutes) within a specified period.

By default, all activity between the default start-time (the first minute of the current day) and the default end-time (the current system time) is displayed.

The calendar server must be up to run unilogons.

OPTIONS

-e

<endtime>

Specify an end time for the statistics. Without this option, the default end time is the current time of the current day. See TIME ARGUMENT FORMAT below for details on how to specify <endtime>.

-f

<filename>

Specify the name of the input file. By default the input file is /users/unison/log/act.log. The input file specified with the -f option must be in the same format as the act.log file.

-i

<interval>

Specify a time interval. The default interval is <endtime> minus <starttime>. See INTERVAL ARGUMENT FORMAT below for details on how to specify interval.

-s

<starttime>

Specify a start time for the statistics. Without this option, the default start time is the first minute of the current day. See TIME ARGUMENT FORMAT below for details on how to specify <starttime>.

-t

[<time>]

If used without the -s, e, and -i options, this displays statistics for the current time (-t) or for a given time (-t <time>). When used together with all of the -s, -e, and -i options, the -t (without a time argument) restricts output to activity at only the precise times determined by the interval (-i) argument. See the last two EXAMPLES for sample output of the -s, -e, -i options both with and without the -t option. See TIME ARGUMENT FORMAT below for details on how to specify time.

-v

Print the current version number of unilogons.

-h

Print a usage message explaining how to run unilogons.

FORMATS

FORMAT OF THE time ARGUMENTS

The <starttime>, <endtime>, and <time> arguments may each be expressed as either:

where

The order of the individual elements in the argument is unimportant. What is important is that either day and month be specified, or time be specified. For example, the following are all valid:

Feb 22 1996 10:00:00         
22 february 10:00:00         
10:00:00  february 22 1996   
1996 feb 22                  
feb 22                       
10:00:00

Default values for day, month, year and time are current day, current month, current year and current system time respectively.

Any missing field in time (HH, MM, or SS) is replaced with the current HH, MM, or SS value. Thus, if the current date and time is March 12 1998 10:12:34, and only HH:MM are specified in the argument, the SS becomes "34":

-e 12:41 -> March 12 1998 12:41:34 
-s 12:41 -> March 12 1998 12:41:34 

If none of the time fields are specified, starttime defaults to the first minute of the day, and endtime defaults to the last minute of the day:

-s feb 22 -> feb 22 1998 00:00:00
-e feb 22 -> feb 22 1998 23:59:59 

FORMAT OF THE interval ARGUMENT

The interval argument must be an integer greater than zero and be input as minute, hour or day as follows:

minutes: 1m, 2m, etc. up to 999999999m  (9 digits)  
hours:   1h, 2h, etc. up to 9999999h    (7 digits)
days:    1d, 2d, etc. up to 99999d      (5 digits) 

EXAMPLES

FILES

/users/unison/log/act.log 

By default unilogons obtains its information from this file. Note that this file is only created if the [ENG] activity parameter in unison.ini is set to "TRUE".

WARNINGS

Input file and processing time

unilogons may take some time to finish depending on the size of the input file.

Input file and disk space

The disk space requirement to run unilogons is one and a half times the input file. Thus, if the size of the input file is 8 Mb, approximately 12 Mb of free disk space is required to run unilogons. unilogons creates its temporary files in the /users/unison/tmp directory so sufficient free space must exist in that directory.

EXIT STATUS

Exit values are:

0 Success

1 Failure

UNIMVUSER

unimvuser - Move a user from one calendar server node to another.

SYNTAX

unimvuser -u <user> -host1 <hostname1> -host2 <hostname2> -n1 <node-ID1> -n2 
<node-ID2> [-p1 <sysOpPsw1>] [-p2 <sysOpPsw2>] [-up <userPsw>] [-UID <preserve>] 
[-verbose] 

unimvuser -v 
unimvuser -h 

DESCRIPTION

unimvuser moves a user from one calendar server node to another.


Note:

unimvuser only works if all hosts in the network use a server greater than 4.0. Use unicpoutu and unicpinu to move users in a node network that includes nodes created by earlier versions of the calendar server.



Note:

See the WARNINGS section below before attempting to move a user from a 5.0 or greater node to a 4.0 or earlier node.


The move operation makes the following changes to the user information:

unimvuser logs these changes, along with the rest of its activity, in the /users/unison/log/unimvuser.log file.

It is important to understand that the move operation may still be in progress even after unimvuser has successfully completed. In particular, work is being done by the destination node (the node to which the user has moved) and by remote nodes (where other users reside who may have invited the user). Until the work is complete, the moved user sees an incomplete agenda.

The time required to complete the move operation depends on the number of requests waiting in the request queue of the Corporate-Wide Services daemon/service. For this reason, it is advisable to run unimvuser during off-peak hours for the calendar server.

In addition, the user being moved should not attempt to sign in to the calendar server before unimvuser has completed, nor should any other user attempt to work as a designate for the user being moved. Any changes made under these circumstances will be lost.

Never run more than one unimvuser operation at the same time. Even if the users involved are on different nodes and you run unimvuser on different calendar server hosts, the users may share some meetings or events; this scenario can cause database corruptions.

unimvuser can move a user from a node using an external directory server to a node using the calendar server's internal directory, but cannot move a user from a node using the calendar server's internal directory to a node using an external directory server.

Always use the most recent version of unimvuser, even when moving a user between nodes on calendar server hosts of earlier versions. For example, if your node network has two calendar server hosts of version 5.1 and one host of version 5.2, you should use the unimvuser utility in the bin directory of the 5.2 server.

In addition, it is recommended that you always invoke unimvuser from the command line rather than through the Windows NT administration tool.

Be aware also that differences in the configurations between the source host and the destination host may cause problems or block the move entirely. For example, if the maximum number of instances of a recurring meeting (unison.ini [ENG] maxinstances parameter) on the source server is set higher than on the destination server, and the user to be moved owns a recurring meeting with more instances than the destination host allows, the move will fail.

Note also that users cannot be specified using only the UID key/value pair.

The calendar server must be up to run unimvuser.

OPTIONS

-host1

<hostname1>

Specify the host name of the source node.

-host2

<hostname2>

Specify the host name of the destination node.

-n1

<node-ID1>

Specify the source node.

-n2

<node-ID2>

Specify the destination node.

-p1

<sysOpPsw1>

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

-p2

<sysOpPsw2>

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

-u

<user>

Specify the user to be moved. See FORMAT OF THE user ARGUMENT below for details on the proper specification of the user argument. For directory servers, the user must already exist in the directory server used by the destination node.

-UIDpreserve

Preserve original CAPI event UIDs. This option is required if CAPI is used on both the source and the destination node.

-up

<userPsw>

Internal directory only. Specifies a new password for the user. If this option is not used, the user will be able to log into the calendar server without a password. In the case of a directory server, this option has no effect since the password is stored in the directory server and thus remains unchanged.

-verbose

Use verbose mode.

-v

Print the current version number of unimvuser.

-h

Print a usage message explaining how to run unimvuser.

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. For all keys except the ID key, 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. Further note that the ID key-value pair may be specified without using the ID key, i.e. "-u 256" is a valid specification and is equivalent to "-u ID=256".


Table C-13 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

PHONE

Phone number

EXT

Phone extension

FAX

Fax phone number

EMPL-ID

Employee number

JOB-TITLE

Job title

EXAMPLES

FILES

/users/unison/log/unimvuser.log 

unimvuser logs its activity in this file.

WARNINGS

Moving a User from a 5.0 or Greater Node to a 4.0 Node

If you move a user from a 5.0 or greater node to a 4.0 node, the user loses the following data:

For this reason, performing such a move is not recommended. unimvuser warns you of this data loss and asks for confirmation before proceeding with the move.

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

UNINODE

uninode - Administer a calendar server node network.

SYNTAX

uninode -add [-nologinfo] <hostname>

uninode -apply [-y | -n] [-nologinfo] [<SysOpPsw>]

uninode -cws [-nologinfo] [<node-ID> | <hostname> | <group>]

uninode -edit [-e <editor>] [<SysOpPsw>]

uninode -import [-nologinfo] [<SysOpPsw>]

uninode -init [-nologinfo] [<SysOpPsw>]

uninode -reset [-nologinfo] [<node-ID> | <hostname> | <group>] [<SysOpPsw>] 

uninode -retry [-nologinfo] [<node-ID> | <hostname> | <group>] [<SysOpPsw>] 

uninode -snc [-nologinfo] [<node-ID> | <hostname> | <group>] 

uninode -test <node-ID> | <hostname> | <group>

uninode -v 
uninode -h 

DESCRIPTION

uninode is a centralized tool for setting up and administering a calendar server node network. See EXAMPLES for an example of setting up a node network. Use uninode to add and remove nodes from the node network, as well as to add and remove connections between nodes. Also use uninode to make queries about the node network configuration and about the status of remote connections.

uninode uses the node network configuration information in the nodes.ini file to configure the node network. Only one nodes.ini file should exist for a node network, regardless of how many calendar servers are linked. Furthermore, you manage the calendar server node network, that is you run uninode, from the machine on which this file exists. When your node network includes coexistence of multiple calendar server versions, always make sure that the host of the nodes.ini file is of the most recent version.

The <sysOpPsw> is the SYSOP password for the node in the calendar server network with the lowest node-ID on the machine hosting the nodes.ini file.

<node-ID>, <hostname> and <group> each restrict uninode's actions to certain nodes in the nodes.ini file. <node-ID> restricts uninode to the specified node, <hostname> to the nodes on the specified host, and <group> to the nodes in the specified group. <group> may be one of the following:

<group> may also be a customized group name. Consult your calendar server Administrator's Guide for further details on the meaning of each of these values. If none of these values are specified, uninode will assume the value all.

If you are using a directory server, you may want to run unidssync on each node before running uninode to ensure that the local information in each node is synchronized with what is in the directory server. Note that all nodes in a calendar server node network must use the same directory server.

uninode only runs if the calendar server is up.

uninode is not used with Business-to-Business (B2B) deployments.

OPTIONS

-add

<hostname>

Add all nodes found on the specified host to the nodes.ini file. This option first determines which nodes exist on the specified host. It then removes all lines for that host in the nodes.ini file, and finally adds a line for each node found on the host. Nodes are added as excluded nodes. You must edit the nodes.ini file to include them in the network.

-apply

Apply the configuration in the nodes.ini file. The <node-ID>, <group>, and <hostname> arguments restrict the application to specified nodes in the nodes.ini file.

uninode first verifies that:

If any of these verifications fails, uninode terminates.

Otherwise, it proceeds to check the remote node information in each of the nodes involved, and if it finds there are entries missing, it prompts the user to confirm the addition of the missing entries. Use the -y or -n option to automatically provide a response. Note that uninode does not delete any surplus entries from any of the nodes.

-cws

Print the following information for each connection between two nodes. This includes information from the CWS daemon/service.

-edit

<editor>

Safely edit a COPY of the nodes.ini file using the specified text editor. uninode first performs the verifications described in the -apply option and terminates if any of the verifications fails. If all verifications succeed, it invokes the editor. On exit from the editor uninode parses the edited file, and, if it does not find any errors, updates the original nodes.ini file. If uninode finds errors in the edited file, it prompts the user to either re-edit the file or abort the operation.

-import

Same as -apply with the -y option.

-init

Construct a nodes.ini file from the currently running node network configuration. The node with the lowest node-ID on the machine hosting the nodes.ini file is the one from which uninode begins construction of the file. If a nodes.ini file already exists, uninode prompts for confirmation to overwrite it.

-n

Prevent correction of any directory inconsistency when you use the -apply option.

-nologinfo

Do not write to the log file. By default, uninode logs any errors, as well as any output it sends to the screen, to the uninode.log file.

-reset

Reset the statistics of a Synchronous Network Connection (SNC) daemon. It is recommended that you reset all nodes at the same time by running uninode -reset all. Resetting the statistics allows the administrator to compare the statistics for different nodes at a later time.

-retry

Restart the retry mechanism of an SNC daemon. When there are fewer connections available than are configured, the SNC daemon attempts to acquire new connections at specific time intervals. It retries at intervals of 1, 2, 4, 8, 16, 32, and finally every 64 minutes. This option resets the interval to 1 minute. One use of this option might be to run uninode -retry all after a network-related problem is solved.

-snc

Print the following information on the TCP/IP connections for the specified node, or for each node in the specified group or on the specified host.

-test

Verify that it is possible to connect to a node or group of nodes. See the -apply option for a list of the items uninode -test verifies.

-y

Auto-confirm the correction of any directory inconsistency when you use the -apply option.

-v

Print the current version number of uninode.

-h

Print a usage message explaining how to run uninode.

EXAMPLES

CREATE A NODE NETWORK

You have a company with offices in three different countries. Each office runs its own calendar server. You want to set up a node network and manage it from the calendar server running on "gravlax" in Sweden.

  1. Log on to "gravlax" and create a nodes.ini file.
    % uninode -init
    
    

    Since no node network currently exists, uninode creates an empty nodes.ini file with sample lines included as comments.

  2. Add the nodes from each of the three calendar servers.
    % uninode -add gravlax
    % uninode -add gnocchi
    % uninode -add biryani
    
    
  3. Examine the contents of the nodes.ini file.
    % cat nodes.ini
    - H=biryani/N=32
    - H=biryani/N=31
    - H=gnocchi/N=25
    - H=gnocchi/N=24
    - H=gnocchi/N=23
    - H=gnocchi/N=22
    - H=gnocchi/N=21
    - H=gravlax/N=13
    - H=gravlax/N=12
    - H=gravlax/N=11
    
    
  4. Edit the file to configure the node network.
    % vi /users/unison/misc/nodes.ini
    
    

    The nodes.ini file now contains the following lines.

    % cat /users/unison/misc/nodes.ini
    + H=biryani/N=32/ALIAS=salesIndia/GR=india
    + H=biryani/N=31/ALIAS=adminIndia/GR=india
    - H=gnocchi/N=26/ALIAS=tempItaly/GR=italy
    + H=gnocchi/N=25/ALIAS=supportItaly/GR=italy
    + H=gnocchi/N=24/ALIAS=financeItaly/GR=italy
    + H=gnocchi/N=23/ALIAS=r&dItaly/GR=italy
    + H=gnocchi/N=22/ALIAS=salesItaly/GR=italy
    + H=gnocchi/N=21/ALIAS=adminItaly/GR=italy
    - H=gravlax/N=16/ALIAS=tempSweden/GR=sweden
    + H=gravlax/N=13/ALIAS=r&dSweden/GR=sweden
    + H=gravlax/N=12/ALIAS=salesSweden/GR=sweden
    + H=gravlax/N=11/ALIAS=adminSweden/GR=sweden
    included:2
    india:+2
    italy:+3
    sweden:+2
    
    

The node network has the following characteristics:

In this configuration, the total number of connections from node 13 is 22 (two to each of the other nine nodes in the network gives 18, plus two to each of the other two included nodes in the "sweden" group gives 4).

Consult your calendar server's Administrator's Guide for rules on configuring connections between nodes.

Next, apply the configuration. Since this is the first time that nodes "see" other nodes, you expect inconsistencies in their remote node directories. For this reason you use the -y option.

% uninode -apply -y

During execution of this command, uninode prints out information on the work it is performing. For example:

Processing node 11
connected to gravlax, node 11
connected to gravlax, node 12
added 11->12, TCP/IP connection
placed a request in the CWS queue to get node 12 user directory

FILES

/users/unison/misc/nodes.ini 

Contains the list of nodes and the rules that describe the calendar server's node network configuration.

/users/unison/log/uninode.log 

By default, uninode logs any errors, as well as any output it sends to the screen, to this file.

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

UNIPASSWD

unipasswd - Change a calendar server SYSOP or CWSOP password.

SYNTAX

unipasswd [-sysop | -cwsop] [-n <node-ID>] [-host <hostname>] [-p <sysOpPsw>]

unipasswd -v 
unipasswd -h 

DESCRIPTION

unipasswd changes the password of the SYSOP or CWSOP of a given node. Note that the -sysop and -cwsop options are all mutually exclusive.

The maximum length of a password is 15 characters.

unipasswd only runs if the calendar server is up.

If you use a Business-to-Business (B2B) deployment, always omit the -n option when changing SYSOP and CWSOP passwords. By default, unipasswd will change these passwords for all nodes. See WARNINGS.

OPTIONS

-cwsop

Change the password of the CWSOP.

-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 password is to be changed. Required if more than one node exists.

-p

<sysOpPsw>

Provide the current SYSOP password.

-sysop

Change the password of the SYSOP.

-v

Print the current version number of unipasswd.

-h

Print a usage message explaining how to run unipasswd.

EXAMPLES

WARNINGS

Business-to-Business (B2B) deployments and the Calendar Administrator

Do not change the SYSOP and CWSOP passwords for individual nodes. Doing so may cause the Calendar Administrator web interface to fail. In addition, after changing the SYSOP password, make sure that you update the [ADMINSETTINGS] serverpassword and serveroldpassword parameters in uniwebadm.ini. Failure to do so may cause an interruption in Calendar Administrator services.

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

UNIPING

uniping - Ping another calendar server.

SYNTAX

uniping [-host <hostname>] [-n <node-ID>] [-u <user>] [-p <password>] [-domain] 
[-i <sec>] [-allnodes] [-s <size>] [-stats] [-log] [-time]

uniping -v 
uniping -h 

DESCRIPTION

uniping sends echo messages to a node or a node network. Receiving nodes reply to the message, and uniping prints the elapsed time between sending the original message and receiving the replies. Use this utility to verify that a node is up, or to measure server response time under various load conditions.

Before sending any messages, uniping first authenticates the specified user on the specified node. uniping only sends messages if this authentication is successful.

uniping runs whether the calendar server is up or down.

OPTIONS

-allnodes

Send the echo message to all nodes connected to the node network containing the specified node.

-domain

Business-to-Business (B2B) deployments only. Used with the -host option. Checks whether the specified host is running Calendar Domain Services.

-host

<hostname>

Specify the name of a calendar server host. If this option is not used, the local host is assumed.

-i

<sec>

Specify an interval in seconds after which uniping repeats its echo message. If this option is not used, uniping sends one echo message to each specified node.

-log

Print errors to a log file (/users/unison/log/uniping.log).

-n

<node-ID>

Specify a node to connect to. Required if more than one node exists on the calendar server specified by the -host option.

-p

<password>

Provide the password for the user specified by the -u option. If you do not use the -u option, use -p to provide the SYSOP password. If you do not use the -p option, uniping will prompt you for the password.

-s

<size>

Specify the size of the echo message in bytes. The default is 64 bytes.

-stats

Display statistics on startup.

-time

Display the time at which each message is sent.

-u

<user>

Specify a user name to use for authentication. If this option is not used, SYSOP is used by default. Please note: this user name must be valid on the node specified by the -n option. Use the -p option to specify this user's password. See "FORMAT OF THE user ARGUMENT" below.

-v

Print the version number of uniping.

-h

Print a usage message explaining how to run uniping.

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. For all keys except the ID key, 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. Further note that the ID key-value pair may be specified without using the ID key, i.e. "-u 256" is a valid specification and is equivalent to "-u ID=256".


Table C-14 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

PHONE

Phone number

EXT

Phone extension

FAX

Fax phone number

EMPL-ID

Employee number

JOB-TITLE

Job title

EXAMPLES

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

UNIREQDUMP

unireqdump - View, and optionally delete, requests in the queue of the Corporate-Wide Services (CWS) daemon.

SYNTAX

unireqdump [-delete] [-excl <filter>] [-incl <filter>] [-item <itemnum>] 
[-remotenode <node-ID>] [-prompt] [-reqid <ID>] [-trcode <code>] [-n <node-ID>] 
[-p <sysOpPsw>]

unireqdump -v 
unireqdump -h 

DESCRIPTION

unireqdump outputs the set of requests currently in the queue of the Corporate-Wide Services daemon/service, unicwsd. The utility is also used to delete requests from the queue (using the -delete option).

By default, all requests in the queue are output. The -excl, -incl, -item, -remotenode, -reqid, and -trcode options allow you to select requests satisfying specific criteria. These options are applied successively so each of the requests in the output must meet the combined criteria for all of the options specified.

Numeric arguments can be either decimal or hexadecimal values (where hexadecimal values are prefixed by "0x"). The single exception is the ID argument to the -reqid option, where a hexadecimal value is always assumed, even if the "0x" prefix is not present.

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

OPTIONS

-delete

Enable the deletion option. After each request is output, the user is prompted to confirm whether or not they wish to delete it. The -prompt option may be used along with this option to tell unireqdump to automatically delete ALL of the requests in the output, without prompting for confirmation.

-excl

<filter>

Set an exclusion filter. Requests matching this filter are excluded from the output. The possible filters are:

-incl

<filter>

Set an inclusion filter. Requests matching this filter are included in the output. The possible filters are listed under the -excl option.

-item

<itemnum>

Select only requests matching the specified item number. itemnum is the numeric ID of the item.

-n

<node-ID>

Specify the node from which the request originated. Required if more than one node exists on the server running unireqdump. The SYSOP password unireqdump requires is the one for this node.

-p

<sysOpPsw>

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

-prompt

Used with the -delete option to tell unireqdump to automatically delete all of the requests in the output, without prompting for confirmation. Use this option with care!

-remotenode

<node-ID>

Select only requests destined for the specified remote node.

-reqid

<ID>

Select the request with the specified ID. ID is a hexadecimal value (it is not necessary to prefix the value with "0x", though doing so causes no harm).

-trcode

<code>

Select requests with the specified transaction code. The transaction code may be expressed numerically (the numeric values are available in the documentation for the calendar programming interface), or as one of the following strings:

agendaget
attendadd
echo
eventattend
eventcreated 
eventdeleted
eventmodified
foreignerdeleted
instanceadded
instancemodified
itemdeleted
itemmodified
mailmessagepost 
nodeitemsget
notifynewevent 
notifynewinstance
securityadd
securitydeleted
securitymodified

-v

Print the current version number of unireqdump.

-h

Print a usage message explaining how to run unireqdump.

EXAMPLES

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

UNIRES

unires - List, add, or delete calendar resources, or modify the information associated with them.

SYNTAX

Listings

unires -ls [<res>] [-format <format>]  [-host <hostname>] -n <node-ID> [-p 
<sysOpPsw>]

unires -format <format>  [-host <hostname>] -n <node-ID> [-p <sysOpPsw>]

Addition

unires -add <res> [-s <sections>]  [-host <hostname>] -n <node-ID> [-p 
<sysOpPsw>]

Deletion

unires -del <res> [-y]  [-host <hostname>] -n <node-ID> [-p <sysOpPsw>]

unires -desdel <res>  [-host <hostname>] -n <node-ID> [-p <sysOpPsw>]

unires -grpdel <res>  [-host <hostname>] -n <node-ID> [-p <sysOpPsw>]

Modification

unires -mod <res> -s <sections> | -m <modifier>  [-host <hostname>] -n <node-ID> 
[-p <sysOpPsw>]

Multiple additions, deletions, modifications

unires -ex <filename> [-s <sections>] [-k]  [-host <hostname>] -n <node-ID> [-p 
<sysOpPsw>]

Other

unires -s [<sections>] -n <node-ID> [-p <sysOpPsw>]

unires -info 

unires -v 
unires -h 

DESCRIPTION

unires is used to list, add, or delete calendar resources, and to modify the information associated with them. Resources are identified by their names so each must be unique. Details on how to specify the res argument are given in the FORMAT OF THE res ARGUMENT section below. Note that the -ls, -add, -del, -grpdel, -desdel, and -mod options are all mutually exclusive.

The information associated with a resource is a combination of the key-value pairs described in the FORMAT OF THE res ARGUMENT below and that contained in the resource.ini file (which includes the resource preferences, security, personal group, admin group membership, and the list of users permitted to work as a designate for the resource).

uniuser is the complementary utility for users.

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

OPTIONS

-add

<res>

Create a new resource. If the resource already exists, an error is reported. The information associated with the new resource is a combination of what is specified in the res argument, and the default values in the resource.ini file. By default, when unires reads the resource.ini file, it considers only the default values in the [GEN] section. Use the -s option to apply default values from other sections of the resource.ini file. Use the -ex option to create multiple resources.

When using the calendar server's internal directory, the "R" key is mandatory for the -add option.

For external directory server contexts, the DID (Directory ID) should be specified in the res argument. If no DID is specified, unires will generate one from the "R=" value. See EXAMPLES.

-del

<res>

Delete the specified resource. unires prompts for confirmation before performing the deletion unless the -y option is used. To delete more than one resource, use the -ex option.

-desdel

<res>

Delete the list of designates for the specified resource. If more than one resource matches <res>, the command fails.

-edit

This option exists only under UNIX. It allows you to first output the list of existing calendar resources to a file, then edit the file to make desired modifications, and finally input the changes back into the node. The following sequence of commands is performed:

% unires -ls -n node-ID > file
% vi file
% unires -ex file -n node-ID
% rm file

-ex

<filename>

Perform the additions, deletions and/or modifications specified in filename. Each line of the file must begin with one of the characters `.', `#', `A', `a', `D', `d', `M', `m', `S', `s', or `+'. This initial character specifies the action to take, as follows:

Character Action

`.' or `#'

ignore the line

`A' or `a'

add the resource

`D' or `d'

delete the resource

`M' or `m'

modify the resource

'S' or 's'

update the resource with the settings from the resource.ini file

`+'

treat the line as the continuation of the previous line; note that key-value pairs cannot break over lines

The initial character must be followed by a space and a resource specification. In the case of a modification, the ID for the resource must be supplied; it is used to identify the resource, while the other key-value pairs specified along with it are applied as the modifications. See EXAMPLES.

For each deletion specified in the file, unires prompts for confirmation before performing the deletion. The -y option may be used to automatically provide confirmation.

One way to create this file is to save the output of unires -ls to a file. This can then be edited and input to unires -ex.

The -s sections option may be used with -ex to set the corresponding resource information to the default values contained in the specified sections of the resource.ini file.

For directory servers, the DID can be followed by data in X.400 format. Note that the ability to modify the name of a resource (the "R" key) depends on the directory server.

-format

<format>

This option is used to select resource information fields and customize the format of the output. The -info option lists the parameters that can be used to specify the customized format. These are also listed in the FORMAT OF THE res ARGUMENT section below. If this option is not used, all resource information fields are output, and a default presentation is used. See EXAMPLES.

-grpdel

<res>

Delete the specified resource from all admin groups. A single resource must match <res> or the command fails.

-host

<hostname>

Specifies a host on which to look for the node specified by the -n option. Required for remote hosts. If -host is not present, unires will assume the local host. For modification or deletion, if -host is specified and -n is not, unires will search for a master node on the specified host. If a master node is found, unires will use it to locate the selected users.

-info

List the format parameters used with the -format option.

-k

Used with the -ex option to force unires to process all lines in the file even if it encounters an error. Errors are sent to standard error; use file redirection to capture these to a file.

-ls

[<res>]

If a resource is specified, -ls lists that resource (in the specified node). Each output line contains a period (`.'), a space, the resource description, and the ID of the resource. If no resource is specified, all resources in the node are listed. The -format option can be used with -ls to configure the presentation of the output (see EXAMPLES).

-m

<modifier>

Specify a modification to make to the resource information. The modifier is a string of the same form as the <res> argument with the following exceptions: the ID key may NOT be specified, and the PSW key MAY be specified.

-mod

<res>

Modify the information associated with the specified resource. This option is used with either the -s sections or the -m modifier option. When used with the -s option, it sets the corresponding information for the resource to the values contained in the specified sections of the resource.ini file. When used with the -m modifier option, modifications are made to the key-value pairs listed in the FORMAT OF THE res ARGUMENT. In the case of a directory server, the ability to modify the name of a resource (the R key) may depend on the directory server.

-n

<node-ID>

Specify a node.

-p

<sysOpPsw>

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

-s

[<sections>]

Evaluate all or some of the contents of the resource.ini file and output information from it to standard output.

Use this option without the <sections> argument to determine what sections exist in the resource.ini file. The output in this case is a list of all section names along with their respective "Info" key-value pairs.

Use the <sections> argument to evaluate all of the key-value pairs in the specified sections. In this case all key-value pairs in the specified sections are output, along with any errors detected in these pairs. This is one way to validate the contents of the resource.ini file. See the -add and -mod options for information on using -s <sections> to apply values from resource.ini.

The <sections> argument is a list of one or more section names, each separated by a forward slash (e.g. "GEN/GR1/GR2" specifies the sections GEN, GR1 and GR2). Evaluation is done from left to right. Thus, in the above example, GEN is evaluated first, GR1 second, and GR2 last. Where the same key appears in more than one section, the value of the last instance evaluated takes precedence.

-y

Used with the -del and -ex options to auto-confirm the deletion(s).

-v

Print the current version number of unires.

-h

Print a usage message explaining how to run unires.

FORMATS

FORMAT OF THE res ARGUMENT

The res 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. For all keys except the ID key, 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/G=James\/Jim".

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. Also note that the PSW key may only be specified in the res argument for the -add option.

The format parameters listed in the third column below are used with the -format option to configure the presentation of a listing (see EXAMPLES).

Table C-15 Accepted keys
Key Field Format parameter

R

Resource name

%R

N

Resource number

%N

CA

Capacity

%CA

S

Contact's surname

%S

G

Contact's given name

%G

ID

Identifier

%ID

LOC

Location

%LOC

PHONE

Phone number

%PHONE

EXT

Phone extension

%EXT

FAX

Fax phone number

%FAX

PSW

Password

(maximum of 15 characters; -add only)

None

EXAMPLES

LISTINGS

ADDITION

DELETION

MODIFICATION

MULTIPLE ADDITIONS, DELETIONS, MODIFICATIONS

Multiple additions, deletions, modifications are done using the -ex option. In this example two new resources are added (a BetaCam and a VCR; the contact for the BetaCam is specified at the same time as the add is being done), the capacity of an existing resource is modified, and an existing resource is deleted. A directory server is being used.

  1. Create the file:
    % vi multiple.dat
    % cat multiple.dat
    A DID=cn=betacam,o=Acme,c=US/S=Fellini/G=Fred
    A DID=cn=vcr1,o=Acme,c=US
    M R=RedRoom/CA=25/ID=441
    D R=BlueRoom
    
    

    Note that in the case of the modification, the resource is the one which has ID=441; the capacity of the resource is modified to "25".

  2. Input the file to unires:
    % unires -ex multiple.dat -n 12
    
    
  3. Enter SYSOP password:
    unires: added "cn=betacam,o=Acme,c=US"
    unires: added "cn=vcr1,o=Acme,c=US"
    unires: modified "RedRoom"
    unires: deleted "BlueRoom"
    

FILES

unires.ini 

This file specifies possible calendar resource configurations. See also the calendar server Reference Manual, Appendix A, "User and Resource Parameters".

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.

Modification of Key-Value Pairs

This utility uses the [UTL] adm_modres<field> parameters in unison.ini to determine whether or not it can modify the corresponding resource key-value pairs. For example, if adm_modrescapacity is set to "FALSE", then the value associated with the CA key cannot be modified by this utility.

If no corresponding adm_modres<field> for a particular key appears in the file, the utility assumes it CAN modify it.

Deleting resources with large agendas

Deleting resources with a large numbers of meetings and events can take a long time and cause a decrease in performance for other calendar users. It is recommended that you delete such resources outside of normal hours, or at least not at times of peak calendar usage.

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

SEE ALSO

uniuser is the complementary utility for users

UNIRMOLD

unirmold - Remove old events and tasks from agendas in a calendar server database.

SYNTAX

unirmold [<user>] [-event | -task] [-n <numOfDays>] [-y] <node-ID> [-p 
<sysOpPsw>] [-include <types>] [-sync]

unirmold -res [<resource>] [-n <numOfDays>] [-y] <node-ID> [-p <sysOpPsw>]

unirmold -v 
unirmold -h 

DESCRIPTION

unirmold removes events and/or tasks older than a specified number of days from agendas in a calendar server database.

To remove an event from an agenda, unirmold "uninvites" the owner of the agenda from the event. This has two consequences: the event no longer appears in that agenda AND the owner of that agenda no longer appears on the list of invitees to the event. The update to the list of invitees propagates as necessary to the other nodes in the node network.

By default, unirmold removes all events and tasks older than 90 days from all user agendas in the node and all events older than 90 days from all resource agendas in the specified node. The -res option restricts unirmold to events in resource agendas. The <user> argument restricts unirmold to the agendas of the specified users. See FORMAT OF THE <user> ARGUMENT below for details on how to specify <user>.

When using unirmold in -res mode, you may specify a resource filter using the <resource> argument. See FORMAT OF THE <resource> ARGUMENT below for details on how to specify <resource>.


Note:

unirmold only removes tasks if the start date, the due date, and the completion date are all older than the specified number of days.


unirmold only runs if the calendar server is up.

OPTIONS

-event

Delete only old events. By default unirmold deletes both events and tasks from the user agenda.

-include

<types>

Delete events which are special types of events. Currently this option applies only to events which are either Outlook journal entries or sticky notes. The <types> argument is one or more of the following: journal, sticky. For example, to delete both events which are journal entries and events which are sticky notes, use -include journal sticky. To delete only events which are sticky notes, use -include sticky.

-n

<numOfDays>

Delete events and tasks that are more than <numOfDays> days old from the agenda. If you do not use this option, the default value is 90 days. The minimum value is 30 days.

-p

<sysOpPsw>

Provide the SYSOP password for the node. If you do not use this option, unirmold prompts for the password.

-res

<resource>

Remove all events in resource agendas only. You may specify a filter to select specific resources by providing the <resource> argument. See FORMAT OF THE <resource> ARGUMENT below for details.

-sync

Removes all sync records from the user agenda.

-task

Delete only old tasks from the user agenda. If this option is not used, both events and tasks are deleted.

-y

Eliminate prompting for confirmation of any deletions.

-v

Print the current version number of unirmold.

-h

Print a usage message explaining how to run unirmold.

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-16 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

FORMAT OF THE <resource> ARGUMENT

The <resource> 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. For all keys except the ID key, 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/G=James\/Jim".

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 <resource> argument, all other key-value pairs specified along with it are ignored.

Table C-17 Accepted keys
Key Field Format parameter

R

Resource name

%R

N

Resource number

%N

ID

Identifier

%ID

EXAMPLES

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

UNIRNDEL

unirndel - Delete a remote node from a local calendar server node database.

SYNTAX

unirndel remoteNoteId [<sysOpPsw>] [-n <node-ID>]

unirndel -v 
unirndel -h 

DESCRIPTION

unirndel deletes all references to a remote node from the database of a local node. By default the local node is the one with the name "N1". unirndel should only be used to delete a remote node created for test purposes. You should consult Oracle Support before using unirndel.

It is recommended that you back up the local /users/unison/db directory before running unirndel.

unirndel runs only if the calendar server is up.

OPTIONS

-n

<node-ID>

Specifies the node-ID of the local node database from which the remote node should be deleted.

-v

Print the current version number of unirndel.

-h

Print a usage message explaining how to run unirndel.

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

UNIRNSYNCH

unirnsynch - Propagate deletions in the local information of one node to another node in the network.

SYNTAX

unirnsynch -rn <node-ID> [-rhost <hostname>] [-rp <remote-sysop-password>] -n 
<node-ID> [-host <hostname>] [-p <sysop-password>] 

unirnsynch -v 
unirnsynch -h 

DESCRIPTION

unirnsynch is used to propagate deletions in the local information of one node to another node in the network. Each node in a node network contains both local information and remote node information, where:

The remote node information of a given node is constructed from the local information of each of the other nodes in the node network.

Changes to the local information of a node are normally automatically propagated to the remote node information of all other nodes in the network. However, if for any reason discrepancies do occur, the remote node information can be updated using unirnsynch and/or uninode. uninode (using the -apply option) may be used to add missing entries while unirnsynch is used to delete entries which no longer exist in the local information.

uninode -cws all may be used to determine whether or not discrepancies exist (see the IMPORT-DIR field of the output).

The calendar server must be up to run unirnsynch.

OPTIONS

-host

<hostname>

Specify the host where the node that has had deletions to local information resides.

-n

<node-ID>

Specify the node-ID of the node that has had deletions to its local information.

-p

<sysOpPsw>

Provide the SYSOP password of the node that has had deletions to its local information.

-rhost

<hostname>

Specify the host where the node that is to have its remote node information updated resides. Default is the local host.

-rn

<node-ID>

Specify the node-ID of the node that is to have its remote node information updated.

-rp

<remote-sysOpPsw>

Provide the SYSOP password of the node that is to have its remote node information updated.

-v

Print the current version number of unirnsynch.

-h

Print a usage message explaining how to run unirnsynch.

EXAMPLES

EXIT STATUS

Exit values are:

0 Success

1 Usage error

2 System error

SEE ALSO

uninode

UNISIZEOF

unisizeof - Compute the size of the calendar server installation.

SYNTAX

unisizeof [-db | -n <node-ID>]

unisizeof -v 
unisizeof -h 

DESCRIPTION

unisizeof computes the size of a calendar server installation. By default, it determines the size of the /users/unison directory, including all database nodes and the calendar server (executables, *.ini files, etc.). Use the -db option to determine the size of the entire database and the -n option to determine the size of a single database node.

unisizeof runs whether the calendar server is up or down.

OPTIONS

-db

Compute the size of the entire database. The entire database is made up of all nodes on the server.

-n

<node-ID>

Compute the database size of the specified node.

-v

Print the version number of unisizeof.

-h

Print a usage message explaining how to run unisizeof.

EXAMPLES

FILES

/users/unison/misc/unison.ini 

Used to determine the default node (i.e. the node for which "name = N1" in this file) when unisizeof is used with the -db option.

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

UNISLICE (UNIX ONLY)

unislice - Extract information from the calendar server's log files.

SYNTAX

unislice <logFile(s)> [-s <starttime>] [-e <endtime>]

unislice -v 
unislice -h 

DESCRIPTION

unislice extracts information from the specified log file(s) and sends it to standard output. The unisnapshot utility uses unislice to gather information contained in log files. The <logFile(s)> argument is a list of one or more log files; each must be a fully-specified pathname separated from the others by a space. unislice can run on most of the log files in the /users/unison/log directory.

unislice runs whether the calendar server is up or down.

OPTIONS

-e

<endtime>

Set an end time. Only log file information with time stamps prior to this time are included in the output. Thus, if an end time of January 1 is set, no information from the 1st of January is included. See FORMAT OF starttime, endtime ARGUMENTS below for details on how to specify these arguments.

-s

<starttime>

Set a start time. Only log file information with time stamps on or after this time are included in the output. See FORMAT OF starttime, endtime ARGUMENTS below for details on how to specify these arguments.

-v

Print the current version number of unislice.

-h

Print a usage message explaining how to run unislice.

FORMATS

FORMAT OF THE time ARGUMENTS

Each of these arguments can take one of the forms:

where

EXAMPLES

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

SEE ALSO

unisnapshot

UNISNAPSHOT

unisnapshot - Compile calendar server information for diagnostic purposes.

SYNTAX

unisnapshot [<date>] [-nolog] [-p <sysOpPsw>]

unisnapshot [-s <starttime>] [-e <endtime>] [-nolog] [-p <sysOpPsw>]

unisnapshot -v 
unisnapshot -h 

DESCRIPTION

unisnapshot assembles information used by support staff to diagnose most calendar server problems. Should a problem ever arise, only this file need be supplied to support staff.

Output is written to the unisnapshot.log file in the /users/unison/log directory. unisnapshot can be restricted to include log file information logged during a single day, or during a specified time period. This reduces the amount of irrelevant information in the output.

Under Windows operating syatems, unisnapshot requires the SYSOP password for each node. See the -p option below for more information.

See FORMAT OF THE date ARGUMENT below for details on how to specify <date>.

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

OPTIONS

-e

<endtime>

Set an end time. Only log file information with time stamps prior to this time are included in the output of unisnapshot. Thus, if an end time of January 1 is set, no information from the 1st of January is included. <endtime> is a string of the same format as <date>.

-nolog

Prevent unisnapshot from including log file information in its output.

-p

<sysOpPsw>

This option exists only under Windows operating systems. Specify the SYSOP password to use to connect to each node. If you use this option, the SYSOP password must be the same for all nodes. If you do not use this option under Windows, unisnapshot prompts for the SYSOP password for the first node at the time it connects to that node. For each subsequent node, it prompts for the SYSOP password only if the SYSOP password for that node is different from the last SYSOP password entered.

-s

<starttime>

Sets a start time. Only log file information with time stamps on or after this time are included in the output of unisnapshot. <starttime> is a string of the same format as date.

-v

Print the current version number of unisnapshot.

-h

Print a usage message explaining how to run unisnapshot.

FORMATS

FORMAT OF THE date ARGUMENT

The date argument takes one of the forms:

where

If no year is specified, the default is the current year.

EXAMPLES

FILES

/users/unison/log/unisnapshot.log 

This is the file where unisnapshot writes its output. If a previous file exists at the time unisnapshot is invoked, it is overwritten.

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

WARNING

unisnapshot may take some time to complete.

UNISNCDUMP

unisncdump - Retrieve statistics from the calendar server's Synchronous Network Connection daemon/service.

SYNTAX

unisncdump [-host <hostname>] [-n <node-ID>] [-p <sysOpPsw>] [-screen]

unisncdump -v 
unisncdump -h 

DESCRIPTION

unisncdump retrieves statistics from the unisncd daemon and writes them to the /users/unison/log/unisncdump.log file. Included are the number of configured and available connections for each service.

OPTIONS

-host

<hostname>

Specify the host on which the unisncd is located.

-n

<node-ID>

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

-p

<sysOpPsw>

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

-screen

Display the output on the screen instead of writing it to the log file.

-v

Print the version number of unisncdump.

-h

Print a usage message explaining how to run unisncdump.

EXAMPLES

FILES

/users/unison/log/unisncdump.log 

unisncdump writes to this file by default.

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

UNISTART

unistart - Start up the calendar server.

SYNTAX

unistart [-bypass] [-nocws | -cws] [-nosnc | -snc] [-das] [-r] [-w <secs>] [-c] 
[-n] [-s] 

unistart -v 
unistart -h 

DESCRIPTION

unistart starts the calendar server. The default action is to start all 5 the calendar server daemons/services, in the following order: unilckd, uniengd, unidasd (if a Directory Server is being used), unisncd, and unicwsd. If you start any of the daemons/services manually, you must respect this order to avoid problems. For example, if you start unisncd manually, you must be certain that unilckd, uniengd, and unidasd (if you are running a Directory Server) are all running, and that unicwsd is not running.

By default, unistart calls unicheck to check the file system. It invokes unicheck with the option "-maxdb 30", restricting the check to including only the first 30 node databases.


Note:

-bypass, -c, -cws, -das, -n, -nosnc, -s, -snc and -w are all UNIX-only options.


OPTIONS

-bypass

By default, unicheck is run before the daemons/services are started. This option causes unistart to execute without running unicheck.

-c

Same as -cws. Included for backwards compatibility.

-cws

Starts only unicwsd, the Corporate-Wide services daemon/service, provided that the unilckd and uniengd daemons/services are up. To avoid problems, you should also be certain that unidasd (if you are running a Directory Server) and unisncd are running.

-das

Starts only unidasd, provided that the unilckd and uniengd daemons/services are up. Note that this daemon is used only with directory servers. To avoid problems, you should also be certain that unisncd and unicwsd are not running.

-n

Same as -nocws. Included for backwards compatibility.

-nocws

By default, unicwsd is started if the [CWS] enable parameter in unison.ini is set to "TRUE". This option overrides this setting and prevents unicwsd from being started. If this option is used under NT, unicwsd can be brought up later by simply running unistart again without this option.

-nosnc

By default, unisncd is started if the [SNC] enable parameter in unison.ini is set to "TRUE". This option overrides this setting and prevents unisncd from being started.

-r

Removes the log files act.log, cws.log, das.log, dbv.log, eng.log, lck.log, and snc.log from the /users/unison/log directory. Note that new log files are immediately created for cws.log, das.log, eng.log, lck.log, and snc.log.

-s

Same as -w. Included for backwards compatibility.

-snc

Starts only unisncd, provided that the unilckd and uniengd daemons/services are up. To avoid problems, you should also be certain that unidasd (if you are running a Directory Server) is running and unicwsd is not running.

-w

<secs>

When a process is started there is a short delay before a ps(1) command acknowledges the existence of the process. It is therefore appropriate to sleep until a ps(1) verifies that the process is running. The default period is 2 seconds. This option can be used to override this default; the <secs> argument specifies the number of seconds to sleep.

-v

Print the current version number of unistart.

-h

Print a usage message explaining how to run unistart.

EXAMPLES

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

UNISTAT

unistat - Produce a report on a calendar server node.

SYNTAX

unistat [-l | -p] [-s | -g] [-m] [-sn] -n <node-ID> 

unistat -v 
unistat -h 

DESCRIPTION

unistat produces a report for the specified node and sends it to standard output. unistat prompts the user for the SYSOP password for the node. The following information is included in the report:

The calendar server must be up for unistat to run.


Note:

The -l and -p options are mutually exclusive, as are the -s and -g options.


OPTIONS

-g

Print the list of public groups.

-l

Print the report in 128 characters per line mode. If this option is not used, the default is 80 characters per line.

-m

Print the members of the public groups.

-n

<node-ID>

Generate statistics for the specified node.


Note:

On UNIX, the -n is optional; a node-ID may be specified on the command line without being preceded by -n.


-p

Create a PostScript report. File redirection should be used to capture this to a file.

-s

Print database statistics.

-sn

Print serial numbers. Obsolete with Oracle Collaboration Suite.

-v

Print the current version number of unistat.

-h

Print a usage message explaining how to run unistat.

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

UNISTATS

unistats - Display summary statistics of the data in a calendar server stats file.

SYNTAX

unistats [-s <starttime>] [-e <endtime>] [-f <filename>] [-server <version>] 
[-client <entry>] [-n <node-ID>] [-user <name> | -res <resource> | -ruser] 
[-all]

unistats -v 
unistats -h 

DESCRIPTION

Displays summary statistics of the data in a calendar server stats file. By default, the input file is /users/unison/log/stats.log. Filters (i.e. the -server, -client, -n, -user, -res, -ruser options) may be used to compile statistics from a subset of the information in the stats file.

The default output is a summary for each unique client. Different versions of the same client are treated as separate clients, and a summary is output for each. The -all option displays a summary incorporating all clients. All output is displayed in 122-character-wide format. A complete list of all output fields is given in the OUTPUT section below.

OPTIONS

-all

Display summary incorporating all interface clients.

-client

<entry>

Display summary statistics on a specific calendar client. <entry> is the name and version of that client. See FORMAT OF THE entry, name, AND resource ARGUMENTS below for details on how to specify <entry>.

-e

<endtime>

Specify end time for statistics. If this option is not used, the default is the current time of the current day of the current month of the current year. See FORMAT OF THE time ARGUMENT below for details on how to specify <endtime>.

-f

<filename>

Specify the file to be used. This file must be in the same format as the default input file /users/unison/log/stats.log. This option is commonly used where a file has been created from an existing stats.log file and is supplied as input to unistats.

-n

<node-ID>

Display summary statistics on a specific node. <node-ID> is a calendar server node-ID.

-res

<resource>

Display summary statistics on a specific resource. <resource> is the name and/or identification number of the resource. See FORMAT OF THE entry, name, AND resource ARGUMENTS for details on how to specify <resource>.

-ruser

Display summary statistics on all reserved users (e.g. SYSOP).

-s

<starttime>

Specify a start time for the statistics. If this option is not used, the default start time is "Jan 1 1991 00:00:00". See FORMAT OF THE time ARGUMENT below for details on how to specify <starttime>.

-server

<version>

Display summary statistics on a specific calendar server. <version> is the version number of that server (e.g. A.02.90).

-user

<name>

Display summary statistics on a specific user. <name> is some combination of the surname, given name, and organizational units of the user. See FORMAT OF THE entry, name, AND resource ARGUMENTS below for details on how to specify <name>.

-v

Print the current version number of unistats.

-h

Print a usage message explaining how to run unistats.

FORMATS

FORMAT OF THE entry, name, AND resource ARGUMENTS

Each of the arguments <entry>, <name>, and <resource> 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 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-18 Accepted keys
OPTION KEY MEANING OF THE KEY

-client

N

Client Name

-client

V

Client Version

-user

S

Surname

-user

G

Given name

-user

OU1

Organizational Unit 1

-user

OU2

Organizational Unit 2

-user

OU3

Organizational Unit 3

-user

OU4

Organizational Unit 4

-res

R

Resource Name

-res

ID

Resource ID

Some example specifications are:

-client "N=Windows CorporateTime - 32 Bit/V=version 4.1"
-user "S=Carter/G=Angela"
-res "R=laptop"
-res "ID=328"

FORMAT OF THE time ARGUMENT

The <starttime> and <endtime> arguments may be expressed as either:

where

The order of the individual elements in the argument is unimportant. What is important is that either day and month be specified, or time be specified. The following are all valid examples:

Feb 22 1996 10:00:00 
22 february 10:00:00
10:00:00 february 22 1996 
1996 feb 22 
feb 22 
10:00:00

Default values for <day>, <month>, <year>, and <time> are the current day, current month, current year and current system time respectively.

Any missing field in <time> (HH, MM, or SS) is replaced with the current HH, MM, or SS value. E.g. if the current date and time is March 12 1998 10:41:34, and only HH:MM are specified in the argument, the SS becomes "34":

-e 12:41 -> March 12 1998 12:41:34 
-s 12:41 -> March 12 1998 12:41:34 

If none of the time fields are specified, <starttime> defaults to the first minute of the day, and <endtime> defaults to the last minute of the day:

-s feb 22 -> feb 22 1998 00:00:00
-e feb 22 -> feb 22 1998 23:59:59 

OUTPUT

All output fields displayed by unistats are explained here, in the order in which they will be seen:

Table C-19 unistats CLIENT output fields
CLIENT fields Description

CLIENT

Name and Version of the calendar client

SYSTEM

Name of the host operating system of the calendar server

SERVER

The calendar server version

SIGNONS

Number of records used for the summary statistics of this client

SESSION AVERAGE

Average session time

CPU TOTAL

Total cpu time for all SIGNONS

CPU MEDIAN

Median cpu time

CPU AVERAGE

Average cpu time; "usr" stands for user and "sys" stands for system

NETWORK TOTAL

Total number of bytes exchanged between the client and calendar server host

NETWORK MEDIAN

Median of NETWORK TOTAL

NETWORK AVERAGE

Average of NETWORK TOTAL; "snd" stands for send and "rcv" stands for receive

CALLS

Total number of function calls

Table C-20 unistats FUNCTION NAME output fields
FUNCTION NAME fields: Description

CALL (%)

Percentage of all calls for this function

TIME (W)

Greatest user response time for function to process one call

TIME (A)

Average user response time for processing this function

CPU (%)

Percentage of all cpu time taken by this function

CPU (%U)

Percentage (of CPU(%) above) taken by the user

CPU (%S)

Percentage (of CPU(%) above), taken by the system

CPU (W)

Greatest cpu time taken by this function to process one call

CPU (A)

Average cpu time taken by this function to process one call

NET (%)

Percentage of all network i/o used by this function

NET (%S)

Percentage (of NET(%) above) of data sent

NET (%R)

Percentage (of NET(%) above) of data received

EXAMPLES

FILES

/users/unison/log/stats.log 

By default, unistats obtains its information from this file. The [ENG] stats parameter in unison.ini must be set to "TRUE" to enable uniengd to log information to this file.

/users/unison/log/unistats.log 

unistats logs any errors in this file.

EXIT STATUS

Exit values are:

0 Success

1 usage error

2 system error

UNISTATUS

unistatus - Determine the status of the calendar server.

SYNTAX

unistatus [-f] [-d] [-s] [-q] [-n] [-e] 

unistatus -v 
unistatus -h 

DESCRIPTION

By default unistatus determines which of the calendar server daemons/services are running and prints their current status to standard output. The -d, -f, -n, -q, and -s options are currently supported only on UNIX platforms.

unistatus runs whether the calendar server is up or down.

OPTIONS

-d

Produce a report for daemon processes only.

-e

Alter the default exit status values to provide information about the calendar server daemon/services. See EXIT STATUS below for the values and their meanings.

-f

Produce an extensive ps-like report, taking into account the distinction between daemons and servers. The calendar server may have the following daemons and servers running:

-n

Suppress the printing of the messages "CORPORATE-WIDE SERVICES are down" or "REMOTE-NODE SERVICES are down" when the unilckd and uniengd daemons/services are running but the unicwsd or unisncd daemons/services are not.

-q

Force the quiet version of the command which does not produce the usual status message.

-s

Produce a report for server processes.

-v

Print the current version number of unistatus.

-h

Print a usage message explaining how to run unistatus.

EXAMPLES

EXIT STATUS

The default exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

Use of the -e option alters the default exit values to encode the status of the various calendar server daemons/services. These values are as follows:

UNISTOP

unistop - Shut down the calendar server.

SYNTAX

unistop [-y] [-bypass] [-ser] [-cws] [-snc] [-das] [-dass] [-w <secs>] [-l 
<level>] [-cl <level>] 

unistop -v 
unistop -h 

DESCRIPTION

unistop shuts down all or part of a running calendar server. By default, all daemons/services are shut down, in the following order: unicwsd, unisncd, unidasd (if a directory server is being used), uniengd, and unilckd. If any users are currently signed-on, unistop prompts for confirmation before proceeding with the shutdown. If you stop any of the daemons/services manually, you must respect this order to avoid problems. For example, if you stop unisncd manually, you must be certain that unicwsd is not running and that unilckd, uniengd, and unidasd (if you are running a Directory Server) are all running.

The -bypass, -cl, -das, -dass, -l, -ser, -snc, -w, and -y options are all UNIX-only. The -l and -cl options are mutually exclusive.

unistop can only be run if the calendar server is at least partially up (i.e. one or more daemons/services are running).

OPTIONS

-bypass

Allow unistop to execute even if another unistart or unistop process is running.

-cl

<level>

Allow cycling of shutdown levels from 0 up to the specified level, when the current level fails. Thus, levels 0, 1, 2, & 3 are tried until either the specified level is reached or the shutdown is successful. The user is NOT prompted for any confirmation.


Warning:

A shutdown at level 3 may corrupt the calendar server database. See the -l option for more information.


-cws

Shut down only the Corporate-Wide Services daemon/service (unicwsd). The unilckd and uniengd daemons/services must be running for this option to succeed. To avoid problems, you should also be certain that unisncd and unidasd (if you are running a Directory Server) are both running.

-das

Stop only the unidasd daemons and servers. These are used only with a directory server. The unilckd and uniengd daemons/services must be running for this option to succeed. To avoid problems, you should also be certain that unicwsd and unisncd are both running.

-dass

Stop only the unidasd servers. These are used only with a directory server.

-l

<level>

The shutdown levels are 0, 1, 2 and 3, with the normal level (and the default) being 0. The higher the number, the more severe the shutdown. You should always begin with 0 and only in the rare event that this fails should you proceed to 1, then 2 and finally 3.


Warning:

A level 3 shutdown is guaranteed to succeed but it may corrupt the calendar server database. Contact qualified support staff before performing a shutdown at this level. unistop prompts for confirmation before proceeding with a level 3 shutdown.


-ser

Shut down only the uniengd servers. The unilckd and uniengd daemons must be running for this option to succeed. Each uniengd server is associated with a signed-on calendar user; the uniengd daemon is always present when the calendar server is running. If this option is not used, both uniengd daemons and servers are shut down.

-snc

Shut down only the unisncd daemon. The unilckd and uniengd daemons must be running for this option to succeed. To avoid problems, you should also be certain that unidasd (if you are running a Directory Server) is running and unicwsd is not running.

-w

<secs>

When a process is stopped there is a short delay during which the ps(1) command continues to acknowledge the existence of the process. It is therefore necessary to sleep for a short period of time until a ps verifies that the process is no longer running. The default delay is 4 seconds. This option overrides the default; the <secs> parameter specifies the number of seconds to sleep.

-y

By default, if there are any users signed on to the calendar server, a prompt is issued to confirm that a shutdown is desired. This option causes unistop to automatically proceed with the shutdown even if there are users signed on. The shutdown of each of the active uniengd servers proceeds in such a way as to ensure the integrity of the database.

-v

Print the current version number of unistop.

-h

Print a usage message explaining how to run unistop.

EXAMPLES

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

UNISYNCREFRESH

unisyncrefresh - Refresh calendar server sync records.

SYNTAX

unisyncrefresh [-node <node-ID>] [-host <hostname>] [-fr <date>] [-p 
<SYSOPpassword>]

unisyncrefresh -v 
unisyncrefresh -h 

DESCRIPTION

unisyncrefresh refreshes calendar server synchronization records.

If you are experiencing long refresh times when piloting newer calendar clients including 3.0 versions of the Sync clients and Outlook Connector 3.3 with a small number of users, you can increase performance by creating a script to run unisyncrefresh automatically every 5 to 15 minutes.

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

OPTIONS

-fr

<date>

Forces a specified start date for the refresh. This option is not recommended for general use; consult Oracle support for instructions on using this option in specific circumstances.

-host

<hostname>

Specifies a host on which to look for the node specified by the -n option. Required for remote hosts. If -host is not present, unisyncrefresh will assume the local host. If -host is specified and -n is not, unisyncrefresh will search for a master node on the specified host.

-n

<node-ID>

Specify a node. If -n is not used, unisyncrefresh will search for a master node located on the host specified by the -host option. If no master node exists, -n is required.

-p

<SYSOPpassword>

Provide the SYSOP password for the specified node. If this option is not used, unisyncrefresh will prompt for the password.

-v

Print the current version number of unisyncrefresh.

-h

Print a usage message explaining how to run unisyncrefresh.

EXAMPLES

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

UNITZINFO

unitzinfo - Print information about a calendar server time zone.

SYNTAX

unitzinfo [-c] [-l] [-t <timezone>] [-node <node-ID>] [-y <year>]

unitzinfo -v 
unitzinfo -h 

DESCRIPTION

Extracts information from the calendar server time zone table found in the /users/unison/misc/timezone.ini file. By default, only the information for the configured time zone and the current year used by the calendar server is printed in an 80-character-wide format.

The calendar server table contains time zone information from the year 1991 to 2074 inclusive.

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

OPTIONS

-c

List the time zone information by country. Time zones within a country are listed in sequence. The printed fields are:

Table C-21 Time zone fields
Field Description

COUNTRY

Country name

TIMEZONE

Time zone name

ST

The difference (in hours) from GMT

DST

The difference (in hours) from GMT during Daylight Savings Time (DST)

EFFECTIVE PERIOD

The period when DST is in effect

-l

Print the information in 132-character-wide ("large") output format.

-node

<node-ID>

Specify the node. This option causes the information for the time zone configured for the node to be output.

-t

<timezone>

Specify the name of the time zone to print. If timezone has the value "all", the complete list of time zones is printed.

-y

<year>

Specify the year for which the time zone information will be output (e.g. to view the DST period for that year). <year> must be specified using four digits. The default is the current year.

-v

Print the current version number of unitzinfo.

-h

Print a usage message explaining how to run unitzinfo.

EXAMPLES

FILES

/users/unison/misc/timezone.ini 

This file contains the time zone descriptions used by the calendar server.

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

UNIUSER

uniuser - List, add, or delete calendar users, or to modify the information associated with them.

SYNTAX

Listings

uniuser -ls [<user>] [-format <format>] [-host <hostname>] -n <node-ID> [-p 
<sysOpPsw>]

uniuser -format <format> -n <node-ID> [-p <sysOpPsw>]

Addition

uniuser -add <user> [-s <sections>] [-host <hostname>] -n <node-ID> [-p 
<sysOpPsw>]

Deletion

uniuser -del <user> [-y] [-host <hostname>] [-n <node-ID>] [-p <sysOpPsw>]

uniuser -desdel <user> [-host <hostname>] [-n <node-ID>] [-p <sysOpPsw>]

uniuser -grpdel <user> [-host <hostname>] [-n <node-ID>] [-p <sysOpPsw>]

Modification

uniuser -mod <user> -s <sections> | -m <modifier> [-host <hostname>] [-n 
<node-ID>] [-p <sysOpPsw>]

Multiple additions, deletions, modifications

uniuser -ex <filename> [-s <sections>] [-k] [-host <hostname>] [-n <node-ID>] 
[-p <sysOpPsw>]

uniuser -edit [-host <hostname>] [-n <node-ID>] [-p <sysOpPsw>]

Other

uniuser -s [<sections>] [-host <hostname>] -n <node-ID> [-p <sysOpPsw>]

uniuser -info 

uniuser -v 
uniuser -h 

DESCRIPTION

uniuser can list, add, or delete calendar users, or modify the information associated with them. See the FORMAT OF THE user ARGUMENT section below for details on how to specify the user argument. Note that the -ls, -add, -del, -grpdel, -desdel, and -mod options are all mutually exclusive.

The information associated with a calendar user is a combination of the key-value pairs described in the FORMAT OF THE user ARGUMENT below, and that contained in the user.ini file. This includes user preferences, security, administrative rights, X.400 information, personal group, admin group membership and the list of persons permitted to work as a designate for the user.

It is recommended that you use uniuser to modify only user attributes that are specific to the calendar server. Any attributes that can be modified using the Oracle Internet Directory administration tools directly should not be modified through uniuser.

The calendar server must be up to run uniuser.

unires is the complementary utility for resources.

OPTIONS

-add

<user>

Create a new calendar user. The information associated with the new user is a combination of what is specified in the <user> argument and the default values in the user.ini file. By default, when uniuser reads the user.ini file, it considers only the values in the [GEN] section. Use the -s option to apply values from other sections of the user.ini file. Use the -ex option to add multiple users.

When using the calendar server's internal directory, the "S" key is mandatory for the -add option.

For external directories, the user must already exist in the directory server. The DID (Directory ID) for the user must be specified, and it must be in DN (Distinguished Name) format. This can be followed by data in X.400 format. See EXAMPLES.

-del

<user>

Delete the specified calendar user. uniuser prompts for confirmation before performing the deletion unless the -y option is used. If more than one user is to be deleted, the -ex option must used.

This operation can take a long time for users with very large agendas, and may have an impact on the performance of the calendar server for other users. It is recommended that you only delete users in off-peak hours.

-desdel

<user>

Delete the list of designates for the specified user. If more than one user matches <user>, the command fails.

-edit

This option only exists under UNIX. It allows you to first output the list of existing calendar users to a file, then edit the file to make desired modifications, and finally to input the changes back into the node. The following sequence of commands is performed:

% uniuser -ls -n node-ID > file
% vi file
% uniuser -ex file -n node-ID
% rm file

-ex

<filename>

Perform the additions, deletions, and/or modifications specified in the file <filename>. Each line of the file must begin with one of the characters `.', `#', `A', `a', `D', `d', `M', `m', `S', `s', or `+'. This initial character specifies the action to take, as follows:

Character Action

`.' or `#'

ignore the line

`A' or `a'

add the user

`D' or `d'

delete the user

`M' or `m'

modify the user

'S' or 's'

update the user with the settings from the user.ini file

`+'

treat the line as the continuation of the previous line; note that key-value pairs cannot break over lines

The initial character must be followed by a space and a user specification. In the case of a modification, the ID must be specified; it alone is used to identify the user, while the other key-value pairs specified along with it are applied as the modifications. See EXAMPLES.

For each deletion specified in the file, uniuser prompts for confirmation before performing the deletion. The -y option is used to automatically provide confirmation.

One way to create this file is to save the output of uniuser -ls to a file. This can then be edited and input to uniuser -ex.

The -s sections option may be used with -ex to set the corresponding user information to the default values contained in the specified sections of the user.ini file.

For directory servers, the most common way of adding many calendar users is to first use unidssearch to output the list of all non-calendar users to a file. This file can then be modified (if necessary), and input to uniuser using the -ex option. unidssearch outputs in the same "key=value/key=value/...." format that uniuser requires for input. See EXAMPLES.

-format

<format>

This option is used to select user information fields and to customize the format of the output. The -info option lists the parameters that can be used to specify the customized format. These are also listed in the FORMAT OF THE user ARGUMENT section below. If this option is not used, all user information fields are output, and a default presentation format is used. See EXAMPLES.

-grpdel

<user>

Delete the specified user from all admin groups. A single user must match <user> or the command fails.

-host

<hostname>

Specifies a host on which to look for the node specified by the -n option. Required for remote hosts. If -host is not present, uniuser will assume the local host. For modification or deletion, if -host is specified and -n is not, uniuser will search for a master node on the specified host. If a master node is found, uniuser will use it to locate the selected users.

-info

List the format parameters used with the -format option.

-k

Used with the -ex option to force uniuser to continue processing all lines in the file even if it encounters an error. Errors are sent to standard error; file redirection may be used to capture these to a file.

-ls

[<user>]

If a user is specified, -ls lists that user (in the specified node). If no user is specified, all users in the node are listed. The -format option can be used with -ls to configure the presentation of the output (see EXAMPLES).

-m

<modifier>

Specify a modification to be made to the user information of a particular user. The modifier is a string of the same form as the user argument with the following exceptions: the ID key may NOT be specified, and the PSW, PUBLISHEDTYPE and GLOBALREADONLY keys MAY be specified.

-mod

<user>

Modify the information associated with the specified user. This option is used with either the -s or the -m options. When used with the -s option, it sets the corresponding information for the user to the values contained in the specified sections of the user.ini file. When used with the -m option, modifications are made to the user's X.400 information.


Note:

It is recommended that you use uniuser to modify only user attributes that are specific to the calendar server. Any attributes that can be modified using the Oracle Internet Directory administration tools directly should not be modified through uniuser.


-n

<node-ID>

Specify a node. If -n is not used, uniuser will search for a master node located on the host specified by the -host option. If a master node is found, uniuser will use it to locate or distribute the specified users. If no master node exists, -n is required.

-p

<sysOpPsw>

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

-s

[<sections>]

Evaluate all or some of the contents of the user.ini file and output information from it to standard output.

Use this option without the <sections> argument to determine what sections exist in the user.ini file. The output in this case is a list of all section names along with their respective "Info" key-value pairs.

Use the <sections> argument to evaluate all of the key-value pairs in the specified sections. In this case all key-value pairs in the specified sections are output, along with any errors detected in these pairs. This is one way to validate the contents of the user.ini file. See the -add and -mod options for information on using -s <sections> to apply values from the user.ini file.

The <sections> argument is a list of one or more section names, each separated by a forward slash (e.g. "GEN/GR1/GR2" specifies the sections GEN, GR1 and GR2). Evaluation is done from left to right. Thus, in the above example, GEN is evaluated first, GR1 second, and GR2 last. Where the same key appears in more than one section, the value of the last instance evaluated takes precedence.

-y

Used with the -del and -ex options to auto-confirm the deletion(s).

-v

Print the current version number of uniuser.

-h

Print a usage message explaining how to run uniuser.

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. For all keys except the ID key, 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.


The format parameters listed in the third column below are used with the -format option to configure the presentation of a listing (see EXAMPLES).

Table C-22 Accepted keys
Key X.400 Field Format Parameter

S

Surname

%S

G

Given name

%G

I

Initials

%I

ID

Identifier

%ID

X

Generation

%X

OU1

Organizational Unit 1

%OU1

OU2

Organizational Unit 2

%OU2

OU3

Organizational Unit 3

%OU3

OU4

Organizational Unit 4

%OU4

O

Organization

%O

C

Country

%C

A

Administration domain

%A

P

Private domain

%P

PHONE

Phone number

%PHONE

EXT

Phone extension

%EXT

FAX

Fax phone number

%FAX

EMPL-ID

Employee number

%en

JOB-TITLE

Job title

%jt

EMAIL

<value of [ENG] usermailmap parameter>

None

PSW

Password

(maximum of 15 characters)

None

MOB-ENABLE

Mobile notification (ON/OFF)

None

MOB-FILTERRANGE

Time range of SMS filter (hh:mm-hh:mm)

None

MOB-FILTERRANGEACTION

Filter action (NOTHING/SUSPEND/DISCARD)

None

MOB-NOTIFY

Notify of new, modified and deleted events (ON/OFF)

None

MOB-PHONE

User's mobile phone number

None

MOB-REMINDER

Set mobile device alarm for vCalendar reminders (ON/OFF)

None

MOB-SUSPEND

Disable SMS (ON/OFF)

None

MOB-TYPE

Type of mobile device (NOK.A61XX (vCalendar note), NOK.A61XX- (text message), NOK.A61XX+ (vCalendar and text), NOK.A91XX, or TEXT for generic device)

None

SMSC-PHONE

User's preferred SMSC number

None

REMINDER-AUDIBLE

Audible reminder (ON/OFF)

None

REMINDER-VISUAL

Visual reminder (ON/OFF)

None

REMINDER-SERVEREMAIL

E-mail reminder (ON/OFF)

None

REMINDER-SERVERSMS

SMS reminder (ON/OFF)

None

REMINDER-UPCOMING

Unpcoming reminder (ON/OFF)

None

PUBLISHEDTYPE

Published type

(NOTPUBLISHED, PUBLISHED, EVENTCALENDAR; -add only)

None

GLOBALREADONLY

Global read access

(ON/OFF; -add only)

None

LANG

Language

(en-US, fr-FR, it-IT, es-ES, fi-FI, de-DE, pt-PT, ja-JP, zh-CN, ko-KR, sv-SE, pt-BR, nl-NL)

None

EXAMPLES

LISTINGS

ADDITION

DELETION

MODIFICATION

  1. Modify Milan Kundera's entry to reflect recent changes to the [GEN] section of the user.ini file (Milan Kundera exists in node 23). Look at the values in the GEN section of the user.ini file and ensure they are all valid:
    % uniuser -s "GEN" -n 23
    StartDay = 08h00
    EndDay = 18h00
    TimeInc = 30
    ShowSunday = FALSE
    ShowSaturday = FALSE
    TimeFormat = 2
    RefreshFrequency = 60
    DefaultReminder = 0
    TimeBeforeReminder = 10
    MailNotification = TRUE
    OU1 = 
    OU2 = 
    OU3 = 
    OU4 = 
    O = 
    C = 
    A = 
    P = 
    TimeZone = 
    ViewNormalEvent = TIME
    ViewPersonalEvent = TIME
    ViewConfidentialEvent = TIME
    ViewNormalTask = NO
    ViewPersonalTask = NO
    ViewConfidentialTask = NO
    CanBookMe = TRUE
    
    
  2. Proceed with the modification:
    % uniuser -mod "S=Kundera/G=Milan" -s "GEN" -n 23
    
    
  3. Modify Milan Kundera's OU1 value to "authors":
    % uniuser -mod "S=Kundera/G=Milan" -m "ou1=authors" -n 23
    

MULTIPLE ADDITIONS, DELETIONS, MODIFICATIONS

Multiple additions, deletions, and modifications are done using the -ex option. In this example, three new calendar users are added, one modified, and one deleted. A directory server is being used.

  1. Output all users in the directory server who are not currently calendar users:
    % unidssearch > multiple.dat 
    % cat multiple.dat
    A DID=cn=Italo Calvino,o=Acme, c=US
    A DID=cn=Herman Hesse,o=Acme, c=US
    A DID=cn=Doris Lessing,o=Acme, c=US
    A DID=cn=Anja Kauranen,o=Acme, c=US
    
    
  2. Modify the data in the file: change the country for Italo Calvino to Italy; add the modification to Walt Whitman's first name; add the deletion of Nicole Brossard.
    % vi multiple.dat
    % cat multiple.dat
    A DID=cn=Italo Calvino,o=Acme, c=US/C=Italy
    A DID=cn=Herman Hesse,o=Acme, c=US
    A DID=cn=Doris Lessing,o=Acme, c=US
    A DID=Anja Kauranen,o=Acme, c=US
    M G=Walter/ID=154
    D G=Nicole/S=Brossard
    
    

    In the case of the modification, the ID is used to find the user, and the given name is modified to "Walter".

  3. Input the file to uniuser:
    % uniuser -ex multiple.dat 23
    Enter SYSOP password:
    uniuser: added "cn=Italo Calvino,o=Acme, c=US"
    uniuser: added "cn=Herman Hesse,o=Acme, c=US"
    uniuser: added "cn=Doris Lessing,o=Acme, c=US"
    uniuser: added "cn=Anja Kauranen,o=Acme, c=US"
    uniuser: modified "Whitman,Walt"
    uniuser: deleted "Brossard,Nicole"
    
    

Note that if this example did not use a directory server, the input file would contain the following:

% cat multiple.dat
A S=Calvino/G=Italo/C=Italy
A S=Hesse/G=Herman
A S=Lessing/G=Doris
A S=Kauranen/G=Anja
M G=Walter/ID=154
D G=Nicole/S=Brossard

FILES

/users/unison/misc/user.ini 

This file specifies possible calendar user configurations. See also the calendar server Reference Manual, Appendix A, "User and Resource Parameters".

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

WARNINGS

Modification of Key-Value Pairs

This utility uses the [UTL] adm_moduser<field> parameters in unison.ini to determine whether or not it can modify the corresponding key-value pairs for the user. For example, if adm_modusersurname were set to FALSE, then the value associated with the S key could be modified by this utility.

If no corresponding adm_moduser<field> for a particular key appears in the file, the utility assumes it CAN modify it.

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.

Deleting users with large agendas

Deleting users with a large numbers of meetings and events can take a long time and cause a decrease in performance for other calendar users. It is recommended that you delete such users outside of normal hours, or at least not at times of peak calendar usage.

SEE ALSO

unires is the complementary utility for resources.

UNIVERSION

universion - Verify the version of the calendar server.

SYNTAX

universion [-all] [-nowarn] 

universion -v 
universion -h 

DESCRIPTION

universion displays the version number of the calendar server and checks all scripts and binaries to see if their versions are up to date.

universion runs whether the calendar server is up or down.

OPTIONS

-all

Display version number for each component of the calendar server.

-nowarn

Suppress warning messages.

-v

Print the current version number of universion.

-h

Print a usage message explaining how to run universion.

EXAMPLES

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 Warning error

4 Severe error

5 Critical error

6 User interrupt

UNIWHATOS (UNIX ONLY)

uniwhatos - Determine whether the calendar server package runs under the current operating system.

SYNTAX

uniwhatos 

uniwhatos -v 
uniwhatos -h 

DESCRIPTION

uniwhatos determines whether the current operating system is the one under which the calendar server package is intended to run. If a discrepancy exists, uniwhatos outputs the operating system(s) the package runs under.

The calendar server installation procedure calls this utility to determine whether or not to proceed with the installation.

uniwhatos runs whether the calendar server is up or down.

OPTIONS

-v

Print the current version number of uniwhatos.

-h

Print a usage message explaining how to run uniwhatos.

EXAMPLES

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 Warning error

4 Severe error

5 Critical error

6 User interrupt

UNIWHO

uniwho - Display information on signed-on calendar users.

SYNTAX

uniwho [-a] [-t] [-j] [-x] [-f] [-p <pattern>] 

uniwho -v 
uniwho -h 

DESCRIPTION

This utility allows the system manager to determine who is using the calendar server, where they are signed-on from, and the process-ID associated with their session. The options allow the display of various combinations of process-id, network address, node-ID, and user information.

This information is essential in certain situations. For example, when a user has done an abnormal shutdown of a client (say a powerdown while their client is active) the associated server process for that client continues to remain active for a fixed period of time. If the calendar server is configured (via the [ENG] max_userlogons parameter in unison.ini) to limit the number of sessions per user to 1, this user will not be able to log on again until their server process had terminated. uniwho allows the system manager to find the process-ID of the session and terminate it.

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

OPTIONS

-a

Display the alias associated with the default network address.

-f

Display telephone, job-title and X.400-address when available.

-j

Display job-title when available.

-p

<pattern>

Display information for sessions which contain <pattern> in their information. For example, the pattern "128.192.64.96" would result in the display of session information for those logged on from this IP address. Matching is performed on all fields (network address/alias, telephone number, job-title, X.400 address), regardless of which of these may have been specified on the command line.

-t

Display telephone number when available.

-x

Display X.400 address when available.

-v

Print the current version number of uniwho.

-h

Print a usage message explaining how to run uniwho.

EXAMPLES

EXIT STATUS

Exit values are:

0 Success

1 Failure

2 Usage error

3 User interrupt

NOTES

Logging

uniwho starts a calendar server process. If activity logging has been enabled (via the [ENG] activity parameter in unison.ini), the start-up and shutdown of this process is logged.