Home > Veritas Storage Foundation™ File System Manual Pages

VXLOGCFG (1)
User Commands

Table of contents

NAME

vxlogcfg - Registers and unregisters the log configuration settings for a product.

SYNOPSIS

vxlogcfg -a -p ProductID -c ConfigPath -n Names [-q] vxlogcfg -a -p ProductID [-o OriginatorID ] -s KeyName=value [-q] vxlogcfg -l [-p ProductID ] [-o OriginatorID ] [-q] vxlogcfg -r -p ProductID [-o OriginatorID ] [-s KeyName ] [-q] vxlogcfg -v vxlogcfg -h

DESCRIPTION

The vxlogcfg utility registers and unregisters the product log configurations during installation and uninstallation.

ARGUMENTS

Specify the product log configuration you wish to register or unregister. Use fully-qualified path names for all directory paths. If a directory name contains spaces, use quotes around the path name for that directory (for example, "Program Files").

-a, --add
Register/create the product log configuration settings. Any existing log settings will be overwritten.
-c, --config ConfigPath
Provide the path from which the product log configuration settings should be read. On Windows, it should be the path to the product log registry settings, such as \\SOFTWARE\VERITAS\PRODUCTA. On Unix, it should be the absolute path to the product log configuration file, such as /opt/vrts/ProductA/log.conf.
-h, --help
List and describe the command-line options available for this command.
-i, --import FileName
Provide a configuration file with absolute path.
-l, --list
Display the configuration settings that are defined.
-n, --names Name
Specify one or more abbreviated or short names for the product. Multiple names should be separated by a comma.
-o, --orgid OrgID
Create/modify log configuration settings for the given originator ID. This is a required argument. The Originator ID can be passed as a valid originator ID (a number), it can be "Default", or it can be "ALL". If the Originator ID is "Default" then the configuration setting given by -s will be considered to be the default setting. If the Originator ID is "ALL" then the configuration setting given by -s will be considered for all the originators of a given product ID.
-p, --prodid ProductID
Create/modify log configuration settings for the ProductID.
-q, --quiet
Do not display error or informational messages; quiet mode.
-r, --remove
Unregister and remove the product log configuration settings.
-s, --setting KeyName=value
Set individual configuration setting. KeyName is the configuration setting's name and "value" is the value for that setting. User can pass more than one KeyName=value pair separated by a comma. Maximum length for each setting's value is 400 bytes. See the section, Configuration settings for the complete list of settings.
-s, --setting KeyName
Use this with the-r remove option. To remove a configuration setting, provide the KeyName. Multiple settings can be removed by providing multiple -s options.
-v, --version
Display the version information for this command.

Log configuration settings -Windows and UNIX

LogDirectory - Provides absolute path to a directory. No default value.

DebugLevel - Valid values are 0-6. The default value is 0, no debug messages.

DiagnosticLevel - Valid values are 0-6. The default value is 0, no diagnostic messages

DynaReloadInSec - Dynamic reloading of Debug and Diagnostic settings. Integers 0-60 reload after 60 seconds. Integers greater than 60 reload at the seconds specified.

LogToStdout - Valid values are true, false. The default value is false.

LogToStderr - Valid values are true, false. The default value is false.

LogToOslog - Valid values are true, false. The default value is false

RolloverMode - Valid values are FileSize, LocalTime, Periodic, None, FileSize | LocalTime, FileSize | Periodic. The default value is None.

MaxLogFileSizeKB - Valid values are 1-4294967295 KB. The default value is 10240 (10 MB)

RolloverPeriodInSeconds - Valid values are 1-2147483648. The default value is 43200 (12 hours)

RolloverAtLocalTime - Valid values are 00:00-23:59. The default value is 00:00 (Midnight local time)

NumberOfLogFiles - Valid values are 1-4294967295. The default value is 4294967295.

LogRecycle - Valid values are true, false. The default value is false. If true, number of log files will not exceed NumberOfLogFiles.

OIDNames - Names assigned to originator separated by a space.

L10nLib - Absolute path and filename of external localization library.

L10nResource - Resource name defined by the product.

L10nResourceDir - Resource directory defined by the product.

UNIX only settings

LogFilePermissions - Octal number defined by Unix file permissions. Default value is 660 (read/write permission for file owner).

SyslogIdent - Valid values are any string up to 80 characters long. Default value is VERITAS.

SyslogOpt - Valid values are from 0-4294967295. Default value is 0.

SyslogFacility - Valid values are: LOG_KERN, LOG_USER, LOG_MAIL, LOG_DAEMON, LOG_AUTH, LOG_LPR, LOG_NEWS, LOG_UUCP, LOG_CRON, LOG_LOCAL0, LOG_LOCAL1, LOG_LOCAL2, LOG_LOCAL3, LOG_LOCAL4, LOG_LOCAL5, LOG_LOCAL6, LOG_LOCAL7. The default value is LOG_USER.

Windows only settings

NtEventLogCategory - Valid value: any DWORD value. The default value is 0.

LogFileSDDL - Valid value is a properly formatted SDDL string. Defaults to the ACLs associated with the log directory.

NtEventLogSourceName - The name listed in the HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Eventlog\Application registry setting for the source application. If the name does not match the name in the registry, the localized messages will not display correctly.

EXAMPLES

The following example installs product 1 with the product configuration path /tmp/smf.conf:

vxlogcfg -a --prodid 1 -c /tmp/smf.conf -n 'VxSMF,vxsmf'

The following example sets the LogDirectory for originator ID 2 and product ID 1:

vxlogcfg -a --prodid 1 --orgid 2 -s LogDirectory=/tmp/logs

The following example sets the RolloverMode for the Default:

vxlogcfg -a --prodid 1 --orgid Default -s RolloverMode=FileSize

The following example sets the DebugLevel and DiagnosticLevel for all the originators of product ID 1:

vxlogcfg -a --prodid 1 --orgid ALL -s DebugLevel=0 -s DiagnosticLevel=1

The following example removes LogDirectory setting for product ID 1 and originator ID 2:

vxlogcfg -r --prodid 1 --orgid 2 -s LogDirectory

The following example removes all the settings for originator ID:

vxlogcfg -r --prodid 1 --orgid 2

The following example removes product 1 and does not display any messages on the screen.

vxlogcfg -r --prodid 1 -q

The following example displays all configuration settings for originator 2 for product 2:

vxlogcfg -l --prodid 2--orgid 2

The following example lists all the originators configured for the product 2:

vxlogcfg -l --prodid 2

The following example lists all configured products:

vxlogcfg -l

SEE ALSO

The vxlogview and vxlogmgr commands.

Last updated: 10 Mar 2006
Copyright ©2009 Symantec Corporation
All rights reserved.