UM-Client for OS/2 - Parameter file help
--------------------------------------------------------------------


Note: comments may be inserted in the parameter file
       by beginning the comment line with ;



General parameters : Section [General]
======================================

VA Rating : VARating
--------------------
This is the VA rating of the system. This
parameter is not critical and may be ignored.

Range           : 1 - 9999
Default setting : 200 VA


Maximum size of the log file : LogSize
--------------------------------------
This is the maximum number of lines in the log file.

Range           : 1 - 9999
Default setting : 1000


Interval between messages : MessagePeriod
-----------------------------------------
This is the time interval in minutes between
successive broadcasts of power failure messages.

Range           : 1 - 9999
Default setting : 1 minute


Broadcast to users flag : UserBroadcast
---------------------------------------
If this parameter is set to 1, all users will
be informed when UPS goes on battery backup
and when power is restored.
If set to 0, users are only informed when system
shutdown begins.

Range           : 0 - 1
Default setting : 1


Automatic Start flag : AutomaticStart
-------------------------------------
If this parameter is set to 1, automatic start
of UM-Client after system initialization is
enabled. If set to zero, it is disabled.

Range           : 0 - 1
Default setting : 1


Delay after boot : StartDelay
-----------------------------
This is the number of seconds to wait after system
initialization before activating UM-Client.

Range           : 0 - 9999
Default setting : 120 to 360 seconds depending on OS


Reference of manager : ManagerReference
---------------------------------------
UM-Client writes this reference into the 
manager table of agents.
This parameter MUST NOT BE MODIFIED.

Default setting : Um_client V2.0.0


Communication parameters : Section [Communication]
==================================================


Trap UDP port : TrapPort
------------------------
This is the number of the port used to receive traps.
This parameter may be changed if another manager is
listening to the trap on this port. In this case the other
manager must send received traps to UM-Client on
this new port.
This parameter may also be set to zero to use the port
defined in the standard "services" file.

Range           : numeric
Default setting : 162


Request UDP port : RequestPort
------------------------------
This is the number of the port used to send SNMP
requests to the agents.
This parameter may also be set to zero to use the port
defined in the standard "services" file.

Range           : numeric
Default setting : 161


Trap community name : TrapCommunityName
---------------------------------------
This is the community name accepted by UM-Client
for received traps.

Default setting : public


Agent test period : AgentTestPeriod
-----------------------------------
This is the number of minutes between testing for communication 
with the Agent.

Range           : 1 - 9999
Default setting : 5 minutes


Agent retry period : AgentRetryPeriod
-------------------------------------
This is the maximum time in seconds permitted
for an agent to reply to a SNMP request.

Range           : 1 - 9999
Default setting : 10 seconds


Agent retry number : AgentRetryNumber
-------------------------------------
This is the maximum number of times an unsuccessful
SNMP request is sent to an agent. If the agent
does not reply after this number of retries, agent
communication failure is detected.

Range           : 1 - 9999
Default setting : 3


Agent inscription retry period : AgentInsRetryPeriod
----------------------------------------------------
This is the time between two tries of inscription
in the agent tables.

Range           : 30 - 300
Default setting : 60


Agent inscription retry number : AgentInsRetryNumber
----------------------------------------------------
This is the maximum number of times a inscription in
the agent tables may be unsuccessful. After this 
number of tries, a message is sent and UM-Client stops.

Range           : 1 -10
Default setting : 5


Shutdown parameters : Section [Shutdown]
========================================

Grace Period : GracePeriod
--------------------------
This is the number of minutes after a power failure
before the first warning message is broadcast to users.

Range           : 0 - 9999
Default setting : 1 minute


Shutdown Duration : ShutdownDuration
------------------------------------
This is the number of seconds the client system needs to
run its shutdown procedure. This value is used by
the agents to generate the 'Off sequence in progress'
event with enough time left to each client system to
complete its shutdown procedure.

Range           : 0 - 9999
Default setting : 120 to 240 seconds depending on OS


Shutdown Timer : ShutdownTimer
------------------------------
The shutdown timer specifies how long UM-Client
waits after detecting a power failure before starting
the shutdown sequence. Enter the desired time in
minutes. Choose a period that gives the users
enough time to close their current application(s) and
log out of the system without exhausting the UPS
battery supply. See the UPS manual for guidelines on
battery autonomy. If the UPS battery runs low before
this timer ends, shutdown will begin immediately.

Range           : 0 - 9999
Default setting : 31 minutes


Shutdown Delay : ShutdownDelay
------------------------------
This is the number of seconds that UM-Client delays
shutdown to allow UM-Agent to send its last trap
before system shutdown.

Range           : 0 - 9999
Default setting : 10 seconds


Shutdown if on Bypass : ShutdownOnBypass
----------------------------------------
If this parameter is set to 1, system shutdown
will start if UPS is on bypass.

Range           : 0 - 1
Default setting : 0


