PowerChute Network Shutdown Configuration Files

Transcription

1 PowerChute TM Network Shutdown 設定ファイル

2 目次 1 はじめに INI ファイルのフォーマット 形式 プロパティ セクション コメント 設定 INI ファイルの使用方法 設定のインポートとエクスポート PowerChute INI の編集 INI ファイルの検証 形式が無効 またはエントリが存在しない 重複エントリ 設定ファイルが存在しない INI エラーメッセージ PCNSConfig.INI: セクション プロパティ 値 NMC の環境設定 イベントログの設定 シャットダウンの設定 ネットワーク処理の設定 イベントの設定 イベント名 冗長 UPS 構成の詳細設定...14 PCNSconfig.INI ii

3 1 はじめに PowerChute Network Shutdown(PCNS) バージョン 3.0 以前では 設定データはバイナリファイルに保存されていたため インストール後に設定変更を行ったり 同じ設定を他の PCNS にコピーしたりすることは容易ではありませんでした バージョン 3.0 では PCNS の設定はテキスト形式の INI ファイルに保存されます 本書で は INI ファイルの形式とその使用方法について説明します 各章ではそれぞれ 以下の内容を説明しています 第 2 章 INIファイルのフォーマットでは 基本的なINIファイルのフォーマットについて紹介しています 第 3 章 設定 INIファイルの使用方法では INIファイルの保存されているフォルダと 手動でファイルを編集する方法を示します 第 4 章 INIファイルの検証では 設定値の検証について示します 第 5 章 PCNSConfig.INI: セクション プロパティ 値では PowerChute 設定 INIでサポートされているセクション プロパティおよび値について説明します 2 INI ファイルのフォーマット PCNS の INI ファイルは 一般に使用されている設定ファイルのフォーマットを使用しています INI ファイルはテキストファイルで 基本的な構造を持っています このファイルフォーマットは一般的に Microsoft Windows で使用されることが多いのですが 他のプラットフォームでも使用されています 2.1 形式 プロパティ INI ファイルで基本となる要素がプロパティです すべてのプロパティは名前と値を持ち それらが等号記号 (=) によって区切られています 名前は等号の左側に示されます 例 : name = value PCNSconfig.INI 1

4 2.1.2 セクションプロパティは 任意の 名前を持つセクションにグループ分けできます セクションを宣言するには 1 行に角括弧 ([ と ]) で囲んだセクション名のみを記述します セクション宣言の次の行以降に記述されたプロパティは そのセクションに含まれます セクションの終了 を明示的に示す区切り記号はありません セクションは次のセクション宣言 またはファイルの終端で終わります セクションは ネストすることができません 例 : [Section] コメントセミコロン (;) はコメントの開始を示します コメントはその行の終端で終了します セミコロンから行の終端までに記述された内容はすべてコメントとして無視されます 例 : ; This is a comment PCNSconfig.INI 2

5 3 設定 INI ファイルの使用方法 PowerChute Network Shutdown(PCNS)3.0 では 設定値の保存と読み取りのために INI ファイルが使用されています このセクションでは PowerChute Network Shutdown がこのファイルをどのように処理しているかについて説明します 3.1 設定のインポートとエクスポート PowerChute Network Shutdown の設定内容は 次のディレクトリまたはフォルダに以下のファイル名で保存されます <install dir>\group1\pcnsconfig.ini <install dir>\group1\pcnsconfig.ini.bak ユーザインターフェイスを使用して設定を変更すると 変更内容は上記の INI ファイルに書 き込まれます ユーザ名やパスワードなど 機密性の高い一部の値は設定ファイルには書 き込まれません 設定 INI ファイルの内容は PowerChute Network Shutdown サーバが起動すると自動的にイ ンポートされます この時 ファイルの内容が検証され 問題がある場合はエラーが PCNS のイベントログに書き込まれます 必要がある場合 PCNS は INI ファイルから設定値を読み取ります この時 PCNS が要求す るプロパティ 値 形式がファイル中に記述されていない場合 または設定内容が無効であ る場合は 検証エラーとなる場合があります Pcnsconfig.ini.bak は INI ファイルのバックアップファイルです メインの INI ファイルからの読み取り中に検証エラーが発生した場合は 前回正常起動時の値がバックアップファイルから読み込まれます また 各プロパティにはそれぞれ固有の規則が適用され それによっても検証されます バックアップファイルの値が使用された場合は エラーまたは警告が記録され 同時に PCNS イベントログにメイン INI ファイル値の検証エラーが記録されます その後メイン INI ファイルにこの値が上書きされ 自動的に修正が行われます また バッ クアップ INI ファイル中にも値が見つからないか それが無効である場合は 必要に応じて デフォルト値が使用されます PCNSconfig.INI 3

