Symantec NetBackup™ コマンドリファレンスガイド
- 概要
- 付録 A. NetBackup コマンド
名前
vxlogcfg — 統合ログ機能の構成設定の変更
概要
vxlogcfg -a -p ProductID -c ConfigPath -n Names [-q]
vxlogcfg -a -p ProductID -o OriginatorID -s keyname=value [-q]
vxlogcfg -a -p ProductID -g LogSet -s keyname=value [-q]
vxlogcfg -d -p ProductID
vxlogcfg -l [-p ProductID [-o OriginatorID]] [-q]
vxlogcfg -l [-p ProductID [-g LogSet]] [-q]
vxlogcfg -r -p ProductID [-o OriginatorID] [-s keyname] [-q]
vxlogcfg -r -p ProductID [-g LogSet] [-s keyname] [-q]
vxlogcfg -v
UNIX システムでは、このコマンドへのディレクトリパスは /usr/openv/netbackup/bin/ です。
Windows システムでは、このコマンドへのディレクトリパスは install_path\NetBackup\bin\ です。
説明
vxlogcfg コマンドは NetBackup の統合ログ機能のログの設定の変更に使用します。このコマンドによって、インストールおよびアンインストール時に製品のログ構成の登録または登録解除が行われます。
統合ログ機能では、ログファイルに次の共通の命名形式が使用されます。
productID-originatorID-hostID-date-rotation.log
統合ログ機能の命名形式およびオリジネータ ID について詳しくは、『NetBackup ログリファレンスガイド』を参照してください。
オプション
このオプションは、製品のログ構成の登録または登録解除を指定します。すべてのディレクトリパスには、フルパス名を使用します。ディレクトリ名に空白が含まれる場合は、そのディレクトリのパス名を二重引用符で囲みます ("Program Files" ディレクトリなど)。
- -a, --add
このオプションを指定すると、製品のログ構成の設定が登録または作成されます。既存のログ設定は上書きされます。このオプションを使用して、統合ログ機能を使用する製品をリストに追加しないでください。代わりに、このオプションは、統合ログ機能の既存の設定を変更するためだけに使用してください。詳しくは、例を参照してください。
- -c, --config ConfigPath
このオプションでは、製品のログ構成設定の読み込み元の絶対パスを指定します。
UNIX システムでは、製品のログ構成ファイルへの絶対パスを使います (たとえば、
/opt/vrts/ProductA/log.conf
)。Windows システムでは、製品のログ設定レジストリへのパスを使用します (たとえば、
\\SOFTWARE\VERITAS\PRODUCTA\
)。- -d, --delete
このオプションを指定すると、製品用に構成されたオリジネータ ID がない場合に、メインログ構成ファイルから製品のログ構成設定が登録解除され、削除されます。対応する製品のログ構成ファイルも削除されます。
- -g, --logset LogSet
指定した LogSet のログ構成設定を作成または修正します。LogSet はテキスト文字列 Default または ALL として指定されます。LogSet に Default を指定すると、-s の構成設定がデフォルト設定になります。LogSet に ALL を指定すると、-s の構成設定は、指定したプロダクト ID のすべてのオリジネータに適用されます。
- -l, --list
次のいずれかが表示されます。
構成されたすべての製品。
すべてのオリジネータ ID と LogSet
プロダクト ID とオリジネータ ID のペアまたはプロダクト ID と LogSet のペアに定義されているすべての設定
- -n, --names Name
製品の略称または短縮名が指定されます。複数の名前はカンマで区切ります。
- -o, --orgid OrgID
指定したオリジネータ ID のログ構成設定が作成または修正されます。オリジネータ ID には有効なオリジネータ ID (番号)、テキスト文字列「Default」またはテキスト文字列「ALL」を指定できます。オリジネータ ID に Default を指定すると、-s の構成設定がデフォルト設定になります。オリジネータ ID に ALL を指定すると、-s の構成設定は、指定したプロダクト ID のすべてのオリジネータに適用されます。
- -p, --prodid ProductID
このオプションを指定すると、productID のログ構成設定を作成または変更できます。
- -q, --quiet
このオプションを指定すると、エラーメッセージまたは情報メッセージが表示されなくなります (抑止モード)。
- -r, --remove
製品のログ構成ファイルから、指定された OID および製品用のログ構成設定が登録解除され、削除されます。個々の設定は "-s, --setting keyname=value" オプションを使用して削除できます。
注意:
-r オプションは常に -o オプションと組み合わせて使用します。そのようにしないと、既存のすべての NetBackup ログ設定が削除され、その後 NetBackup のすべてのログが実行されなくなります。
- -s, --setting keyname=value
-a (add オプション) を使って、個々の構成を設定できます。keyname は設定名、value はその設定の値です。コマンドラインで、複数の -s keyname=value 引数を使用できます。
- -s, --setting keyname
このオプションを -r オプションと組み合わせて使用すると、構成設定が削除されます。-r オプションでは 1 つのキー名のみを使用します。複数の設定を削除するには、複数の -s オプションを指定します。特定のキーの名前については、「キーの名前および値」の項を参照してください。
- -v, --version
このオプションを指定すると、このコマンドのバージョン情報が表示されます。
キーの名前および値
次に、-s オプションで指定できるキーの名前および値を示します。NetBackup の場合は、vxlogcfg コマンドを実行すると、UNIX の /usr/openv/netbackup/nblog.conf
ファイルおよび Windows の install_path\NetBackup\nblog.conf
にキーの名前および値が格納されます。PBX の場合は、UNIX の /etc/vx/VxICS/icsul.conf
および Windows のレジストリエントリ SOFTWARE\VERITAS\VxICS\logcfg
にキーの名前および値が格納されます。
UNIX および Windows のキーの名前および値
- LogDirectory
ディレクトリへの絶対パスまたは相対パスを指定します。デフォルト値は存在しません。オリジネータ ID に相対パスを指定する場合は、ログ構成ファイルの Default.LogDirectory に指定されているプロダクト ID のログディレクトリの相対パスを指定します。
注意:
LogDirectory キー名を使って統合ログを代替ディレクトリにリダイレクトする場合は、NetBackup サービスを停止してから再起動します。この操作によってリダイレクトが有効になります。
- DebugLevel
デバッグログメッセージの詳細レベルを設定します。(デバッグログは、Symantecの技術者が使用します)。有効な値は、0 から 6 です。
- DiagnosticLevel
診断ログメッセージの詳細レベルを設定します。(診断ログは、NetBackup の管理者およびユーザーが使用します)。有効な値は 0 から 6 です。0 (ゼロ) はデバッグメッセージがないことを意味します。
- DynaReloadInSec
デバッグおよび診断設定が動的に再ロードされます。0 から 60 までの整数を指定した場合は、60 秒後に再ロードされます。60 を超える整数を指定した場合は、指定した秒数で再ロードされます。
- LogToStdout
すべてのログメッセージが、標準出力 (デフォルトでは端末) とログファイルに送信されます。有効な値は、true および false (デフォルト値) です。
- LogToStderr
アプリケーションログメッセージが、
Stderr
(デフォルトでは端末) とログファイルに送信されます。有効な値は、true および false (デフォルト値) です。- LogToOslog
アプリケーションログメッセージをオペレーティングシステムのログ (UNIX の場合は syslog、Windows の場合はイベントログ) に送信します。有効な値は、true および false (デフォルト値) です。
- RolloverMode
ログファイルをロールオーバータイミングを指定します。ログファイルを切り替えると、現在のログファイルが閉じて、新しいログファイルが開きます。これによって、保持するログファイルのサイズを小さくして、古いログファイルを削除またはアーカイブすることができます。有効な値は、FileSize、LocalTime、Periodic、FileSize | LocalTime、FileSize | Periodic、None です。
FileSize
を指定すると、MaxLogFileSizeKB で設定したサイズに達したときにログファイルが切り替えられます。デフォルト値は、FileSize
です。LocalTime
を指定すると、日に 1 回、RolloverAtLocalTime で指定した時間にログファイルをロールオーバーします。Periodic を指定すると、RolloverAtLocalTime で指定した秒数が経過したときにログファイルをロールオーバーします。
FileSize | LocalTime を指定すると、FileSize または LocalTime のいずれかの値に達したときにログファイルが切り替えられます。
FileSize
| Periodic を指定すると、FileSize または Periodic のいずれかの値に達したときにログファイルが切り替えられます。None を指定すると、ログファイルはロールオーバーされません。
- MaxLogFileSizeKB
RolloverMode に FileSize を設定した場合に、ログファイルが切り替えられる最大サイズを指定します。有効な値は、1 から 4294967295 です。デフォルト値は 51200 (51.2 MB) です。
- RolloverPeriodInSeconds
RolloverMode に Periodic を設定した場合に、ログファイルがロールオーバーされるまでの時間を秒数で指定します。有効な値は、1 から 2147483648 です。デフォルト値は 43200 (12 時間)です。
- RolloverAtLocalTime
RolloverMode に LocalTime を設定した場合に、ログファイルがロールオーバーされる時刻を指定します。有効な値は 00:00 から 23:59 です。デフォルト値は 00:00 (ローカル時間の午前 0 時) です。
- NumberOfLogFiles
統合ログ機能の各オリジネータのログディレクトリ内に保持するファイルの最大数を指定します。有効な値は、1 から 4294967295 です。
vxlogmgr --auto コマンドでは、NumberOfLogFiles を使用して、削除または移動するログファイルの数を決定します。最も古いファイルから削除または移動されます。たとえば、ログディレクトリに、特定のオリジネータによって作成されたログファイルが 7 個含まれているとします。NumberOfLogFiles は 5 に設定されています。この場合、vxlogmgr --auto --del コマンドを実行すると、そのオリジネータによって作成されたファイルのうち、最も古いファイルが 2 個削除されます。
- LogRecycle
有効な値は、true および false です。デフォルト値は false です。true を設定した場合には、ログファイルの数は NumberOfLogFiles を超えません。
- OIDNames
-o オプションで指定した統合ログ機能のオリジネータの代替名を 1 つ以上指定します。これらの名前は、vxlogview コマンドを使用した検索の実行時に、オリジネータ ID の代わりとして使用できます。各名前は、最大 80 文字で指定できます。複数の名前を、空白で区切って指定できます。
- L10nLib
外部ローカライゼーションライブラリの絶対パスおよびファイル名を指定します。このオプションはSymantec内でのみ使用されます。このオプションを使用すると、統合ログ機能が無効になる場合があります。
- L10nResource
統合ログ機能を使用する製品またはオリジネータに関連付けるローカライゼーションリソースの名前を指定します。このオプションは内部でのみ使用されます。このオプションを使用すると、統合ログ機能が無効になる場合があります。
- L10nResourceDir
統合ログ機能を使用する製品またはオリジネータに関連付けるローカライゼーションリソースディレクトリの名前を指定します。このオプションは内部でのみ使用されます。このオプションを使用すると、統合ログ機能が無効になる場合があります。
次の 4 つのキー名は UNIXシステムでのみ動作します。
- LogFilePermissions
UNIX ファイルの権限を 8 進数で指定します。この権限は、-o オプションで指定したオリジネータによって作成されたログファイルに割り当てられます。多くの場合、このオプションを使用する必要はありません。
- SyslogIdent
LogToOslog を true に設定した場合に、各 syslog メッセージの最初に付加する文字列を指定します。SyslogIdent には最大 80 文字の文字列を指定できます。多くの場合、このオプションを使用する必要はありません。
- SyslogOpt
syslog openlog 関数に渡される syslog オプションの値を指定します。LogToOslog が有効な場合には、ログメッセージを UNIX の syslog に送信します。有効な値は、0 から 4294967295 です。多くの場合、このオプションを使用する必要はありません。
- SyslogFacility
syslog に送信されたログメッセージに関連付ける syslog 機能値を指定します。LogToSyslog が有効な場合には、ログメッセージを syslog に送信します。多くの場合、このオプションを使用する必要はありません。
次に、有効な値を示します。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。デフォルトは LOG_USER です。
次の 3 つのキー名は Windows システムでのみ動作します。
- NtEventLogCategory
LogToOslog が有効な場合に、Windows のイベントログに送信するログメッセージに関連付けるカテゴリ番号を指定します。多くの場合、このオプションを使用する必要はありません。
- LogFileSDDL
Windows セキュリティ記述子定義言語 (SDDL) 文字列を指定します。この文字列は、-o オプションで指定したオリジネータによって作成されたログファイルのアクセス制御リスト (ACL) を設定します。多くの場合、このオプションを使用する必要はありません。
- NtEventLogSourceName
Windows で LogToOslog オプションが有効な場合に、ログメッセージを送信する Windows イベントログを指定します。このオプションは、内部だけで使用されます。このオプションを使用すると、統合ログ機能が無効になる場合があります。
例
例 1 - UNIX で NetBackup の LogDirectory およびオリジネータ ID 111 を設定します。
# vxlogcfg -a --prodid 51216 --orgid 111 -s LogDirectory=/usr/openv/logs
例 2 - NetBackup 内の統合ログ機能を使用しているすべてのオリジネータに DebugLevel および DiagnosticLevel を設定します。
# vxlogcfg -a --prodid 51216 -o ALL -s DebugLevel=3 -s DiagnosticLevel=3
例 3 - プロダクト ID 1 にデフォルトの RolloverMode を設定します。
# vxlogcfg -a --prodid 1 -o Default -s RolloverMode=FileSize
例 4 - プロダクト ID 1 のオリジネータ 2 の構成設定を表示します。
# vxlogcfg -l --prodid 1 --orgid 2
例 5 - プロダクト ID 1 に構成されたすべてのオリジネータをリスト表示します。
# vxlogcfg -l --prodid 1
例 6 - すべての構成された製品をリスト表示します。
# vxlogcfg -l
ファイル
UNIX システムの場合:
/usr/openv/netbackup/nblog.conf /etc/vx/VxICS/icsul.conf