XML ファイルでのターゲット・システムの指定

XML ファイルを使用して、エージェントの更新またはインストールを行うターゲット・システムを指定します。

XML ファイルの概要

「エージェント更新およびデプロイメント」ユーティリティーには、エージェントの更新またはインストールを行うコンピューターを決定する XML ファイルが必要です。このファイルでは、ユーティリティーで必要なログイン資格情報やその他の項目も指定する必要があります。

ファイルには以下の要件があります。

  • 他のエレメントを格納する 1 つの <AgentDeploymentAndUpdate> エレメント
  • 各ターゲット・コンピューターを指定する 1 つ以上の <Target> エレメント
  • <Globals> エレメントを使用する場合は、1 つのみ使用できます。このエレメントを、すべてのターゲット・コンピューターに適用する項目に対して使用します。

以下の例に、単一の <Target> エレメントと <Globals> エレメントを示します。<Globals> エレメントは、単一の <Target> エレメントと共に使用しても効果的ではありません。 <Globals> エレメントは、複数の <Target> エレメントがある場合に使用するのが効果的です。

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

<Target id="9.184.112.152">
<Parameter Name="ConnectionType" Value="ssh"/>
<Parameter Name="UserName" Value="root"/>
<Parameter Name="Password" Value="passWord"/>
<Parameter Name="ExistingAgentPath" Value="/usr/local/bin/bfagent"/>
<Parameter Name="GZIPPath" Value="/usr/contrib/bin/"/>
</Target>

<Globals>
<Parameter Name="KeyFile" Value="..¥test¥keyfile.txt"/>
</Globals>

</AgentDeploymentAndUpdate>

XML ファイルの構文

各 <Parameter> エレメントは、<Target> と <Globals> の両方のエレメントで有効です。この柔軟性により、パラメーターをすべてのターゲット・コンピューターに適用する場合に、<Target> エレメントを使用して id 属性のみを指定して、各 <Parameter> エレメントを <Globals> エレメント内に配置することができます。

パラメーターで Value="" と指定することは、パラメーターを指定しないことと同じ意味になります。

下の表で、ファイル構文について説明します。

ターゲット属性
id ターゲット・コンピューターの名前または IP アドレス。
パラメーター
AgentInstallLocation IBM AIX、HP-UX、および Windows の各システムの場合のみ。その他のプラットフォームでは無効になります。

新規エージェントの配置場所。指定がない場合は、システム・デフォルトの一時ディレクトリーが使用されます。

BFAgentPort IBM AIX および HP-UX の各システムの場合のみ。

使用するエージェント用のポート。応答ファイルの生成時に使用されます。

BFASolarisAdminFile Solaris システムの場合のみ。

サイレント・インストール用の応答ファイルを保管するターゲット・システム上の場所。 指定がない場合は、システム・デフォルトの一時ディレクトリーが使用されます。

BFASolarisResponseFile Solaris システムの場合のみ。

応答ファイルを保管するターゲット・システム上の場所。 指定がない場合は、システム・デフォルトの一時ディレクトリーが使用されます。

ConnectionType UNIX または Linux の場合: SSH または RSH

Windows の場合: SSH、RSH、SMB、または CIFS

(RSH はリモート・シェルです。SMB は Server Message Block です。 CIFS は Common Internet File System です。)

ConnectionPort (オプション) ターゲットでデフォルト・ポートを使用しない場合に、(ConnectionType パラメーターで) 指定した接続タイプに対して使用するポート番号。ターゲットでデフォルト・ポートを使用する場合は、このパラメーターを指定する必要はありません。
ExistingAgentPath IBM AIX、HP-UX、および Windows の各システムで必要。

ターゲット・コンピューター上の既存のエージェントの場所。ユーティリティーは、指定した場所にある BFAgent.conf ファイルのバックアップを作成し、インストールまたはアップグレードの完了後にリストアします。他のシステムの場合、デフォルトのシステム・インストール場所が使用されます。

GZIPPath IBM AIX、HP-UX、および Solaris の各システム。

エージェント・インストーラーによって (インストーラーを解凍する) gzip コマンドが検出されるディレクトリー。

IsSudoEnabled ターゲット・システムで有効になっている sudo を使用する場合は yes に設定します。SudoPassword を適切な sudo パスワードに設定します。設定されていない場合、ユーティリティーは sudo ログインに対して Password の使用を試みます。
KeyFile ユーティリティーを実行するコンピューター上にある、パスワードの暗号化と暗号化解除に使用する鍵を保管するためのファイル。
LocalTempLocation IBM AIX、HP-UX、および Windows の場合のみ。

応答ファイルを保管するターゲット・システム上の場所。 指定がない場合は、システム・デフォルトの一時ディレクトリーが使用されます。Solaris システムの場合は、BFASolarisResponseFile または BFASolarisAdminFile を使用します。

ManagedScriptsDir ユーティリティーが実行されるディレクトリーに設定します。 このディレクトリーは、agentupdate ユーティリティーを実行するコンピューター上にあります。
SourceDirectory ターゲット・コンピューター用の (.exe、.rpm、および .gz フォームの) インストーラーを保管するディレクトリー。このディレクトリーは、agentupdate ユーティリティーを実行するコンピューター上にあります。
StartCommand (オプション) ターゲット・コンピューター上の Rational Build Forge エージェントを開始するためにカスタマイズしたコマンド。

