HP

HP Systems Insight Managerテクニカル リファレンス ガイド

日本語
  デフォルト ツールの使用法  |  新規コマンド ライン ツールの作成  |  コマンド ライン ツール リファレンス   

コマンド ライン ツール リファレンス

目次
索引
注意事項
はじめに
製品概要
お使いになる前に
検出と識別
ユーザと認証
ネットワークとセキュリティ
システム、クラスタ、イベントの監視
ストレージ統合
タスクの使用法
デフォルト ツールの使用法
クラスタ監視
コマンド ライン ツール
新規コマンド ライン ツールの作成
新規コマンド ライン ツール
新規コピー ファイル ツール
新規X Windowツール
コマンド ライン ツール リファレンス
コマンド ライン ツールでのパラメータ化された文字列の使用例
カスタム コマンド
DMIアクセスの設定
SNMPアクセスの設定
デバイスのping
ディスク スレッショルド
ライセンス マネージャ
管理プロセッサ ツール
MIBの管理
OpenSSHのインストール
PMPツール
ツールの削除と回復
エージェント設定のレプリケート
RPMパッケージ マネージャ
Server Migration Pack
System Management Homepage
システム ページ
バージョン コントロール
Virtual Machine Management Pack
WBEMベース ツール
利用可能なMSAツール
パートナー アプリケーション
レポート機能
システムとイベントの管理
トラブルシューティング
リファレンス情報
印刷用画面へ
用語集
ヘルプの使い方
 ツールのタイプ
 パラメータ化された文字列
 ツール フィルタ
 バージョン番号
 その他の要件
 文書型定義
 関連プロシージャ
 関連トピック

ツールのタイプ

HP Systems Insight Managerのツールには、5つの基本タイプ(単一システム対応(SSA)ツール、マルチシステム対応(MSA)ツール、Web起動対応(WLA)ツール)があります。

SSAツールは、ターゲット システム上で実行され、ターゲット システム環境にのみ対応します。このため、SSAツールを実行する場合は、分散タスク ファシリティ(DTF)がツール情報を各HP Systems Insight Managerエージェントに送信してツールを実行します。SSAツールには、lscatcpなど、一般的なUNIXコマンドをラップするツールがあります。

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

WLAツールは、通常、ブラウザ内で実行されるツールで、URL(universal resource location)で指定されます。

パラメータ化された文字列

ツールを正しく作成するために、ツール開発者は、URLとコマンド ラインの形成方法を理解する必要があります。ツール開発者は、パラメータ化された文字列を使用することにより、ツール定義ファイル(TDEF)作成の際に使用できるオプションの機能を大幅に強化できます。

パラメータ化された文字列は、置換フィールドのある文字列で、標準Cライブラリにある有名なprintf()関数で使用されるフォーマット文字列と似ています。これらのフィールドは、(ツール パラメータ属性で定義されているとおり)実行時にユーザが入力した値、タスク コントローラの提供する標準のタスク プロパティ、選択されたターゲット システムまたはシステム グループに関連する値、またはグローバル ツール プロパティ ファイルから取得されたプロパティ値で置き換えることができます。これによって、非常に具体的なURLまたはコマンド ラインを生成することが可能になります。

パラメータ化された文字列の置換テーブル

次のパラメータは、グローバル属性値の置換を提供します。

パラメータ説明
%t実行されているタスクのタスクID。
%uこのツールを実行するユーザの名前。
%eこのツールを実行するユーザ権限の名前。
%sこのツールを実行するコアCMSの管理サーバ ホスト名。
%#(#は正の整数)リスト インデックス位置(%1、%2、%3などのように1ずつ増える)として提供される番号(#)が示すパラメータを、ユーザ入力値に置き換えてください。
%ySOAPログオン トークン。SOAP single sing-on Webアプリケーションで使用します。

次のパラメータは、現在選択されているターゲットの置換を提供します。