Shutdown if on Battery fault : ShutdownOnBatteryFault
-----------------------------------------------------
If this parameter is set to 1, system shutdown
will start if UPS is on battery fault.

Range           : 0 - 1
Default setting : 0



Imperative down flag : ImperativeDown
-------------------------------------
If this parameter may be used in shutdown script to
start conditionnal shutdown.

Range           : 0 - 1
Default setting : 1


Remote shutdown parameters : Section [RemoteShutdown]
=====================================================

Shutdown trap number : ShutdownTrapNumber
-----------------------------------------
This is the numeric value of the trap that managers
can use to start shutdown of a client computer.
This numeric value must be different from the numeric
values of the traps generated by agents.

Range           : numeric
Default setting : none


Enterprise field for shutdown trap : ShutdownEnterpriseMask
-----------------------------------------------------------
This is the enterprise field accepted for shutdown
trap. If the enterprise field of the trap received
does not match, the trap is ignored.

Range           : dotted decimal enterprise field
Default setting : none


IP address mask for shutdown trap : ShutdownManagerTrap
-------------------------------------------------------
When a shutdown trap is received, the IP address of
the manager that sent the trap is compared to each number
of this mask. A 0 in the mask matches any value in
the manager IP address. A not null value in the mask
matches only the same value in the manager IP
address.
Example : Mask        IP Address     Match
          168.0.0.90  168.12.144.90  Yes
                      169.12.144.90  No
          0.0.0.0     any address    Yes

If the address matches the mask, the manager is
allowed to shut the system down and system shutdown
begins.

Range           : dotted decimal IP address
Default setting : none


IP address of a shutdown manager : ShutdownManagerIP.x
------------------------------------------------------
If the address of an agent that sent a shutdown
trap does not match the mask, it is
compared with each of the 10 IP address (from
ShutdownManagerIP.1 to ShutdownManagerIP.10)
of managers allowed to shut the system down.
If the address is found, system shutdown begins.

Range           : dotted decimal IP address
Default setting : none


Files parameters : Section [Files]
==================================

Log script : LogScript
----------------------
This is the name of the source file of the log script
followed, after a comma, by the name of the
command file build and executed by UM-Client.
This script is used to write records in the log file.
If only one file name is specified, no build is made,
the file is just executed.

Range           : file name,file name
Default setting : UMC_LOG.CMD


Shutdown script : ShutdownScript
--------------------------------
Same definition as above for the shutdown script used
to start shutdown procedure.

Range           : file name,file name
Default setting : UMC_SHUT.CMD


Broadcast script : BroadcastScript
----------------------------------
Same definition as above for the broadcast script used
to send messages to users.

Range           : file name,file name
Default setting : UMC_BRDC.CMD


Unknown trap script : UnknownTrapScript
---------------------------------------
Same definition as above for the unknown trap script
used when an unknown trap is received.

Range           : file name,file name
Default setting : UMC_UNKN.CMD


Log file name : LogFile
-----------------------
This is the name of the log file.

Range           : file name
Default setting : UMC_LOG


Message file name : MessageFile
-----------------------------
This is the name of the message file.

Range           : file name
Default setting : UMC_MESG


UPS agent parameters : Section [upsAgent]
=========================================

UPS agent IP Address : upsagentIPAddress
----------------------------------------
This is the IP address of the agent connected to
the UPS which protects the system.

Range           : dotted decimal IP address
Default setting : None


UPS agent community name : upsagentCommunityName
------------------------------------------------
This community name is used to check the access right
to the UPS agent. This community name must be
allowed to get and set values into the agent MIB.

Default setting : public

Protocol Interface flag : ProtocolInterfacePresent
--------------------------------------------------
This parameter must be set to 1 if the UPS is managed
by a Protocol Interface. It must be set to 0 in the
other case.

Range           : 0 - 1
Default setting : 0

Switchable plug flag : SwitchablePlugPresent
--------------------------------------------
This parameter must be set to 1 if the UPS is
equipped with switchable plugs. It must be set
to 0 in the other case.

Range           : 0 - 1
Default setting : 0


Receptacle Number : ReceptacleNumber
------------------------------------
If the UPS is equipped with switchable plugs,
this parameter is the receptacle number to which the
system is connected.

Range           : 1 - 9999
Default setting : 1


UM-Switch agent #x parameters : Section [Agent.x]
=================================================

Up to 24 UM-Switch agents (Agent.1 to Agent.24)
may be defined as follows.

Agent #x IP address : agentIPAddress.x
--------------------------------------
This is the IP address of the UM-Switch agent #x

Range           : dotted decimal IP address
Default setting : None


Agent #x community name : agentCommunityName.x
----------------------------------------------
This community name is used to check the access right
to this agent. This community name must be
allowed to get and set values into the agent MIB.

Default setting : public


Agent #x plug number : plugNumber.x
-----------------------------------
This parameter is the plug number to which the
system is connected.

Range           : 1 - 9999
Default setting : 1