6 3.2 PowerChute INI の編集 PCNS ユーザインターフェイスで設定内容が変更されると その値が設定 INI ファイルに書き込まれます 例えば ユーザインターフェイス上でシャットダウンまたは通知のイベントを有効にすると 設定 INI ファイルが自動的に更新され この変更内容が反映されます INIファイルを編集する場合は PCNSサービスを停止してから行ってください PCNSサービスを停止しないと 意図せず サービスによって変更内容が上書きされてしまう場合があります INIファイルの編集はテキストエディタを使用して行うことができます INIファイルに設定可能なセクション プロパティ 値 形式については 本書の第 5 章で詳しく説明します INI ファイルは PCNS サービスによって自動的に更新されるため このファイルを読み取り専用に変更しないでください INI ファイルを読み取り変更にすると PowerChute Network Shutdown が動作しません PCNSconfig.INI 4

7 4 INI ファイルの検証 このセクションでは PowerChute Network Shutdown(PCNS) の設定 INI に含まれるプロパティがどのように検証されるかを説明します 4.1 形式が無効 またはエントリが存在しない プロパティの名前および値 または値をエントリと呼びます メインおよびバックアップのいずれの INI ファイルにもエントリが記載されていない場合 そのエントリがないと見なされます この場合 検証エラーが生成され デフォルト値が設定されている場合は代わりにデフォルト値が使用されます エントリがメイン INI ファイルには存在しないが バックアップ INI ファイルには存在する場合には そのエントリは形式が無効であると判断されます 形式が無効なパラメータとしては この他に要求されたタイプに変換できないもの 範囲外の値のもの 正規表現に一致しないものなどもあります このような状況では PCNS はバックアップ INI ファイルから前回の正常起動時の値を探します バックアップファイルの値 またはバックアップファイルにそのエントリがない場合に デフォルト値 ( 該当する場合 ) のいずれかが使用された場合 検証エラーが報告されます エラーの重大性は それぞれのパラメータによって変わります 4.2 重複エントリ PowerChute Network Shutdown では ひとつのセクションに同じ名前を持つプロパティが複数存在することはできません 重複するエントリが存在する場合は 重複エントリの検証エラーが記録されます 重複するエントリが存在する場合 PCNS は そのセクションで最初に指定されている値を適用します この値には そのプロパティ用の通常の検証規則が適用されます プロパティが無効である場合には さらに別の検証エラーと警告が記録されます 例 [NetworkManagementCard] port = 80 port = 81 PCNSconfig.INI 5

8 この場合は PCNS によって適用される値は 80 となります この場合 NetworkManagementCard セクション内に重複するプロパティが存在しますので 検証エ ラーが記録されます 4.3 設定ファイルが存在しない INI ファイルが存在しない場合は PCNS はそれ自身が内部に保存している設定情報を使用し ます そこにも必要な値がない場合は INI ファイルが存在しないため安全なシャットダウ ンが保証されないという内容の PCNS の警告が発生する可能性があります 4.4 INI エラーメッセージ INI ファイルとその設定内容が検証され 問題がある場合はエラーメッセージがイベントロ グに記録されます 記録されるエラーメッセージを以下の表に示します INI 検証メッセージ 理由 メッセージテキスト 値 必要なセクションが INI ファイルに ERROR: The ini file is missing the 0: セクション名 見つからない required {0} section. 値が INI ファイルのグローバル領域 ( セクションの範囲外 ) に含まれている WARNING: The ini file has entries defined outside of a section. 認識不可能なセクションが INI ファイルで定義されている INI ファイルにプロパティが見つからない これは メインとバックアップ INI ファイルの両方でそのプロパティが見つからないときのみに発生する NMC カードの詳細が INI ファイルに指定されていない セクション内に重複プロパティが検出される セクション内に認識できない追加プロパティが検出される プロパティに無効な値が指定されている 代替値が利用できない ( 代替値はバックアップの INI ファイルで指定された値 または定義済みのデフォルト値 ) WARNING: The invalid section {0} should be removed from the ini file. ERROR: The ini file is missing {1} key from section {0}. ERROR: The ini file could not find IP address information in section {0}. WARNING: The ini file has detected duplicate values for {1} in section {0}. WARNING: The invalid key {1} should be deleted from section {0} in the ini file. ERROR: The ini contains an invalid value for {1} in section {0}. 0: セクション名 0: セクション名 1: プロパティ名 0: Network Management Card の INI セクションの名前 0: セクション名 1: プロパティ名 0: セクション名 1: プロパティ名 0: セクション名 1: プロパティ名 PCNSconfig.INI 6

