Config.xml リファレンス (Windows SharePoint Services)
Windows SharePoint Services 3.0 のインストール方法を制御するときは、Setup.exe で Config.xml ファイルを使用します。config.xml ファイルを使用すると、たとえば以下のことができます。
Windows SharePoint Services 3.0 のサイレント インストールを実行する。
複数のサーバーにわたって共通の構成を使用して、Windows SharePoint Services 3.0 をインストールする。
Windows SharePoint Services 3.0 の自動インストールまたはスクリプト化されたインストールを実行する。
この記事の内容 :
Config.xml をカスタマイズする
Config.xml 要素のクイック リファレンス
動作
Config.xml ファイルの形式
Config.xml 要素のリファレンス
Config.xml をカスタマイズする
インストールを制御するには、まずテキスト エディタで Config.xml ファイルを編集して必要な要素を含め、それらの要素にとって適切な設定を指定します。次に、setup.exe /config [path and file name]
を実行し、Config.xml ファイルで設定したオプションを使用して Setup.exe を実行することを指定します。
重要
Config.xml を編集するには、メモ帳などのテキスト エディタを使用します。Microsoft Office Word 2007 などの汎用の XML エディタは使用しないでください。
製品 DVD には Config.xml ファイルのサンプルが含まれています。これらのサンプル ファイルは、DVD のルートにある \Files フォルダの下に、異なるシナリオに対応するフォルダに分けて格納されています。以下のフォルダがあります。
Setup クリーン インストールのセットアップで使用する config.xml ファイルが含まれています。サーバーまたはサーバー ファームの構成を完了するには、Setup の実行後に psconfig.exe を実行する必要があります。
SetupFarmSilent サイレント モードでのサーバー ファームのセットアップで使用する config.xml ファイルが含まれています。
SetupGradualUpgradeSilent 既存のサーバー ファームを段階的にアップグレードする場合に使用する config.xml ファイルが含まれています。
SetupSilent サイレント モードで (Windows Internal Database を使用するスタンドアロンの) 単一サーバーのクリーン インストールをセットアップする場合に使用する config.xml ファイルが含まれています。
SetupUpgradeSilent 既存のサーバー ファームを段階的にアップグレードする場合に使用する config.xml ファイルが含まれています。
重要
Windows SharePoint Services 3.0 に含まれている既定の構成ファイルでは、SETUP_REBOOT 設定が省かれています。コマンドライン インストール時の再起動を制限する場合は、この設定を含める必要があります。
さまざまなアップグレード シナリオの違いの詳細については、「アップグレード方法を決定する (Windows SharePoint Services)」を参照してください。
Config.xml 要素のクイック リファレンス
次の表は、Config.xml の要素の一覧です。これらの要素は任意の順序で記述することができます。ただし、Configuration は最初に記述する必要があります。また、Command などの要素では、Config.xml 内での順序がインストール時の処理方法に影響します。
要素 |
説明 |
Configuration |
最上位の要素です。 |
ARP |
製品についてコントロール パネルの [プログラムの追加と削除] のテキストと動作を制御する値です。 |
Command |
インストール時にコマンドを実行します。 |
Display |
セットアップがユーザーに対して表示する UI のレベルです。 |
Logging |
セットアップが実行するログ記録の種類を指定するオプションです。 |
DATADIR |
データ ファイルの格納に使用する場所です。 |
Package |
インストールするパッケージまたは製品です。 |
Setting |
Windows インストーラのプロパティの値です。 |
動作
セットアップは、Setup.exe と同じフォルダで Config.xml のコピーを検索します。この場所でコピーが見つからない場合、セットアップはインストールする製品の中心的なフォルダである \Files フォルダに置かれている Config.xml ファイルを使用します。
Setup の /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> で閉じられます。
次の例は、Windows SharePoint Services 3.0 パッケージのクリーン インストールを行うためのサンプル構成ファイルを示しています。
<Configuration>
<Package Id="sts">
<Setting Id="REBOOT" Value="ReallySuppress"/>
<Setting Id="SETUPTYPE" Value="CLEAN_INSTALL"/>
</Package>
<DATADIR Value="%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\12\Data"/>
<Logging Type="verbose" Path="%temp%" Template="Microsoft Windows SharePoint Services 3.0 Setup(*).log"/>
<Setting Id="UsingUIInstallMode" Value="1"/>
<Setting Id="SETUP_REBOOT" Value="Never"/>
</Configuration>
重要 Windows SharePoint Services 3.0 に含まれている既定の構成ファイルでは、SETUP_REBOOT 設定が省かれています。コマンドライン インストール時の再起動を制限する場合は、この設定を含める必要があります。
コメントは、"<!--" と "-->" で区切って、任意の場所に追加できます。
たとえば、次のように使用します。
<!-- Install Windows SharePoint Services for clean install, using UI-->
<Configuration>
<Package Id="sts">
<Setting Id="REBOOT" Value="ReallySuppress"/>
<!-- Tells Windows Installer not to reboot -->
<Setting Id="SETUPTYPE" Value="CLEAN_INSTALL"/>
</Package>
<DATADIR Value="%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\12\Data"/>
<Logging Type="verbose" Path="%temp%" Template="Microsoft Windows SharePoint Services 3.0 Setup(*).log"/>
<Setting Id="UsingUIInstallMode" Value="1"/>
<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 |
*Package ID* |
インストールされるパッケージです。 |
備考
Package Id 属性は、この Config.xml ファイルの影響を受ける製品とテクノロジを識別します。
例
Windows SharePoint Services 3.0 のパッケージ ID は sts です。Config.xml でパッケージ ID として sts を使用して Windows SharePoint Services 3.0 を指定するには、次のように入力します。
<Configuration>
<Package Id="sts">
...
</Package>
...
</Configuration>
ARP 要素
製品についてコントロール パネルの [プログラムの追加と削除] のテキストと動作を制御する値を指定します。
構文
<ARP attribute**="value"** [attribute**="value"**] ... />
属性
属性 |
値 |
説明 |
ARPCOMMENTS |
*text* |
追加のテキストです。最大で 255 文字まで入力できますが、一部の文字が表示されない場合があります。 |
ARPCONTACT |
*text* |
技術サポートの連絡先の一覧です。 |
ARPNOMODIFY |
Yes |
[変更] ボタンを使用できないようにして、ユーザーが製品のインストールを変更できないようにします。 |
No (既定値) |
ユーザーが製品のインストールを変更することを許可します。 |
|
ARPNOREMOVE |
Yes |
[削除] ボタンを使用できないようにして、ユーザーが製品を削除できないようにします。 |
No (既定値) |
ユーザーが製品を削除することを許可します。 |
|
ARPURLINFOABOUT |
*URL* |
製品のホーム ページの URL です。 |
ARPURLUPDATEINFO |
*URL* |
製品の更新プログラムに関する情報の URL です。 |
ARPHELPLINK |
*URL* |
ユーザーがテクニカル サポートを受けることができる Web サイトの URL です。 |
ARPHELPTELEPHONE |
*text* |
テクニカル サポートの電話番号です。 |
Command 要素
実行するコマンド ラインを指定します。Command 要素のコマンドは、初回のインストール時とアンインストール時にだけ処理されます。Command 要素のコマンドが初回のインストール後にカスタマイズのために使用された場合は、無視されます。
構文
<Command
Path="path"
[QuietArg="arguments"]
[Args="args"]
[ChainPosition="Before" | "After"(既定値)]
[Wait="mseconds"]
[QuietWait="mseconds"]
[Execute="Install"(既定値) | "Uninstall"]
[Platform="x86"(既定値) | "x64"]
/>
属性
Path 属性および Args 属性で二重引用符 (") を指定するには、二重引用符を 2 つ ("") 指定します。
属性 |
値 |
説明 |
Path |
*path* |
実行可能な Microsoft® Windows インストーラ (MSI) パッケージ ファイルへの絶対パスです。 |
QuietArg |
*string* |
Display Level=None である場合に、コマンド ラインに追加される引数の文字列です。 |
Args |
*string* |
実行可能ファイルに渡される引数の文字列です。 |
ChainPosition |
Before |
このコマンドは、主な製品のインストールの前に実行されます。 |
After (既定値) |
このコマンドは、主な製品のインストールの後に実行されます。 |
|
Wait |
*mseconds* |
Display Level 属性を "Full" または "Basic" に設定してインストールする場合、プログラムを実行してから、インストールを続行するまでに待機するミリ秒単位の時間です。既定値は 0 (ゼロ) で、待ち時間がないことを示します。 |
QuietWait |
*mseconds* |
Display Level 属性を "None" に設定してインストールする場合、プログラムを実行してから、インストールを続行するまでに待機するミリ秒単位の時間です。既定値は 0 (ゼロ) で、待ち時間がないことを示します。 |
Execute |
Install (既定値) |
セットアップは、主な製品をインストールするときにこのコマンドを実行します。 |
Uninstall |
セットアップは、主な製品をアンインストールするときにこのコマンドを実行します。 |
|
Platform |
x86 (既定値) |
このプログラムは Intel x86 プラットフォームを必要とすることを指定します。このコマンドは、インストールを実行するコンピュータがこのプラットフォームの要件に一致している場合にのみ実行されます。 |
x64 |
このプログラムが x86 アーキテクチャに対する x64 拡張機能をサポートする 64 ビット プロセッサを必要とすることを指定します。このコマンドは、インストールを実行するコンピュータがこのプラットフォームの要件に一致している場合にのみ実行されます。 |
備考
コマンド ラインは、チェーン インストールまたはこの製品をインストールするときに実行される実行可能プログラムについて指定できます。これを指定する場合は、単一の MSI ファイルではなく、Setup.exe のコマンド ラインを指定する必要があります。
Config.xml ファイルに複数の Command 要素がある場合は、Config.xml で指定されている順序で実行されます。
例
<Command Path=”myscript.exe” Args=”/id ""123 abc"" /q”/>
<Command Path="\\<server>\<share>\setup.exe /config \\<server>\<share>\<folder>\config.xml"
DATADIR 要素
検索インデックス ファイルを含めて、データ ファイルの格納に使用する場所です。
構文
<DATADIR Value="path"/>
属性
属性 |
値 |
説明 |
Value |
path |
セットアップは、指定された場所にデータ ファイルを格納します。 |
備考
このパスでは、システム環境変数を使用できます。この要素が指定されていない場合、データは次のパスに格納されます。
%ProgramFiles%\Microsoft SQL Server\MSSQL$SHAREPOINT\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 |
セットアップは、起動画面、マイクロソフト ソフトウェア ライセンス条項のページ (必要な場合)、進行状況バー、および完了通知 (許可されている場合) を表示します。 |
|
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" に設定されていない場合、セットアップはマイクロソフト ソフトウェア ライセンス条項のページを表示します。 |
備考
この要素が定義されていない場合、既定の設定が使用されます。無効な値が指定されている場合は、セットアップはインストールを終了します。
注意
セットアップで Display 要素が使用されるのは、セットアップが setup.exe と同じフォルダで Config.xml ファイルを見つけた場合、またはセットアップのコマンド ライン オプション /config を使用して Config.xml ファイルを指定した場合だけです。
例
<Display Level=”basic”
CompletionNotice=”yes”
SupressModal=”no”
AcceptEula=”yes”
/>
Logging 要素
セットアップが実行するログ記録の種類を指定します。
構文
<Logging
Type="Off" | "Standard"(既定値) | "Verbose"
Path="path"
Template="filename.txt"
/>
属性
属性 |
値 |
説明 |
Type |
Off |
セットアップはログを記録しません。 |
Standard (既定値) |
セットアップはインストール情報をログ ファイルに書き込みます。 |
|
Verbose |
セットアップはすべてのインストール情報をログ ファイルに書き込みます。 |
|
Path |
*Path* |
ログ ファイル用に使用されるフォルダへの絶対パスです。環境変数を使用できます。既定値は %temp% です。 |
Template |
*filename*.txt |
ログ ファイルの名前です。ファイル名の任意の場所に文字列 * を挿入した場合、Setup.exe によって実行される各インストールについて一意のログ ファイルが作成されます。* が含まれておらず、指定したファイル名が既に存在している場合は、既存のファイルにログ情報が追加されます。ファイル拡張子 .txt を含める必要があります。既定のテンプレートは SetupExe(*).log です。 |
備考
Template 値の任意の場所に * を指定できます。セットアップは、その場所に以下の形式で文字列を挿入します。
YYYYMMDDHHMMSSxxx
それぞれの値の意味は次のとおりです。
YYYY = 年
MM = 月
DD = 日
HH = 時
MM = 分
SS = 秒
xxx = セットアップによって生成される一意の文字列
注意
セットアップで Logging 要素が使用されるのは、セットアップのコマンド ライン オプション /config を使用して Config.xml ファイルを指定した場合だけです。使用する Config.xml ファイルを指定しない場合、セットアップは既定のログ記録オプションを使用します。
例
<Logging Type=”standard” Path=”%temp%”
Template=”MyLog(*).txt”
/>
この例では、セットアップは製品をインストールするたびにログ ファイルを作成します。次のような一意のファイル名が使用されます。
%temp%\MyLog(20060428110717CFC).txt
%temp%\MyLog(20060429113143C70).txt
Package 要素
インストールするパッケージまたは製品です。
Windows SharePoint Services 3.0 のパッケージ ID は sts です。
Setting 要素
Windows インストーラのプロパティの値を指定できます。
構文
<Setting Id="name" Value="value" />
属性
属性 |
値 |
説明 |
Id |
*name* |
Windows インストーラのプロパティの名前です。 |
Value |
*value* |
プロパティに割り当てる値です。 |
値
サーバーのインストールには、以下の設定 ID が使用されます。
ID |
指定できる値 |
説明 |
REBOOT |
ReallySuppress |
セットアップの完了後に再起動を許可するかどうかを (Windows インストーラに) 指定します。再起動しないことを指定するには、ReallySuppress を使用します。パッケージ単位ではなく、グローバル レベルで指定する必要があります。 |
SETUP_REBOOT |
Never、AutoAlways、Always、AutoIfNeeded、IfNeeded |
セットアップの完了後に再起動を許可するかどうかを (Setup.exe に) 指定します。再起動しないことを指定するには、Never を使用します。パッケージ単位ではなく、グローバル レベルで指定する必要があります。 |
SETUPTYPE |
CLEAN_INSTALL、V2V_GRADUAL_UPGRADE、V2V_INPLACE_UPGRADE |
製品またはテクノロジの新しいコピーをインストールするか (CLEAN_INSTALL)、段階的なアップグレードのために以前のバージョンを残したまま新しいバージョンをインストールするか (V2V_GRADUAL_UPGRADE)、新しいバージョンをインストールして使用中の以前のバージョンをアップグレードするか (V2V_INPLACE_UPGRADE) を指定します。パッケージ単位ではなく、グローバル レベルで指定する必要があります。 |
SETUPCALLED |
0 | 1 |
Package Id 属性の一部として使用します。 |
SERVERROLE |
SINGLESERVER、WFE |
インストール先のサーバーの種類として、スタンドアロン (SINGLESERVER) またはフロントエンド Web サーバー (WFE) を指定します。 |
USINGUIINSTALLMODE |
0 | 1 |
サイレント インストールを実行するか (0) 、セットアップにユーザー インターフェイスを使用するか (1) を指定します。 |
備考
Windows インストーラのすべてのプロパティを Setting 要素で指定できるわけではありません。ブロックされているプロパティが指定されている場合、セットアップはインストール処理を終了します。サポートされているプロパティが指定されている場合、セットアップをプロパティを直接 Windows インストーラに渡します。
例
<Setting Id="REBOOT" Value="ReallySuppress" />
このドキュメントをダウンロードする
このトピックは、簡単に読んだり印刷したりできるように、次のダウンロード可能なドキュメントに収められています。
入手可能なブックの一覧については、「Windows SharePoint Services のダウンロード可能なブック」を参照してください。