SYNOPSIS

       /usr/openv/netbackup/bin/vxlogcfg  -a  -p  ProductID  -c  ConfigPath -n
              Names [-q]

       /usr/openv/netbackup/bin/vxlogcfg -a -p ProductID [-o OriginatorID ] -s
              keyname=value [-q]

       /usr/openv/netbackup/bin/vxlogcfg -d -p ProductID

       /usr/openv/netbackup/bin/vxlogcfg  -r  -p ProductID -o OriginatorID [-s
              keyname ] [-q]

       /usr/openv/netbackup/bin/vxlogcfg -l [-p ProductID ] [-o OriginatorID ]
              [-q]

       /usr/openv/netbackup/bin/vxlogcfg -v

       /usr/openv/netbackup/bin/vxlogcfg -h


DESCRIPTION

       Use  the  vxlogcfg command to change the logging settings for a product
       that uses unified logging, such as NetBackup. It registers and unregis-
       ters the product log configurations during installation and uninstalla-
       tion.

       Unified logging uses a standardized naming format  for  log  files,  as
       follows:

       productID-originatorID-hostID-date-rotation.log

       For  more  information about the unified logging naming format, and the
       logging originator IDs, refer to the  NetBackup  Troubleshooting  Guide
       for UNIX, Windows, and Linux.