パラメータ説明
%fターゲット システム(%xトグルが文字列内にある場合はシステム グループ)のデータベース名。
%nネットワーク名(ホスト名、IPアドレス、IPXアドレス、またはシステム名の順)
%aネットワーク アドレス(IPアドレス、またはIPXアドレスの順)
%lシステム リンクの設定で指定されたフォーマットでのリンク名(名前、IPアドレス、または完全DNS名)
%pこのターゲットのWBEMプロキシのIPアドレス。<ip address>:<port#></port#></ip>の形式。
%gターゲット システム(%xトグルが文字列内にある場合はシステム グループ)のデータベースGUID。
%bターゲット システムのシステム タイプ。
%cターゲット システムのシステムsupタイプ。
%r% (rt[.attribute]%)パラメータ"rt"に指定されているリレーション タイプのある関連システムで置換します。有効なリレーションシップ タイプ文字列は、device_associationsテーブルのassociationTypeNumber列に格納されているものです。[.attribute]が指定されている場合は、指名されたシステム属性の1つがシステムに返されます。また、ネットワーク名などの一般属性(.a)も有効です。たとえば、サーバの管理プロセッサのIPアドレスを取得するには、%r{MgmtProcToServer.a%}を使用し、通信を取得するには、%r{MgmtProcToServer.Contact%}を使用してください。関連システム属性が省略されると、各システムに対して、ネットワーク名とIPアドレスが返されます。ネットワーク名とIPアドレスは、"network name|ip address"という形式で返されます。複数のノードが返される場合は、カンマで区切られます。なお、リレーションシップ タイプ"MgmtProcToServer"を使用して、すべての管理プロセッサ リレーションシップ タイプに対する関連システム情報を返すことができます。
%(attribute]%)ターゲット システムの指名された属性の値。

次のパラメータは、選択されているターゲット システムを複数サポートするために繰り返しを提供します。

パラメータ説明
%( ... %)繰り返しパターン(現在の選択が存在する場合にのみ繰り返します)。現在ターゲットの選択が存在しない場合は、拡張内の区切り文字の間のテキストが削除されます。これによって、テキストがオプションとなり、ターゲット選択リストに依存するようになります。
%i選択インデックス(1から始まる)。
%z何も置換しません。選択インデックスを次の整数に増加させ、参照されるターゲット システムを選択されたターゲット リスト内の次のターゲットに移動します。
%⇚< ... >l暗号化されたテキスト(他のすべてのパラメータが置換された後に暗号化します)。
%%置換語に、コマンド/URLに%を保持することを可能にします。

ツール フィルタ

ツール フィルタは、ツールの記述者が、選択したシステム上でツールを実行するかどうかを制御できるようにする機能です。ほとんどのツールは、正常な動作が一部のプラットフォームのみで提供されているコマンドに依存するという点でプラットフォーム依存です。たとえば、bdfツールは、bdfコマンドに依存します。このコマンドは、HP-UXプラットフォームで提供されますが、Linuxプラットフォームではその名前では使用できません。ツールは、フィルタ要件を満たすシステムが1台以上検出されている場合にのみ、[ツール]メニューに表示される必要があります。検出されたシステムは、フィルタ要件を満たす必要があり、すべてのフィルタ要件に合格した場合のみ実行されます。そのためには、ツールは、システム フィルタ式に、動作可能なすべてのシステムがもつ必要のあるシステム属性を指定します。

ツールが動作するために必要なシステム属性は、次の形式をもつシステム フィルタ式によって指定されます。

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

eq演算子は、ツールの動作可能なシステムは指定された属性値と完全に同じ属性値をもつ必要があることを指定します。この演算子は、システム フィルタ式で使用可能なあらゆる属性名に適用されます。ge演算子は、ツールの動作可能なシステムは指定されている属性値以上の値をもつ必要があることを指定します。lt属性とge属性は、リビジョン属性、特にOSタイプ フィルタ内のOSRivision属性、およびProtocolタイプ フィルタのすべての属性でのみ使用できます。これらの属性の値は、数値または文字列で指定できます。ct演算子は、ツールの動作可能なシステムは指定された値を含む属性をもつ必要があることを指定します。neq演算子は、ツールの動作可能なシステムは指定された属性値と完全に同じ属性値をもってはならないことを指定します。この演算子は、システム フィルタ式で使用可能なあらゆる属性名に適用されます。nct演算子は、ツールの動作可能なシステムは指定された値を含む属性をもってはならないことを指定しますシステムでは、フィルタ式が指定できる数値の属性に、OSRevisionProtocol Support属性を含みます。これらは、バージョン番号ですバージョン番号に指定できる値とその比較方法は、以下の「バージョン番号」の項に説明されています。attribute-nameは、以下の表にある値の1つ、またはシステムのProtocolSupport属性からのプロトコル名です。attribute-valueは、attribute-nameに対して存在するシステム属性値の1つです