このコマンドを必ず PATH/path 変数に組み込むか、または XML ファイルに絶対パスを指定してください。

StopCommand (オプション) ターゲット・コンピューター上の Rational Build Forge エージェントを停止するためにカスタマイズしたコマンド。

このコマンドを必ず PATH/path 変数に組み込むか、または XML ファイルに絶対パスを指定してください。

SudoPassword sudo 用に使用するパスワード。IsSudoEnabled を参照してください。
パスワード ターゲット・コンピューターへのログオン時に UserName 用に使用するパスワード。
重要: 最初に、XML ファイルに Password パラメーターを平文で定義します。次に、agentupdate ユーティリティーの実行に示されているように、-encrypt コマンド行オプションを使用して、パスワードを暗号化します。
TemporaryLocation ユーティリティーを実行する前にインストーラーを保管するターゲット・コンピューター上の場所。
UseManagedScripts yes または no に設定します。yes に設定した場合、ユーティリティーは、ManagedScriptsDir ディレクトリー内の StartCommand および StopCommand の検索を試みます。
UserName ターゲット・コンピューターへのログオン時に使用するユーザー名。

サンプル XML ファイル

以下のサンプルで、XML ファイルの使用法を示します。

  • サンプル 1

    このサンプルでは、ターゲットは 1 つしかありません。ターゲット IP アドレスは 9.164.259.143 です。<Target> エレメントには、オプション・パラメーターの SourceDirectoryTemporaryLocation も含まれていません。 ただし、<Globals> エレメントには SourceDirectory パラメーターが含まれています。 ユーティリティーは、このパラメーターの値をターゲットに使用します。

    <?xml version="1.0" encoding="UTF-8"?>
    <AgentDeploymentAndUpdate>
    
    <Globals>
    <Parameter Name="SourceDirectory" Value="..¥test"/>
    <Parameter Name="KeyFile" Value="..¥test¥keyfile.txt"/>
    </Globals>
    
    <Target id="9.164.259.143">
    <Parameter Name="ConnectionType" Value="ssh"/>
    <Parameter Name="UserName" Value="root"/>
    <Parameter Name="Password" Value="toor"/>
    <Parameter Name="ExistingAgentPath" Value="/usr/local/bin/bfagent"/>
    <Parameter Name="AgentInstallLocation" Value="/usr/local/bin/bfagent"/>
    </Target>
    
    </AgentDeploymentAndUpdate>
  • サンプル 2

    このサンプルでは、ターゲットが 4 つあります。ただし、どのターゲットにもそれぞれに固有のパラメーターは必要ありません。したがって、UserNamePassword、および ConnectionType を含むすべてのパラメーターが、<Globals> セクションに指定されています。

    <?xml version="1.0" encoding="UTF-8"?>
    <AgentDeploymentAndUpdate>
    
    <Globals>
    <Parameter Name="SourceDirectory" Value="..¥test"/>
    <Parameter Name="ConnectionType" Value="ssh"/>
    <Parameter Name="UserName" Value="root"/>
    <Parameter Name="Password" Value="toor"/>
    <Parameter Name="TemporaryLocation" Value="/tmp"/>
    <Parameter Name="ExistingAgentPath" Value="/usr/local/bin/bfagent"/>
    <Parameter Name="AgentInstallLocation" Value="/usr/local/bin/bfagent"/>
    <Parameter Name="KeyFile" Value="..¥test¥keyfile.txt"/>
    </Globals>
    
    <Target id="9.164.259.143">
    </Target>
    
    <Target id="9.164.102.169">
    </Target>
    
    <Target id="9.164.102.196">
    </Target>
    
    <Target id="9.106.189.157">
    </Target>
    
    </AgentDeploymentAndUpdate>
  • サンプル 3

    ターゲット・システム用の IP アドレスの範囲を指定できます。 以下は、各システムで同じログイン資格情報 (ログイン: root、パスワード: password) を使用した、IP アドレスの範囲が 9.184.112.152 から 9.184.112.160 までの場合の例です。

    <?xml version="1.0" encoding="UTF-8"?>
    <AgentDeploymentAndUpdate>
    <Target id=”9.184.112.152-160”>
    <Parameter Name="ConnectionType" Value="ssh">
    <Parameter Name="ConnectionPort" Value=""/>
    <Parameter Name="UserName" Value="root">
    <Parameter Name="Password" Value="passWord">
    </Target>
    </AgentDeploymentAndUpdate>
  • サンプル 4

    すべてのターゲットのプロパティー (接続タイプ、接続ポート、ユーザー名、パスワード) が同じである場合は、それらのプロパティーをファイルの Globals セクションで指定できます。

    <?xml version="1.0" encoding="UTF-8"?>
    <AgentDeploymentAndUpdate>
    <Globals>
    <Parameter Name="ConnectionType" Value="ssh">
    <Parameter Name="ConnectionPort" Value="">
    <Parameter Name="UserName" Value="root">
    <Parameter Name="Password" Value="passWord">
    </Globals>
    
    <Target id=”9.184.112.152-160”>
    </Target>
    
    <Target id=”9.184.80.12-16”>
    </Target>
    </AgentDeploymentAndUpdate>

フィードバック