Référence de Config.xml (SharePoint Foundation 2010)

 

S’applique à : SharePoint Foundation 2010

Dernière rubrique modifiée : 2015-03-09

Lorsque vous souhaitez contrôler la façon dont Microsoft SharePoint Foundation 2010 est installé, utilisez le fichier Config.xml et l’outil en ligne de commande Setup. Vous pouvez par exemple utiliser le fichier Config.xml pour effectuer les opérations suivantes :

  • effectuer une installation en mode silencieux de SharePoint Foundation 2010 ;

  • installer SharePoint Foundation 2010 en utilisant une configuration commune à plusieurs serveurs ;

  • effectuer une installation automatisée ou à base de script de SharePoint Foundation 2010.

Dans cet article :

  • Personnalisation de Config.xml

  • Aide-mémoire sur les éléments du fichier Config.xml

  • Fonctionnement

  • Format du fichier Config.xml

  • Guide de référence sur les éléments du fichier Config.xml

Personnalisation de Config.xml

Pour contrôler l’installation, commencez par modifier le fichier Config.xml dans un éditeur de texte afin d’y inclure les éléments souhaités ainsi que leurs paramètres appropriés. Ensuite, exécutez setup.exe /config [path and file name] pour spécifier que le programme d’installation s’exécutera et utilisera les options que vous avez définies dans le fichier Config.xml.

Important

Utilisez un éditeur de texte, tel que le Bloc-notes, pour modifier le fichier Config.xml. N’utilisez pas un éditeur XML à usage général, tel que Microsoft Office Word 2007.

Le DVD du produit contient des exemples de fichiers Config.xml. Ceux-ci sont stockés dans le dossier Files à la racine du DVD, dans des dossiers qui correspondent aux différents scénarios. Il s’agit des dossiers suivants :

  • Setup   Contient un fichier Config.xml utilisable lors de la configuration d’une nouvelle installation. Vous devez exécuter l’outil en ligne de commande Psconfig après avoir exécuté le programme d’installation, afin de terminer la configuration du serveur ou de la batterie de serveurs.

  • SetupFarmSilent   Contient un fichier Config.xml utilisable pour la configuration d’une batterie de serveurs en mode silencieux.

  • SetupSilent   Contient un fichier Config.xml file utilisable pour la configuration d’une nouvelle installation pour un serveur unique (autonome, avec Base de données interne Windows) en mode silencieux.

  • SetupUpgradeSilent   Contient un fichier Config.xml file utilisable lors de la mise à niveau d’une batterie de serveurs existante sur place.

Pour plus d’informations sur les différences entre les différents scénarios de mise à niveau, voir Déterminer l’approche de mise à niveau (SharePoint Foundation 2010).

Aide-mémoire sur les éléments du fichier Config.xml

Le tableau suivant contient une liste d’éléments du fichier Config.xml. Ces éléments peuvent apparaître dans n’importe quel ordre, à l’exception de l’élément Élément Configuration, qui doit être le premier élément du fichier, et des éléments tels que Élément Command, dont la place dans le fichier Config.xml influe sur leur traitement au cours de l’installation.

Élément

Description

Élément Configuration

Élément de niveau supérieur.

Élément ARP

Valeurs qui déterminent le texte et le comportement de l’option Ajouter ou supprimer des programmes dans le Panneau de configuration du produit.

Élément Command

Exécute une commande durant l’installation.

Élément Display

Niveau d’interface utilisateur affiché pour l’utilisateur par le programme d’installation.

Élément Logging

Options déterminant le type de journalisation mis en œuvre par le programme d’installation.

Élément DATADIR

Emplacement à utiliser pour stocker les fichiers de données.

Élément Package

Package ou produit à installer.

Élément Setting

Valeurs des propriétés de Windows Installer.

Fonctionnement

Le programme d’installation recherche une copie de Config.xml dans le même dossier que Setup.exe. En l’absence de copie à cet endroit, le programme d’installation utilise le fichier Config.xml qui réside dans le dossier Files principal du produit en cours d’installation.

Vous pouvez également utiliser l’option de ligne de commande /config du programme d’installation pour indiquer l’emplacement du fichier Config.xml. Par exemple :

\\<serveur>\<partage>\setup.exe /config \\<serveur>\<partage>\<dossier>\config.xml

Format du fichier Config.xml

Les éléments XML dans Config.xml commencent par un crochet pointu (<) et se terminent par une barre oblique et un crochet pointu (/>).

