home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / upsmange.zip / CLIENT / UMC_PAR.TXT < prev    next >
Text File  |  2001-05-16  |  12KB  |  438 lines
  1. UM-Client for OS/2 - Parameter file help
  2. --------------------------------------------------------------------
  3.  
  4.  
  5. Note: comments may be inserted in the parameter file
  6.        by beginning the comment line with ;
  7.  
  8.  
  9.  
  10. General parameters : Section [General]
  11. ======================================
  12.  
  13. VA Rating : VARating
  14. --------------------
  15. This is the VA rating of the system. This
  16. parameter is not critical and may be ignored.
  17.  
  18. Range           : 1 - 9999
  19. Default setting : 200 VA
  20.  
  21.  
  22. Maximum size of the log file : LogSize
  23. --------------------------------------
  24. This is the maximum number of lines in the log file.
  25.  
  26. Range           : 1 - 9999
  27. Default setting : 1000
  28.  
  29.  
  30. Interval between messages : MessagePeriod
  31. -----------------------------------------
  32. This is the time interval in minutes between
  33. successive broadcasts of power failure messages.
  34.  
  35. Range           : 1 - 9999
  36. Default setting : 1 minute
  37.  
  38.  
  39. Broadcast to users flag : UserBroadcast
  40. ---------------------------------------
  41. If this parameter is set to 1, all users will
  42. be informed when UPS goes on battery backup
  43. and when power is restored.
  44. If set to 0, users are only informed when system
  45. shutdown begins.
  46.  
  47. Range           : 0 - 1
  48. Default setting : 1
  49.  
  50.  
  51. Automatic Start flag : AutomaticStart
  52. -------------------------------------
  53. If this parameter is set to 1, automatic start
  54. of UM-Client after system initialization is
  55. enabled. If set to zero, it is disabled.
  56.  
  57. Range           : 0 - 1
  58. Default setting : 1
  59.  
  60.  
  61. Delay after boot : StartDelay
  62. -----------------------------
  63. This is the number of seconds to wait after system
  64. initialization before activating UM-Client.
  65.  
  66. Range           : 0 - 9999
  67. Default setting : 120 to 360 seconds depending on OS
  68.  
  69.  
  70. Reference of manager : ManagerReference
  71. ---------------------------------------
  72. UM-Client writes this reference into the 
  73. manager table of agents.
  74. This parameter MUST NOT BE MODIFIED.
  75.  
  76. Default setting : Um_client V2.0.0
  77.  
  78.  
  79. Communication parameters : Section [Communication]
  80. ==================================================
  81.  
  82.  
  83. Trap UDP port : TrapPort
  84. ------------------------
  85. This is the number of the port used to receive traps.
  86. This parameter may be changed if another manager is
  87. listening to the trap on this port. In this case the other
  88. manager must send received traps to UM-Client on
  89. this new port.
  90. This parameter may also be set to zero to use the port
  91. defined in the standard "services" file.
  92.  
  93. Range           : numeric
  94. Default setting : 162
  95.  
  96.  
  97. Request UDP port : RequestPort
  98. ------------------------------
  99. This is the number of the port used to send SNMP
  100. requests to the agents.
  101. This parameter may also be set to zero to use the port
  102. defined in the standard "services" file.
  103.  
  104. Range           : numeric
  105. Default setting : 161
  106.  
  107.  
  108. Trap community name : TrapCommunityName
  109. ---------------------------------------
  110. This is the community name accepted by UM-Client
  111. for received traps.
  112.  
  113. Default setting : public
  114.  
  115.  
  116. Agent test period : AgentTestPeriod
  117. -----------------------------------
  118. This is the number of minutes between testing for communication 
  119. with the Agent.
  120.  
  121. Range           : 1 - 9999
  122. Default setting : 5 minutes
  123.  
  124.  
  125. Agent retry period : AgentRetryPeriod
  126. -------------------------------------
  127. This is the maximum time in seconds permitted
  128. for an agent to reply to a SNMP request.
  129.  
  130. Range           : 1 - 9999
  131. Default setting : 10 seconds
  132.  
  133.  
  134. Agent retry number : AgentRetryNumber
  135. -------------------------------------
  136. This is the maximum number of times an unsuccessful
  137. SNMP request is sent to an agent. If the agent
  138. does not reply after this number of retries, agent
  139. communication failure is detected.
  140.  
  141. Range           : 1 - 9999
  142. Default setting : 3
  143.  
  144.  
  145. Agent inscription retry period : AgentInsRetryPeriod
  146. ----------------------------------------------------
  147. This is the time between two tries of inscription
  148. in the agent tables.
  149.  
  150. Range           : 30 - 300
  151. Default setting : 60
  152.  
  153.  
  154. Agent inscription retry number : AgentInsRetryNumber
  155. ----------------------------------------------------
  156. This is the maximum number of times a inscription in
  157. the agent tables may be unsuccessful. After this 
  158. number of tries, a message is sent and UM-Client stops.
  159.  
  160. Range           : 1 -10
  161. Default setting : 5
  162.  
  163.  
  164. Shutdown parameters : Section [Shutdown]
  165. ========================================
  166.  
  167. Grace Period : GracePeriod
  168. --------------------------
  169. This is the number of minutes after a power failure
  170. before the first warning message is broadcast to users.
  171.  
  172. Range           : 0 - 9999
  173. Default setting : 1 minute
  174.  
  175.  
  176. Shutdown Duration : ShutdownDuration
  177. ------------------------------------
  178. This is the number of seconds the client system needs to
  179. run its shutdown procedure. This value is used by
  180. the agents to generate the 'Off sequence in progress'
  181. event with enough time left to each client system to
  182. complete its shutdown procedure.
  183.  
  184. Range           : 0 - 9999
  185. Default setting : 120 to 240 seconds depending on OS
  186.  
  187.  
  188. Shutdown Timer : ShutdownTimer
  189. ------------------------------
  190. The shutdown timer specifies how long UM-Client
  191. waits after detecting a power failure before starting
  192. the shutdown sequence. Enter the desired time in
  193. minutes. Choose a period that gives the users
  194. enough time to close their current application(s) and
  195. log out of the system without exhausting the UPS
  196. battery supply. See the UPS manual for guidelines on
  197. battery autonomy. If the UPS battery runs low before
  198. this timer ends, shutdown will begin immediately.
  199.  
  200. Range           : 0 - 9999
  201. Default setting : 31 minutes
  202.  
  203.  
  204. Shutdown Delay : ShutdownDelay
  205. ------------------------------
  206. This is the number of seconds that UM-Client delays
  207. shutdown to allow UM-Agent to send its last trap
  208. before system shutdown.
  209.  
  210. Range           : 0 - 9999
  211. Default setting : 10 seconds
  212.  
  213.  
  214. Shutdown if on Bypass : ShutdownOnBypass
  215. ----------------------------------------
  216. If this parameter is set to 1, system shutdown
  217. will start if UPS is on bypass.
  218.  
  219. Range           : 0 - 1
  220. Default setting : 0
  221.  
  222.  
  223. Shutdown if on Battery fault : ShutdownOnBatteryFault
  224. -----------------------------------------------------
  225. If this parameter is set to 1, system shutdown
  226. will start if UPS is on battery fault.
  227.  
  228. Range           : 0 - 1
  229. Default setting : 0
  230.  
  231.  
  232.  
  233. Imperative down flag : ImperativeDown
  234. -------------------------------------
  235. If this parameter may be used in shutdown script to
  236. start conditionnal shutdown.
  237.  
  238. Range           : 0 - 1
  239. Default setting : 1
  240.  
  241.  
  242. Remote shutdown parameters : Section [RemoteShutdown]
  243. =====================================================
  244.  
  245. Shutdown trap number : ShutdownTrapNumber
  246. -----------------------------------------
  247. This is the numeric value of the trap that managers
  248. can use to start shutdown of a client computer.
  249. This numeric value must be different from the numeric
  250. values of the traps generated by agents.
  251.  
  252. Range           : numeric
  253. Default setting : none
  254.  
  255.  
  256. Enterprise field for shutdown trap : ShutdownEnterpriseMask
  257. -----------------------------------------------------------
  258. This is the enterprise field accepted for shutdown
  259. trap. If the enterprise field of the trap received
  260. does not match, the trap is ignored.
  261.  
  262. Range           : dotted decimal enterprise field
  263. Default setting : none
  264.  
  265.  
  266. IP address mask for shutdown trap : ShutdownManagerTrap
  267. -------------------------------------------------------
  268. When a shutdown trap is received, the IP address of
  269. the manager that sent the trap is compared to each number
  270. of this mask. A 0 in the mask matches any value in
  271. the manager IP address. A not null value in the mask
  272. matches only the same value in the manager IP
  273. address.
  274. Example : Mask        IP Address     Match
  275.           168.0.0.90  168.12.144.90  Yes
  276.                       169.12.144.90  No
  277.           0.0.0.0     any address    Yes
  278.  
  279. If the address matches the mask, the manager is
  280. allowed to shut the system down and system shutdown
  281. begins.
  282.  
  283. Range           : dotted decimal IP address
  284. Default setting : none
  285.  
  286.  
  287. IP address of a shutdown manager : ShutdownManagerIP.x
  288. ------------------------------------------------------
  289. If the address of an agent that sent a shutdown
  290. trap does not match the mask, it is
  291. compared with each of the 10 IP address (from
  292. ShutdownManagerIP.1 to ShutdownManagerIP.10)
  293. of managers allowed to shut the system down.
  294. If the address is found, system shutdown begins.
  295.  
  296. Range           : dotted decimal IP address
  297. Default setting : none
  298.  
  299.  
  300. Files parameters : Section [Files]
  301. ==================================
  302.  
  303. Log script : LogScript
  304. ----------------------
  305. This is the name of the source file of the log script
  306. followed, after a comma, by the name of the
  307. command file build and executed by UM-Client.
  308. This script is used to write records in the log file.
  309. If only one file name is specified, no build is made,
  310. the file is just executed.
  311.  
  312. Range           : file name,file name
  313. Default setting : UMC_LOG.CMD
  314.  
  315.  
  316. Shutdown script : ShutdownScript
  317. --------------------------------
  318. Same definition as above for the shutdown script used
  319. to start shutdown procedure.
  320.  
  321. Range           : file name,file name
  322. Default setting : UMC_SHUT.CMD
  323.  
  324.  
  325. Broadcast script : BroadcastScript
  326. ----------------------------------
  327. Same definition as above for the broadcast script used
  328. to send messages to users.
  329.  
  330. Range           : file name,file name
  331. Default setting : UMC_BRDC.CMD
  332.  
  333.  
  334. Unknown trap script : UnknownTrapScript
  335. ---------------------------------------
  336. Same definition as above for the unknown trap script
  337. used when an unknown trap is received.
  338.  
  339. Range           : file name,file name
  340. Default setting : UMC_UNKN.CMD
  341.  
  342.  
  343. Log file name : LogFile
  344. -----------------------
  345. This is the name of the log file.
  346.  
  347. Range           : file name
  348. Default setting : UMC_LOG
  349.  
  350.  
  351. Message file name : MessageFile
  352. -----------------------------
  353. This is the name of the message file.
  354.  
  355. Range           : file name
  356. Default setting : UMC_MESG
  357.  
  358.  
  359. UPS agent parameters : Section [upsAgent]
  360. =========================================
  361.  
  362. UPS agent IP Address : upsagentIPAddress
  363. ----------------------------------------
  364. This is the IP address of the agent connected to
  365. the UPS which protects the system.
  366.  
  367. Range           : dotted decimal IP address
  368. Default setting : None
  369.  
  370.  
  371. UPS agent community name : upsagentCommunityName
  372. ------------------------------------------------
  373. This community name is used to check the access right
  374. to the UPS agent. This community name must be
  375. allowed to get and set values into the agent MIB.
  376.  
  377. Default setting : public
  378.  
  379. Protocol Interface flag : ProtocolInterfacePresent
  380. --------------------------------------------------
  381. This parameter must be set to 1 if the UPS is managed
  382. by a Protocol Interface. It must be set to 0 in the
  383. other case.
  384.  
  385. Range           : 0 - 1
  386. Default setting : 0
  387.  
  388. Switchable plug flag : SwitchablePlugPresent
  389. --------------------------------------------
  390. This parameter must be set to 1 if the UPS is
  391. equipped with switchable plugs. It must be set
  392. to 0 in the other case.
  393.  
  394. Range           : 0 - 1
  395. Default setting : 0
  396.  
  397.  
  398. Receptacle Number : ReceptacleNumber
  399. ------------------------------------
  400. If the UPS is equipped with switchable plugs,
  401. this parameter is the receptacle number to which the
  402. system is connected.
  403.  
  404. Range           : 1 - 9999
  405. Default setting : 1
  406.  
  407.  
  408. UM-Switch agent #x parameters : Section [Agent.x]
  409. =================================================
  410.  
  411. Up to 24 UM-Switch agents (Agent.1 to Agent.24)
  412. may be defined as follows.
  413.  
  414. Agent #x IP address : agentIPAddress.x
  415. --------------------------------------
  416. This is the IP address of the UM-Switch agent #x
  417.  
  418. Range           : dotted decimal IP address
  419. Default setting : None
  420.  
  421.  
  422. Agent #x community name : agentCommunityName.x
  423. ----------------------------------------------
  424. This community name is used to check the access right
  425. to this agent. This community name must be
  426. allowed to get and set values into the agent MIB.
  427.  
  428. Default setting : public
  429.  
  430.  
  431. Agent #x plug number : plugNumber.x
  432. -----------------------------------
  433. This parameter is the plug number to which the
  434. system is connected.
  435.  
  436. Range           : 1 - 9999
  437. Default setting : 1
  438.