9 理由 メッセージテキスト 値 プロパティに無効な値が指定されている 代替値が利用できない ( 代替値はバックアップの INI ファイルで指定された値 または定義済みのデフォルト値 ) ERROR: The ini contains an invalid value for {1} in section {0}. Using {2} instead. Please validate the configuration. INI ファイルが見つからない プロパティ値が有効な正規表現に一致しない プロパティ値が有効なタイプに変換できなかった イベントはコマンドファイルの実行を有効にしているが コマンドパラメータの 1 つが検証に失敗した イベントはコマンドファイルの実行を有効にしているが コマンドパラメータの 1 つが検証に失敗した FATAL ERROR: PCNS cannot find the configuration file ({0}) or the backup configuration file ({1}). Shutting down. ERROR: The key {1} in section {0}, failed to match the supplied regular expression. ERROR: Could not convert the value of {1} in section {0} to its expected type. ERROR: Event {0} is enabled for command file execution, but an invalid value for {1} is specified. WARNING: Disabling command file execution for event {0} due to bad parameters. Please validate the configuration. 0: セクション名 1: プロパティ名 2: 代替値 0: メイン INI ファイルのパス 1: バックアップ INI ファイルのパス 0: セクション名 1: プロパティ名 0: セクション名 1: プロパティ名 0: イベント 1: 検証に失敗したパラメータ 0: イベント PCNSconfig.INI 7

10 5 PCNSConfig.INI: セクション プロパティ 値 この章では PowerChute Network Shutdown(PCNS) の設定 INI ファイルで指定可能なセクシ ョン プロパティ および値について説明します ここで説明する値以外の値を使用した 場合 PowerChute のイベントログに検証エラーが記録されます 5.1 NMC の環境設定 セクション名 : [NetworkManagementCard] プロパティ 形式 デフォルト 説明 Mode single redundant single シングル UPS 冗長構成またはパラレル構成を指定します parallel のうちの 1 つ IP_1 ~ IP_9 IP アドレス XXX.XXX.XXX.XXX なし 最大 9 つの IP アドレスを指定します IP_1_Outlet ~ IP_9_Outlet 0 = メインコンセント 1 = 切替コンセント 1 2 = 切替コンセント 2 その他 切替コンセントが搭載されている UPS モデルの場合 PCNS サーバに給電するコンセントグループを指定します port 整数 80 NMC 用の HTTP ポート username 3~10 の英数文字 (A Z a z 0 9) apc NMC 通信用のユーザ名 PCNS 用ユーザ名としても使用されます password authenticationphrase 3~32 の英数文字 (A Z a z 0 9) 15~32 の英数文字 (A Z a z 0 9) apc admin user phrase PCNS のパスワード NMC 通信用の認証フレーズ PCNS 用の認証フレーズとしても使用されます UPS NMC 用の通信プロトコル protocol HTTP または HTTPS HTTP acceptcerts true/false false SSL が有効になっている NMC へ PCNS を登録するように設定さ れているときには このプロパ ティの設定値が使用されます true に設定すると PCNS は NMC の自動署名の SSL 証明書を 受理します enrolwithnmc true/false true デフォルトでは PCNS は サー ビスの起動時に自動的にターゲ ット NMC に登録します 値を false に設定するとこれを無 効にすることができます PCNSconfig.INI 8

11 PCNS はユーザ名 パスワード 認証フレーズの値を INI ファイルから読み取ることができ ますが セキュリティのため これらの値はファイルに書き込まれません PCNS がこれら の値を INI ファイルから読み取った後に 自動的に削除されます パスワードをリセットするには INI ファイルを編集して 新しいユーザ名とパスワード値 を入力します サービスが再開されると 新しいユーザ名とパスワードが有効になります 5.2 イベントログの設定 セクション名 : [EventLog] プロパティ デフォルト 最小 最大 形式 説明 logsize 整数 ログファイルの最大行数 logfile EventLog.txt なし なし 引用符で囲まれたファイルパス ログファイルのパス 5.3 シャットダウンの設定 セクション名 : [Shutdown] プロパティ デフォ 最小 最大 形式 説明 ルト shutdowncommand デフォルト値はプラ 引用符で囲まれたフ 実行可能なオペレーティングシステムのシャットダウンコマンドのパス ットフォームによって異なる ァイルパス shutdowncommandduration 整数 シャットダウンコマンドがオペレーティングシステムをシャットダウンするのに要する時間 ( 秒 ) shutdowncommandfile 引用符で囲まれたファイルパス シャットダウン時に実行するオプションのコマンドファイル ( スクリプト ) のフルパス 存在しないコマンドファイルのパスが入力された場合は 検証エラーとなり イベントがイベントログに記録されます Unix システムでは スク PCNSconfig.INI 9

