|
|
|
|
|
CorporateTime Server |
Reference Manual |
| View in pdf format |
| Go to Administrator's Guide |
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:
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":
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:
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
- Display the current number of logged-on users:
- Display the number of users logged-on at 3:00 p.m. on October 6, 1998:
- Display the number of users logged-on at 3:00 p.m. on October 6, 1998, and at each 15-minute interval, up to 5:00 p.m. on October 6, 1998.
A sample section of the output from this command shows the form of what is output for each of the times 15:00:00, 15:15:00, 15:30:00, etc., up to 17:00:00. (Compare this with the output of the next example, where the -t is removed from the command line.)
- Output the signon/signoff statistics for a defined period of time (from 3:00 p.m. to 5:00 p.m. on October 6, 1998), providing cumulative statistics for each of the 15-minute intervals in the period. Note how the output from this command line differs from that of the previous example where the -t was included.
Time Period 1: From Oct 6 1998 15:00:00 Till Oct 6 1998 15:15:00
--------------------------------------------------------------------------------
Client Logons Logoffs Average Time Median Time
Name & Version Logged-On(hrs) Logged-On(hrs)
Windows/32/CorporateTime 4 4 0.02 0.02
--------------------------------------------------------------------------------
FILES
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 FailureUNIMVUSER
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.
NOTEunimvuser 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.
NOTESee 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:
- Any designate rights granted by the moved user are removed.
- Any admin groups created by the user are not moved to the new node.
- Any public groups created by the moved user are made into private groups.
- In installations using an internal directory, the user's password is not retained. See the -up option below.
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> -n2
<node-ID2> -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
-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.
NOTEIf 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".
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:
- additional meeting information introduced in 5.0
- additional task information introduced in 5.0
- folders
- journal entries
- sticky notes (in the case of Outlook users)
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 interruptSEE ALSO
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.
- the syntax of the nodes.ini file is correct
- the specified host name or specified node-ID is valid
- the uniengd and unisncd servers are up
- the version of uniengd is greater than A.01.15
- the SNC daemon is running
- the nodes.ini file exists only on the host currently running uninode
- all nodes in the node network are available
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.
- Log on to "gravlax" and create a nodes.ini file.
- Add the nodes from each of the three calendar servers.
- Examine the contents of the nodes.ini file.
- Edit the file to configure the node network.
- % 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
The node network has the following characteristics:
- It has ten nodes.
- There are two excluded nodes (nodes 16 and 26).
- There are two connections going from each node in the node network to every other node in the node network. For example, two connections go from node 32 to node 13, and two go from node 13 to node 32. A single connection is unidirectional.
- The "india" group of nodes has two additional connections going from each node in the "india" group to each of the other nodes in the "india" group. Similarly, the "italy" group of nodes has three additional connections between each of the nodes in the "italy" group, and the "sweden" group has two additional connections between each of the nodes in the "sweden" group.
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
Contains the list of nodes and the rules that describe the calendar server's node network configuration.
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 interruptUNIPASSWD
unipasswd - Change a calendar user password.
SYNTAX
- unipasswd [-e <entry> | -sysop | -cwsop] [-n <node-ID>] [-host <hostname>] [-p <sysOpPsw>]
- unipasswd -v
- unipasswd -h
DESCRIPTION
unipasswd changes the password of the SYSOP, the CWSOP, or a specific user on a given node. By default, the SYSOP password is changed. Note that the -e, -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.
-e
<entry>Change a user password (search filter). See FORMAT OF THE entry ARGUMENT for details on how to specify an entry.
-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 SYSOP password. Required if -e option is used and a SYSOP password is set. If this is required and it is not supplied on the command line, prompting for it occurs.
-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.
FORMATS
FORMAT OF THE entry ARGUMENT
The entry 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.
NOTEIf the ID key-value pair is specified in the user argument, all other key-value pairs specified along with it are ignored.
EXAMPLES
- Change the SYSOP password on node 20 on the remote host "jupiter":
- Change the password of the local user "Jean Leblanc" on node 10:
- Change the local CWSOP password where only one node is configured:
WARNINGS
Modification of Password
This utility uses the [UTL] adm_moduserpassword parameter in unison.ini to determine whether or not it can modify the user password. If this value is set to "FALSE", then the user password cannot be modified by this utility. If this parameter pair does not appear in the file, the utility assumes it CAN modify the password.
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.
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 interruptUNIPING
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.
NOTEIf 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".
EXAMPLES
- Ping node 14 of a calendar server on the host "Scribe", using the SYSOP user account:
- Ping all nodes in the node network containing node 60, using the user "Dashiell Hammett", and displaying the time of each sent message:
EXIT STATUS
Exit values are:
0 Success
1 Failure
2 Usage errorUNIREQDUMP
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:
-v
- agendaget
- attendadd
- echo
- eventattend
- eventcreated
- eventdeleted
- eventmodified
- foreignerdeleted
- instanceadded
- instancemodified
- itemdeleted
- itemmodified
- mailmessagepost
- nodeitemsget
- notifynewevent
- notifynewinstance
- securityadd
- securitydeleted
- securitymodified
Print the current version number of unireqdump.
-h
Print a usage message explaining how to run unireqdump.
EXAMPLES
- Select all requests in the queue which originate in node 10:
- Output all requests in the queue which originate in node 10, and interactively prompt for confirmation to delete each one:
- Output all requests in the queue except those already serviced (a single node exists on this server so the -n option is unnecessary):
- Output all unserviced requests with the "eventattend" transaction code, orginating in node 10 and destined for the remote node 20, and interactively prompt for confirmation to delete each one:
EXIT STATUS
Exit values are:
0 Success
1 Failure
2 Usage error
3 User interrupt