OPTIONS

       Specify  the  product  log configuration 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  Registers or creates the product log configuration settings.
                 Any  existing  log  settings are overwritten. Do not use this
                 option to add a product to the list of those that use unified
                 logging. Instead, use it only to modify existing unified log-
                 ging settings. See examples.

       -c, --config ConfigPath
                  Provides the path from which the product  log  configuration
                 settings should be read.

                 Use  the  absolute path to the product log configuration file
                 (for example, /opt/vrts/ProductA/log.conf.)

       -l, --list

                 Displays the configuration settings that are defined.

       -n, --names Name
                  Specifies one or more abbreviated or  short  names  for  the
                 product. Separate multiple names with a comma.

       -o, --orgid OrgID
                  Creates or modifies log configuration settings for the spec-
                 ified originator ID. This option is required . The Originator
                 ID  can  be  supplied as a valid originator ID (a number); it
                 can be "Default," or it can be "ALL." If the Originator ID is
                 "Default," then the -s configuration settings are the default
                 settings. If the Originator ID is "ALL, then the -s  configu-
                 ration  settings  are considered for all the originators of a
                 given product ID.

       -p, --prodid ProductID
                  Creates or modifies the log  configuration  settings  for  a
                 productID.

       -q, --quiet

                 Prevents  the  display  of  error  or  informational messages
                 (quiet mode).

       -r, --remove

                 Unregisters and removes the specified product from  the  list
                 of  products by using unified logging and remove unified log-
                 ging configuration settings for this product.

                 Note   Although the -r option is available, do  not  use  it.
                        All  existing  log settings are removed and no further
                        logging takes place.

       -s, --setting keyname=value
                  Sets individual configuration settings  when  used  with  -a
                 (add option). keyname is the configuration setting's name and
                 value is the value for that setting. You can use multiple  -s
                 keyname=value arguments on the command line.

       -s, --setting keyname
                   Removes a configuration setting when it is used with the -r
                 option. Use only keyname with the -r option. To remove multi-
                 ple  settings,  provide multiple -s options. See the KEYNAMES
                 AND VALUES section for particular key names.

       -v, --version

                 Provides an absolute path to a directory. No default value.

                 Caution  When  you  use  the LogDirectory keyname to redirect
                          unified logs to an  alternate  directory,  stop  and
                          restart  the  NetBackup  services. This action makes
                          redirection take effect.

                 DebugLevel Sets the verbosity level for the  debug  log  mes-
                 sages.  (Debug  logs  are  intended  for Symantec engineers.)
                 Valid values are 0 through 6.

       DiagnosticLevel

                 Sets the verbosity level for  the  diagnostic  log  messages.
                 (Diagnostic  logs  are  intended for NetBackup administrators
                 and users.) Valid values are 0 through 6.

       DynaReloadInSec

                 Dynamically reloads debug and diagnostic  settings.  Integers
                 0-60 reload after 60 seconds. Integers greater than 60 reload
                 at the specified number of seconds.

       LogToStdout

                 Sends all log messages to standard  output  (by  default  the
                 terminal)  and  to  the  log  file. Valid values are true and
                 false (default value).

       LogToStderr

                 Sends the application log messages to Stderr (by default  the
                 terminal)  and  to  the  log  file. Valid values are true and
                 false (default value).

       LogToOslog

                 Sends the application log messages to  the  operating  system
                 log (syslog on UNIX and the Event Log on Windows). Valid val-
                 ues are true and false (default value).

       RolloverMode

                 Specifies when log files are rolled over. If you roll over  a
                 log file, it closes the current log file and opens a new one.
                 The purpose is to keep log file size low and allow older  log
                 files  to  be deleted or archived. Valid values are FileSize,
                 LocalTime, Periodic, FileSize | LocalTime, FileSize  |  Peri-
                 odic and None.

                 FileSize  indicates  that  the  rollover  occurs when the log
                 reaches the size that the MaxLogFileSizeKB sets. FileSize  is
                 first.

                 None indicates that log files are not rolled over.

       MaxLogFileSizeKB

                 Specifies  the  maximum size that is allowed for the log file
                 (in kilobytes) before rollover occurs, if the RolloverMode is
                 set to FileSize. Valid values are 1 through 4294967295.

       RolloverPeriodInSeconds

                 Specifies  a  period  of  time in seconds after which the log
                 file is rolled over, if the RolloverMode is set to  Periodic.
                 Valid values are 1 through 2147483648.

       RolloverAtLocalTime

                 Specifies  the  time  of  day at which the log file is rolled
                 over, if the RolloverMode is set to LocalTime.  Valid  values
                 are 00:00 through 23:59.

       NumberOfLogFiles

                 Specifies  the  maximum  number of files to retain in the log
                 directory for each unified logging originator.  Valid  values
                 are 1 through 4294967295.

                 The  vxlogmgr  --auto command uses NumberOfLogFiles to deter-
                 mine how many log files to delete or move, that  starts  with
                 the oldest files. For example, a log directory contains seven
                 files that a particular originator created.  NumberOfLogFiles
                 is  set  to  5. The vxlogmgr --auto --del command deletes the
                 two oldest files that the originator created.

       LogRecycle

                 Valid values are true, false. The default value is false.  If
                 true,  the  number  of  log  files  does  not exceed the Num-
                 berOfLogFiles.

       OIDNames   Specifies one or more alternate names for the  unified  log-
                 ging originator that the -o option specifies. These names can
                 be used in place of Originator IDs when you perform  searches
                 by  using  the  vxlogview  command. Each name can be up to 80
                 characters in length. Multiple names can be specified,  sepa-
                 rated by a space.

       L10nLib     Specifies  the  absolute  path and filename of the external
                 localization library. This option is  for  Symantec  internal
                 use only. Use of this option can disable unified logging.

       LogFilePermissions

                 An octal number that specifies the UNIX file permissions that
                 are assigned to log the files that  the  originator  created,
                 which  the -o option specified. In most cases, this option is
                 not needed.

       SyslogIdent

                 Specifies a string that is attached to the beginning of every
                 syslog  message  when  LogToOslog  is set to true. Can be any
                 string up to 80 characters long. In most cases,  this  option
                 is not needed.

       SyslogOpt   Specifies  the  syslog  option value that are passed to the
                 syslog openlog function. Log messages  are  directed  to  the
                 UNIX  syslog  when LogToSyslog is enabled. Valid values are 0
                 through 4294967295. In most cases, this option is not needed.

       SyslogFacility

                 Specifies  the syslog facility value that are associated with
                 log  messages  directed  to  the  syslog.  Log  messages  are
                 directed  to  the syslog when LogToSyslog is enabled. In most
                 cases, this option is not needed.

                 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 is LOG_USER.


EXAMPLES

       Example 1

       The following sets the LogDirectory for NetBackup and originator ID 111
       on UNIX:

              vxlogcfg -a --prodid 51216 -orgid 111 -s LogDirectory=/usr/openv/logs

       Example 2

       The following sets the DebugLevel and DiagnosticLevel for  all  unified
       logging originators in NetBackup:

               vxlogcfg -a --prodid 51216 -orgid ALL -s DebugLevel=3 -s DiagnosticLevel=3

       Example 3

       The following sets the default RolloverMode for product ID 1:

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

       Example 6

       The following lists all configured products.

               vxlogcfg -l


FILES

              /usr/openv/netbackup/nblog.conf
              /etc/vx/VxICS/icsul.conf


SEE ALSO

       vxlogview(1), vxlogmgr(1)





                                  21 Mar 2007                     vxlogcfg(1M)