Customization of command files

      You can also customize the command files (with a text editor) for special events.

      Each file receives, when it is executed by UM-Client, a set of parameters representative of the event causing its execution (trap number, agent IP address, etc. ...).

      The list of parameters available for each file is documented in the file itself.

      Two utilities, snmpm and wr_log (which are stored in the UM-Client installation directory) can be used to customize these files. Refer to the chapter dedicated to SNMPM for a description of the utility snmpm. The syntax of the utility WR_LOG (which is used to write in the trace file) is given by entering the command "wr_log \h" .

      customization examples:

      stopping UM-Agent
       When UM-Client and UM-Agent are used on the same system, it is best to insert the command uma_stop at the start of the command file provoking the system shutdown (umc_shut.xx) , so that UM-Agent is stopped correctly.

      ing a message on reception of an unknown trap
       Customization of the command file umc_unkn.xx.
       By default, if an unknown trap is received by the client, an event is written in the trace file. The command file umc_unkn.xx can be customized so that UM-Client s a special message in this case.

      • For Unix systems, add the command
        umc_brdc "unknown trap" YES "An unknown trap has been received"
      • For systems with Windows emulation, add the command
        umc_brdc.xx "unknown trap" "YES" "An unknown trap has been received "

      Remark:
       Depending on the system used, the command file names are followed by an extension:

      *.bat     for Microsoft systems

      *.src     src for Netware.

      *.cmd   emd for OS/2

      *           for Unix systems

      Customization of messages for Unix systems

      UM-Client contains text files and command files which may be customized. These files are used when UM-Client detects an event concerning an agent monitored.
      To customize UM-Client messages, modify the file umc_mesg (which is stored in the UM-Client installation directory) with a text editor.

      The format of the message file umc_mesg is as follows:

      • one line per message.
      • the first field identifies the message. It must not be modified.
      • the second field (after the = sign) is the actual message. This field can be customized. As well as a character string (excluding the " character), the message may contain substitution variables. These variables are special characters that UM-Client will evaluate before ing the message. The following variables are supported:

        		•

        %t 

        replaced by the trap number corresponding to the event,

        %p 

        replaced by the receptacle number concerned by the event (or 0 if there is none),

        %a 

        replaced by the IP address of the agent which caused the event,

        %s 

        replaced by the system name,

        %d 

        replaced by an estimation of the time remaining before the system shutdown.

      The list of default UM-Client messages is as follows:

      • UPS utility power failed
      • UPS utility power restored
      • UPS battery entering fault status
      • UPS is on Bypass
      • UPS battery entering minimum conditions
      • Serial communication failed
      • Serial communication restored
      • Shutdown of %s in progress
      • Without load-shedding, shutdown in %d
      • Communication with agent %a failed
      • Communication with agent %a Restored
      • Agent %a : Plug %p off sequence to be started
      • Agent %a : Plug %p off sequence in progress
      • Agent %a : Bad plug number ( %p )
      • Remote shutdown by manager %a