付録G.39　nnmnodegroupmapsettings.ovpl

SYNOPSIS

nnmnodegroupmapsettings.ovpl -h | -help

nnmnodegroupmapsettings.ovpl create -nodeGroup <name|uuid> [-bgImage <string>] [-bgScale <float>] [-connThresh <number>] [-connType <string>] [-ifaceFilter <string>] [-isConnNodeGroups (true|false)] [-isConnNodes (true|false)] [-isL2Conn (true|false)] [-isL2ConnEdit (true|false)] [-isNeighborConn (true|false)] [-isShowIncidents (true|false)] [-mapRefresh <interval>] [-maxEndpoints <number>] [-maxNodes <number>] [-neighborConnFilter <string>] [-order <number>] [-role <string>]

nnmnodegroupmapsettings.ovpl list (-nodeGroup <name|uuid>|-uuid <uuid>)

nnmnodegroupmapsettings.ovpl update (-nodeGroup <name|uuid>|-uuid <uuid>) [-bgImage <string>] [-bgScale <float>] [-connThresh <number>] [-connType <string>] [-ifaceFilter <string>] [-isConnNodeGroups (true|false)] [-isConnNodes (true|false)] [-isL2Conn (true|false)] [-isL2ConnEdit (true|false)] [-isNeighborConn (true|false)] [-isShowIncidents (true|false)] [-mapRefresh <interval>] [-maxEndpoints <number>] [-maxNodes <number>] [-neighborConnFilter <string>] [-order <number>] [-role <string>]

nnmnodegroupmapsettings.ovpl delete (-nodeGroup <name|uuid>|-uuid <uuid>)

nnmnodegroupmapsettings.ovpl exists (-nodeGroup <name|uuid>|-uuid <uuid>)

nnmnodegroupmapsettings.ovpl pin list -nodeGroup <name|uuid>

nnmnodegroupmapsettings.ovpl pin update (-nodeGroup <name|uuid> -nodeName <name> [-x <value>] [-y <value>]) | -f <csv_file>

nnmnodegroupmapsettings.ovpl annotation create -nodeGroup <name|uuid> [-text <string>] [-style <string>] [-fontFamily <string>] [-fgColor <color>] [-bgColor <color>] [-bgAlpha <value>] [-x <value>] [-y <value>] [-scale <value>] [-width <value>] [-height <value>] [-zIndex <value>]

nnmnodegroupmapsettings.ovpl annotation list -nodeGroup <name|uuid>

nnmnodegroupmapsettings.ovpl annotation update -uuid <annotation_uuid> [-text <string>] [-style <string>] [-fontFamily <string>] [-fgColor <color>] [-bgColor <color>] [-bgAlpha <value>] [-x <value>] [-y <value>] [-scale <value>] [-width <value>] [-height <value>] [-zIndex <value>]

nnmnodegroupmapsettings.ovpl annotation delete -uuid <annotation_uuid>

DESCRIPTION

nnmnodegroupmapsettings.ovplは，ノードグループマップの設定を新規作成，更新，変更，および削除するために使用するコマンドラインツールです。ノードグループマップの設定は，ノードグループごとに個別に作成されます。ノードグループマップの設定は，ノードグループ名またはUUIDまたはマップ設定UUIDによって更新または削除される場合があります。さらに，任意のノードグループ設定の詳細を画面に一覧表示したり，CVSやXMLなどの各種形式にフォーマットしたりできます。

nnmnodegroupmapsettings.ovplは，ノードグループマップビューのノードやサブネットなどのマップオブジェクトの位置の調整やマップ注釈の編集も可能です。この機能を使うためには，ユーザーはノードグループマップの設定で指定されたマップの保存に必要なロールを満たす必要があります。

Commands

nnmnodegroupmapsettings.ovplコマンドは，次のサブコマンドの先頭に-（ハイフン）をつけた場合も動作可能です。

create

指定したノードグループ用の新しいノードグループマップの設定を作成します。

