付録G.47 nnmscheduledoutage.ovpl
ノードの停止を計画するために使用するコマンドラインツールです。
SYNOPSIS
nnmscheduledoutage.ovpl -u <user> -p <password> [-h | -help]
-create (-node <NODE>| -nodeGroup <NODEGROUP>| -file <FILE) <TIME-SPEC> -name <NAME> [ -description <DESCRIPTION>] [-retroactive]
-delete (-name <NAME> [-node <NODE>]) | -uuid <UUID>
-list [-v] [-node <NODE> | -uuid <UUID> | -name <NAME> ] [-format <FORMAT>]
-dump {-node <NODE> | <TIME-SPEC>} [-retroactive] [-format <FORMAT>]
-update (-name <NAME> [-node <NODE>] | -uuid <UUID>) (<TIME-SPEC> | -addNode <NODE> | -removeNode <NODE>)
[-newName <NEWNAME>] [-description <DESCRIPTION>] [-enable | -disable] <TIME-SPEC> ::= -start <TIME> (-duration <DURATION> | -end <TIME>) [-tz <TIMEZONE>]
DESCRIPTION
nnmscheduledoutage.ovplコマンドは,ノードの計画停止を作成するために使用するコマンドラインツールです。計画された停止の期間中,停止中のノードは管理モードが「サービス停止中」に変更され,停止の期間が終了すると「管理対象」に戻されます。テキストファイルを使用して,複数のノードをノードグルーブ単位で個別の停止グループにまとめたり,既存の停止グループに追加したりできます。計画停止は,停止名,停止に含まれるノード,または計画停止のUUIDの単位で削除できます。計画停止は,任意の参加ノード別に画面に詳細を一覧表示したり,CSVなどの各種形式でフォーマットしたりできます。計画停止を更新して,ノードを追加または削除したり,停止の時間指定を変更したりできます。
Parameters
nnmscheduledoutage.ovplコマンドは,次のオプションをサポートします。
- -h | -help
-
コマンドの使用方法を表示します。
- -u <username>
-
コマンドの実行に必要なNNMiの管理者名を指定します。nnm.propertiesファイルが存在していない限り,これが必要になります。詳細はnnm.propertiesリファレンスページを参照してください。
- -p <password>
-
コマンドの実行に必要なNNMiの管理者パスワードを指定します。nnm.propertiesファイルが存在していない限り,これが必要になります。 詳細は nnm.properties リファレンスページを参照してください。
- -addNode <NODE>
-
指定した計画停止にノードを追加するために,計画停止を更新するときに使用します。
- -create
-
指定したシステムの計画停止を新規作成します。
- -delete
-
指定した計画停止を削除します。
- -description <DESCRIPTION>
-
計画停止についての追加の説明情報を提供します。
- -disable
-
計画停止を無効化します。
- -duration <DURATION>
-
計画停止の期間を分単位で設定します。これは,「分」を示す"m"("m" を省略した場合はデフォルトで「分」を示す),「時間」を示す "h",または「日」を示す"d"を,数字の後につけて指定できます。例えば,"3h"は3時間の停止です。
- -enable
-
計画停止を有効化します。
- -end <TIME>
-
計画停止の終了日時です。構文については,下記の「FORMATTING RULES」項を参照してください。終了日時が現在日時より前である場合,"-retroactive"フラグが必要です。
- -file <FILE>
-
計画停止に関連付けるノードのリストを含むテキストファイルの名前です。ファイルには,空白行や"#"文字で始まるコメントを含めることができ,残りの行はノードと見なされます。ノードは,ホスト名,IPアドレス,またはノードのUUIDのどれかを指定することができます。ホスト名またはIPアドレスが一意でない場合は,停止が適用されるノードを決定することができないので,エラーが発生します。
- -format <FORMAT>
-
一覧表示の出力形式です。'text', 'list', 'csv' および 'xml'が利用できます。
- -nodeGroup <NODEGROUP>
-
ノードグループ名を指定します。
- -list
-
指定したシステムの計画停止の情報を一覧表示します。 システムを指定しない場合は,すべての計画停止を一覧表示します。詳細表示フラグが立っている場合は,影響を受けるノードなど,詳細な情報が表示されます。UUIDによる一覧表示は,常に指定した計画停止の詳細な情報を提供します。
- -dump
-
開始日時と終了日時を持ったノード停止の履歴を一覧表示します。停止の履歴には,ノードが管理対象状態から非管理対象またはサービス停止中に変更されてから(開始日時),管理対象状態に戻った場合には(終了日時),いつでも記録されます。
-
When the -retroactiveオプションを指定した場合は,さかのぼって作成された停止のみが出力されます。
-
ノードパラメータを付与した場合は,指定されたノードの停止をダンプします。
-
時間指定を付与した場合は,その時間枠内に完了した停止をダンプします。 時間指定には開始日時を含める必要があり,さらに期間や終了日時を含めることもできます。期間や終了日時がない場合は,実質的に,"開始日時以降のすべての停止をダンプする" ことを意味します。 開始日時は時間枠に含まれますが,終了日時は含まれません。
-
ノードか開始日時を指定する必要があることに注意してください。 両方を指定した場合は,指定したノードの時間枠内の停止を一覧表示します。
- -name <NAME>
-
計画停止の名前です。名前は当該の停止に一意に準じる名前であり,その名前で停止を参照できます。 しかし,停止の名前は必ずしも一意である必要はなく,同じ名前を持つ2つの停止がある場合は,対象の停止に含まれるノードを一覧表示して,さらに指定を絞り込むことができます。
- -newName <NEWNAME>
-
計画停止の新しい名前です。
- -node <NODE>
-
ノード名,ホスト名,管理アドレス,またはUUIDを指定します。
- -retroactive
-
さかのぼって,過去に計画停止を作成します。これは,事前に計画されずに発生した,いくつかの過去の停止のために,データベース内の停止エントリを作成するために使用されます。
- -removeNode <NODE>
-
指定した計画停止からノードを削除します。
- -start <TIME>
-
計画停止の開始日時です(「FORMATTING RULES」項を参照してください)。
- -tz <TIMEZONE>
-
タイムゾーンの指定です(「FORMATTING RULES」項を参照してください)。
- -update
-
指定した計画停止を更新します。停止のタイミングも,含まれるノードと同様に変更できます。
- -uuid
-
計画停止のUUIDです。
FORMATTING RULES
開始日時と終了日時は,YYYY-MM-DDTHH:MM として指定します。例えば,2013-05-08T14:56は2013年5月8日午後2時56分です。 開始日時と終了日時はまた,すぐに計画停止を開始するため,または,現在進行中の計画停止を終了するため,"now"として指定することができます。
上述したように,期間はそれぞれ,数字(分),または"m","h","d"に続く数字を指定することで,それぞれ分,時間,日となります。大文字小文字は無視されます。そのため,"1d"と"1D"は同じです。
タイムゾーンパラメータは,任意の有効なJavaタイムゾーンパラメータを指定できます。例えば,"US/Mountain"や"Australia/Perth"です。 タイムゾーンのパラメータも"target"(大文字/小文字は区別しない)にできます。これは,計画停止の時間を対象ノードのタイムゾーンで指定することを意味します。"target"を指定した場合は,すべてのノードが同じタイムゾーンに存在する必要があります。さらに,"target"を指定する場合は,そのノードがタイムゾーン属性を持っている必要があります。タイムゾーンには,"server"を指定することもできます。これは,ユーザーのシェルプロセスのタイムゾーンと異なるNNMiサーバーのタイムゾーンを使用する場合があることを意味します。 タイムゾーンが指定されていない場合,ユーザーのシェルプロセスのタイムゾーンが使用されます。
注:計画停止を作成するときは,開始日時と,終了日時または期間のどちらか(両方ではない)を指定しなければなりません。
注:計画停止の最小継続時間は15分です。15分より短い停止は拒否されます。 また,開始日時から15分経過していない場合に,停止を"今すぐ(now)"終了させようとした場合も拒否されます。
EXAMPLES
ノードのタイムゾーンを使用して,1日持続する,ノードの計画停止を作成します(2013年5月21日を将来の日付と仮定します)。
nnmscheduledoutage.ovpl -create -node cisco6509 -start 2013-05-21T09:00 -tz TARGET -duration 1d -name "Replace power supply"
同上ですが,遡及停止です(2013年5月21日を,前の例の未来に代わり,過去の日付と仮定します)。
nnmscheduledoutage.ovpl -create -node cisco6509 -retroactive -start 2013-05-21T09:00 -tz TARGET -duration 1d -name "Replace power supply" -retroactive
ローカルの開始日時および終了日時を使用して,ノードの計画停止を作成します。
nnmscheduledoutage.ovpl -create -node cisco6509 -start 2013-05-21T10:00 -end 2013-05-21T14:00 -name "Replace power supply"
指定されたタイムゾーンで計画停止を作成します。
nnmscheduledoutage.ovpl -create -node cisco6509 -start 2013-05-21T09:00 -end 2013-05-21T10:00 -tz Australia/Perth -name "Replace power supply"
"nodes.txt"ファイルに記載されているノードのリストの停止を計画します。
nnmscheduledoutage.ovpl -create -file nodes.txt -start 2013-05-21T09:00 -tz TARGET -duration 1d -name "Weekly Maintenance"
指定されたタイムゾーンで,経過時間で計画停止を作成します。ノードグループ名がこの例で使用されています。
nnmscheduledoutage.ovpl -create -nodeGroup Routers -start 2013-05-25T09:00 -duration 2h -tz Australia/Perth -name "Weekly Router Maintenance"
指定されたノードの計画停止を一覧表示します。計画停止のUUID,名前,開始時間,終了時間および説明がテーブルに表示されます。
nnmscheduledoutage.ovpl -list -node cisco6509
CSV形式で計画停止を一覧表示します。
nnmscheduledoutage.ovpl -list -node cisco6509 -format csv
2013年7月1日以降のすべての停止について,CSV形式でノードの停止履歴をダンプします。
nnmscheduledoutage.ovpl -dump -node cisco6509 -format csv -start 2013-07-01T00:00
2013年12月のすべての遡及停止をCSV形式でダンプします。
nnmscheduledoutage.ovpl -dump -retroactive -start 2013-12-01T00:00 -end 2014-01-01T00:00 -format csv
名前から計画停止を削除します。複数の計画停止が同じ名前を持つ場合,それらはすべて削除されます。
nnmscheduledoutage.ovpl -delete -name "Weekly Router Maintenance"
指定した計画停止だけが削除されるように,一意な計画停止のUUIDによって停止を削除します。
nnmscheduledoutage.ovpl -delete -uuid 204846c0-a35b-4a92-9726-4ce0a8be596d
新たな停止終了日時により,指定した名前の計画停止の停止期間を拡張します。
nnmscheduledoutage.ovpl -update -name "Weekly Router Maintenance" -end 2013-05-21T12:00
計画停止のUUIDと新しい期間(計画された開始日時からの相対)により,計画停止の停止期間を拡張します。
nnmscheduledoutage.ovpl -update -uuid 204846c0-a35b-4a92-9726-4ce0a8be596d -duration 2h
ノードと名前と新しい開始日時(ただし,同じ終了日時を維持)により,計画された停止を遅らせます。
nnmscheduledoutage.ovpl -update -node cisco6509 -name "Replace power supply" -start 2013-05-21T08:00
AUTHOR
nnmscheduledoutage.ovpl was developed by Micro Focus.
FILES
-
Windows:%NNM_BIN%\nnmscheduledoutage.ovpl
-
Linux:$NNM_BIN/nnmscheduledoutage.ovpl