execNative 手順

<execNative> 手順は、対象ホストでネイティブコマンドを実行するために使用されます。 コマンドが予期しなかった結果を生成する場合、手順は失敗し、実行が停止します。

execNative 手順属性

execNative は、次のものを指定するために入れ子になった要素を持つことができます。

• 環境変数

• バックグラウンド実行

• コマンドの標準出力ファイル

• コマンドエラーの出力ファイル

• コマンド入力

• 実行するコマンド

• 手順の成功基準

execNative 要素の子要素

1 <background> 要素を指定する場合は、<outputFile> と <errorFile> の両方を指定する必要があります。

2 inputText および inputFile 要素は省略可能です。 これらの指定は一度に 1 つずつ行う必要があります。

3 exec または shell 要素の 1 つを指定する必要があります。 execNative 要素内に exec 要素と shell 要素の両方を入れることは認められません。

<inputText> および <inputFile> 要素は省略可能です。 これらの指定は一度に 1 つずつ行う必要があります。

3 exec または shell 要素の 1 つを指定する必要があります。 execNative 要素内に exec 要素と shell 要素の両方を入れることは認められません。

env 子要素

<execNative> 要素は、コマンドの環境変数を指定する目的で、必要に応じて <env> 要素を含むことができます。 <env> を使用すると、コマンド環境の新しい変数を提供することも、既存の変数を無効にすることもできます。

コマンドの環境変数セットは、遠隔エージェントの環境変数セットと、<env> タグを使用して提供される変数を合わせたものです。

env 要素属性

background 要素

<background> 要素は <execNative> 要素の子です。この要素が指定される場合、コマンドをバックグラウンドプロセスとして実行する必要があることを示します。 この要素には属性も子要素もありません。

<background> 要素が指定された <execNative> の場合、以下の制限が適用されます。

• <successCriteria> は指定の必要はありません。 手順は、バックグラウンドプロセスを開始する上で何も問題が存在しなかった場合には成功します。 指定すると、コマンドをバックグラウンドプロセスとして実行するために使用されるスクリプトに照らして <successCriteria> のテストが行われます。

• 実行されるコマンドの標準出力およびエラー出力はキャプチャされません。 「details」をクリックすると、終了ステータス 0 と、空の出力、およびエラー出力が表示されます。 しかし、バックグラウンドでネイティブコマンドを開始するのに問題があった場合は、エラーの特性と診断出力に応じ、別の終了ステータスが表示されます。

• <outputFile> および <errorFile> 要素を指定する必要があります。 指定したファイルがすでに存在する場合、それらは無効にされます。

outputFile 要素

outputFile 要素は、実行されるコマンドの標準出力が格納される、エージェント上のローカルファイルのパスを指定するために使用されます。 ローカルファイルのパスは、outputFile 要素内の name 属性で指定します。 相対パスは、コマンドの作業ディレクトリに相対的であると解釈されます。

background 要素を指定する場合は、outputFile 要素を指定する必要があります。

outputFile を指定せず、successCriteria 要素で outputMatches も指定しないと、コマンドの各出力は格納されずに消失します。 outputMatches を指定すると、標準出力は一時ファイルに格納され、コマンドの実行後そのファイルが削除されます。

outputFile 属性

errorFile 要素

errorFile 要素は、実行されるコマンドのエラー出力を格納する、エージェント上のローカルファイルのパスを指定するために使用されます。 ローカルファイルのパスは、errorFile 要素内の name 属性で指定します。 相対パスは、コマンドの作業ディレクトリに相対的であると解釈されます。

background 要素を指定する場合は、errorFile 要素を指定する必要があります。

errorFile を指定せずに、かつ successCriteria 要素で errorMatches を指定しないと、コマンドの各出力は格納されずに消失します。 errorMatches を指定すると、エラー出力は一時ファイルに格納され、コマンドの実行後そのファイルが削除されます。

errorFile 属性

inputText 子要素

<inputText> 要素は、<execNative> の子要素です。 <inputText> 要素は、コマンドの標準入力に送り込む必要がある任意のテキストを指定します。 このテキストは、この要素のコンテンツとして指定されます。

<inputText> は、CDATA セクションの入力を囲む目的で使用できます。入力を囲むことで、入力フォーマットを保持するとともに、文字 `& や `<' を含む入力で発生しえる解析エラーを防ぐことができます。