list

指定したノードグループ名またはUUIDのノードグループマップの設定情報を一覧表示します。ノードグループ名またはUUIDを指定しない場合は，すべてのノードグループのすべての設定を一覧表示します。

update

指定されたノードグループマップの設定を更新します。ノードグループマップの設定フィールドにnullを設定する場合は，値なしで引数を指定してください。例えば，

nnmnodegroupmapsettings.ovpl -update -nodeGroup ルーター -ifaceFilter

ノードグループ，接続タイプ，およびロールのフィールドは値を必要とし，nullに設定することはできません。

delete

指定したノードグループマップの設定を削除します。

exists

指定したノードグループのノードグループマップ設定が存在するかどうかを確認します。ノードグループマップ設定が存在する場合は"true"を出力し，存在しない場合はその旨のメッセージを出力します。

pin list

ノードグループマップで保存されたマップオブジェクトの位置を一覧表示します。あるノードグループマップビューに新たに追加されたマップオブジェクトは，位置が保存されるまではこの一覧には表示されません。マップオブジェクトの位置を保存するには，NNMiコンソールのノードグループマップビューで「マップを保存」を使用してください。

「-format csv」オプションを使用したこのコマンドの出力は，ヘッダー行を削除することで「pin update」の入力に使用可能です。

pin update

ノードグループマップの指定したマップオブジェクトの位置を更新します。コマンドライン引数を使用した単一のマップオブジェクトの位置を更新と，CSVファイルを使用した複数の位置の更新が可能です。このコマンドを使用する前に，NNMiコンソールのノードグループマップビューで「マップを保存」を使用しマップオブジェクトの位置を保存する必要があります。

このコマンドによって，NNMiコンソールでは編集できない位置にマップオブジェクトを移動することが可能になる場合があります。そのようになった場合は，このコマンドを用いて有効な位置にマップオブジェクトを移動するか，NNMiコンソールのノードグループマップビューで「レイアウトのクリア」を使用してください。

annotation create

指定したノードグループマップにマップ注釈を作成します。

annotation list

指定したノードグループマップのマップ注釈を一覧表示します。

annotation update

指定したマップ注釈を更新します。

annotation delete

指定したマップ注釈を削除します。

Parameters

nnmnodegroupmapsettings.ovplコマンドは，次のオプションをサポートします。

-h | -help

コマンドの使用方法を表示します。

-bgAlpha <value>

マップ注釈のボックスの背景色の透明度です。有効な値の範囲は0.0から1.0です。

-bgColor <value>

マップ注釈のボックスの背景色です。値の形式は"<Red>,<Green>,<Blue>"で有効な値の範囲は0から255です。例："0,128,255"

-bgImage <string>

ノードグループマップに関連付けられる，背景イメージファイルの名前です。

-bgScale <float>

ノードグループマップに関連付けられる，背景イメージファイルのスケールです。浮動小数点の値として解釈されます。デフォルト値は1.0です。

-connThresh <number>

複数接続しきい値です。接続を多重接続に折りたたまないで表示する，ノード間またはノードグループ間の接続の最大数です。

-connType <string>

接続タイプです。接続のタイプは，関連するノードグループマップに表示されます。有効な値は，"none"，"L2" または"L3"です。引数は大文字と小文字を区別しない方法で解釈されます。デフォルト値は"none"です。

-f <CSV file>

マップオブジェクトの位置の更新に使うCSVファイルです。

CSVファイルは以下の形式に従う必要があります。

空行は無視されます。"#"から始まる行は無視されます。全ての列は必須です。

• 列1(A)：ノードグループの名前またはUUID

• 列2(B)：位置を更新するマップオブジェクトの名前

  このマップオブジェクトの名前は，pin listコマンドに表示される名前と同じにします。インベントリやノードグループマップビューに表示される名前とは異なる可能性があります。

• 列3(C)：マップオブジェクトの位置のX座標