12 プロパティ デフォルト 最小 最大 形式 説明 リプトに実行許可があるかもチェックされます shutdowncommandfileduration 整数 shutdowncommandfile の実行に要する時間 ( 秒 ) turnoffups false true/fals e シャットダウン後にこの PCNS エージェントが UPS を停止するかどうかを示す値 これは パラレル Silcon UPS Smart UPS VT または Galaxy には適用されません turnoffsog false true/fals e シャットダウン後に PCNS が切替コンセントグループの電源をオフするかどうかを示す値 これは 切替コンセントを持つ UPS モデルにのみ適用されます shutdowndelay 10 秒 整数 PCNS が OS シャットダウンを開始する前に待機する時間 5.4 ネットワーク処理の設定 セクション名 : [Networking] ネットワーキング処理のプロパティ 値 プロパティ デフォ 最小 最大 形式 説明 ルト localhostaddress IP アドレス XXX.XXX.XXX.XXX PCNS エージェントの IP アドレス NMC での登録に使用されます protocol HTTP HTTP または HTTPS Web ユーザインターフェイス用のプロトコル HTTP と HTTPS(SSL) のいずれかを HTTPPort 3052 整数 下記の注を参照してください HTTPSPort 6547 整数 下記の注 を参照してくださ い 指定します HTTP ポート番号 HTTPS ポート番号 PCNSconfig.INI 10

13 有効な HTTP ポート番号は以下のとおりです : 80, 3052, 5000~32768 有効な HTTPS ポート番号は以下のとおりです : 443, 6547, 5000~ イベントの設定 セクション名 : [Events] イベント名このセクションでは 設定 INI ファイルで設定可能なイベント名について説明します イベントセクションのプロパティ名には 先頭に event_<eventname>_ が付けられます 代表的な PowerFailed イベントの設定は以下のようになります [Events] event_powerfailed_enablelogging = true event_powerfailed_enablecommandfile = false event_powerfailed_commandfilepath = event_powerfailed_commandfiledelay = 0 event_powerfailed_commandfileduration = 0 event_powerfailed_enableshutdown = false event_powerfailed_shutdowndelay = 120 UPS イベント名 イベント名 PCNS UI で設定可能か? PowerFailed はい UPS: On Battery PowerRestored はい Input Power: Restored Overload はい UPS: Overloaded OverloadSolved はい UPS Overload: Corrected PCNSconfig.INI 11

14 イベント名 PCNS UI で設定可能か? RuntimeExceeded はい Runtime: Exceeded RuntimeWithinRange はい Runtime: Normal Again BatteryDischarged はい Battery: Discharged BatteryChargeInRange はい Battery: Recharged LowBattery いいえ FaultBypassEnabled はい Bypass: Due to a Fault BypassEnabled はい Bypass: For Maintenance BypassDisabled はい Bypass: Ended BypassContactorFailed はい Bypass Switch: Failed BypassContactorOk はい Bypass Switch: Replaced CommunicationLostWhileOnBattery はい Communication Lost: While on Battery CommunicationLost はい Communication: Management Card cannot communicate with the UPS. NetCommunicationLost はい Communication: PowerChute cannot communicate with the Management Card CommunicationEstablished はい Communication: Established MinRedundancyLost はい Minimum Redundancy: Lost MinRedundancyRegained はい Minimum Redundancy: Regained MaxInternalTempExceeded はい UPS Temperature: Overheated MaxInternalTempInRange はい UPS Temperature: Normal Again MinLoadCapabilityLost はい Load (kva) Alarm Violation MinLoadCapabilityRegained はい Load (kva) Alarm Violation OK PowerSourceTurnOffInitiated いいえ UPS の電源オフが開始された ShutdownStarting いいえ OS のシャットダウンが開始された AccountLockOut いいえ 続けて 3 回ログインに失敗したため アカ ウントが一時的にロックされた PowerOff いいえ UPS の出力電源がオフになっている TurnOffUpsStarting いいえ PCNS から UPS/ コンセントグループに電源 オフコマンドが出されている ShutdownOnBattery いいえ 詳細設定に関連 バッテリ運転になって いた UPS の電源がオフになっている MultipleCriticalEvent いいえ 冗長構成に含まれる 2 台以上の UPS で重大 なイベントが発生している 重大なイベントが 10 秒以上続く場合は OS シャットダウンの手順が開 始される CannotCommunicate いいえ 内部イベント CannotCommunicateResolved いいえ 内部イベント MonitoringStarted いいえ 内部イベント ParallelSilconNotSupported ParallelSilconSupported いいえ パラレル UPS 構成のみに適用 パラレル構成から UPS を物理的に取り外した場合に このイベ ントが発生する PCNSconfig.INI 12

