名称

      mxtool - Systems Insight Manager ツールの定義ファイル


構文

      mxtool


説明

      mxtool コマンドは、拡張マークアップ言語 (XML) 形式のツール定義の読み取
      りと書き込みをサポートしています。この機能を使用して、別々の Systems
      Insight Manager 環境間でツール定義を共有したり、Systems Insight
      Manager 環境にあるツール定義を変更したりできます。各ファイルには、1 つ
      または複数のツールの定義を記述できます。

      Systems Insight Manager ツールを複数のターゲット ノードで実行する場
      合、Systems Insight Manager 分散タスク ファシリティ (DTF) はツールを各
      ターゲット ノードで実行します。

    ツールの種類
      Systems Insight Manager ツールの基本的な 5 種類のツールは、単一システ
      ム対応 (SSA) ツール、マルチ システム対応 (MSA) ツール、Web 起動対応
      (WLA) ツール、自動化ツール、およびアプリケーション起動ツールです。

      SSA ツールはターゲット ノードで実行され、ターゲット ノード環境でのみ動
      作します。このため、SSA ツールを実行するとき、DTF はツール情報を各
      Systems Insight Manager エージェントに送信して SSA ツールを実行しま
      す。SSA ツールの例として、ls、cat、cp など一般的な UNIX コマンドをラッ
      プするツールがあります。

      MSA ツールは、中心となるノード (場合によっては中央管理サーバ) で実行さ
      れ、ターゲット ノードのリストを処理できます。MSA ツールの例として、
      HP-UX システム上の Ignite-UX の機能をラップするツールがあります。

      WLA ツールは、ほとんどの場合ブラウザで実行され、URL (Uniform Resource
      Locator) で指定されます。

      自動化ツールは、CMS 上で実行され、ターゲット ノードの検出などの処理を
      行います。

      アプリケーション起動ツールは、CMS 上で実行されます。このツールは、各
      ターゲット ノードにて 1 つのインスタンスが起動されます。

    文書型定義
      文書型定義 (DTD) ファイルは、XML ファイルの規則を定義したものです。こ
      の規則として、有効な要素タグ、属性、XML ファイル内の要素の出現回数があ
      ります。ツール DTD ファイルの名前は toollist.dtd であり、その内容を以
      下に示します。マンページの書式上、DTD の内容は実際のファイル内容と同じ
      には表示されないことに注意してください。

      <?xml version="1.0" encoding="UTF-8" ?>

      <!-- tool-list 要素には、ssa-command-tool 要素、msa-command-tool 要素、

	   web-launch-tool 要素、automation-tool 要素、または app-launch-tool
	   要素がゼロ個以上含まれている場合があります。-->
      <!ELEMENT tool-list ( ssa-command-tool |
			    msa-command-tool |
			    web-launch-tool  |
			    automation-tool  |
			    app-launch-tool )* >

      <!-- ssa-command-tool 要素では、単一システム対応ツールを指定します。
	   また、ssa-command-tool 要素では、category 要素、description 要素、
	   comment 要素、owner 要素、default-target 要素、execute-as-user
	   要素、job-display-handler 要素、toolbox-enabled 要素、ゼロ個以上の
	   toolbox 要素、ゼロ個以上の include-filter 要素、またはゼロ個以上の
	   env-variable 要素を、必要に応じて指定できます。(注記: role-enabled
	   要素と role 要素はお勧めできませんので、本製品では使用しないで
	   ください。これらは旧製品との互換性を確保するために存在しています。
	   代わりに、toolbox-enabled 要素と toolbox 要素を使用してください)。
	   これらの要素を複数指定する場合は、この定義に記載されている順序で要素
	   を記述してください。ssa-command-tool 要素には、ssa-block 要素が
	   含まれていなければなりません。また、オプション要素を指定する場合は、
	   上記のオプション要素の後に ssa-block 要素を記述する必要があります。
	   ssa-block 要素の後には、ゼロ個以上の attribute 要素を指定でき
	   ます。-->
      <!ELEMENT ssa-command-tool (category?, description?, comment?,
				  owner?, default-target?, execute-as-user?,
				  job-display-handler?,
				  toolbox-enabled?, toolbox*,
				  role-enabled?, role*,
				  include-filter*, env-variable*,
				  ssa-block, attribute* ) >

      <!-- 上記の要素のほかに、ssa-command-tool 要素では、以下の属性を指定
	   します。name 属性では、ツール名を指定します。この属性は
	   ssa-command-tool 要素内に指定する必要があります。visible 属性では、
	   実行中にツールを表示するかどうかを指定します。デフォルトでは、
	   ツールは表示されます。max-targets 属性では、ツールを実行するター
	   ゲットの最大数を指定します。revision 属性を使用すると、ツールの
	   作成者はツールのリビジョンを指定できます。これは単なる情報提供用
	   です。job-log 属性では、コマンドの結果をこのシステムのジョブ ログ
	   に保存するかどうかを指定します。この属性は、スケジュールされた
	   タスクとして実行されたときにのみツールに適用されます。「すぐに
	   実行」タスクとして実行されたときは適用されません。job-log
	   を "true" に設定すると、ジョブの完了後に、ジョブとツールのター
	   ゲットのステータスが、システムで定義されている期間 (比較的長い)、
	   データベースに保存されます。job-log を "false" に設定すると、完了
	   した最後のジョブのコピーと、タスクのターゲットのステータスが
	   キャッシュに短期間保存され、データベースには書き込まれません。
	   ジョブのログ機能はデフォルトでは有効になっています。schedulable
	   属性では、スケジュールされたタスクとしてツールを実行できるように
	   するかどうかを指定します。schedulable を "false" に設定すると、
	   ツールは「すぐに実行」タスクとしてのみ実行できます。デフォルト
	   では、ツールはスケジュールできるようになっています。guid 属性
	   では、グローバルに一意の識別子 (GUID) をツールに対して指定し
	   ます。ツールの GUID は追加操作中に生成されるため、このフィールド
	   は変更操作中にのみ指定してください。 accepts-targets 属性では、
	   ツールが実行するとき、ターゲットを使用するかどうかを指定します。
	   accepts-targets 属性のデフォルト値は、true です。 -->
      <!ATTLIST ssa-command-tool name	     CDATA   #REQUIRED
				 visible     (true | false) "true"
				 max-targets NMTOKEN #IMPLIED
				 revision    CDATA   #IMPLIED
				 job-log     (true | false) "true"
				 schedulable (true | false) "true"
				 guid	     NMTOKEN #IMPLIED
				 accepts-targets (true|false) "true" >

      <!-- ssa-block では、単一システム対応ツールに固有の要素を指定します。
	   ssa-block では、コマンド (command) かコピーブロック (copy-block)、
	   またはその両方を指定できます。コマンドは 1 つしか指定できません
	   が、コピーブロックは 16 個まで指定できます。コマンドまたは
	   コピーブロックの後には、それの引き数 (parameter) を指定
	   できます。 -->
      <!ELEMENT ssa-block (( command | copy-block )+, parameter*) >

      <!-- copy-block では、コピー元のファイルパス (source) とコピー先の
	   ファイルパス (destination) を指定します。 -->
      <!ELEMENT copy-block ( source, destination )+ >

      <!-- source 要素では、コピー元のファイル パスを指定します。 -->
      <!ELEMENT source (#PCDATA) >

      <!-- destination 要素では、コピー先のファイル パスを指定します。 -->
      <!ELEMENT destination (#PCDATA) >

      <!-- msa-command-tool 要素では、マルチ システム対応ツールを指定します。
	   msa-command-tool 要素では、必要に応じて、category 要素、description
	   要素、comment 要素、owner 要素、default-target 要素、execute-as-user
	   要素、job-display-handler 要素、toolbox-enabled 要素、ゼロ個以上の
	   toolbox 要素、ゼロ個以上の include-filter 要素、またはゼロ個以上の
	   env-variable 要素を指定できます。(注記: role-enabled 要素と
	   role 要素はお勧めできませんので、本製品では使用しないでください。
	   これらは、旧製品との互換性を確保するために存在しています。
	   代わりに、toolbox-enabled 要素と toolbox 要素を使用してください)。
	   これらの要素を複数指定する場合は、この定義に記載されている順序で
	   要素を記述してください。msa-command-tool 要素には、msa-block 要素が
	   含まれていなければなりません。オプション要素を指定する場合は、
	   上記のオプション要素の後に msa-block 要素を記述する必要があります。
	   msa-block 要素の後には、ゼロ個以上の attribute 要素を指定でき
	   ます。 -->
      <!ELEMENT msa-command-tool (category?, description?, comment?, owner?,
				  default-target?, execute-as-user?,
				  job-display-handler?,
				  toolbox-enabled?, toolbox*,
				  role-enabled?, role*,
				  include-filter*, env-variable*,
				  msa-block, attribute* ) >

      <!-- 上記の要素のほかに、msa-command-tool 要素では、以下の属性を指定し
	   ます。name 属性では、ツール名を指定します。この属性は、
	   msa-command-tool 要素内に指定する必要があります。visible 属性では、
	   実行中にツールを表示するかどうかを指定します。デフォルトでは、
	   ツールは表示されます。max-targets 属性では、ツールを実行するター
	   ゲットの最大数を指定します。revision 属性を使用すると、ツールの
	   作成者はツールのリビジョンを指定できます。これは単なる情報
	   提供用です。job-log 属性では、コマンドの結果をこのシステムの
	   ジョブ ログに保存するかどうかを指定します。job-log を "true" に
	   設定すると、ジョブの完了後に、ジョブとツールのターゲットのステー
	   タスが、システムで定義されている期間 (比較的長い)、データベース
	   に保存されます。job-log を "false" に設定すると、完了した最後の
	   ジョブのコピーと、ツールのターゲットのステータスがキャッシュに
	   短期間保存され、データベースには書き込まれません。ジョブのログ機能
	   はデフォルトでは有効になっています。schedulable 属性では、スケ
	   ジュールされたタスクとしてツールを実行できるようにするかどうかを
	   指定します。schedulable を "false" に設定すると、ツールは「すぐ
	   に実行」タスクとしてのみ実行できます。デフォルトでは、ツールはスケ
	   ジュールできるようになっています。guid 属性では、グローバルに一意
	   の識別子 (GUID) をツールに対して指定します。ツールの GUID は
	   追加操作中に生成されるため、このフィールドは変更操作中にのみ指定
	   してください。 accepts-targets 属性では、ツールが実行するとき、
	   ターゲットを使用するかどうかを指定します。accepts-targets 属性
	   のデフォルト値は、true です。 -->
      <!ATTLIST msa-command-tool name	     CDATA   #REQUIRED
				 visible     (true | false) "true"
				 max-targets NMTOKEN #IMPLIED
				 revision    CDATA   #IMPLIED
				 job-log     (true | false) "true"
				 schedulable (true | false) "true"
				 guid	     NMTOKEN #IMPLIED
				 accepts-targets (true|false) "true" >

      <!-- msa-block では、マルチ システム対応 (MSA) ツールに固有の要素を
	   指定します。msa-block では MSA コマンド (command)、コマンドの
	   引き数 (parameter)、コマンドが実行される
	   実行ノード (execution-node) を指定できます。 -->
      <!ELEMENT msa-block ( command, parameter*, execution-node ) >

      <!-- command 要素では、SSA ツールまたは MSA ツールのコマンドを指定
	   します。コマンドに引き数を指定する場合は、パラメータ文字列
	   として指定してください。 -->
      <!ELEMENT command ( #PCDATA ) >

      <!-- command 要素には、2 つの属性を指定できます。command-type 属性
	   では、コマンドの種類を x-window、stdout、restart、launch、
	   unknown の中から指定します。デフォルトのコマンド
	   タイプは、stdout です。log 属性では、コマンドの結果をこのシス
	   テムの監査ログに出力するかどうかを指定します。log を "true" に
	   設定すると、コマンドの標準出力 (stdout) と標準エラー (stderr)
	   の結果がシステムの監査ログに出力されます。デフォルトでは記録
	   されません。 -->
      <!ATTLIST command command-type (x-window |
				      stdout   |
				      restart  |
				      launch   |
				      unknown) "stdout"
			log (true | false) "false" >

      <!-- execution-node 要素では、MSA ツールを実行するノードを
	   指定します。 -->
      <!ELEMENT execution-node ( #PCDATA ) >

      <!-- web-launch-tool 要素では、Web 起動ツールを指定します。
	   web-launch-tool 要素では、必要に応じて、category 要素、
	   description 要素、comment 要素、owner 要素、default-target 要素、
	   execute-as-user 要素、job-display-handler 要素、
	   toolbox-enabled 要素、ゼロ個以上の toolbox 要素、ゼロ個以上の
	   include-filter 要素、またはゼロ個以上の env-variable 要素を指定
	   できます。(注記: role-enabled 要素と role 要素はお勧めできません
	   ので、本製品では使用しないでください。これらの要素は、旧製品との
	   互換性を確保するために存在しています。代わりに、toolbox-enabled 要素
	   と toolbox 要素を使用してください)。これらの要素を複数指定する
	   場合は、この定義に記載されている順序で要素を記述してください。
	   web-launch-tool 要素には、web-block 要素が含まれていなければ
	   なりません。オプション要素を指定する場合は、上記のオプション要素
	   の後に web-block 要素を記述する必要があります。web-block 要素の
	   後には、ゼロ個以上の attribute 要素を指定できます。-->
      <!ELEMENT web-launch-tool (category?, description?, comment?, owner?,
				 default-target?, execute-as-user?,
				 job-display-handler?,
				 toolbox-enabled?, toolbox*,
				 role-enabled?, role*,
				 include-filter*, web-block, attribute* ) >

      <!-- 上記の要素のほかに、web-launch-tool 要素では、以下の属性を指定
	   します。name 属性では、ツール名を指定します。この属性は、
	   web-launch-tool 要素内に指定する必要があります。visible 属性では、
	   実行中にツールを表示するかどうかを指定します。デフォルトでは、
	   ツールは表示されます。max-targets 属性では、ツールを実行するター
	   ゲットの最大数を指定します。revision 属性を使用すると、ツールの
	   作成者はツールのリビジョンを指定できます。これは単なる情報提供
	   用です。job-log 属性では、コマンドの結果をこのシステムのジョブ
	   ログに保存するかどうかを指定します。job-log を "true" に設定
	   すると、ジョブの完了後に、ジョブとツールのターゲットのステータス
	   が、システムで定義されている期間 (比較的長い)、データベースに
	   保存されます。job-log を "false" に設定すると、完了した最後の
	   ジョブのコピーと、ツールのターゲットのステータスがキャッシュに
	   短期間保存され、データベースには書き込まれません。ジョブの
	   ログ機能はデフォルトでは有効になっています。schedulable 属性
	   では、スケジュールされたタスクとしてツールを実行できるようにする
	   かどうかを指定します。schedulable を "false" に設定すると、
	   ツールは「すぐに実行」タスクとしてのみ実行できます。デフォルト
	   では、ツールはスケジュールできるようになっています。guid 属性
	   では、グローバルに一意の識別子 (GUID) をツールに対して指定し
	   ます。ツールの GUID は追加操作中に生成されるため、このフィー
	   ルドは変更操作中にのみ指定してください。 -->
      <!ATTLIST web-launch-tool name	    CDATA #REQUIRED
				visible	    (true | false) "true"
				max-targets NMTOKEN #IMPLIED
				revision    NMTOKEN #IMPLIED
				job-log	    (true | false) "true"
				schedulable (true | false) "true"
				guid	    NMTOKEN #IMPLIED >

      <!-- web-block では、Web 起動ツールに固有の要素を指定します。
	   web-block では main-url 要素を指定してください。必要に応じて、
	   side-url 要素、status-url 要素、および current-url 要素を指定
	   できます。さらに、web-block では URL 用のパラメータ (parameter)
	   を指定できます。最後に、必要に応じて web-block でターゲット形式
	   を指定することによって、ターゲット形式 (target-format) を Web
	   起動対応ツールに渡す方法を記述することもできます。 -->
      <!ELEMENT web-block (main-url, (side-url?, status-url?, current-url?),
			   parameter*, target-format? ) >

      <!-- 上記の要素のほかに、web-block 要素には 1 つの属性があります。
	   accepts-targets 属性では、Web 起動ツールを実行するとき
	   ターゲットを使用するかどうかを指定します。デフォルトでは、
	   accepts-targets 属性は true です。 -->
      <!ATTLIST web-block accepts-targets (true|false) "true">

      <!-- main-url では、ツールを起動する URL を指定します。URL に引き数
	   を指定できる場合は、URL はパラメータ文字列として指定して
	   ください。 -->
      <!ELEMENT main-url ( #PCDATA ) >

      <!-- status-url では、この Web 起動ツールのステータスを実行中に表示
	   することができる URL を指定します。 -->
      <!ELEMENT status-url ( #PCDATA ) >

      <!-- current-url では、現在の URL を指定します。 -->
      <!ELEMENT current-url ( #PCDATA ) >

      <!-- side-url では、除外する URL を指定します。 -->
      <!ELEMENT side-url ( #PCDATA ) >

      <!-- target-format では、Web 起動ツールのターゲットの形式を定義し
	   ます。パラメータ文字列として指定してください。 -->
      <!ELEMENT target-format ( #PCDATA ) >

      <!-- 自動化ツールは、ターゲット ノードへのアクセスなどの処理を CMS
	   上で行います。automation-tool 要素では、必要に応じて、
	   category 要素、menu-category 要素、description 要素、
	   comment 要素、owner 要素、default-target 要素、
	   execute-as-user 要素、job-display-handler 要素、
	   default-parameter 要素、role-enabled 要素、ゼロ個以上の
	   role 要素、ゼロ個以上の include-filter 要素、またはゼロ個以上
	   の env-variable 要素を指定できます。これらの要素を複数指定する
	   場合は、この定義に記載されている順序で要素を記述してください。
	   automation-tool 要素には、automation-block 要素が含まれて
	   いなければなりません。また、オプション要素を指定する場合は、
	   上記のオプション要素の後に automation-block 要素を記述する
	   必要があります。automation-block 要素の後には、ゼロ個以上の
	   attribute 要素を指定できます。 -->
      <!ELEMENT automation-tool (category?, description?, comment?, owner?,
				 default-target?, execute-as-user?,
				 job-display-handler?,
				 toolbox-enabled?, toolbox*,
				 role-enabled?, role*,
				 include-filter*, automation-block,
				 attribute* ) >

      <!-- 上記の要素のほかに、automation-tool 要素では、以下の属性を指定
	   します。name 属性では、ツール名を指定します。この属性は、
	   automation-tool 要素内に指定する必要があります。visible 属性
	   では、実行中にツールを表示するかどうかを指定します。デフォルト
	   では、ツールは表示されます。max-targets 属性では、ツールを実行
	   するターゲットの最大数を指定します。revision 属性を使用すると、
	   ツールの作成者はツールのリビジョンを指定できます。これは単なる
	   情報提供用です。job-log 属性では、コマンドの結果をこのシステム
	   のジョブ ログに保存するかどうかを指定します。job-log を "true"
	   に設定すると、ジョブの完了後に、ジョブとツールのターゲットの
	   ステータスが、システムで定義されている期間 (比較的長い)、
	   データベースに保存されます。job-log を "false" に設定すると、
	   完了した最後のジョブのコピーと、ツールのターゲットのステータス
	   がキャッシュに短期間保存され、データベースには書き込まれません。
	   ジョブのログ機能はデフォルトでは有効になっています。
	   schedulable 属性では、スケジュールされたタスクとしてツールを
	   実行できるようにするかどうかを指定します。schedulable
	   を "false" に設定すると、ツールは「すぐに実行」タスクとして
	   のみ実行できます。デフォルトでは、ツールはスケジュールできる
	   ようになっています。guid 属性では、グローバルに一意の
	   識別子 (GUID) をツールに対して指定します。ツールの GUID は
	   追加操作中に生成されるため、このフィールドは変更操作中にのみ
	   指定してください。 accepts-targets 属性では、ツールが実行する
	   とき、ターゲットを使用するかどうかを指定します。accepts-targets
	   属性のデフォルト値は、true です。-->
      <!ATTLIST automation-tool	 name	     CDATA   #REQUIRED
				 visible     (true | false) "true"
				 max-targets NMTOKEN #IMPLIED
				 revision    CDATA   #IMPLIED
				 job-log     (true | false) "true"
				 schedulable (true | false) "true"
				 guid	     NMTOKEN #IMPLIED
				 accepts-targets (true|false) "true" >

      <!-- automation-block では、自動化ツールに固有の要素を指定します。
	   automation-block では、message-id を指定する必要があります。 -->
      <!ELEMENT automation-block (message-id) >

      <!-- message-id は、ツールを実行する Automation エンジンによって
	   送信されるメッセージの内部文字列表現です。 -->
      <!ELEMENT message-id ( #PCDATA ) >

      <!-- app-launch-tool 要素では、アプリケーション起動ツールを指定
	   します。app-launch-tool 要素では、必要に応じて、category 要素、
	   menu-category 要素、description 要素、comment 要素、
	   owner 要素、default-target 要素、execute-as-user 要素、
	   job-display-handler 要素、default-parameter 要素、
	   role-enabled 要素、ゼロ個以上の role 要素、ゼロ個以上の
	   include-filter 要素、またはゼロ個以上の env-variable 要素を
	   指定できます。これらの要素を複数指定する場合は、この定義に
	   記載されている順序で要素を記述してください。
	   app-launch-tool 要素には、app-launch-block 要素が含まれて
	   いなければなりません。また、オプション要素を指定する場合は、
	   上記のオプション要素の後に app-launch-block 要素を記述する
	   必要があります。app-launch-block 要素の後には、ゼロ個以上の
	   attribute 要素を指定できます。 -->
      <!ELEMENT app-launch-tool (category?, description?, comment?, owner?,
				 default-target?, execute-as-user?,
				 job-display-handler?,
				 role-enabled?, role*,
				 toolbox-enabled?, toolbox*,
				 include-filter*,  env-variable*,
				 app-launch-block, attribute* ) >

      <!-- 上記の要素のほかに、app-launch-tool 要素では、以下の属性を指定
	   します。name 属性では、ツール名を指定します。この属性は、
	   app-launch-tool 要素内に指定する必要があります。visible 属性
	   では、実行中にツールを表示するかどうかを指定します。
	   デフォルトでは、ツールは表示されます。max-targets 属性では、
	   ツールを実行するターゲットの最大数を指定します。revision 属性を
	   使用すると、ツールの作成者はツールのリビジョンを指定できます。
	   これは単なる情報提供用です。job-log 属性では、コマンドの結果を
	   このシステムのジョブ ログに保存するかどうかを指定します。
	   job-log を "true" に設定すると、ジョブの完了後に、ジョブと
	   ツールのターゲットのステータスが、システムで定義されている
	   期間 (比較的長い)、データベースに保存されます。job-log
	   を "false" に設定すると、完了した最後のジョブのコピーと、
	   タスクのターゲットのステータスがキャッシュに短期間保存され、
	   データベースには書き込まれません。ジョブのログ機能はデフォルト
	   では有効になっています。schedulable 属性では、スケジュール
	   されたタスクとしてツールを実行できるようにするかどうかを指定
	   します。schedulable を "false" に設定すると、ツールは「すぐに
	   実行」タスクとしてのみ実行できます。デフォルトでは、ツールは
	   スケジュールできるようになっています。guid 属性では、グローバル
	   に一意の識別子 (GUID) をツールに対して指定します。ツールの
	   GUID は追加操作中に生成されるため、このフィールドは変更操作中
	   にのみ指定してください。 accepts-targets 属性では、ツールが実行
	   するとき、ターゲットを使用するかどうかを指定します。accepts-targets
	   属性のデフォルト値は、true です。-->
      <!ATTLIST app-launch-tool	 name	     CDATA   #REQUIRED
				 visible     (true | false) "true"
				 max-targets NMTOKEN #IMPLIED
				 revision    CDATA   #IMPLIED
				 job-log     (true | false) "true"
				 schedulable (true | false) "true"
				 guid	     NMTOKEN #IMPLIED
				 accepts-targets (true|false) "true" >

      <!-- app-launch-block では、アプリケーション起動ツールに固有の要素を
	   指定します。app-launch-block では、必要な command 要素を指定
	   します。 -->
      <!ELEMENT app-launch-block (command, app-parameters?) >

      <!-- 上記の要素のほかに、app-launch-block 要素では、以下の属性を指定
	   します。alert-driven 属性では、ツールを実行するターゲット ノード
	   を判定するために警告リストまたはノード リストを使用するかどうか
	   を指定します。 -->
      <!ATTLIST app-launch-block alert-driven (true | false) "false" >

      <!-- app-parameters 要素は、アプリケーションのパラメータ定義文字列で、
	   値に文字列を指定します。 -->
      <!ELEMENT app-parameters ( #PCDATA ) >

      <!-- env-variable 要素は、環境変数定義文字列で、値に文字列を指定
	   します。 -->
      <!ELEMENT env-variable ( #PCDATA ) >

      <!-- 上記の要素のほかに、env-variable 要素では、以下の属性を指定
	   します。name 属性では、環境変数の名前を指定します。 -->
      <!ATTLIST env-variable name CDATA #REQUIRED >

      <!-- owner 要素では、ツールの所有者を指定します。所有者フィールド
	   を指定すると、ツールは[すべてのツール]ツールボックスにのみ
	   関連付けられます。
	   所有者フィールドを指定しないと、ツールは関連付けられたすべての
	   役割で有効です。制限付き権限を持つユーザがツールを追加または
	   変更すると、そのユーザの名前が所有者フィールドに格納されます。
	   所有者を指定しないでツールを追加または変更できるのは完全な
	   権限を持つユーザ (フル) だけです。 -->
      <!ELEMENT owner ( #PCDATA ) >

      <!-- コメント フィールドでは、ツールの追加情報を指定します。ほと
	   んどの場合、description 要素よりも詳細に指定します。 -->
      <!ELEMENT comment ( #PCDATA ) >

      <!-- parameter 要素では、ツールの 1 番目から 10 番目の引き数を
	   指定します。 -->
      <!ELEMENT parameter EMPTY >

      <!-- parameter 要素には、3 つの属性があります。index 属性では、この
	   引き数をパラメータ文字列のどの引き数に対応させるかを指定
	   します。引き数には、1 〜 10 の索引を付けることができ、
	   デフォルトの索引は 1 です。ツールには、索引が重複した引き
	   数を含めることはできません。ツール定義の複数の引き数
	   に同じ索引がある場合は、ツールに最初に追加された、重複する
	   索引を持つ引き数だけがツール内に残ります。prompt 属性では、
	   引き数についての参考情報を記述し、これは参考として GUI
	   に表示されます。required 属性では、ツールを実行するときに
	   この引き数を指定する必要があるかどうかを指定します。
	   デフォルトでは、引き数は必要ではありません。
	   private属性は、このパラメータがコード化され、セキュアに
	   保存されているかを指定します。
	   デフォルトでは、引き数はプライベートではありません。
		 -->
      <!ATTLIST parameter index	 (1|2|3|4|5|6|7|8|9|10) "1"
			  prompt CDATA #REQUIRED
			  required (true|false) "false"
			  private (true|false) "false" >

      <!-- toolbox-enabled 要素では、ツールに関連付けられたツールボックス
	   を有効にするかどうかを指定します。 -->
      <!ELEMENT toolbox-enabled EMPTY >

      <!-- toolbox-enabled 要素には、属性が 1 つあります。value 属性
	   では、ツールボックス中のツールを有効にするかどうかを指定します。
	   このため、ツールは[すべてのツール]ツールボックスで常に有効
	   になりますが、完全な権限を持つユーザ (フル) はツールボックスの
	   ツールを明示的に無効にすることができます。
	   デフォルトでは、このツールはそれがあるすべてのツールボックスで
	   有効にされます。
	   ツールがツールボックスで無効の場合は、実行することができません。 -->
      <!ATTLIST toolbox-enabled value (true|false) "true">

      <!-- role-enabled 要素では、ツールに関連付けられたロールを有効に
	   するかどうかを指定します。これは、廃止された要素です。
	   代わりに、toolbox-enabled 要素を使用してください。
	   -->
      <!ELEMENT role-enabled EMPTY >

      <!-- toolbox-enabled 要素の属性の説明を参照してください。 -->
      <!ATTLIST role-enabled value (true|false) "true">

      <!-- default-target 要素では、実行時にターゲットが指定されていない
	   場合にツールを実行するターゲットを指定します。ノードを指定する
	   か、CMS 上でデフォルトで実行されるように CMS と指定するか、
	   権限が付与されたすべてのノードでデフォルトで実行されるよう
	   に ALL と指定します。 -->
      <!ELEMENT default-target ( #PCDATA ) >

      <!-- category 要素では、ツールを関連付けるカテゴリを指定します。
	   デフォルトでは、ツールは "Local Tools" カテゴリに関連付け
	   られています。-->
      <!ELEMENT category ( #PCDATA ) >

      <!-- description 要素では、ツールの簡単な説明を指定します。ツールの
	   実行方法など詳細な情報を指定するには、comment 要素を使用しま
	   す。 -->
      <!ELEMENT description ( #PCDATA ) >

      <!-- SSA コマンドツールと MSA コマンドツールの場合、
	   execute-as-user 要素ではターゲット ノードでツールを実行する
	   ユーザ名またはターゲット ノードでツールを実行するアカウントを
	   指定します。Web 起動ツールの場合は、execute-as-user は URL
	   に渡されて使用されます。 -->
      <!ELEMENT execute-as-user ( #PCDATA ) >

      <!-- job-display-handler 要素では、JobDisplayHander インタフェース
	   を実装するクラスの完全修飾名を指定します。このインタフェース
	   は、このツールを実行して生成されたジョブの結果を表示するために
	   使用されます。 -->
      <!ELEMENT job-display-handler ( #PCDATA ) >

      <!-- toolbox 要素では、ツールに関連付けるツールボックスを指定
	   します。ツールを実行するには、指定されているツールボックスの
	   いずれかで権限がユーザに与えられている必要があります。 -->
      <!ELEMENT toolbox EMPTY >

      <!-- toolbox 要素には、ツールボックス名を指定する属性が 1 つあり
	   ます。 -->
      <!ATTLIST toolbox toolbox-name CDATA #REQUIRED >

      <!-- role 要素では、ツールに関連付けるロールを指定します。ツールを
	   実行するには、指定されているロールのいずれかの権限がユーザに
	   与えられている必要があります。この要素は廃止されています。
	   代わりに、toolbox 要素を使用してください。 -->
      <!ELEMENT role EMPTY >

      <!-- toolbox 要素の属性の説明を参照してください。 -->
      <!ATTLIST role role-name CDATA #REQUIRED >

      <!-- include-filter 要素では、ツール実行時にフィルタを適用

	   するノード属性を指定します。指定する include-filter 要素には、
	   1 つ以上の node-filter 要素が含まれている必要があります。
	   ツールにフィルタを適用するときは、各 include-filter ブロック
	   が論理和 (OR) で 1 つにまとめられ、それが最終的にフィルタとして
	   使用されます。include-filter ブロック内の各 node-filter 要素
	   は論理積 (AND) で 1 つにまとめられます。 -->
      <!ELEMENT include-filter (node-filter)+ >

      <!-- include-filter 要素には、属性が 1 つあります。type 属性では、
	   実行するインクルード フィルタのタイプを指定します。現時点では
	   4 つのタイプが認識されます。そのうち3つはos(オペレーティング
	   システム)、hardware、および protocolのフィルタ処理です。
	   4つ目のタイプは、他のすべてのノード属性のフィルタを許可する
	   otherと呼ばれます。	 -->
      <!ATTLIST include-filter type (os | hardware | protocol | other) "os" >

      <!-- node-filter 要素は空の要素です。この要素には、ツール実行時
	   にフィルタを適用するノード属性を指定するために使用
	   される属性があります。 -->
      <!ELEMENT node-filter EMPTY >

      <!-- node-filter 要素は、3 つの属性を使用して指定します。name 属性
	   では、フィルタを適用するノード属性の名前を指定します。
	   operator 属性では、等しい値、それ未満の値、それ以上の値、指定値
	   等しくない値、または指定値以外のどれでフィルタを適用するかを指定
	   します。演算子 (operator) の名前は、大文字と小文字が区別されません。
	   value 属性では、フィルタの適用に使用するノード属性の値を指定します。
	    -->
      <!ATTLIST node-filter name CDATA #REQUIRED
			    operator (EQ | GE | LT | CT | NEQ | NCT |
				      eq | ge | lt | ct | neq | nct |
				      Eq | Ge | Lt | Ct | Neq | Nct |
				      eQ | gE | lT | cT | nEQ | nCT ) "EQ"
			    value CDATA #REQUIRED >

      <!-- attribute 要素では、クライアント属性を構成する、名前と値との
	   組み合わせを指定します。クライアント属性の名前は name 属性を
	   使用して指定し、クライアント属性の値はその要素の PCDATA として
	   指定します。 -->
      <!ELEMENT attribute ( #PCDATA ) >
      <!ATTLIST attribute name CDATA #REQUIRED >

    リビジョン属性
      リビジョン属性は、バージョン番号として解釈可能な値があります。バージョ
      ン番号は、ピリオドによって分離された負ではない10進のシリーズ番号です。
      バージョン番号を比較する場合、以下のルールが使用されます:

	 シリーズ中の左端の数が最も重要で、
	      "1.0" は、"0.1" より大きいです。

	 数字の最初のゼロは、無視され、
	      "003" は、"3" と同じです。


	 2つの隣接する間のピリオドは、ゼロとして解釈され、
	      "1.0.3" は、"1..3" と同じです。

	 開始がピリオドの場合は、ゼロをたいして解釈され、
	      ".9" は、"0.9" と同じです。

	 ピリオドの間のゼロは、無視され、
	      "1.0.0" は、"1" と同じです。

    XML ヘッダー行
      ツール XML ファイルの最初の行は、次のように記述しなければなりません。

      <?xml version="1.0" encoding="encoding-value" ?>

      encoding-value パラメータは、有効なエンコード値に置き換えます。有効な
      エンコード値は、次の Web サイトにあります。

      http://www.iana.org/assignments/character-sets

      XML ヘッダー行が指定されていない場合は、システムのデフォルトのエンコー
      ドは "UTF-8" になります。

    パラメータ文字列
      ツールを正しく作成するため、ツールの開発者は URL とコマンド ラインの形
      式を理解しておく必要があります。Web 起動ツールのさまざまなビュー URL
      属性およびターゲット フォーマットと、コマンド ライン ツールのコマンド
      ライン属性は、いずれもパラメータ文字列です。

      パラメータ文字列は、置換フィールドを含む文字列であり、標準 C ライブラ
      リの一般的な printf() 関数で使用されるフォーマット文字列に似ています。
      これらのフィールドは、実行時にユーザが (ツールのパラメータの属性での定
      義に従って) 入力した値、Task Controller によって指定されたいくつかの標
      準のタスク プロパティ、選択したターゲット ノードまたはノード グループ
      に関する値、またはグローバル ツール プロパティ ファイルから取り出され
      たプロパティ値に置き換えることができます。このため、きわめて詳細な URL
      またはコマンド ラインを生成できます。

    パラメータ文字列の置換表
      以下のパラメータは、グローバル属性の値の代入に使用されます。

      引き数の説明
	  %t	実行されるタスクのタスク ID。
	  %u	このツールを実行するユーザ名。
	  %e	このツールを実行に使用するユーザ アカウント。
	  %s	ツールを実行するコア CMS の管理サーバのホスト名。
		Web起動対応ツールの特別な処理のための例を参照してください。
	  %#	(# は正の整数)。リストの索引位置 (1 で始まります。%1、%2、
		%3 など) と見なされ、指定された数 (#) が指すパラメータに、
		ユーザによる入力値が代入されます。
	  %y	SOAP のログオン トークン。SOAP のシングル サインオン Web
		アプリケーションとともに使用されます。

      以下の引き数は、選択されている現在のターゲットの代入に使用されます。

      引き数の説明
	  %f	ターゲット ノード ("%x" 切り替えが文字列内にあった場合は
		ノード グループ) のデータベース名。
	  %n	ネットワーク名 (ホスト名、IP アドレス、IPX アドレス、または
		ノード名。この順序どおりに)。
	  %a	ネットワーク アドレス (IP アドレス、または IPX アドレス。
		この順序どおりに)。
	  %l	Node Link Configuration 設定で指定された形式 (名前、IP
		アドレス、完全な DNS 名) のリンク名。
	  %p	このターゲットの WBEM プロキシ (存在する場合) の IP アドレス。
		形式は <ip address>:<port#> です。
	  %g	ターゲット ノード ("%x" 切り替えが文字列内にあった場合はノード
		グループ) のデータベース GUID。
	  %b	ターゲット ノードのデバイス タイプ。
	  %c	ターゲット ノードのデバイス サブタイプ。
      %r%{rt[.attribute]%}
	  	パラメータ "rt" で指定されている関連タイプがあるノードに置き換えます。
	  	有効な関連タイプ文字列は、device_associations テーブルの 
	  	associationTypeNumber の桁に記憶されます。
		[.attribute]が指定された場合、1つのノードの名前付き属性がネットワーク名
		(.a) のように共通の属性を関連した nodeIn addition に戻されます。例えば、
		連絡先に %r{MgmtProcToServer.Contact%} を使用するには、プロセッサの
		IP アドレスに %r{MgmtProcToServer.a%} を使用して、サーバの管理をします。
		関連するノードの属性が各ノードのために省略される場合、ネットワーク名と
		IP アドレスは、基に戻ります。ネットワーク名と IP アドレスは、1つ以上の
		ノードが返される場合、コンマで区切られ、"network name|IP address" から
		返されます。注意として、関連タイプの "MgmtProcToServer" は、全ての管理
		プロセッサに関連するノードの情報を返すことが可能です。
      %{attribute%}
		ターゲット ノードの名前付きの属性の値。

      以下の引き数は、選択されている複数のターゲット ノードをサポート
      するための反復処理に使用されます。

      引き数の説明
       %( ... %)	 繰り返しパターン (現在の選択対象が存在する場合にのみ繰り
		 返されます)。現在のターゲットの選択対象が存在しない場合は、
		 区切り文字間のテキストが展開時に削除されます。これにより、
		 このテキストをオプションとしターゲットの選択リストを優先する
		 ことができます。
	  %i	 選択対象の索引 (1 から始まります)。
	  %z	 何も代入しませんが、選択対象の索引を次の整数に増加し、参照先
		 ターゲット ノードを、選択されたターゲット リスト内の次のター
		 ゲットにします。
       %< ... %>	 暗号化されたテキスト (ほかのすべてのパラメータが代入されてから
		 暗号化されます)。
	  %%	 コマンドまたは URL の % が代入されないようにすることができ
		 ます。

    パラメータ文字列の例
      Web 起動対応ツールの URL 文字列は、"http://" または "https://" で始ま
      る絶対 URL で指定する必要があります。以下に例を示します。

	  https://%n:1188/kcweb/
	  https://%l:2381/

      常に管理サーバで実行される Web 起動対応ツールは、"/" で始まる相対 URL
      で指定する必要があります。以下に例を示します。

	  /propertypages/Identify.jsp?device=%n
      %sパラメータを使用しているWeb起動対応ツールでは、ブラウザで指定したCMS
      ホスト名に置き換わります。


	  https://%s:2381/pmp/AdminHome.htm

      複数の選択内容を URL に代入することができます。選択対象の索引は、「現
      在」の選択対象を追跡するため、置換処理中に使用されます。選択対象の索引
      は、まず 1 に設定され、"%z" パラメータが URL 内で検出されるまで、選択
      されたターゲット ノード リストの最初の選択対象が現在の選択対象となりま
      す (後述する反復ブロックでは例外があります)。すると次の選択対象が現在
      の選択対象となり、選択対象の索引は 1 で増加されます (以後このことが繰
      り返されます)。以下に例を示します。

	  http://server/app/doit.jsp?name=%n%z&addr=%a

      この例では、選択された 1 番目のノードのネットワーク名が "name" パラ
      メータに割り当てられ、選択された 2 番目のターゲットの IP アドレスが
      "addr" パラメータに割り当てられてから、"doit.jsp" ページが呼び出されま
      す。

      選択された任意の個数のターゲットを、反復ブロック構造である "%( ... %)"
      を使用して代入できます。反復ブロックの区切り文字で囲まれた部分は、現在
      の選択対象および選択対象の索引で始まり、選択リストの最後に達するまで繰
      り返されます。以下に例を示します。

	  https://%[deploy.server%]/deploy/deployimage.jsp?device1=%n%z%(&device%i=%n%z%)

      "%i" パラメータが使用されていることに注意してください。代入処理中に、
      このパラメータは現在の選択対象の索引 (1、2、3 など) に置き換わります。

      注記: 反復句の末尾に達しても "%z" パラメータが検出されない場合は、代入
      段階での無限ループを回避するため、選択対象の索引と現在の選択対象は自動
      的に増加されます。

      上記の例で、選択されたターゲット ノードが 2 つある場合は、展開される
      URL 文字列は以下のようになります。

	  https://deploy.hp.com:280/deploy/deployimage.jsp?device1=nodea.hp.com&device2=nodeb.hp.com


      上記の例で、選択されたターゲット ノードが 1 つしかない場合は、展開され
      る URL は以下のようになります。

	  https://deploy.hp.com:280/deploy/deployimage.jsp?device1=nodea.hp.com


      反復ブロックに達しても、現在の選択対象がないため、置換処理中には反復ブ
      ロック全体が処理されません。

    ツールのフィルタ処理
      ツールのフィルタ処理は、1 つまたは複数のノードが選択されているときに
      [ツール] メニューにツールを表示するかどうかをツールの作成者が設定でき
      る機能です。ほとんどのツールはプラットフォームに依存しており、ツールが
      正常に実行されるかどうかは、一部のプラットフォームにしかないコマンドに
      左右されます。たとえば、"bdf" ツールには "bdf" コマンドが必要ですが、
      このコマンドは HP-UX プラットフォームにあり Linux プラットフォームには
      ありません。ツールが [ツール] メニューに表示されるのは、実行する必要が
      あるコマンドが、選択されているすべてのノードで使用できる場合だけでなけ
      ればなりません。そうするには、そのツールが実行されうるすべてのノードが
      所有していなければならないノード属性を、そのツールがノード フィルタ式
      で指定します。

      1 つのツールを実行するのに必要なノード属性は、以下の形式のノード フィ
      ルタの式で指定されます。

      <node-filter name="attribute-name" operator="eq" value="attribute-value" />
      または
      <node-filter name="attribute-name" operator="ge" value="attribute-value" />
      または
      <node-filter name="attribute-name" operator="lt" value="attribute-value" />
      または
      <node-filter name="attribute-name" operator="ct" value="attribute-value" />
      または
      <node-filter name="attribute-name" operator="neq" value="attribute-value" />
      または
      <node-filter name="attribute-name" operator="nct" value="attribute-value" />

      "eq" 演算子は、ツールを実行できるノードの属性値が、指定された属性値と
      まったく同じであることを意味します。この演算子は、ノード フィルタ式で
      使用できるどの属性名にも適用されます。 "ge" 演算子は、ツールを実行でき
      るノードが、指定された属性値かそれ以上を持っていることを意味します。
      "lt" 演算子は、ツールを実行できるノードの値が、指定された値よりも小さ
      いことを意味します。「より大きいか等しい」または「より小さい」という関
      係は、数値属性においてのみ意味を持ちます。 "ct" 演算子は、ツールが実行
      可能なノードを指定します。ノードには、指定した値を含む属性が必要です。
      "neq"演算子は、ツールを実行できるノードの属性値が、指定された属性値と
      まったく違うことを意味します。この演算子は、ノード フィルタ式で使用で
      きるどの属性名にも適用されます。 "nct"演算子は、ツールが実行可能なノー
      ドを指定します。ノードには、指定した値を含まない属性が必要です。ノード
      の場合、フィルタ式に指定可能な数値属性は、OSRevision 属性と
      ProtocolSupport 属性であり、その値はバージョン番号です。バージョン番号
      に使用できる値と、その比較方法は、後述の「バージョン番号」で説明しま
      す。attribute-name は、後に示す表に記載されている値のいずれかである
      か、ノードの ProtocolSupport 属性からのプロトコル名です。 attribute-
      value は、attribute-name がとりうるノード属性値のいずれかです。

      属性値は、Distributed Management Task Force (DMTF) の Common
      Information Model (CIM) に基づいています。通常、これらの値は、ノード識
      別プロセスの間に定義され、WBEM と SNMP を使用してノード属性を特定しま
      す。本リリースでは、OSName の有効な値は "HPUX" および "LINUX" です。
      OSName の値が "HPUX" である場合、OSRelease の属性値では先頭のアルファ
      ベットの部分が削除されます (たとえば B.11.11 は 11.11 として格納されま
      す)。

      ノード フィルタ式は、インクルード フィルタ式の一部として使用されます。
      インクルード フィルタ式は 3 種類あり、それぞれ異なるカテゴリの属性名で
      フィルタ処理できます。

      カテゴリ                   フィルタのタイプ  許容される属性名
      オペレーティング システム  os                OSName、OSVendor、
                                                   OSRevision
      ハードウェア               hardware          DeviceType、DeviceSubType、
                                                   Model
      プロトコル サポート        protocol          任意のプロトコル名
      その他                     other             事前に定義されたシステム
                                                   属性については、mxnode(1M)
                                                   またはmxnode(4) を参照して
                                                   ください。
      インクルード フィルタには、許容される属性名を使用した、1 つまたは複数
      のノード フィルタ式が含まれています。たとえば、"os" フィルタは以下のよ
      うに構成できます。

	  <include-filter type="os">
	      <node-filter name="OSName"     operator="eq" value="LINUX"  />
	      <node-filter name="OSVendor"   operator="eq" value="RedHat" />
	      <node-filter name="OSRevision" operator="ge" value="7.2"	  />
	  </include-filter>

      インクルード フィルタには、許容されるすべての属性を含める必要はありま
      せん。複数の属性が含まれている場合は、条件は論理積 (AND) で 1 つにまと
      められます。1 つの属性をインクルード フィルタに複数回含めて、例外とし
      てバージョン番号の値を持つ属性は、演算子の一方が "lt" であり他方が
      "ge" であれば、2 つ含まれていてもかまいません。以下に例を示します。

	  <include-filter type="protcol">
	      <node-filter name="WBEM" operator="lt" value="2.6" />
	      <node-filter name="WBEM" operator="ge" value="2.4" />
	  </include-filter>

      これは、バージョン 2.4 以降 2.6 以前の WBEM プロトコルをサポートしてい
      るノード群に対してツールを表示することを意味します。

      異なるタイプの複数のインクルード フィルタがツールに含まれている場合
      は、フィルタの条件は論理積 (AND) で 1 つにまとめられます。オペレーティ
      ング システムとハードウェアの両方に依存するツールでは、以下のフィルタ
      を使用できるでしょう。

	  <include-filter type="os">
	      <node-filter name="OSName"     operator="eq" value="LINUX"  />
	  </include-filter>
	  <include-filter type="hardware">
	      <node-filter name="DeviceSubType" operator="eq" value="HPVectra" />
	  </include-filter>

      同じタイプの複数のインクルード フィルタがツールに含まれている場合は、
      フィルタの条件は論理和 (OR) で 1 つにまとめられます。2 つの異なるオペ
      レーティング システムで使用可能なツールでは、以下のように指定できるで
      しょう。

	  <include-filter type="os">
	      <node-filter name="OSName"     operator="eq" value="LINUX"  />
	  </include-filter>
	  <include-filter type="os">
	      <node-filter name="OSName"     operator="eq" value="HPUX"	 />
	  </include-filter>

      このツールは、Linux または HP-UX を使用しているノードのどの集まりでも
      表示されます。

      ツールのフィルタ処理は、選択されたノードで定義された値を持つ、フィルタ
      処理される属性に依存します。"os"のフィルタ タイプでは、フィルタ処理さ
      れるいずれかの属性がノード用に定義されていない場合、フィルタに必要な値
      をノードが持っていると見なされます。したがって、ツール フィルタによっ
      て定義されている "os"を持たないノードは、そのツールを実行できると見な
      されます。ツールのフィルタ処理は、選択されたノードで定義された値を持
      つ、フィルタ処理される属性に依存します。 "os"のフィルタ タイプでは、
      フィルタ処理されるいずれかの属性がノード用に定義されていない場合、フィ
      ルタに必要な値をノードが持っていると見なされます。 したがって、ツール
      フィルタによって定義されている"os"を持たないノードは、そのツールを実行
      できると見なされます。 "hardware"フィルタ タイプでは、"Model"属性の場
      合上の記述は真になります。 "DeviceType"および"DeviceSubType"属性の場合
      は、選択したノード上で既知の値のみでツール フィルタが適用されます。
      "protocol"フィルタ タイプは、オペレータが適用する前にノード上でプロト
      コルが存在していることが必要です。 これは、"neq"および"nct"オペレータ
      がプロトコルを持つノードに頼っていることを意味しています。 "other"フィ
      ルタは、オペレータが適用する前にノード上に存在している属性がフィルタさ
      れた"protocol"フィルタと同じように動作します。 ツールが"other"および/
      または"protocol"フィルタを使用している場合、GUIに表示できるツールのた
      めにフィルタできる属性で少なくとも1つのノードが含まれている必要があり
      ます。

    バージョン番号
      OSRevision とプロトコル サポートのノード属性は、可能な場合にバージョン
      番号として解釈される値を持っています。バージョン番号は、負でない 10 進
      数を並べてピリオド (.) で区切ったものです。バージョン番号を比較すると
      きは、以下の規則が使用されます。

      より左の数字ほど、より大きい単位です。したがって、"1.0" は "0.1"
      よりも大きいです。

      数字に先行するゼロは無視されます。したがって、"003" は "3" と同じです。

      連続する 2 つのピリオドは、間にゼロがあるのと同じに解釈されます。
      したがって、"1.0.3" は "1..3" と同じです。

      先頭のピリオドは、直前にゼロがあると解釈されます。したがって、".9"
      は "0.9" と同じです。

      後続のゼロは無視されます。したがって、"1.0.0" は "1" と同じです。


    コメント
      XML ファイルにはコメントを記述することができます。コメントは、"<!--"
      で始まり "-->" で終了していなければなりません。コメントは開始タグと終
      了タグとの間に、複数行に渡って記述できます。

    その他の要件
      SSA コマンド ツールには、実行文 (execStmt) かファイル コピー文
      (copyStmt)、またはその両方が含まれている必要があります。実行文だけが指
      定されている場合は、コマンドの実行前にどのファイルもコピーされません。
      ファイル コピー文だけが指定されている場合は、ファイル コピー後にどのコ
      マンドも実行されません。これらの両方が指定されている場合は、まずファイ
      ルがコピーされ、次にコマンドが実行されます。

      MSA コマンド ツールは、コマンドと、そのコマンドが実行されるノードを指
      定する必要があります。

      ツール名は、1 〜 256 文字の長さでなければなりません。名前の先頭の文字
      は英字でなければなりません。2 文字目以降は、英数字かスペース、または
      "-"、"."、"("、")"、"_" のいずれかを使用できます。

      Web 起動対応ツールは、メインの URL を指定する必要があります。

      ファイル コピー ペアを指定するとき、1 つのツール定義内にある各ファイル
      コピー ペアのコピー先のファイル パスは一意でなければなりません。複数の
      コピー元のファイル パスに、同じコピー元のファイル パスを指定すると、
      ファイル解析エラーになります。

      ファイルが存在しないか読み取れない場合、ファイルをコピーするツールを実
      行するとエラーが発生します。コピー元のファイル パスは、ツールが作成ま
      たは変更されたときにはチェックされませんが、ツールが実行されるときには
      存在していなければなりません。


      log 要素が true に設定されているときは、ツールの実行による標準出力およ
      び標準エラー出力は中央管理サーバ (CMS) のログファイル
      /var/opt/mx/logs/mx.log に記録されます。この要素が false に設定されて
      いるときは、開始時刻、終了時刻、タスク ステータスなどサマリ タスク ロ
      グ情報だけがログに記録されます。

    デフォルト値
      一部のツール属性は、デフォルト値が null でありません。以下の属性です。

	       category      "Local Tools"
	       log           true (SSA ツールおよび MSA ツールの場合のみ)
	       user          現在の Systems Insight Manager 実行時ユーザ
	       toolboxes     All Tools



制限事項

      ツール名の長さは、256 文字以内に制限されています。
      ツールのカテゴリ名の長さは、80 文字以内に制限されています。
      ツールの説明の長さは、128 文字以内に制限されています。
      ツールの所有者名の長さは、オペレーティング システムによってのみ制限さ
      れています。
      ツールボックス名の長さは、16 文字以内に制限されています。
      コピー可能なファイルの最大数は 16 です。
      登録可能なツールの個数は無制限です。


      以下の例は、指定されたパラメータのセットについて、 ps(1) の出力を返す
      SSA ツールです。

      <?xml version="1.0" encoding="UTF-8"?>
      <tool-list>
	  <ssa-command-tool name="ps" revision="1.0">
	      <category>General Tools</category>
	      <description>ps <options></description>
	      <comment>-ef などのオプションを指定してください。</comment>
	      <include-filter>
		  <node-filter name="OSName" operator="eq" value="HPUX" />
	      </include-filter>
	      <include-filter>
		  <node-filter name="OSName" operator="eq" value="LINUX" />
	      </include-filter>
	      <ssa-block>
		  <command command-type="stdout" log="false">ps %1</command>
		  <parameter index="1" prompt="ps のすべての引き数を指定: <options>" required="true" />
	      </ssa-block>
	  </ssa-command-tool>
      </tool-list>


      以下のリストでは、CMS 上の crontab をターゲットにコピーし crontab(1)
      コマンドで実行するツールが記述されています。
      <?xml version="1.0" encoding="UTF-8"?>
      <tool-list>
	<ssa-command-tool name="Replace root crontab" revision="2.1">
	  <category>General Tools</category>
	  <description>root crontab を CMS からのもので置き換える。</description>
	  <owner>root</owner>
	  <execute-as-user>root</execute-as-user>
	  <ssa-block>
	    <copy-block>
	      <source>/var/spool/cron/crontabs/root</source>
	      <destination>/var/tmp/root_crontab</destination>
	    </copy-block>
	    <command log="true">
		      /usr/bin/crontab -l > ~root/.crontab.old;
		      /usr/bin/crontab /var/tmp/root_crontab;
		      rm /var/tmp/root_crontab
	     </command>
	   </ssa-block>
	</ssa-command-tool>
      </tool-list>


      以下のリストでは、SAM 管理ツールの GUI を起動するツールが記述されてい
      ます。

      <?xml version="1.0" encoding="UTF-8"?>
      <tool-list>
	<ssa-command-tool name="SAM">
	  <category>General Tools</category>
	  <description>SAM を実行する。</description>
	  <comment>このツールでは、GUI が適切な X サーバにリダイレクト
		   されるように DISPLAY 環境変数を設定する必要があります。
		   これは起動ツールであるため、DISPLAY 変数を正しく設定
		   していないと、ツールが正常終了したことを Systems
		   Insight Manager が示していても何も起きません。
	  </comment>
	  <execute-as-user>root</execute-as-user>
	  <toolbox toolbox-name="lvmadmin" />
	  <ssa-block>
	      <command command-type="x-window">/usr/sbin/sam</command>
	  </ssa-block>
	</ssa-command-tool>
      </tool-list>


      以下のリストでは、パラメータの代用として多数の関連タイプを指定するツー
      ルについて記述します。

      <?xml version="1.0" encoding="UTF-8"?>
      <tool-list>
	<msa-command-tool name="PingTest" revision="1.0">
	  <category>General Tools</category>
	  <description>拡張パラメータ パスの管理をテストする</description>
	  <msa-block>
	      <command command-type="stdout" log="true">ping %r%{MgmtProcToServer.a%}
	      %r%{ServerToEnclosure%} %r%{EnclosureToRack%}</command>
	      <execution-node>CMS</execution-node>
	  </msa-block>
	</msa-command-tool>
      </tool-list>


      以下のリストでは、 shutdown(1m) を呼び出すツールが記述されています。こ
      のツールが呼び出される結果、 shutdown(1m) によってエージェントが停止さ
      れた時点でタスクはすでに完了しており CMS にはその応答を待っているリ
      ソースがないようになります。

      <?xml version="1.0" encoding="UTF-8"?>
      <tool-list>
	<ssa-command-tool name="Shutdown the system">
	  <category>General Tools</category>
	  <description>システムをシャットダウンする。</description>
	  <comment>本ツールが起動されます。この結果、本ツールが何らかの
		   理由で正常に動作しない場合でも、通知は行われません。
		   Systems Insight Manager ユーザは、shutdown(1m) を実行
		   する権限を持っている必要があります。
		   /etc/shutdown.allow を参照してください。
	  </comment>
	  <ssa-block>
	    <command command-type="restart">/usr/sbin/shutdown %1 %2</command>
	    <parameter index="1"
		       prompt="-r、-h、-y など目的のオプションを入力してください。"
		       required="false" />
	    <parameter index="2"
		       prompt="猶予期間を秒単位で入力するか、"now" と入力してください。"
		       required="false" />
	  </ssa-block>
	</ssa-command-tool>
      </tool-list>



制限事項

      このコマンドは、CMS 上でのみ実行できます。


著者

      mxtool は、HP により開発されました。


参照 (HP-UX)

      mxtool(1M)、mxexec(1M)


参照 (Linux)

      mxtool(8)、mxexec(8)