• 列4(D)：マップオブジェクトの位置のY座標

行の例：

ルーター,test-node,100,200

-fgColor <value>

マップ注釈の文字色です。値の形式は"<Red>,<Green>,<Blue>"で有効な値の範囲は 0 から255です。例:"0,128,255"

-fontFamily <value>

マップ注釈のテキストのフォントです。有効な値は"sans-serif"，"serif"，"monospace"または"cursive"です。

-height <value>

マップ注釈の領域の高さです。

-ifaceFilter <string>

関連するノードグループマップに適用する，終了ポイントインタフェースのフィルターの名前です。

-isConnNodeGroups (true|false)

関連するノードグループマップにノードグループを接続するかどうかを示すフラグです。ブール値として解釈します。"true"は，どのような大文字と小文字の組み合わせで設定してもtrueと解釈されますが，その他すべての引数の値はfalseと解釈されます。

-isConnNodes (true|false)

関連するノードグループマップにノードを接続するかどうかを示すフラグです。ブール値として解釈します。"true"は，どのような大文字と小文字の組み合わせで設定してもtrueと解釈されますが，その他すべての引数の値はfalseと解釈されます。

-isL2Conn (true|false)

IPv4サブネット接続ルールによって判別されたレイヤー2接続を，関連するノードグループマップ上に表示するかどうかを示すフラグです。ブール値として解釈します。"true"は，どのような大文字と小文字の組み合わせで設定してもtrueと解釈されますが，その他すべての引数の値はfalseと解釈されます。

-isL2ConnEdit (true|false)

nnmconnedit.ovplコマンドラインツールを使用して追加したレイヤー2接続編集を，関連するノードグループマップ上に表示するかどうかを示すフラグです。ブール値として解釈します。"true"は，どのような大文字と小文字の組み合わせで設定してもtrueと解釈されますが，その他すべての引数の値はfalseと解釈されます。

-isNeighborConn (true|false)

ノードグループのメンバーではない（1ホップ離れた距離にある）主要なネットワークデバイスへの追加接続を行うかどうかを示すフラグです。ブール値として解釈します。"true"は，どのような大文字と小文字の組み合わせで設定してもtrueと解釈されますが，その他すべての引数の値はfalseと解釈されます。フィルターが提供されていない場合は，「ネットワーキングインフラストラクチャデバイス」ノードグループがフィルターとして使用されます。子ノードグループのデバイスフィルターがあっても無視されます。

-isShowIncidents (true|false)

ノードグループマップ上で重要なインシデントと関連するノードのマップシンボルを拡大表示するかどうかを示すフラグです。ブール値として解釈します。"true"は，どのような大文字と小文字の組み合わせで設定してもtrueと解釈されますが，その他すべての引数の値はfalseと解釈されます。

-mapRefresh <interval>

分と秒で指定するマップのリフレッシュ間隔です。フォーマットはmmMssSの形で，mm，ssには0～59の数値を入れます。例：59M59S(最大値)，1S(1秒)，5M(5 分)，5M30S(5分30秒)

-maxEndpoints <number>

関連するノードグループマップ上に表示される，エンドポイントの最大数です。

-maxNodes <number>

関連するノードグループマップ上に表示される，ノードの最大数です。

-neighborConnFilter <string>

ノードグループに所属していない，1ホップ近隣のノードをノードグループマップに表示する場合に，フィルターの役割を果たすノードグループです。ノードグループに対して定義されたデバイスフィルターがあれば，候補となる近隣ノードに適用されます。重要な注意 - フィルターを適用するとき，子ノードグループは無視されます。isNeighborConnオプションの説明も参照してください。

-nodeGroup (<name>|<uuid>)

ノードグループの名前です。

-nodeName <name>

マップオブジェクトの名前です。

-order <number>

整数で指定された，ノードグループマップの設定の優先順序です。番号が低いほど優先度が高くなります。例えば，1は10よりも高い優先順序です。

-role <string>