属性値は、Distributed Task Force(DMTF)の共通情報モデル(CIM)に基づいています。 通常、これらの値はシステム認証プロセス中に定義されます。このプロセスは、WBEMとSNMPを使用してシステム属性を決定します。 このリリースでは、有効なOSName値は、HP-UXとLinuxです。HP-UXのOSName値については、OSRelease属性値の最初のアルファベット フィールドが削除されます(たとえば、B.11.11は11.11として格納されます)。

システム フィルタ式は、includeフィルタ式の一部として使用されます。includeフィルタ式には3つのタイプがあり、それぞれ、異なったカテゴリの属性名でのフィルタが可能です。

カテゴリフィルタ タイプ可能な属性名
オペレーティング システムosOSName、OSVendor、OS Revision
ハードウェアhardwareDeviceType、DeviceSubType、Model
プロトコル サポートprotocolHTTPを除く任意のプロトコル名
その他otherあらかじめ定義されているシステム属性については、mxsystem(1M) (mxsystem(1M)) またはmxsystem(4) (mxsystem(4))を参照してください。あらかじめ定義されている任意のシステム属性または任意のカスタム システム属性が該当する可能性があります。

includeフィルタには、可能な属性名を使用した1つまたは複数のシステム フィルタ式が含まれています。たとえば、osフィルタでは、次のように構成することができます。

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

includeフィルタは、可能なすべての属性をすべて含む必要はありません。複数の属性が含まれる時は、条件はともに論理ANDになります。属性は、includeフィルタ内に複数回出てきてはいけません。ただし、バージョン番号をもつ属性は、片方の演算子がlt、もう一方の演算子がgeの場合は、2回指定することができます。次に例を示します。

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

これは、ツールが、WBEMプロトコルバージョン2.4以上で2.6未満をサポートするシステムの任意の集合に対して表示されるべきであることを指定します。

ツールに異なるタイプのincludeフィルタが複数ある場合は、条件はともに論理ANDになります。オペレーティング システムとハードウェア依存の両方をもつツールは、次のフィルタを使用できます。

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

ツールに同じタイプのincludeフィルタが複数ある場合は、条件はともに論理ORになります。2つ異なったオペレーティング システム上で使用可能なツールは、次のように指定できます。

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

このツールは、LinuxまたはHP-UXのいずれかを使用するシステムのあらゆる収集で表示されます。

ツール フィルタは、選択されたシステム上に定義された値をもつフィルタされる属性に依存します。"os"フィルタタイプでは、フィルタされる属性がシステムに対して定義されていない場合は、そのシステムはそのフィルタに必要とされる値をもつと見なされます。したがって、ツールフィルタによって指定されたos属性をもたないシステムは、ツールを実行できると見なされます。ハードウェア フィルタ タイプでは、Model属性の場合にこれが当てはまります。しかし、DeviceType属性およびDeviceSubType属性では、ツール フィルタは、選択されたシステム上の既知の値に対してのみ適用されます。プロトコル フィルタ タイプでは、演算子を適用する前にプロトコルがシステム上に存在する必要があります。すなわち、neq演算子およびnct演算子も、システムがそのプロトコルをもつかどうかに依存します。 その他のフィルタも、演算子を適用する前にフィルタされる属性がシステム上に存在する必要があるという点でプロトコル フィルタのように動作します。ツールがその他のフィルタおよびプロトコル フィルタまたはそのいずれかを使用する場合は、ツールがGUIに表示されるためには、少なくとも1つのシステムがフィルタ可能な属性を含む必要があります。

バージョン番号

OSRevisionおよびProtocol Supportシステム属性は、可能であれば、バージョン番号として解釈される値をもちます。バージョン番号は、ピリオド(.)文字で区切られた、負ではない一連の十進数です。バージョン番号を比較するときは、次のルールが使用されます。

  • 左端の数字の組は、最も重要です。したがって、1.0は0.1より大きくなります。

  • 数字の左にある0は、無視されます。したがって、003は3と同じです。

  • 2つ並んだピリオド文字は、0を区切っているものと解釈されます。したがって、1.0.3と1..3は等しくなります。

  • 最初にピリオド文字がある場合は、前に0があるものと解釈されます。したがって.9と0.9は等しくなります。

  • 数字の右にある0は、無視されます。したがって、1.0.0は1と同じです。

その他の要件

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

MSAコマンド ツールは、コマンドと、そのコマンドが動作するシステムを指定する必要があります。

