Config.xml リファレンス (SharePoint Server 2010)

  • [アーティクル]

 

適用先: SharePoint Server 2010

トピックの最終更新日: 2015-03-09

Microsoft SharePoint Server 2010 のインストール方法を制御するときは、Config.xml ファイルとセットアップ コマンド ライン ツールを使用します。Config.xml ファイルを使用すると、たとえば以下のことができます。

  • SharePoint Server 2010 のサイレント インストールを実行する。

  • 複数のサーバーで共通の構成を使用して SharePoint Server 2010 をインストールする。

  • SharePoint Server 2010 の自動インストールまたはスクリプト化インストールを実行する。

この記事の内容

  • Config.xml をカスタマイズする

  • Config.xml 要素のクイック リファレンス

  • 動作のしくみ

  • Config.xml ファイルの形式

  • Config.xml 要素のリファレンス

Config.xml をカスタマイズする

インストールを制御するには、まずテキスト エディターで Config.xml ファイルを編集して必要な要素を組み込み、それらの要素にとって適切な設定を指定します。次に setup.exe /config [path and file name] を実行して、Config.xml ファイルで設定されているオプションを使用してセットアップが実行されるようにします。

重要

Config.xml を編集するには、メモ帳などのテキスト エディターを使用します。Microsoft Office Word 2007 などの汎用の XML エディターは使用しないでください。

製品 DVD には Config.xml ファイルのサンプルが含まれています。これらのサンプル ファイルは、DVD のルートにある Files フォルダーの下の、異なるシナリオごとのフォルダーに格納されています。これらのフォルダーを以下に示します。

  • Setup   単一サーバー (スタンドアロン、SQL Express を含む) のクリーン インストールをセットアップするときに使用する Config.xml ファイルが含まれています。

  • SetupFarm   サーバー ファームのクリーン インストールをセットアップするときに使用する Config.xml ファイルが含まれています。

  • SetupFarmSilent   サイレント モードでサーバー ファームをセットアップするときに使用する Config.xml ファイルが含まれています。

  • SetupFarmUpgrade   既存のサーバー ファームをアップグレードするときに使用する Config.xml ファイルが含まれています。

  • SetupSilent   サイレント モードで単一サーバー (スタンドアロン、SQL Express を含む) のクリーン インストールをセットアップするときに使用する Config.xml ファイルが含まれています。

  • SetupSingleUpgrade   既存の単一サーバー (スタンドアロン) をアップグレードするときに使用する Config.xml ファイルが含まれています。

さまざまなアップグレード シナリオの違いの詳細については、「アップグレード方法を決定する (SharePoint Server 2010)」を参照してください。

Config.xml 要素のクイック リファレンス

以下は、Config.xml の要素の一覧表です。これらの要素は、最初に記述しなければならない Configuration 要素 を除き、任意の順序で記述できます。ただし、Command 要素 のような要素は、Config.xml 内での順序がインストール時の要素の処理方法に影響します。

要素

説明

Configuration 要素

最上位の要素です。

ARP 要素

製品についてコントロール パネルの [プログラムの追加と削除] のテキストと動作を制御する値です。

Command 要素

インストール時にコマンドを実行します。

Display 要素

セットアップがユーザーに対して表示する UI のレベルです。

INSTALLLOCATION 要素

ユーザーのコンピューター上での製品のインストール先フォルダーの完全修飾パスです。

Logging 要素

セットアップによって実行されるログ記録の種類を指定するオプションです。

DATADIR 要素

データ ファイルの格納に使用する場所です。

Package 要素

インストールするパッケージまたは製品です。

PIDKEY 要素

25 文字のボリューム ライセンス キーです。

Setting 要素

Windows インストーラーのプロパティの値です。

動作のしくみ

セットアップは、Config.xml のコピーを Setup.exe と同じフォルダー内で検索します。この場所にコピーが見つからなければ、インストールする製品のコア Files フォルダーにある Config.xml ファイルが使用されます。

セットアップの /config コマンド ライン オプションを使用して、Config.xml ファイルの場所を指定することもできます。次に例を示します。

\\<server>\<share>\setup.exe /config \\<server>\<share>\<folder>\config.xml

Config.xml ファイルの形式