15 環境イベント イベント名 ContactFault1 ContactFault2 ContactFault3 ContactFault4 ContactNormal1 ContactNormal2 ContactNormal3 ContactNormal4 HumidityInRangeProbe1 HumidityInRangeProbe2 HumidityOutOfRangeProbe1 HumidityOutOfRangeProbe2 TempInRangeProbe1 TempInRangeProbe2 TempOutOfRangeProbe1 TempOutOfRangeProbe2 EnvironmentCommunicationEstablished EnvironmentCommunicationLost EnvironmentNoCommunicationSinceLastReboot IntegratedEnvCommunicationEstablished イベントの記録 以下のプロパティと値がイベントセクションに記述されている場合 PowerChute Network Shutdown はイベントログにイベントを記録します イベントの記録のプロパティ 値 プロパティ デフォルト値 最小 最大 タイプ / 形式 説明 enablelogging true true/false このイベントのイベントの 記録を有効にする コマンドの実行 以下のプロパティと値がイベントセクションに記述されている場合 PowerChute Network Shutdown はイベント発生時にコマンドを実行します コマンド実行のプロパティ 値 プロパティ デフォ 最小 最大 タイプ / 説明 ルト値 形式 enablecommandfile false true/false このイベントのコマンドファイ ルの実行を有効にする PCNSconfig.INI 13

16 プロパティ デフォ 最小 最大 タイプ / 説明 ルト値 形式 commandfilepath 文字列 コマンドファイルのフルパス commandfiledelay 整数 コマンドファイルの実行前の遅延時間 ( 秒 ) イベントがここで指定された時間継続した場合にのみ コマンドが実行される commandfileduration 整数 コマンドファイルの実行に必要な時間 ( 秒 ) イベントシャットダウン 以下のプロパティと値がイベントセクションに記述されている場合 PowerChute Network Shutdown はイベント発生時にシャットダウンを実行します イベントシャットダウンのプロパティ 値 プロパティ デフォルト値 最小 最大 タイプ / 説明 形式 enableshutdown false true/false このイベントの OS シャットダウンを有効にする shutdowndelay OnBattery イベント対して 120 その他のすべてのイベントに対して 整数 イベントが発生してからシステムシャットダウンを実行するまでの遅延時間 ( 秒 ) 冗長 UPS 構成の詳細設定 SinglePowerFailed イベントについては特別な処理が行われます このイベントは 冗長 UPS 構成において 1 台の UPS のみがバッテリ運転になっている場合に発生します このイベントは SinglePowerRestored イベントによってキャンセルされます 冗長 UPS 構成で詳細設定を行う場合 このイベントにのみ適用可能な以下のプロパティが使用できます 以下のプロパティは [AdvancedConfig] INI セクションのみに有効です 他のイベント INI セクションに追加された場合は 検証エラーが発生します PCNSconfig.INI 14

17 SinglePowerFailed イベントの追加プロパティ 値 プロパティ デフォルト 最小 最大 形式 説明 SinglePowerFailed_enableLogging true true/ false このイベントの記録を有効にする SinglePowerFailed_enableCommandFile コマンドフ ァイルの引用符で囲まれたパス SinglePowerFailed_turnOffUPS false true/ false 冗長 UPS 構成において 不具合のある 1 台の UPS の電源をオフにする SinglePowerFailed_turnOffUPSDelay 整数 冗長 UPS 構成において 1 台の UPS がこの時間 ( 秒 ) 継続してバッテリ運転になっているときは その UPS の電源をオフにす る PCNSconfig.INI 15