Le format de base des éléments est le suivant :

<nom_élément [nom_attribut="valeur"] [nom_attribut="valeur"] … />

Par exemple :

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

Les éléments et les attributs respectent la casse. Les valeurs des attributs doivent être placées entre guillemets (") et ne respectent pas la casse.

Une définition d’élément peut s’étendre sur plusieurs lignes. Les espaces, retours chariot, sauts de ligne et caractères de tabulation sont ignorés dans une définition d’élément.

Par exemple :

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

Conseil

Dans le cas de définitions d’élément longues, placez les attributs sur des lignes distinctes et utilisez des retraits pour faciliter la lecture du fichier.

L’élément Élément Configuration est un cas particulier et est obligatoire. Tous les autres éléments sont contenus dans l’élément Élément Configuration, qui se termine par </Configuration>.

L’exemple suivant montre un fichier de configuration pour une nouvelle installation du package 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>

Il est possible d’ajouter des commentaires à n’importe quel endroit, délimités d’un côté par un crochet pointu, un point d’exclamation et deux tirets (<!--) et de l’autre côté par deux tirets et un crochet pointu (-->).

Par exemple :

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

Guide de référence sur les éléments du fichier Config.xml

Les conventions ci-dessous sont utilisées dans les descriptions de ce guide de référence :

gras

Nom d’élément ou d’attribut

régulier

Texte à entrer en recopiant exactement le texte indiqué

italique

Espace réservé pour une valeur à ajouter

x|y

Choisir parmi plusieurs valeurs

[x]

Valeur facultative

Élément Configuration

Élément de niveau supérieur. Cet élément est obligatoire et tous les autres éléments doivent être inclus dans cet élément.

Syntaxe

<Configuration>

<Package Id="ID">

...

</Package>

...

</Configuration>

Attributs

Attribut

Valeur

Description

Package ID

ID de package

Package en cours d’installation.

Remarques

L’attribut Package ID identifie le produit et les technologies affectés par ce fichier Config.xml.

Exemple

L’ID de package pour SharePoint Foundation 2010 est sts. Utilisez l’ID de package sts dans Config.xml pour spécifier SharePoint Foundation 2010 en entrant ce qui suit :

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

Élément ARP

Valeurs spécifiques qui déterminent le texte et le comportement de l’option Ajouter ou supprimer des programmes dans le Panneau de configuration du produit.

Syntaxe

<ARP attribut =" valeur " [attribut**="valeur"**] ... />

Attributs

Attribut

Valeur

Description

ARPCOMMENTS

texte

Texte supplémentaire ; peut comporter jusqu’à 255 caractères. Sachez toutefois que tous les caractères risquent de ne pas s’afficher.

ARPCONTACT

texte

Liste de coordonnées de services de support technique.

ARPNOMODIFY

Yes

Empêche les utilisateurs de modifier l’installation du produit en masquant le bouton Modifier.

No (par défaut)

Autorise les utilisateurs à modifier l’installation du produit.

ARPNOREMOVE

Yes

Empêche les utilisateurs de supprimer le produit en masquant le bouton Supprimer.

No (par défaut)

Autorise les utilisateurs à supprimer le produit.

ARPURLINFOABOUT

URL

URL de la page d’accueil du produit.

ARPURLUPDATEINFO

URL

URL permettant d’obtenir des informations sur les mises à jour du produit.

ARPHELPLINK

URL

URL d’un site Web à partir duquel les utilisateurs peuvent bénéficier d’un support technique.

ARPHELPTELEPHONE

texte

Numéros de téléphone de support technique.

Élément Command

Spécifie une ligne de commande à exécuter. Les commandes de l’élément Command sont traitées uniquement pendant les installations et désinstallations initiales. Si des commandes d’élément Command sont utilisées à des fins de personnalisation après l’installation initiale, elles sont ignorées.

Syntaxe

<Command

Path=" chemin_accès "

[QuietArg="arguments"]

[Args="arguments"]

   [ChainPosition="Before" | "After"(par défaut)]

[Wait="millisecondes"]

[Execute="Install"(par défaut) | "Uninstall"]

[Platform="x86"(par défaut) | "x64"]

/>

Attributs

Vous pouvez spécifier des guillemets doubles (") dans les attributs Path et Args en spécifiant deux guillemets doubles ensemble ("").

Attribut

Valeur

Description

Path

chemin_accès

Chemin d’accès complet au package Windows Installer exécutable.

QuietArg

chaîne

Chaîne d’arguments à ajouter à la ligne de commande lorsque Élément DisplayLevel=None.

Args

chaîne

Chaîne d’arguments à passer à l’exécutable.

ChainPosition

Before

Cette commande est exécutée avant l’installation du produit principal.

After (par défaut)

Cette commande est exécutée après l’installation du produit principal.

Wait

millisecondes

Lorsque vous effectuez une installation en affectant la valeur Full ou Basic à l’attribut Élément DisplayLevel, il s’agit du nombre de millisecondes qui doivent s’écouler entre l’exécution du programme et la poursuite de l’installation. La valeur par défaut est 0 (zéro), qui définit un délai d’attente nul.

Execute

Install (par défaut)

Le programme d’installation exécute cette commande lorsque le produit principal est installé.

Uninstall

Le programme d’installation exécute cette commande lorsque le produit principal est désinstallé.

Platform

x86 (par défaut)

Indique que ce programme requiert une plateforme Intel x86. Cette commande s’exécute uniquement si l’ordinateur sur lequel l’installation est exécutée correspond à cette plateforme.

x64

Indique que ce programme requiert un processeur 64 bits prenant en charge les extensions x64 de l’architecture x86. Cette commande s’exécute uniquement si l’ordinateur sur lequel l’installation est exécutée correspond à cette plateforme.

Remarques

L’élément Command dans le fichier Config.xml est destiné uniquement aux installations et désinstallations de produit. Les commandes de l’élément Command sont traitées uniquement pendant les installations et désinstallations initiales. Si les commandes de l’élément Command sont utilisées pour les personnalisations après l’installation initiale, elles sont ignorées.

La ligne de commande peut être spécifiée de façon à exécuter une commande arbitraire ou un exécutable léger que vous souhaitez exécuter lors de l’installation de ce produit.

L’élément Command dans Config.xml ne procure pas les fonctionnalités de déploiement logiciel offertes par un outil de gestion et de déploiement logiciel d’entreprise, telles que la capacité à suivre la progression du déploiement et à résoudre les problèmes. Nous vous recommandons par conséquent de limiter l’usage de l’élément Command dans Config.xml à l’exécution d’un programme exécutable léger ou d’une commande arbitraire ne modifiant pas l’ordinateur ou ne nécessitant aucune entrée de la part de l’utilisateur. Par exemple, vous pouvez exécuter un utilitaire pour copier des journaux ou une commande pour lancer une page d’accueil à l’issue de l’installation.

La ligne de commande peut être spécifiée pour une installation chaînée ou un exécutable qui s’exécute lorsque ce produit est installé. Dans ce cas, vous devez spécifier une ligne de commande pour le programme d’installation au lieu d’un fichier .msi unique.

Si deux éléments Command ou plus sont présents dans le fichier Config.xml, ils sont exécutés dans l’ordre spécifié dans Config.xml.

Important

Le chaînage n’offre pas le même niveau de fiabilité que l’installation distincte de chaque produit. Par exemple, si vous chaînez deux installations ensemble et que l’un des produits échoue ou rencontre une erreur inattendue, l’installation principale et l’installation chaînée peuvent ne pas se dérouler correctement. Par conséquent, l’approche du chaînage n’est pas recommandée. La méthode recommandée pour l’installation conjointe de plusieurs produits dans des environnements d’entreprise consiste à faire appel à un programme de gestion du déploiement, tel que Microsoft System Center Configuration Manager 2007 ou Systems Management Server (SMS) 2003, ou un outil tiers, plutôt qu’au chaînage.

L’utilisation des attributs Args et QuietArg est la suivante :

  • L’attribut Args est toujours ajouté à la commande. Il peut inclure des commutateurs tels que /install ou **Company=**MonEntreprise.

  • L’attribut QuietArg est également ajouté si le programme d’installation est exécuté en mode silencieux (avec Display défini comme Display="none"). Dans ces cas-là, vous pouvez spécifier l’attribut QuietArg avec le commutateur "/quiet". Vous pouvez par exemple utiliser : QuietArg="/quiet".

  • Si la valeur de l’élément Args comprend des guillemets, vous pouvez mettre la valeur entière entre des guillemets simples (') comme dans l’exemple suivant :Args='"/param value"'

Les instructions suivantes s’appliquent à l’attribut Wait :

  • Attribuer à l’attribut Wait la valeur de 0 milliseconde indique une attente nulle entre l’exécution du programme et la poursuite de l’installation.

    Les codes de retour sont respectées uniquement si la valeur Wait est différente de zéro. Si vous spécifiez 0, le programme d’installation n’attendra pas pour poursuivre l’installation après avoir exécuté le programme spécifié. Par conséquent, il n’y a pas de code de retour à rapporter dans ce cas.

  • Attribuer à l’attribut Wait n’importe quelle valeur positive différente de zéro détermine une attente du nombre exact de millisecondes que vous spécifiez. Si le processus se termine avant le délai spécifié, le programme d’installation poursuit son exécution. Si le processus n’a pas terminé à l’issue du délai spécifié, l’installation échoue.

  • Attribuer à l’attribut Wait la valeur -1 indique d’attendre indéfiniment. Cela peut être problématique, car si le processus de commande cesse de répondre (se fige), le programme d’installation cesse de répondre et attend indéfiniment que la commande s’exécute.

Exemple

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

Élément DATADIR

Emplacement à utiliser pour stocker les fichiers de données, y compris les fichiers d’index de recherche.

Syntaxe

<DATADIR Value=" chemin_accès "/>

Attributs

Attribut

Valeur

Description

Value

chemin_accès

Le programme d’installation stocke les fichiers de données à l’emplacement spécifié.

Remarques

Vous pouvez utiliser des variables d’environnement système dans le chemin d’accès. Si cet élément n’est pas spécifié, les données sont stockées à l’emplacement suivant :

%ProgramFiles%\Microsoft SQL Server\MSSQL$SHAREPOINT\Data

Exemple

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

Élément Display

Niveau d’interface utilisateur affiché pour l’utilisateur par le programme d’installation.

Syntaxe

<Display

Level="None" | "Basic" | "Full"(par défaut)

CompletionNotice="Yes"(par défaut) | "No"

SuppressModal="Yes" | "No"(par défaut)

NoCancel="Yes" | "No"(par défaut)

AcceptEula="Yes" | "No"(par défaut)

/>

Attributs

Attribut

Valeur

Description

Level

None

Aucune interface de programme d’installation ne s’affiche.

Basic

Le programme d’installation affiche l’écran d’accueil, la page Termes du contrat de licence logiciel Microsoft (si nécessaire), une barre de progression et l’avertissement de fin d’opération (si cela est autorisé).

Full (par défaut)

Le programme d’installation affiche l’ensemble de l’interface à l’utilisateur.

CompletionNotice

Yes

Applicable uniquement si Level a la valeur Basic ou None. Le programme d’installation affiche l’avertissement de fin d’opération.

No (par défaut)

Applicable uniquement si Level a la valeur Basic. Le programme n’affiche pas l’avertissement de fin d’opération.

SuppressModal

Yes

Applicable uniquement si Level a la valeur Basic. Le programme d’installation n’affiche pas les messages d’erreur ou autres boîtes de dialogue susceptibles d’interrompre l’installation.

No (par défaut)

Applicable uniquement si Level a la valeur Basic. Le programme d’installation affiche les messages d’erreur ou autres boîtes de dialogue éventuellement nécessaires.

NoCancel

Yes

Si Level a la valeur Full ou Basic, désactive le bouton d’annulation (la croix qui se trouve dans le coin supérieur droit de la boîte de dialogue de progression).

No (par défaut)

Si Level a la valeur Full ou Basic, autorise l’utilisateur à annuler l’installation à partir de la barre de progression.

AcceptEULA

Yes

Les termes du contrat de licence logiciel Microsoft sont acceptés pour le compte de l’utilisateur. Le programme d’installation n’affiche pas la page des termes du contrat de licence logiciel Microsoft.

No (par défaut)

Si Level n’a pas la valeur None, le programme d’installation affiche la page Termes du contrat de licence logiciel Microsoft.

Remarques

Si cet élément n’est pas défini, les paramètres par défaut sont utilisés. Si une valeur non valide est spécifiée, le programme d’installation termine l’installation.

Notes

L’élément Display n’est utilisé par le programme d’installation que si ce dernier détecte le fichier Config.xml dans le même dossier que Setup.exe ou si vous spécifiez le fichier Config.xml à l’aide de l’option de ligne de commande /config du programme d’installation.

Exemple

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

Élément Logging

Spécifie le type de journalisation mis en œuvre par le programme d’installation.

Syntaxe

<Logging

Type="Off" | "Standard"(par défaut) | "Verbose"

Path=" chemin_accès "

Template=" nom_fichier .txt"

/>

Attributs

Attribut

Valeur

Description

Type

Off

Le programme d’installation n’effectue pas de journalisation.

Standard (par défaut)

Le programme d’installation écrit les informations d’installation dans le fichier journal.

Verbose

Le programme d’installation écrit toutes les informations d’installation dans le fichier journal.

Path

chemin_accès

Chemin d’accès complet au dossier utilisé pour stocker le fichier journal. Vous pouvez utiliser des variables d’environnement. La valeur par défaut est %temp%.

Template

nom_fichier .txt

Nom du fichier journal. Si vous insérez la chaîne * dans le nom du fichier, un fichier journal unique est créé pour chaque installation effectuée par le programme d’installation (voir l’explication qui suit). Si vous n’insérez pas le caractère * et que le nom de fichier spécifié existe déjà, les informations sont ajoutées à la fin du fichier existant. L’extension de fichier .txt doit être incluse. Le modèle par défaut est SetupExe(*).log.

Remarques

Vous pouvez spécifier un signe * n’importe où dans la valeur Template. Le programme d’installation insère une chaîne à cet emplacement au format suivant :

AAAAMMJJHHMMSSxxx

où :

  1. AAAA = Année

  2. MM = Mois

  3. JJ = Jour

  4. HH = Heure

  5. MM = Minutes

  6. SS = Secondes

  7. xxx = chaîne unique générée par le programme d’installation

Notes

L’élément Logging est utilisé par le programme d’installation uniquement si vous spécifiez le fichier Config.xml à l’aide de l’option de ligne de commande /config du programme d’installation. Si vous ne spécifiez pas de fichier Config.xml à utiliser, le programme d’installation utilise les options de journalisation par défaut.

Exemple

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

Dans cet exemple, le programme d’installation crée un fichier journal chaque fois qu’il installe le produit. Il utilise des noms de fichiers uniques tels que les suivants :

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

Élément Package

Package ou produit à installer.

L’ID de package pour SharePoint Foundation 2010 est sts.

Élément Setting

Permet de spécifier des valeurs pour les propriétés de Windows Installer.

Syntaxe

<Setting Id=" nom " Value=" valeur " />

Attributs

Attribut

Valeur

Description

Id

nom

Nom de la propriété Windows Installer.

Value

valeur

Valeur à assigner à la propriété.

Valeurs

Les ID de paramètres suivants sont utilisés pour les installations de serveur :

ID

Valeurs acceptées

Description

REBOOT

ReallySuppress

Indique (pour Windows Installer) s’il faut autoriser un redémarrage une fois le programme d’installation terminé. Utilisez ReallySuppress pour spécifier qu’aucun redémarrage ne doit être effectué. Cette option doit être spécifiée au niveau global, et non par package.

SETUP_REBOOT

Never, AutoAlways, Always, AutoIfNeeded, IfNeeded

Indique (pour le programme d’installation) s’il faut autoriser un redémarrage une fois le programme d’installation terminé. Utilisez Never pour spécifier qu’aucun redémarrage ne doit être effectué. Cette option doit être spécifiée au niveau global, et non par package.

SETUPTYPE

CLEAN_INSTALL, V2V_INPLACE_UPGRADE

Indique s’il faut installer une nouvelle copie du produit ou de la technologie (CLEAN_INSTALL) ou installer la nouvelle version et mettre à niveau la version précédente sur place (V2V_INPLACE_UPGRADE). Ce paramètre doit être spécifié au niveau global, et non par package.

SETUPCALLED

0 | 1

À utiliser dans le cadre de l’attribut d’ID de package.

SERVERROLE

SINGLESERVER, APPLICATION

Spécifie le type de serveur sur lequel vous effectuez l’installation : autonome (SINGLESERVER) ou application (APPLICATION).

USINGUIINSTALLMODE

0 | 1

Indique si vous effectuez une installation silencieuse (0) ou si vous utilisez l’interface utilisateur pour le programme d’installation (1).

Remarques

Les propriétés de Windows Installer ne peuvent pas toutes être spécifiées dans l’élément Setting. Si une propriété bloquée est spécifiée, le programme d’installation termine le processus d’installation. Si une propriété prise en charge est spécifiée, le programme d’installation passe la propriété directement à Windows Installer.

Exemple

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