Config.xml 内の XML 要素は、左山かっこ (<) で始まり、スラッシュと右山かっこ (/>) で終わります。

基本的な要素の形式は、次のとおりです。

<要素名 [属性名="値"] [属性名="値"] … />

次に例を示します。

<Display Level="none" CompletionNotice="no" />

要素と属性では、大文字と小文字が区別されます。属性値は、二重引用符 (") で囲む必要があり、大文字と小文字が区別されません。

要素の定義は複数行にわたる場合があります。要素の定義内にあるスペース、復帰、改行、およびタブ文字は無視されます。

次に例を示します。

<Display
   Level="none"
   CompletionNotice="no"
/>

ヒント

要素の定義が長い場合は、各属性を独立した行に配置してインデントを使用すると、ファイルが読みやすくなります。

Configuration 要素 要素は特殊な要素で必須です。他のすべての要素は Configuration 要素 要素内に含まれ、この要素は </Configuration> で閉じられます。

次の例は、Microsoft SharePoint Foundation 2010 パッケージのクリーン インストール用の構成ファイルを示しています。

<Configuration>

   <Package Id="sts">

      <Setting Id="SETUPTYPE" Value="CLEAN_INSTALL"/>

   </Package>

   <DATADIR Value="%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\14\Data"/>

   <Logging Type="verbose" Path="%temp%" Template="Microsoft SharePoint Foundation 2010 Setup *.log"/>

   <Setting Id="UsingUIInstallMode" Value="1"/>

   <Setting Id="SETUP_REBOOT" Value="Never"/>

</Configuration>

コメントは、"<!--" (左山かっこと感嘆符と 2 つのハイフン) と "-->" (2 つのハイフンと右山かっこ) で区切って、任意の場所に追加できます。

次に例を示します。

<!-- Install Microsoft SharePoint Server for clean install, using UI-->

<Configuration>

   <Package Id="sts">

      <Setting Id="LAUNCHEDFROMSETUPSTS" Value="Yes"/>

   </Package>

   <Package Id="spswfe">

      <Setting Id="SETUPCALLED" Value="1"/>

   </Package>

   <Logging Type="verbose" Path="%temp%" Template="SharePoint Server Setup(*).log"/>

      <!--<PIDKEY Value="Enter Product Key Here" />-->

      <Setting Id="SERVERROLE" Value="SINGLESERVER"/>

      <Setting Id="USINGUIINSTALLMODE" Value="1"/>

      <Setting Id="SETUPTYPE" Value="CLEAN_INSTALL"/>

      <Setting Id="SETUP_REBOOT" Value="Never"/>

   <!-- Tells Setup.exe not to reboot -->

</Configuration>

Config.xml 要素のリファレンス

このリファレンスの説明では、以下の表記規則を使用します。

太字

要素または属性名

通常のフォント

表示されているとおりに入力するテキスト

斜体

追加する値のプレースホルダー

x|y

複数の値からの選択

[x]

省略可能な値

Configuration 要素

最上位の要素です。この要素は必須であり、他のすべての要素はこの要素内に含まれている必要があります。

構文

<Configuration>

<Package Id="ID">

...

</Package>

...

</Configuration>

属性

属性

値

説明

Package ID

パッケージ ID

インストール対象のパッケージです。

備考

Package Id 属性は、この Config.xml ファイルの影響を受ける製品およびテクノロジを識別します。

例

SharePoint Server 2010 のパッケージ ID は spswfe です。SharePoint Server 2010 は SharePoint Foundation 2010 のプラットフォーム テクノロジに基づいているため、sts (SharePoint Foundation 2010) パッケージもインストールしないと、インストールは正常に行われません。

Config.xml 内でパッケージ ID として sts および spswfe を使用し、次のように入力して SharePoint Foundation 2010 および SharePoint Server 2010 を指定します。

<Configuration>
   <Package Id="sts">
   ...
   </Package>
   ...
   <Package Id="spswfe">
   ...
   </Package>
   ...
</Configuration>

ARP 要素

製品についてコントロール パネルの [プログラムの追加と削除] のテキストと動作を制御する値を指定します。

構文

<ARP 属性 =" 値 " [属性**="値"**] ... />

属性

属性

値

説明

ARPCOMMENTS

テキスト

追加のテキストです。最大文字数は 255 ですが、すべての文字が表示されるとは限りません。

ARPCONTACT

テキスト

技術サポートの連絡先の一覧です。

ARPNOMODIFY

Yes

[変更] ボタンを使用できないようにして、ユーザーが製品のインストールを変更できないようにします。

No (既定値)

ユーザーによる製品のインストールの変更を許可します。

ARPNOREMOVE

Yes

[削除] ボタンを使用できないようにして、ユーザーが製品を削除できないようにします。

No (既定値)

ユーザーが製品を削除することを許可します。

ARPURLINFOABOUT

URL

製品のホーム ページの URL です。

ARPURLUPDATEINFO

URL

製品の更新プログラムに関する情報の URL です。

ARPHELPLINK

URL

ユーザーがテクニカル サポートを受けることができる Web サイトの URL です。

ARPHELPTELEPHONE

テキスト

テクニカル サポートの電話番号です。

Command 要素

実行するコマンド ラインを指定します。 Command 要素のコマンドは、初回インストールおよびアンインストール時にのみ処理されます。 Command 要素のコマンドは、初回インストール後にカスタマイズに使用しても無視されます。

構文

<Command

Path=" パス "

[QuietArg="引数"]

[Args="引数"]

[ChainPosition="Before" | "After"(既定値)]

[Wait="ミリ秒"]

[Execute="Install"(既定値) | "Uninstall"]

[Platform="x86"(既定値) | "x64"]

/>

属性

Path 属性および Args 属性で二重引用符 (") を指定するには、二重引用符を 2 つ ("") 指定します。

属性

値

説明

Path

パス

実行可能な Windows インストーラー パッケージの完全修飾パスです。

QuietArg

文字列

Display 要素 Level=None である場合に、コマンド ラインに追加される引数の文字列です。

Args

文字列

実行可能ファイルに渡される引数の文字列です。

ChainPosition

Before

このコマンドは、主な製品のインストールの前に実行されます。

After (既定値)

このコマンドは、主な製品のインストールの後に実行されます。

Wait

ミリ秒

Display 要素 の Level 属性を Full または Basic に設定してインストールする場合の、プログラムを実行してからインストールを続行するまでに待機するミリ秒単位の時間です。既定値は 0 (ゼロ) で、これは待ち時間がないことを意味します。

Execute

Install (既定値)

セットアップは、主な製品をインストールするときにこのコマンドを実行します。

Uninstall

セットアップは、主な製品をアンインストールするときにこのコマンドを実行します。

Platform

x86 (既定値)

このプログラムには Intel x86 プラットフォームが必要であることを指定します。このコマンドは、インストールを実行するコンピューターがこのプラットフォーム要件に一致している場合にのみ実行されます。

x64

このプログラムには x86 アーキテクチャに対する x64 拡張機能をサポートする 64 ビット プロセッサが必要であることを指定します。このコマンドは、インストールを実行するコンピューターがこのプラットフォーム要件に一致している場合にのみ実行されます。

備考

Config.xml ファイルの Command 要素は、製品の初回インストールおよびアンインストールでのみ使用できます。Command 要素のコマンドは、初回インストールおよびアンインストール時にのみ処理されます。Command 要素のコマンドは、初回インストール後にカスタマイズに使用しても無視されます。

こうしたコマンド ラインを指定して、任意のコマンドを実行したり、この製品のインストール時に必要となる軽量な実行可能ファイルを実行したりできます。

Config.xml ファイルの Command 要素には、開発の進捗の追跡や問題のトラブルシューティングのような、エンタープライズ ソフトウェア展開および管理ツールに備わっているソフトウェア展開機能がありません。そのため、Config.xml ファイルでの Command 要素の使用は、軽量な実行可能プログラムの実行や、コンピューターに対する変更が発生しないかユーザーによる入力を必要としない任意のコマンドの実行に制限することをお勧めします。たとえば、ログをコピーするユーティリティや、インストールの最後にウェルカム ページを表示するコマンドは、実行できます。

コマンド ラインは、チェーン インストールまたはこの製品をインストールするときに実行される実行可能プログラムについて指定できます。これを指定する場合は、単一の .msi ファイルではなく、Setup のコマンド ラインを指定する必要があります。

Config.xml ファイルに複数の Command 要素がある場合は、Config.xml で指定されている順序で実行されます。

重要

チェーン処理の信頼性は、それぞれの製品を個別にインストールする場合ほど高くはありません。たとえば、チェーン処理によって 2 つの製品をインストールし、一方の製品でインストールに失敗したり予期しないエラーが発生したりすれば、主要なインストールとチェーン インストールがどちらも正常に完了しない可能性があります。そのため、チェーン処理による方法はお勧めしません。複数の製品をまとめてエンタープライズ環境にインストールするときの推奨方法は、チェーン処理ではなく、Microsoft System Center Configuration Manager 2007 や Microsoft Systems Management Server (SMS) 2003 のような展開管理プログラム、またはサード パーティ ツールを使用することです。

Args および QuietArg の使用法は、次のとおりです。

  • Args 属性は、必ずコマンドに追加されます。これには、/install や **Company=**MyCorporation のようなスイッチも含まれます。

  • サイレント セットアップの実行時 (Display が Display="none" のように設定されている場合) には、QuietArg 属性も追加されます。そのような場合は、QuietArg 属性で "/quiet" スイッチを指定できます。具体的には、QuietArg="/quiet" のように使用します。

  • Args 要素の値に引用符を含める場合は、Args='"/param value"' のように、値の全体を単一引用符 (') で囲みます。

以下では、Wait 属性について説明します。

  • Wait 属性を 0 ミリ秒に設定すると、プログラムを実行してからインストールを続行するまでの待機時間がなくなります。この場合、コマンドは実行後直ちに処理を先へと進めます。

    リターン コードは、Wait の値が 0 でない場合にのみ意味を持ちます。値に 0 を指定した場合、セットアップは指定されたプログラムの実行後、待機することなくインストールを続行します。そのため、この場合はリターン コードによって返すべき情報がありません。

  • Wait 属性に正の値を設定すると、その値をミリ秒数とした時間だけ待機が行われます。プロセスが指定の時間よりも早く終了した場合は、セットアップが続行されます。指定した時間が経過してもプロセスが終了しない場合、セットアップは失敗します。

  • Wait 属性を -1 に設定すると、待機状態がいつまでも続くことになります。コマンド プロセスが応答を停止 (ハング) すると、セットアップも応答しなくなり、そのコマンドの実行をいつまでも待ち続けるので、この設定は問題を発生させる可能性があります。

例

<Command Path="\\server\share\myscript.exe" Args='/id "123 abc"' QuietArg="/q" Wait="3000">

<Command Path="\\<server>\<share>\setup.exe /config \\<server>\<share>\<folder>\config.xml"

DATADIR 要素

検索インデックス ファイルを含めて、データ ファイルの格納に使用する場所です。

構文

<DATADIR Value=" パス "/>

属性

属性

値

説明

Value

パス

セットアップは、指定された場所にデータ ファイルを格納します。

備考

パスにはシステム環境変数を使用できます。この要素を指定しないと、データは次のパスに格納されます。

%PROGRAMFILES%\Microsoft Office Servers\14.0\Data

例

<DATADIR Value="d:\data"/>

Display 要素

セットアップがユーザーに対して表示する UI のレベルです。

構文

<Display

Level="None" | "Basic" | "Full"(既定値)

CompletionNotice="Yes"(既定値) | "No"

SuppressModal="Yes" | "No"(既定値)

NoCancel="Yes" | "No"(既定値)

AcceptEula="Yes" | "No"(既定値)

/>

属性

属性

値

説明

Level

None

セットアップの UI は表示されません。

Basic

セットアップは、ようこそ画面、プロダクト キー (PIDKEY) のページ (必要な場合)、マイクロソフト ソフトウェア ライセンス条項のページ (必要な場合)、進行状況バー、および完了通知 (許可されている場合) を表示します。

Full (既定値)

セットアップはユーザーに対してすべての UI を表示します。

CompletionNotice

Yes

Level が Basic または None に設定されている場合にのみ適用されます。セットアップは完了通知を表示します。

No (既定値)

Level が Basic に設定されている場合にのみ適用されます。セットアップは完了通知を表示しません。

SuppressModal

Yes

Level が Basic に設定されている場合にのみ適用されます。セットアップは、インストールを中断するエラー メッセージおよびその他のダイアログ ボックスを表示しません。

No (既定値)

Level が Basic に設定されている場合にのみ適用されます。セットアップは、必要に応じてエラーおよびその他のダイアログ ボックスを表示します。

NoCancel

Yes

Level が Full または Basic に設定されている場合に、キャンセル ボタン (進行状況ダイアログ ボックスの右上隅の X) を無効にします。

No (既定値)

Level が Full または Basic に設定されている場合に、ユーザーが進行状況バーからインストールを取り消すことができるようにします。

AcceptEULA

Yes

マイクロソフト ソフトウェア ライセンス条項はユーザーに代わって同意されます。セットアップはマイクロソフト ソフトウェア ライセンス条項のページを表示しません。

No (既定値)

Level が None に設定されていない場合、セットアップはマイクロソフト ソフトウェア ライセンス条項のページを表示します。

備考

この要素が定義されていない場合、既定の設定が使用されます。無効な値が指定されている場合は、セットアップはインストールを終了します。

Level 属性が Basic または None に設定されていて、PIDKEY 要素 要素を使用してプロダクト キーを指定した場合、セットアップは管理者がユーザーの代わりにライセンス条項にも同意したものと見なします。この場合は、AcceptEULA 属性の設定に関係なく、インストール時にライセンス条項の確認がユーザーに求められることはありません。

注意

Display 要素がセットアップによって使用されるのは、Setup.exe と同じフォルダーに Config.xml ファイルが見つかった場合、またはセットアップのコマンド ライン オプション /config を使用して Config.xml ファイルを指定した場合に限られます。

例

<Display Level="basic"
   CompletionNotice="yes"
   SupressModal="no"
   AcceptEula="yes"
/>

INSTALLLOCATION 要素

ユーザーのコンピューター上での製品のインストール先フォルダーの完全修飾パスを指定します。

構文

<INSTALLLOCATION Value=" パス " />

属性

属性

値

説明

Value

パス

ユーザーのコンピューター上での製品のインストール先フォルダーの完全修飾パスです。

備考

パスにはシステム環境変数を使用できます。この要素を指定しないと、製品は次のパスにインストールされます。

%PROGRAMFILES%\Microsoft Office Servers\14.0\

SharePoint Foundation 2010 テクノロジは、この要素による影響を受けず、次のパスにインストールされます。

%COMMONPROGRAMFILES%\Common Files\Microsoft Shared\Web Server Extensions\14

例

<INSTALLLOCATION VALUE="%ProgramFiles%\MyApps" />

Logging 要素

セットアップが実行するログ記録の種類を指定します。

構文

<Logging

Type="Off" | "Standard"(既定値) | "Verbose"

Path=" パス "

Template=" ファイル名 .txt"

/>

属性

属性

値

説明

Type

Off

セットアップはログ記録を実行しません。

Standard (既定値)

セットアップはインストール情報をログ ファイルに書き込みます。

Verbose

セットアップはすべてのインストール情報をログ ファイルに書き込みます。

Path

パス

ログ ファイル用に使用されるフォルダーの完全修飾パスです。環境変数が使用できます。既定値は %temp% です。

Template

ファイル名 .txt

ログ ファイルの名前です。ファイル名の任意の場所に文字列 * を挿入すると、セットアップによって実行されるインストールごとに固有のログ ファイルが作成されます (詳細については後述します)。* が含まれておらず、指定したファイル名が既に存在している場合は、その既存のファイルにログ情報が追加されます。ログ ファイルの名前には、ファイル拡張子 .txt を含める必要があります。既定のテンプレートは SetupExe(*).log です。

備考

Template 値の任意の場所に * を指定できます。セットアップは、その場所に次の形式で文字列を挿入します。

YYYYMMDDHHMMSSxxx

各部分の意味は次のとおりです。

  1. YYYY = 年

  2. MM = 月

  3. DD = 日

  4. HH = 時

  5. MM = 分

  6. SS = 秒

  7. xxx = セットアップによって生成される一意の文字列

注意

セットアップで Logging 要素が使用されるのは、セットアップのコマンド ライン オプション /config を使用して Config.xml ファイルを指定した場合だけです。使用する Config.xml ファイルを指定しない場合、セットアップは既定のログ記録オプションを使用します。

例

<Logging Type="standard" Path="%temp%"
   Template="MyLog(*).txt"
/>

この例では、セットアップによるログ ファイルの作成が製品のインストールごとに行われます。セットアップは、次のような固有のファイル名を使用します。

%temp%\MyLog(20060428110717CFC).txt
%temp%\MyLog(20060429113143C70).txt

Package 要素

インストールするパッケージまたは製品です。

SharePoint Server 2010 のパッケージ ID は spswfe です。SharePoint Server 2010 は SharePoint Foundation 2010 のプラットフォーム テクノロジに基づいているため、sts (SharePoint Foundation 2010) パッケージもインストールしないと、インストールは正常に行われません。

PIDKEY 要素

25 文字のボリューム ライセンス キーです。

構文

<PIDKEY Value=" 25 文字のキー " />

属性

属性

値

説明

Value

25 文字のキー

25 文字のボリューム ライセンス キーです。

備考

PIDKEY 値が設定されている場合、ユーザーはセットアップを実行するときにプロダクト キーを入力する必要がありません。

例

<PIDKEY Value="1234512345123451234512345" />

注意

Display 要素 要素の Level 属性が Basic または None に設定されていて、PIDKEY 要素を使用してプロダクト キーを指定した場合、セットアップは管理者がユーザーの代わりにライセンス条項にも同意したものと見なします。この場合は、Display 要素 要素の AcceptEULA 属性の設定に関係なく、インストール時にライセンス条項の確認がユーザーに求められることはありません。

Setting 要素

Windows インストーラーのプロパティの値を指定できます。

構文

<Setting Id=" 名前 " Value=" 値 " />

属性

属性

値

説明

Id

名前

Windows インストーラー プロパティの名前です。

Value

値

このプロパティに割り当てる値です。

値

サーバーへのインストールには以下の設定 ID が使用されます。

ID

使用できる値

説明

LAUNCHEDFROMSETUPSTS

Yes | No

Package Id 属性の一部として使用します。既定値は Yes です。

REBOOT

ReallySuppress

セットアップの完了後に再起動を許可するかどうかを (Windows インストーラーに) 指定します。再起動しないことを指定するには、ReallySuppress を使用します。パッケージ単位ではなく、グローバル レベルで指定する必要があります。

SETUP_REBOOT

Never、AutoAlways、Always、AutoIfNeeded、IfNeeded

セットアップの完了後に再起動を許可するかどうかを (セットアップに) 指定します。再起動しないことを指定するには、Never を使用します。パッケージ単位ではなく、グローバル レベルで指定する必要があります。

SETUPTYPE

CLEAN_INSTALL、V2V_INPLACE_UPGRADE、SKU2SKU_UPGRADE

製品またはテクノロジの新しいコピーをインストールするか (CLEAN_INSTALL)、新しいバージョンをインストールして使用中の以前のバージョンをアップグレードするか (V2V_INPLACE_UPGRADE)、1 つの製品から別の製品 (SharePoint Foundation 2010 から SharePoint Server 2010 など) にアップグレードするかを指定します。パッケージ単位ではなく、グローバル レベルで指定する必要があります。

SETUPCALLED

0 | 1

Package Id 属性の一部として使用します。

SERVERROLE

SINGLESERVER、APPLICATION

インストール先のサーバーの種類 (スタンドアロン (SINGLESERVER)、またはアプリケーション (APPLICATION) を指定します。

USINGUIINSTALLMODE

0 | 1

サイレント インストールを実行するか (0) 、セットアップにユーザー インターフェイスを使用するか (1) を指定します。

備考

Windows インストーラーのすべてのプロパティが Setting 要素によって指定できるわけではありません。ブロックされるプロパティが指定されている場合、セットアップはインストール処理を終了します。サポートされるプロパティが指定されている場合、セットアップはそのプロパティを直接 Windows インストーラーに渡します。Windows インストーラーのすべてのプロパティの一覧と、サポートおよびブロックされるプロパティの説明については、「Office 2010 のセットアップ プロパティ」を参照してください。

例

<Setting Id="REBOOT" Value="ReallySuppress" />