ノードグループマップ設定にアクセスするために必要なユーザーロールです。有効な値は"admin"，"client"，"level1"，"level2"です。引数は大文字と小文字を区別しない方法で解釈されます。デフォルト値は"admin"です。

-scale <value>

マップ注釈のテキストのスケールです。有効な値の範囲は0.2から10000です。

-style <value>

マップ注釈のテキストのスタイルです。有効な値は"normal"，"bold"，"italic"または"bold-italic"です。

-text <string>

マップ注釈のテキストです。

-uuid <value>

ノードグループマップ設定かマップ注釈のUUIDです。

-width <value>

マップ注釈の領域の幅です。

-x <value>

マップ注釈かマップオブジェクト位置のX座標です。

-y <value>

マップ注釈かマップオブジェクト位置のY座標です。

-zIndex <value>

マップ注釈のZ-indexです。

Additional Parameters

-fields <fields>

表形式のデータが存在しているときに出力フィールドを選択します。

-format <style>

一覧表示の出力形式です。'text','list','csv'および'xml'が利用できます。

-p <password>

コマンドの実行に必要なNNMiの管理者パスワードを指定します。nnm.propertiesファイルが存在していない限り，これが必要になります。詳細はnnm.propertiesリファレンスページを参照してください。

-quiet

通常の出力を抑制し，エラーだけを表示します。

-u <username>

コマンドの実行に必要なNNMiの管理者名を指定します。nnm.propertiesファイルが存在していない限り，これが必要になります。 詳細はnnm.propertiesリファレンスページを参照してください。

FORMATTING RULES

ノードグループ名を指定するとき，スペースが存在する場合は，名前を二重引用符で囲みます。（例："Important Nodes"）

EXAMPLES

必須の引数だけでノードグループマップの設定を作成します。

nnmnodegroupmapsettings.ovpl create -nodeGroup Routers -connType L3 -role admin

オプションの引数でノードグループマップの設定を作成します。

nnmnodegroupmapsettings.ovpl create -nodeGroup Switches -connType L2 -bgImage /images/Colorado.png -bgScale .75 -connThresh 3 -ifaceFilter "VLAN Interfaces" -isConnNodeGroups true -isConnNodes t -isL2Conn true -isL2ConnEdit True -mapRefresh 5M -maxEndpoints 200 -maxNodes 100 -order 10 -role admin

指定されたノードグループのノードグループマップ設定を一覧表示します。属性データがテーブルに表示されます。

nnmnodegroupmapsettings.ovpl list -nodeGroup "Important Nodes"

ノードグループマップ設定のすべてを一覧表示します。属性データがテーブルに表示されます。

nnmnodegroupmapsettings.ovpl list

指定されたノードグループのノードグループマップの設定をCSV形式で一覧表示します。

nnmnodegroupmapsettings.ovpl list -nodeGroup "Non-SNMP Devices" -format csv

ノードグループ名によってノードグループマップ設定を削除します。

nnmnodegroupmapsettings.ovpl delete -nodeGroup "Routers"

設定のUUIDによってノードグループマップ設定を削除します。

nnmnodegroupmapsettings.ovpl delete -uuid 204846c0-a35b-4a92-9726-4ce0a8be596d

ノードグループのノードグループマップ設定を更新します。

nnmnodegroupmapsettings.ovpl update -nodeGroup Routers -bgImage /images/Denver.png -bgScale .75 -connThresh 2 -ifaceFilter "Point to Point Interface" -isConnNodeGroups true -isConnNodes t -isL2Conn false -isL2ConnEdit False -mapRefresh 4M30S -maxEndpoints 200 -maxNodes 100 -order 15 -role admin

AUTHOR

nnmnodegroupmapsettings.ovpl was developed by Micro Focus.

FILES

• Windows：%NNM_BIN%\nnmnodegroupmapsettings.ovpl

• Linux：$NNM_BIN/nnmnodegroupmapsettings.ovpl