jpcconf agttree import
- 〈このページの構成〉
形式
jpcconf agttree import [-nocheck] [-noquery] [-lhost 論理ホスト名] -f エージェント階層定義ファイル名
機能
jpcconf agttree importコマンドは,指定されたファイルからエージェント階層の定義情報をインポートし,エージェント階層を作成・更新するコマンドです。インポートされたエージェント階層の定義情報は,次のどちらかの場合に反映されます。
-
PFM - Web Consoleの[エージェント階層]画面の表示を更新する
-
PFM - Web Consoleに再度ログインする
コマンドを実行できるホスト
PFM - Managerホスト
実行権限
- Windowsの場合
-
Administrators権限を持つユーザー
- UNIXの場合
-
rootユーザー権限を持つユーザー
格納先ディレクトリ
- Windowsの場合
-
インストール先フォルダ\tools\
- UNIXの場合
-
/opt/jp1pc/tools/
引数
-nocheck
エージェント階層定義ファイルで指定したエージェントが,Performance Managementに認識されているかを確認しない場合に指定します。指定を省略した場合,認識されていないエージェントが検出されたときには処理が中断されます。
エージェントは,インストールやセットアップのあと,PFM - Managerに接続した時点で認識されます。エージェントが認識されているかは,[エージェント階層]画面の「Products」にあるかどうかで確認できます。
Performance Managementに認識されていないエージェントは,データモデルバージョンに3.0が仮定されます。実際のデータモデルバージョンは,エージェントの認識後に反映されます。
システムの構築時など,まだPerformance Managementに認識されていないエージェントをエージェント階層定義ファイルに指定している場合は,このオプションを指定してください。
-noquery
このオプションを指定すると,コマンドの実行を中断する問い合わせメッセージが出力されなくなり,ユーザーの応答が不要になります。非対話形式で実行したい場合に指定します。
エージェント階層定義ファイルで指定したユーザーが,すでにエージェント階層を作成している場合,そのエージェント階層は上書きされます。
なお,指定したユーザーのエージェント階層がある場合は,KAVE06073-Iメッセージが出力され,エージェント階層が更新されます。
-lhost 論理ホスト名
このコマンドを実行するホストの論理ホスト名を指定します。1〜32バイトの半角英数字で指定します。指定を省略した場合,物理ホストが仮定されます。
-f エージェント階層定義ファイル名
インポートするエージェント階層定義ファイルのファイル名を指定します。入力ファイルは,XML形式のファイルです。このファイルは,後述の「エージェント階層定義ファイルの形式」に基づいて作成します。絶対ファイルパス名,相対ファイルパス名,ファイル名が指定できます。絶対ファイルパス名以外の場合,カレントディレクトリを基点とします。
エージェント階層定義ファイルの形式
エージェント階層定義ファイルの記述例を次に示します。なお,このファイルのテンプレートファイルは,jpcconf agttree exportコマンドに-templateオプションを指定して実行することで生成できます。記述時のひな形として利用してください。
エージェント階層定義ファイル記述例
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE tree SYSTEM "agttree_param.dtd"> <tree owner="pfm-user"> <folder name="Test Company"> <folder name="Business Department"> <agent name="7A1inst_BD[tHOST_01@host_111]"/> </folder> <folder name="Development Department"> <agent name="7A1inst_DD[tHOST_02@host_111]"/> <agent name="7A1inst_DD[tHOST_03@host_111]"/> </folder> <agent name="TA1host_111"/> </folder> <agent name="TA1host_999"/> </tree>
この場合,次に示す構成でエージェント階層が作成されます。
ファイルの記述方式
エージェント階層定義ファイルの記述方式を次に示します。
-
階層数の上限は,8階層です。また,ルートまたはフォルダ内の各要素数の上限は,フォルダが64フォルダ,エージェントが128エージェントです。
-
空白だけの要素値または属性値については,省略と見なします。また,要素値,属性値の前後に指定した半角空白は,無視します。
-
印字文字以外の文字を要素または属性に指定するとエラーとなります。
-
ファイル内のDOCTYPE宣言は固定です。DOCTYPE宣言には,ファイルの記述を定義するDTDファイル名を必ず指定してください。このコマンドがサポートするDTDファイルは次のとおりです。
-
agttree_param.dtd
-
-
「<」などXML形式の書式制御文字を値に含める場合,XML仕様が定める記法に従って記述する必要があります。
例えば,「<」の場合は「<」,「>」の場合は「>」と記述します。
XMLタグ仕様
-
tree
種別
説明
意味
エージェント階層の最上位(ルート)ノードを表す要素。
指定可能値
なし
省略
不可
属性
owner
エージェント階層の設定を保持するユーザー名を指定する。省略できない。
1〜16バイトの半角英数字,半角空白文字,または次に示す記号を指定できる。ただし,英文字の大文字と小文字は区別されない。
! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
親要素
なし
子要素
folder(複数指定できる)
agent(複数指定できる)
-
folder
種別
説明
意味
エージェント階層のフォルダノードを表す要素。
指定可能値
なし
省略
可
属性
name
フォルダ名を指定する。省略できない。
1〜64文字の全角および半角文字を指定できる。
親要素
tree,folder
子要素
folder(複数指定できる)
agent(複数指定できる)
-
agent
種別
説明
意味
エージェント階層のエージェントノードを現す要素。
指定可能値
なし
省略
可
属性
name
エージェント名をサービスIDの形式で指定する。省略できない。1〜258バイトの長さで指定する。
プロダクトID部分にはPFM - AgentまたはPFM - RMのプロダクトIDを指定する。また,機能ID部分には「A」を指定する。
親要素
tree,folder
子要素
なし
注意事項
-
View Serverサービスが停止している場合,このコマンドは実行できません。
-
PFM - Managerが識別できないPFM - AgentまたはPFM - RMを,エージェント階層定義ファイルに指定した場合,-nocheckオプションの指定の有無に関わらずコマンドの処理は中断されます。この場合,指定したPFM - AgentまたはPFM - RMのプロダクトをPFM - Managerに登録する必要があります。手順については,マニュアル「JP1/Performance Management 設計・構築ガイド」の,インストールとセットアップについて説明している章を参照してください。
- 参考
-
PFM - Managerが識別できないPFM - AgentまたはPFM - RMとは,存在しないプロダクトIDを指定したエージェントのことを指します。そのため,「TA1hostA」がない環境で-nocheckオプションを指定した場合でも,プロダクトID「T」は誤りではないためエラーにはなりません。
-
エージェント階層定義ファイルにASCIIコード以外の文字を記述したい場合,記述文字コードはUTF-8,シフトJIS,またはEUC-JPのどれかにしてください。また,エージェント階層定義ファイル内のXML宣言部のencodingに,それぞれ「UTF-8」「Shift_JIS」「EUC-JP」のうちの1つを指定してください。なお,エージェント階層定義ファイルがASCIIコードだけで記述される場合,XML宣言部のencodingの値には「UTF-8」「Shift_JIS」「EUC-JP」のうちのどれかを指定してください。
次の表に,記述文字コードと指定できるencodingの値の関係を示します。
記述文字コード
encodingの値
UTF-8
Shift_JIS
EUC-JP
ASCII
○
○
○
UTF-8
○
×
×
シフトJIS
×
○
×
EUC-JP
×
×
○
- (凡例)
-
○:指定できる
×:指定できない
-
監視二重化の場合,セカンダリーのPFM - Managerからの実行はできません。
戻り値
0 |
正常終了した。 |
1 |
引数の指定に誤りがある。 |
2 |
コマンドの実行権限がない。 |
5 |
PFM - Baseホスト上でPFM - Managerホストだけで実行できるコマンドを実行しようとした。または,監視二重化の場合に,セカンダリーのPFM - Managerから実行しようとした。 |
6 |
定義ファイルの内容に誤りがある。 |
11 |
ユーザーによって処理が中止された(問い合わせに対して「N」を返した場合)。 |
100 |
Performance Managementの環境が不正である。 |
101 |
コマンドの実行に必要なサービスが起動していない。 |
102 |
指定された論理ホスト名がセットアップされていない。 |
200 |
メモリーが不足している。 |
210 |
ディスク容量が不足している。 |
211 |
ファイルまたはディレクトリにアクセスできない。 |
255 |
予期しないエラーが発生した。 |
使用例
エージェント階層の定義情報をView Serverサービスにインポートする例を次に示します。
# jpcconf agttree import -f agttree_def.xml