運用コマンドレファレンス Vol.1

set_default_loggingメソッド（commandline.CommandLineクラス）

該当インスタンスから実行するコマンドのログを，show loggingコマンドの表示対象とするかどうかのデフォルト値を設定します。

［メソッド名］

set_default_logging(mode)

［引数］

mode

• commandline.ENABLE
  本メソッドから実行するコマンドのログを，show loggingコマンドで表示します。
  
• commandline.DISABLE
  本メソッドから実行するコマンドのログを，show loggingコマンドで表示しません。ただし，show loggingコマンド実行時にscript-onlyパラメータ，またはscript-includeパラメータを指定した場合は表示します。
  

［戻り値］

なし

［例外］

表20-4　set_default_loggingメソッドの例外クラス一覧

例外クラス名	説明
TypeError	引数の型に誤りがあります。
ValueError	引数に不正な値が指定されています。
KeyboardInterrupt	［Ctrl＋C］の入力によって設定が中断されました。
commandline.LoggingError	設定に失敗しました。再度インスタンスを生成後，再実行してください。

［詳細］

該当インスタンスから実行するコマンドのログ（メッセージ種別：KEY，CONFIGERR，CMDRSP）を，show loggingコマンドの表示対象とするかどうかを設定します。本メソッドを呼び出していない場合（デフォルト）は，ログを表示します。

［注意事項］

1. この設定は，本メソッドを呼び出したあとで実行されるコマンドのログに適用されます。呼び出し前のログには，ログ発生時の設定が適用されます。
2. 引数modeにcommandline.DISABLEを指定した場合，運用上重要なコマンドのエラーを見逃すおそれがあります。そのため，次に示す対応を推奨します。
   
   • 重要なコマンドを実行するときは，execメソッドの引数loggingをcommandline.ENABLEに指定して実行する。
   • 実行結果がエラーになった場合は，sysmsgモジュールを使用してメッセージを出力するスクリプトを作成する。

［備考］

• exitメソッドの呼び出し時やスクリプト終了時などに本モジュールが独自に実行するコマンド（exitおよびend）のログを非表示にしたい場合は，本メソッドで非表示に設定（引数modeにcommandline.DISABLEを指定）してください。
• 本メソッドによって，非表示対象（引数modeにcommandline.DISABLEを指定）としたログは，show loggingコマンド実行時にscript-onlyパラメータまたはscript-includeパラメータを指定した場合，次の表に示すメッセージ種別で表示されます。なお，これらのメッセージ種別の最大保存件数は，それぞれ20000件です。
  

  表20-5　非表示対象ログのメッセージ種別

  対象ログ	メッセージ種別
  入力コマンド	SCR-KEY
  コンフィグレーションエラーメッセージ	SCR-CNFERR
  コマンド応答メッセージ	SCR-CMDRSP

[目次][前へ][次へ]

All Rights Reserved, Copyright(C), 2014, 2019, ALAXALA Networks, Corp.