ツール名は、1文字以上、256文字以下の長さでなければなりません。名前の1文字目は、アルファベットである必要があります。2文字目以降の文字には、文字、数字、スペース、または"-"、"."、"("、")"、"_"のいずれかの文字を使用できます。

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

ファイル コピー ぺアを指定するときは、単一のツール定義内の各ファイルコピー ペアに対するコピー先ファイル パスが固有なければなりません。複数のコピー元ファイル パスに対して同じコピー先ファイル パスを指定すると、ファイル解析エラーになります。

存在しない、または読み出せないファイルである場合は、そのファイルをコピーするツールの実行時にエラーが発生します。コピー元ファイルパスは、ツールの作成時や修正時にはチェックされませんが、ツールの実行時には存在する必要があります。

ログ要素が真に設定されている場合、ツールの実行による標準出力および標準エラー出力は、CMS(CMS)ログファイルの/var/opt/mx/logs/mx.logに記録されます。ログ要素が偽に設定されている場合は、開始および終了時間やタスク ステータスなどの要約タスク ログ情報だけが記録されます。

文書型定義

文書型定義(DTD)ファイルは、XMLファイルの制約を定義します。これらの制約には、XMLファイル内の有効な要素タグ、属性、および要素の濃度が含まれます。ツールDTDファイルは、toollist.dtdという名前で、次の段落に含まれます。マンページのフォーマットによって、DTDの内容はファイル内と同じに表示されないことがあることに注意してください。

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

<!-- The tool-list element can contain zero or more of either
ssa-command-tool elements, msa-command-tool elements,
web-launch-tool elements, automation-tool elements or
app-launch-tool elements.-->
      
<!ELEMENT tool-list ( ssa-command-tool |
msa-command-tool |
web-launch-tool  |
automation-tool  |
app-launch-tool )* >

<!-- The ssa-command-tool element specifies a single-system aware
tool.The ssa-command-tool element can optionally specify a
category element, a description element, a comment element, an
owner element, a default-target element, an execute-as-user
element, a job-display-handler element, a toolbox-enabled
element, zero or more toolbox elements, zero or more
include-filter elements, or zero or more env-variable elements.
(NOTE:The role-enabled and role elements are deprecated
elements and should not be used with this product.These
are provided for backward compatibility with previous
products.The toolbox-enabled element and the toolbox
element should be used in their stead.)
If more than one of these elements are specified, the element
must appear in the order as listed in this definition.The
ssa-command-tool element must contain an ssa-block element.The
ssa-block element must appear after the previously described
optional elements, if any of the optional elements are
specified.Following the ssa-block element, one can specify zero
or more attribute elements.-->
	  
<!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* ) >

<!-- In addition to the previously described elements, the
ssa-command-tool element specifies the following attributes.The
name attribute specifies the tool name and must be specified in
the ssa-command-tool element.The visible attribute specifies
whether the tool is visible for running.By default tools are
visible.The max-targets attribute specifies the maximum number
of targets against which a tool can run.The revision attribute
allows a tool author to specify a revision for the tool.Note
that this is for information only.The job-log attribute
specifies whether the results of the command will be kept in this
system's job log.This attribute applies only to tools when they
are run as scheduled tasks, not when they are run as "run now"
tasks.When job-log="true" the job and target status for the tool
will be kept for a relatively lengthy system-defined period in
the database after the job completes.When job-log="false" only
the last completed copy of the job and target status for the task
will be kept in the cache for a much shorter period of time, and
will not be written to the database.	 Job logging is enabled by
default.The schedulable attribute specifies whether the tool can
be run as a schedulable task.When scheduled="false" the tool can
only run as a "run now" task.Tools are scheduled by default.
The GUID attribute specifies a globally unique identifier (GUID)
for the tool.Because the system generates a GUID for a tool
during the add operation, this field should only be specified
during a modify operation.The accepts-targets attribute specifies
whether the tool accepts targets for execution.The
accepts-targets attribute is true by default. -->

<!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" >

<!-- The ssa-block specifies the elements specific to a single-system
aware tool.The ssa-block can specify a command or copy-block or
both.Only one command should be specified but up to 16 multiple
copy-blocks can be specified.After the command and/or
copy-blocks, one can specify the parameters for the command
and/or copy-block. -->
  
<!ELEMENT ssa-block (( command | copy-block )+, parameter*) >

<!-- The copy-block specifies a source file path and a destination
file path for a copy operation. --> -->