(例:

<execNative>
		<inputText> 		  ls –l |fgrep `*test*'|sort –u >file.out 
	</inputText> 		<command exec=”sh”/> </execNative> 

<inputText> を指定すると、<execNative> 手順の XML を生成する際に常に CDATA セクション内に包含されます。 inputText 内の文字はすべて、実行されるコマンドにそのままの形で送り込まれます。 inputText に空白文字だけを含めると、それらの空白文字は指定されているとおりに実行されるコマンドの標準入力に送り込まれます。

<inputText> のコンテンツは config 生成されます。

<inputText> 要素に属性はありません。

inputFile 子要素

<inputFile> 要素は、<execNative> の子要素です。 <inputFile> 要素は、実行されるコマンドの標準入力に送り込まれるコンテンツが入った、遠隔リモートエージェント上のローカルファイルのパスを指定するために使用されます。 ローカルファイルのパスは、<inputFile> 要素内の name 属性を使用して指定します。

<inputFile> 要素は、<execNative> コマンド内で <inputText> 要素と併用することはできません。

inputFile 要素属性

exec 子要素

<execNative> 手順には <exec> 要素を 1 つしか含めることができません。 <exec> 要素は、実行されるネイティブコマンドの詳細を指定します。

<exec> 要素には次のものが含まれます。

• 属性 cmd: 実行するコマンドの名前を指定する

• 入れ子になった一連の arg 要素: cmd で指定されるコマンドの各引数を指定する

<execNative> は、cmd 内に指定されたコマンドを、指定された引数を順に使用して直接実行します。

次に、<execNative> 手順の例を示します。

<execNative>
	<exec cmd=”ps”>
		<arg value=”-fu”/>
		<arg value=”sps”/>
	</exec>
</execNative> 

この手順は、コマンド ps –fu sps を実行します。

exec 要素属性

exec 要素の子要素

arg 子要素属性

shell 子要素

<shell> 要素は、<execNative> の子要素です。 <shell> 要素は、そのコンテンツとして実行されるコマンドを指定します。 実行されるコマンドは、cmd 属性で指定されるインタプリタによってインタプリトされます。 したがって、指定されるコマンドはそのプラットフォームの sh –c `command' 構文を使用して実行されます。 この書式では、コマンドの実行に使用するシェルコマンドを示すために cmd 属性を指定する必要があります。

(例:

<execNative>
	<shell cmd=”/usr/bin/bash -c”>
		ls –l |fgrep `*test*'|sort –u >file.out
	</shell>
</execNative> 

このコードは次のコマンドを実行します。

/usr/bin/bash –c `ls –l |fgrep `*test*'|sort –u >file.out' 

書式を保持するとともに XML の解析エラーを回避するため、<execNative> 手順から XML 表現を生成する際には常に CDATA 要素内にコマンドのテキストコンテンツが包含されます。

コマンド文字列を空の状態にしたり、空白文字だけを入れたりすることは認められません。 コマンド文字列は、(周囲の空白も含め) 指定されているとおりにシェルに送られます。

<shell> 要素のコンテンツは config 生成されます。

シェル要素の属性

successCriteria 要素

<successCriteria> 要素は、<execNative> の子要素です。 <successCriteria> 要素は、<execNative> 手順が正常に実行されたかを評価するために使用される基準を指定します。 この要素が指定されない場合のデフォルト値は次のとおりです。

<successCriteria status=”0”/> 

空の successCriteria を指定すると、successCriteria は無視されます。 次のタグを指定した場合には、

<successCriteria/> 

コマンドがどのような出力または終了コードを生成した場合でも、手順は常に成功します。

successCriteria 要素属性

inverse 属性を true に設定すると、<successCriteria> 内で指定された各条件は無視されます。

たとえば、次の successCriteria を持つ <execNative> 手順の場合、

<successCriteria status=”1” outputMatches=”bin” errorMatches=”none” inverse=”true”/> 

ステータスが 1 でなく、出力が `bin' に一致せず、エラーが `none' に一致しない場合だけ成功します。

inverse 属性だけを含む <successCriteria> 要素は、inverse 属性なしで保存されます。 つまり、次のように指定すると、

<successCriteria inverse=”true”/> 

次のように保存されます。

<successCriteria/> 

結果的に、<successCriteria> は無視されます。