HAMSG(1M)

NAME

hamsg - display contents of a specified log data file (LDF) in any language supported by VCS

SYNOPSIS

hamsg -info [-path path] LDF

hamsg -tail [messages] [-path path] [-lang language] LDF

hamsg [-any] [-sev C|E|W|N|I ] [-otype VCS | RES | GRP | SYS | AGT] [-oname object_name] [-cat category] [-msgid message_ID] [-path path] [-lang language] LDF

hamsg -list

hamsg -help

AVAILABILITY

VRTSvcs

DESCRIPTION

The hamsg utility displays the contents of a specified log data file (LDF) in any language supported by VCS. A log data file, <file>.ldf, contains data about messages written to a corresponding English language log, <file>.log. Typically, for every English VCS log file there is a corresponding LDF. LDF files are generated when the VCS_ENABLE_LDF environment variable is set to 1 (the default); LDF files are not generated when VCS_ENABLE_LDF environment variable is set to 0. By default, LDF files are written to the following directory:
UNIX: /var/VRTSvcs/ldf
Windows NT:
  \program files\VERITAS\Cluster Server\ldf
VCS log messages have the following format:

Timestamp Mnemonic Severity UMI message_text

Example messages are:

     May 10 2010 21:50:12 VCS ERROR V-16-30-423 Unknown resource type
     May 10 2010 11:32:45 VCS ERROR V-16-105-32 
       Share:fooshare:monitor:Share name is Null

The Mnemonic represents the product; for example, VCS (all capital letters without spaces or hyphens). The UMI consists of three parts: Originator_ID Category_ID Message_ID.

OPTIONS

-info [-path path] LDF
  Displays LDF data. -path specifies the path where hamsg should look for the specified LDF file. If -path is not specified, hamsg looks for the LDF file in the default directory.
-tail [messages] [-path path] [-lang language] LDF
  Specifies the number of messages from the end of the file to display. messages must be a positive integer greater than 0. If messages is not specified, the last 20 lines of the LDF will be displayed. -path specifies the path where hamsg should look for the specified LDF file. If -path is not specified, hamsg looks for the LDF file in the default directory. The -lang option specifies a language supported by VCS. For example, the value "en" specifies English and "ja" specifies Japanese.
[-any] [-sev C|E|W|N|I] [-otype VCS | RES | GRP | SYS | AGT] [-oname object_name]
  [-cat category] [-msgid message_ID] [-path path] [-lang language] LDF
-any is used with query options to specify hamsg is to return all messages that match "any" of the specified query options. If this option is not specified, all query options must match before hamsg returns the message. The -sev query option specifies that hamsg return all messages that match the specified message severity. The messages severity values C, E, W, N, and I have the following significance:
C -- Critical
E -- Error
W -- Warning
N -- Notice
I -- Information
The -otype query option specifies that hamsg return all messages that match the specified object type. Object types are:
VCS -- General VCS messages
RES -- Resource
GRP -- Group
SYS -- System
AGT -- Agent
The -oname query option specifies that hamsg return all messages that match the specified object_name. The -cat query option specifies that hamsg return all messages that match the specified message category. Message categories are included as the middle part of the UMI portion of a VCS message. The -msgid query option specifies that hamsg return all messages that match the specified message_ID. The -path option specifies the path where hamsg should look for the specified LDF file. If -path is not specified, hamsg looks for the files in the default directory. The -lang option specifies the language supported by VCS in which to display the messages. For example, the value "en" specifies English and "ja" specifies Japanese.
-help Displays the hamsg usage list.
-list Displays a list of available LDF files that can be viewed on the current system.

EXAMPLES

hamsg engine_A
  Displays the entire contents of the engine_A log.
hamsg -info hashadow_A
  Displays miscellaneous LDF information about the hashadow_A LDF.
hamsg -otype RES -oname FOO1 engine_A
  Displays all messages that are of object type "resource" and whose object name is "FOO1" found in the engine_A log.
hamsg -sev W FileOnOff_A
  Displays all Warning messages in the FileOnOff_A log.
hamsg -any -sev C -msgid 10051 engine_A
  Displays all messages that either have a Critical Severity or a message ID of 10051 in the engine_A log.
hamsg -list
  Displays a list of available LDF files that can be viewed on the current system.

USAGE

The hamsg utility uses the VCS BMC (binary message catalog) to correctly display messages found in the LDF in the user’s language. If a message in the LDF cannot be found in the existing set of BMCs, the following English message will be displayed:

Could not find message Message_ID: arg 1 = arg1_value, arg2 = arg2_value, ...

Example: Could not find message 50010: arg1 = G1, arg2 = thor63
Note: arg1, arg2, and so on refer to the message arguments that need to be inserted into message Message_ID. If the number of message arguments that are specified in the LDF do not match with the corresponding message found in the BMC, "???" is inserted for all message argument placeholders and the message will be displayed.

SEE ALSO

halog(1m)

COPYRIGHTS

Copyright (c) 2016 Veritas.

All rights reserved.


VCS 7.1 HAMSG(1M)