<!ELEMENT copy-block ( source, destination )+ >

<!-- The source element specifies the source file path for a copy
operation. -->

<!ELEMENT source (#PCDATA) >

<!-- The destination element specifies the destination file path for a
copy operation. -->
     
<!ELEMENT destination (#PCDATA) >

<!-- The msa-command-tool element specifies a multiple-system aware
tool.The msa-command-tool element can optionally specify a
category element, a description element, a comment element, an
owner element, a default-target element, an execute-as-user
element, a job-display-handler element, a toolbox-enabled
element, zero or more toolbox elements, zero or more
include-filter elements, or zero or more env-variable elements.
(NOTE:The role-enabled and role elements are deprecated
elements and should not be used with this product.These
are provided for backward compatibility with previous
products.The toolbox-enabled element and the toolbox
element should be used in their stead.)
If more than one of these elements are specified, the element
must appear in the order as listed in this definition.The
msa-command-tool element must contain an msa-block element.The
msa-block element must appear after the previously described
optional elements, if any of the optional elements are
specified.Following the msa-block element, one can specify zero
or more attribute elements.-->
      
<!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* ) >

<!-- In addition to the previously described elements, the
msa-command-tool element specifies the following attributes.The
name attribute specifies the tool name and must be specified in
the msa-command-tool element.The visible attribute specifies
whether the tool is visible for running.By default tools are
visible.The max-targets attribute specifies the maximum number
of targets against which a tool can run.The revision attribute
allows a tool author to specify a revision for the tool.Note
that this is for information only.The job-log attribute
specifies whether the results of the command will be kept in this
systems job log.When job-log="true" the job and target status
for the tool will be kept for a relatively lengthy system-defined
period in the database after the job completes.When
job-log="false" only the last completed copy of the job and
target status for the tool will be kept in the cache for a much
shorter period of time, and will not be written to the database.
Job logging is enabled by default.The schedulable attribute
specifies whether the tool can be run as a scheduled task.When
schedulable="false" the tool can only run as a "run now" task.
Tools are schedulable by default.The guid attribute specifies a
globally unique identifier (GUID) for the tool.Because the
system generates a GUID for a tool during the add operation, this
field should only be specified during a modify operation.The
accepts-targets attribute specifies whether the tool
accepts targets for execution.The accepts-targets attribute is
true by default. -->

<!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" >

<!-- The msa-block specifies the elements specific to a
multiple-system aware (MSA) tool.The msa-block can specify an
MSA command, the parameters for the command and an execution system
on which the command executes. -->
      
<!ELEMENT msa-block ( command, parameter*, execution-node ) >

<!-- The command element specifies the command for an SSA or an MSA
tool.If the command accepts parameters, it must be specified as
a parameterized string. -->
     
<!ELEMENT command ( #PCDATA ) >

<!-- The command element can have two attributes.The command-type
attribute specifies whether the command is an x-window, stdout,
restart, launch, or an unknown command type.The default command
type is stdout.The log attribute specifies whether the results
of the command will be output to this system's audit log.When
log="true" the stdout and stderr results of the command will be
output to the system's audit log.Command output is not logged
by default. -->
      
<!ATTLIST command command-type (x-window |
stdout   |
restart  |
launch   |
unknown) "stdout"
log (true | false) "false" >

<!-- The execution-system element specifies the system on which an MSA
tool will execute. -->
      
<!ELEMENT execution-system ( #PCDATA ) >

<!-- The web-launch-tool element specifies a web launch tool.The
web-launch-tool element can optionally specify a category
element, a description element, a comment element, an owner
element, a default-target element, an execute-as-user element, a
job-display-handler element, a toolbox-enabled element, zero or
more toolbox elements,  zero or more include-filter elements, or
zero or more env-variable elements.
(NOTE:The role-enabled and role elements are deprecated
elements and should not be used with this product.These
are provided for backward compatibility with previous
products.The toolbox-enabled element and the toolbox
element should be used in their stead.)
If more than one of these elements are specified, the element
must appear in the order as listed in this definition.The
web-launch-tool element must contain a web-block element.The
web-block element must appear after the previously described
optional elements, if any of the optional elements are
specified.Following the web-block element, one can specify zero
or more attribute elements.-->
      
<!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* ) >

<!-- In addition to the previously described elements, the
web-launch-tool element specifies the following attributes.The
name attribute specifies the tool name and must be specified in
the web-launch-tool element.The visible attribute specifies
whether the tool is visible for running.By default tools are
visible.The max-targets attribute specifies the maximum number
of targets against which a tool can run.The revision attribute
allows a tool author to specified a revision for the tool.Note
that this is for information only.The job-log attribute
specifies whether the results of the command will be kept in this
systems job log.When job-log="true" the job and target status
for the tool will be kept for a relatively lengthy system-defined
period in the database after the job completes.When
job-log="false" only the last completed copy of the job and
target status for the tool will be kept in the cache for a much
shorter period of time, and will not be written to the database.
Job logging is enabled by default.The schedulable attribute
specifies whether the tool can be run as a scheduled task.When
schedulable="false" the tool can only run as a "run now" task.
Tools are schedulable by default.The guid attribute specifies a
globally unique identifier (GUID) for the tool.Because the
system generates a GUID for a tool during the add operation, this
field should only be specified during a modify operation. -->

<!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 >

<!-- The web-block specifies the elements specific to a web launch
tool.The web-block must specify a main-url element.Optionally,
the web-block can specify a side-url element, a status-url
element, and a current-url element.Additionally, the web-block
can specify the parameters for the URLs.Finally, the web-block
can optionally specify a target format to describe how targets
are passed to a web launch aware tool. -->
      
<!ELEMENT web-block (main-url, (side-url?, status-url?, current-url?),
parameter*, target-format? ) >

<!-- In addition to the above elements, the web-block element has one
attribute.The accepts-targets attribute specifies whether the
web launch tool accepts targets for execution.The
accepts-targets attribute is true by default. -->
      
<!ATTLIST web-block accepts-targets (true|false) "true">

<!-- The main-url specifies the URL to launch the tool.If the URL
accepts parameters, the URL must be specified as a parameterized
string. -->
      
<!ELEMENT main-url ( #PCDATA ) >

<!-- The status-url specifies a URL at which one might find the status
of this web launch tool during execution. -->
      
<!ELEMENT status-url ( #PCDATA ) >

<!-- The current-url specifies the current URL. -->

<!ELEMENT current-url ( #PCDATA ) >

<!-- The side-url specifies a set-aside URL. -->

<!ELEMENT side-url ( #PCDATA ) >

<!-- The target-format defines the format of targets in a web launch
tool and is specified as a parameterized string.-->
      
<!ELEMENT target-format ( #PCDATA ) >

<!-- The automation tool performs an action on the CMS which
involves accessing the target systems.The automation-tool element
can optionally specify a category element, a menu-category
element, a description element, a comment element, an owner
element, a default-target element, an execute-as-user element, a
job-display-handler element, a default-parameter element, a
role-enabled element, zero or more  role elements,  zero or more
include-filter elements, or zero or more env-variable elements.
If more than one of these elements are specified, the element
must appear in the order as listed in this definition.The
automation-tool element must contain an automation-block element.
The automation-block element must appear after the previously
described optional elements, if any of the optional elements are
specified.Following the automation-block element, one can
specify zero or more attribute elements. -->
      
<!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* ) >

<!-- In addition to the previously described elements, the
automation-tool element specifies the following attributes.The
name attribute specifies the tool name and must be specified in
the automation-tool element.The visible attribute specifies
whether the tool is visible for running.By default tools are
visible.The max-targets attribute specifies the maximum number
of targets against which a tool can run.The revision attribute
allows a tool author to specify a revision for the tool.Note
that this is for information only.The job-log attribute
specifies whether the results of the command will be kept in this
systems job log.When job-log="true" the job and target status
for the tool will be kept for a relatively lengthy system-defined
period in the database after the job completes.When
job-log="false" only the last completed copy of the job and
target status for the tool will be kept in the cache for a much
shorter period of time, and will not be written to the database.
Job logging is enabled by default.The schedulable attribute
specifies whether the tool can be run as a scheduled task.When
schedulable="false" the tool can only run as a "run now" task.
Tools are schedulable by default.The guid attribute specifies a
globally unique identifier (GUID) for the tool.Because the
system generates a GUID for a tool during the add operation, this
field should only be specified during a modify operation.The
accepts-targets attribute specifies whether the tool
accepts targets for execution.The accepts-targets attribute is
true by default. -->
      
!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" >

<!-- The automation-block specifies the elements specific to an
automation tool.The automation-block must specify a
message-id. -->
      
<!ELEMENT automation-block (message-id) >

<!-- The message-id is the internal string representation of the message
sent by the Automation engine to cause the tool to run. -->
      
<!ELEMENT message-id ( #PCDATA ) >

<!-- The app-launch-tool element specifies an application launch
tool.The app-launch-tool element can optionally specify a
category element, a menu-category element, a description element,
a comment element, an owner element, a default-target element, an
execute-as-user element, a job-display-handler element, a
default-parameter element, a role-enabled element, zero or more
role elements,  zero or more include-filter elements, or zero or
more env-variable elements.If more than one of these elements
are specified, the element must appear in the order as listed in
this definition.The app-launch-tool element must contain an
app-launch-block element.The app-launch-block element must
appear after the previously described optional elements, if any
of the optional elements are specified.Following the
app-launch-block element, one can specify zero or more attribute
elements. -->

<!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* ) >

<!-- In addition to the previously described elements, the
app-launch-tool element specifies the following attributes.The
name attribute specifies the tool name and must be specified in
the app-launch-tool element.The visible attribute specifies
whether the tool is visible for running.By default tools are
visible.The max-targets attribute specifies the maximum number
of targets against which a tool can run.The revision attribute
allows a tool author to specify a revision for the tool.Note
that this is for information only.The job-log attribute
specifies whether the results of the command will be kept in this
systems job log.When job-log="true" the job and target status
the tool will be kept for a relatively lengthy system-defined
period in the database after the job completes.When
job-log="false" only the last completed copy of the job and
target status for the tool will be kept in the cache for a much
shorter period of time, and will not be written to the database.
Job logging is enabled by default.The schedulable attribute
specifies whether the tool can be run as a scheduled task.When
schedulable="false" the tool can only run as a "run now" task.
Tools are schedulable by default.The guid attribute specifies a
globally unique identifier (GUID) for the tool.Because the
system generates a GUID for a tool during the add operation, this
field should only be specified during a modify operation.The
accepts-targets attribute specifies whether the tool
accepts targets for execution.The accepts-targets attribute is
true by default. -->

<!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" >

<!-- The app-launch-block specifies the elements specific to an
application launch tool.The app-launch-block specifies a
required command element. -->
      
<!ELEMENT app-launch-block (command, app-parameters?) >

<!-- In addition to the previously described elements, the
app-launch-block element specifies the following attribute.The
alert-driven attribute specifies whether the alert list or the
system list is used to determine the target systems to run the tool
on. -->

<!ATTLIST app-launch-block alert-driven (true | false) "false" >

<!-- The app-parameters element is an application parameters
definition string whose value is a string -->
      
<!ELEMENT app-parameters ( #PCDATA ) >

<!-- The env-variable element is an environment variable definition
string whose value is a string -->
      
<!ELEMENT env-variable ( #PCDATA ) >

<!-- In addition to the previously described elements, the
env-variable element specifies the following attribute.The
name attribute specifies the name of the environment variable.-->
      
<!ATTLIST env-variable name CDATA #REQUIRED >

<!-- The owner element specifies the tool owner.When the owner field
is specified, the tool is only associated with the All Tools toolbox.
When the owner field is not specified, tool is enabled in all
of its associated toolboxes.When a limited-rights user adds or
modifies a tool, the owner field contains the name of the
limited-rights user.Only a full-rights user can add or modify a
tool without the owner specified. -->
      
<!ELEMENT owner ( #PCDATA ) >

!-- The comment field specifies additional information about the
tool.It is usually more verbose that the description. -->

<!ELEMENT comment ( #PCDATA ) >

<!-- The parameter element specifies the first to the tenth parameter
of a tool. -->
     
<!ELEMENT parameter EMPTY >

<!-- The parameter element has three attributes.The index attributes
specifies which argument in a parameterized string this parameter
substitutes.Parameters can be indexed from 1 to 10 with a
default index of 1. Tools cannot contain parameters with
duplicate indexes.If more than one parameter in a tool
definition contains the same index, only the first parameter added
to the tool with the duplicate index remains in the tool.The
prompt attribute provides information about the parameter that
can be displayed in a GUI for assistance.The required attribute
specifies whether this parameter must be specified when the tool
is executed.By default, parameters are not required.The private
attribute specifies whether this parameter is encoded and stored
securely.By default, parameters are not 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" >

<!-- The toolbox-enabled element specifies whether the toolboxes
associated with a tool are enabled. -->

<!ELEMENT toolbox-enabled EMPTY >

<!-- The toolbox-enabled element has one attribute.The value
attribute specifies whether the tool within the toolboxes is enabled.
This allows a full-rights user to explicitly disable the tools in
a toolbox though the tool is always enabled in the All Tools
toolbox.By default, the tool is enabled in all the toolboxes that
it is in.  If a tool is disabled within a toolbox, it cannot be
executed. -->
      
<!ATTLIST toolbox-enabled value (true|false) "true">

<!-- The role-enabled element specifies whether the roles associated
with a tool are enabled.This is an obsolete element.The
toolbox-enabled element should be used instead.-->
      
<!ELEMENT role-enabled EMPTY >

<!-- See description of toolbox-enabled element attributes. -->

<!ATTLIST role-enabled value (true|false) "true">

<!-- The default-target element specifies a target on which the tool
can run if no targets are specified at run time.One can specify
a system, &cms2; to run on the &cms2; by default, or ALL to run on all
authorized systems by default. -->
      
<!ELEMENT default-target ( #PCDATA ) >

<!-- The category element specifies the category with which to
associate the tool.By default, tools are associated with the
"Local Tools" category. -->

<!ELEMENT category ( #PCDATA ) >

<!-- The description element specifies a simple description of the
tool.To specify more verbose information such as how to run the
tool, use the comment element. -->

<!ELEMENT description ( #PCDATA ) >

<!-- For SSA and MSA command tools, the execute-as-user element
specifies the user name that the tool runs as or under whose
account the tool runs on the target systems.For Web-launch
tools the execute-as-user is passed to the URL for its use. -->

<!ELEMENT execute-as-user ( #PCDATA ) >

<!-- The job display hander element specifies the fully-qualified
name of a class implementing the JobDisplayHander interface,
used to display the results of a job created by running this
tool. -->

<!ELEMENT job-display-handler ( #PCDATA ) >

<!-- The toolbox element specifies a toolbox to associate with the
tool.To run a tool the user must be authorized with one of the
specified toolboxes. -->

<!ELEMENT toolbox EMPTY >

<!-- The toolbox element has one attribute to specify the toolbox
name. -->

<!ATTLIST toolbox toolbox-name CDATA #REQUIRED >

<!-- The role element specifies a role to associate with the tool.To
run a tool the user must be authorized with one of the specified
roles.This element is obsolete.The toolbox element should be
used instead. -->

<!ELEMENT role EMPTY >

<!-- See the toolbox element attribute description. -->

<!ATTLIST role role-name CDATA #REQUIRED >

<!-- The include-filter element specifies system attributes against
which to filter a tool for execution.A specified include-filter
element must contain one or more system-filter elements.When
filtering a tool each include-filter block is OR'd together to
get the final filter result.Each system-filter element within an
include-filter block is AND'd together. -->
      
<!ELEMENT include-filter (system-filter)+ >

<!-- The include-filter elements has one attribute.The type attribute
specifies the type of include filter to execute.Four types are
currently recognized.Three of them are os (operating system), 
hardware, protocol filtering.The fourth type is called other which 
will allow all other system attributes to be filtered upon.-->

<!ATTLIST include-filter type (os | hardware | protocol | other) "os" >

<!-- The system-filter element is an empty element that contains
attributes used to specify the system attributes against which to
filter a tool for execution. -->
      
<!ELEMENT system-filter EMPTY >

<!-- The system-filter element is specified with three attributes.The
name attribute specifies the system attribute name to filter
against.The operator attribute specifies whether to filter
against an equal value, a less than value, a greater than or
equal value, a contains value, a not equals value or a not
contains value.The operator name is case-insensitive.The
value attribute specifies the value of the system attribute to
filter against. -->
      
<!ATTLIST system-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 >

<!-- The attribute element specifies the name value pairs that
comprise client attributes.The client attribute name is
specified using the name attribute and the client attribute value
is specified as the PCDATA of the element. -->

<!ELEMENT attribute ( #PCDATA ) >

<!ATTLIST attribute name CDATA #REQUIRED >
			

関連プロシージャ

 新規コマンド ライン ツールの作成 - 新規コマンド ライン ツール
 新規コマンド ライン ツールの作成 - 新規コピー ファイル ツール
 デフォルト ツールの使用法 - ツールの削除と回復
 カスタム コマンド - 新規Web起動ツール
 新規コマンド ライン ツールの作成 - 新規X Windowツール

関連トピック

 デフォルト ツールの使用法 - コマンド ライン ツール