Obtenir de l'Aide
S’applique à : Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1, Exchange Server 2007
Dernière rubrique modifiée : 2006-11-15
Dans Microsoft Exchange Server 2007, l'environnement de ligne de commande Exchange Management Shell fournit de nombreuses ressources d’aide vous aidant à en faire la meilleure utilisation possible. Cette rubrique décrit les ressources et fonctionnalités d’aide suivantes :
Ficher d’aide d’Exchange 2007 Le fichier d’aide d’Exchange 2007 contient toutes les rubriques d’aide de cmdlet dans une hiérarchie à base de rôles et de tâches. Les rubriques d'aide de cmdlet sont également liées aux rubriques procédurales qui vous indiquent comment exécuter des tâches spécifiques.
Cmdlets d’aide L'environnement de ligne de commande Exchange Management Shell contient plusieurs cmdlets d’aide qui vous permettent de trouver les informations appropriées pour accomplir votre tâche.
Vues d’aide L’aide de l’environnement de ligne de commande Exchange Management Shell contient des informations complètes sur les cmdlets disponibles. Les vues d’aide vous permettent d’accéder aux informations dont vous avez besoin à propos d’une cmdlet.
Rôles, composants et fonctionnalités de cmdlets Les cmdlets peuvent être répertoriées en fonction de leur rôle, de leurs composants ou de la fonctionnalité qu’elles gèrent. Cela vous permet de trouver la cmdlet appropriée pour le rôle, le composant ou la fonctionnalité que vous voulez gérer.
Saisie semi-automatique Vous pouvez utiliser la saisie semi-automatique sur les noms de cmdlets et de paramètres pour réduire votre saisie sur la ligne de commande.
Fichier d'aide d'Exchange 2007
Le fichier d’aide d’Exchange 2007 contient les mêmes informations d’aide sur les cmdlets que celles disponibles pour chaque cmdlet de l’environnement de ligne de commande Exchange Management Shell. Toutefois, dans le fichier d’aide d’Exchange 2007, l’aide pour toutes les cmdlets est organisée par rôle serveur et tâche d’administration pour vous aider à trouver facilement des cmdlets spécifiques associées à la tâche que vous voulez effectuer. De plus, les rubriques sur les cmdlets du fichier d’aide d’Exchange 2007 sont liées aux rubriques qui vous présentent les fonctions qu’elles gèrent, vous montrent comment utiliser les cmdlets pour gérer cette fonction et fournissent des détails spécifiques sur la fonction ou les scénarios communs.
Pour plus d’informations sur les rubriques d’aide de cmdlet disponibles dans le fichier d’aide d’Exchange 2007, consultez Environnement de ligne de commande Exchange Management Shell (SP1 et SP2).
Pour plus d'informations sur l'utilisation des cmdlets de l'environnement de ligne de commande Exchange Management Shell pour exécuter des tâches spécifiques, consultez la rubrique Opérations.
Cmdlets d’aide
Les tableaux suivants fournissent des exemples sur la manière d’utiliser les cmdlets Get-Help, Get-Command et Get-ExCommand pour accéder aux informations d’aide disponibles pour chaque cmdlet dans l'environnement de ligne de commande Exchange Management Shell.
Le tableau 1 fournit des exemples d’utilisation de la cmdlet Get-Help.
Tableau 1 Exemples d’utilisation de la commande Get-Help
| Commande | Description |
|---|---|
|
Lorsque vous utilisez la cmdlet Get-Help isolément, elle vous donne des instructions de base sur l’utilisation du système d’aide de l'environnement de ligne de commande Exchange Management Shell. |
|
Lorsque vous attribuez à la cmdlet Get-Help une cmdlet Shell comme argument, elle affiche les informations d’aide relatives à cette cmdlet. Par exemple, pour extraire les informations d’aide pour la cmdlet Get-SystemMessage, utilisez la commande suivante :
|
|
Lorsque vous attribuez à la cmdlet Get-Help une cmdlet Shell comme argument, ainsi qu’un caractère générique, la cmdlet Get-Help retourne une liste de toutes les cmdlets qui correspondent au texte que vous avez fourni. Vous pouvez utiliser plusieurs méthodes pour extraire une liste des cmdlets Shell. Ces méthodes sont les suivantes :
En utilisant des caractères génériques de cette manière, vous pouvez facilement afficher une liste de toutes les cmdlets disponibles pour une fonction donnée. Par exemple, la commande Get-Help *-TransportAgent vous permet d’afficher une liste de tous les verbes de cmdlet disponibles pour les agents de transport. |
|
La commande Get-Help About_* fournit une liste de toutes les rubriques d’aide générales de l'environnement de ligne de commande Exchange Management Shell pour vous aider à mieux comprendre et utiliser l'environnement de ligne de commande Exchange Management Shell. Si vous voulez en savoir plus sur une rubrique de la liste affichée, exécutez la commande Get-Help About_<fonction>. Par exemple, si vous voulez en savoir plus sur l'instruction |
|
Consultez la section Vues d'aide plus loin dans cette rubrique. |
|
Consultez la section Vues d'aide plus loin dans cette rubrique. |
|
Consultez la section Vues d'aide plus loin dans cette rubrique. |
|
Consultez la section Vues d'aide plus loin dans cette rubrique. |
|
Consultez la section Paramètres Role, Component et Functionality plus loin dans cette rubrique. |
|
Consultez la section Paramètres Role, Component et Functionality plus loin dans cette rubrique. |
|
Consultez la section Paramètres Role, Component et Functionality plus loin dans cette rubrique. |
Le tableau 2 fournit des exemples d’utilisation de la cmdlet Get-Command.
Tableau 2 Exemples d’utilisation de la commande Get-Command
| Cmdlet | Description |
|---|---|
|
La cmdlet Get-Command fournit une liste de toutes les cmdlets disponibles pour le shell. Comme la cmdlet Get-Help, la cmdlet Get-Command permet l’expansion de caractères génériques. Vous pouvez utiliser cette cmdlet avec les cmdlets Format-List et Format-Table pour obtenir un affichage plus lisible. Par exemple, utilisez |
|
La commande Get-Command <Cmdlet> fournit des informations détaillées sur les paramètres et autres composants de la cmdlet spécifiée. Vous pouvez utiliser cette commande avec les cmdlets Format-List et Format-Table pour obtenir un affichage plus lisible. Par exemple, utilisez |
|
La commande Get-Command -Noun <CmdletNoun> répertorie toutes les cmdlets existantes avec le nom spécifié. Cette commande est utile lorsque vous voulez afficher une liste de toutes les cmdlets associées à une fonction particulière. Par exemple, la commande Get-Help -Noun SystemMessage retourne toutes les cmdlets disponibles pour la fonction |
|
La commande Get-Command -Verb <CmdletVerb> répertorie toutes les cmdlets existantes avec le verbe spécifié. Cette commande est utile lorsque vous voulez afficher une liste de toutes les cmdlets associées à une action particulière. Par exemple, la commande Get-Help -Verb Enable retourne toutes les cmdlets disponibles qui effectuent l’action d’activation. Vous pouvez utiliser cette commande avec les cmdlets Format-List et Format-Table pour obtenir un affichage plus lisible. Par exemple, utilisez |
|
La cmdlet Get-ExCommand se comporte de la même manière que la cmdlet Get-Command, mais retourne uniquement les cmdlets disponibles pour gérer Exchange 2007. |
|
La cmdlet Get-PSCommand se comporte de la même manière que la cmdlet Get-PSCommand, mais exclut les cmdlets utilisées pour gérer Exchange 2007. |
Le tableau 3 fournit des exemples d’utilisation des commandes d’aide diverses.
Tableau 3 Exemples d’utilisation des commandes d’aide diverses.
| Cmdlet | Description |
|---|---|
|
La commande QuickRef ouvre un graphique HTML imprimable qui répertorie les cmdlets de l'environnement de ligne de commande Exchange Management Shell les plus fréquemment utilisées. Pour afficher la version la plus récente de ce graphique, consultez la Référence rapide concernant l'environnement de ligne de commande Exchange Management Shell. |
|
Utilisez la commande <Cmdlet> -? avec n’importe quelle cmdlet pour retrouver les mêmes informations que celles disponibles lorsque vous utilisez la cmdlet Get-Help. Par exemple, tapez |
|
La cmdlet Get-Tip génère une nouvelle Astuce du jour de l'environnement de ligne de commande Exchange Management Shell. |
|
La cmdlet Get-ExBlog ouvre Microsoft Internet Explorer pour afficher le blog de l’équipe Exchange. |
Vues d’aide
Lorsqu’une cmdlet est spécifiée comme paramètre de la cmdlet Get-Help, les informations d'aide pour la cmdlet spécifiée sont affichées. Dans certains cas, les informations retournées peuvent être complètes, alors que vous ne voulez voir que des informations spécifiques. Les vues d’aide vous permettent d’afficher des informations spécifiques à propos d’une cmdlet sans avoir à trier les informations dont vous n’avez pas besoin.
L'environnement de ligne de commande Exchange Management Shell vous fournit quatre vues qui présentent exactement les informations que vous voulez. Vous pouvez également récupérer un paramètre spécifique ou un ensemble spécifique de paramètres similaires. Le tableau 4 illustre les sections affichées dans chaque vue.
Tableau 4 Vues d’aide de l'environnement de ligne de commandeExchange Management Shell
| Vue d’aide | Par défaut | Détails | Complet | Exemples |
|---|---|---|---|---|
Aperçu |
X |
X |
X |
X |
Syntaxe |
X |
X |
X |
|
Description détaillée |
X |
X |
X |
|
Paramètres sans métadonnées |
|
X |
|
|
Paramètres avec métadonnées |
|
|
X |
|
Type d'entrée |
|
|
X |
|
Type de retour |
|
|
X |
|
Erreurs |
|
|
X |
|
Notes |
|
|
X |
|
Exemples |
|
X |
X |
X |
Liens associés |
X |
|
X |
|
Remarques |
X |
X |
|
|
Le tableau 5 décrit chaque vue et fournit un exemple de commande qui appelle chaque vue.
Tableau 5 Exemples de vues d’aide de l'environnement de ligne de commande Exchange Management Shell
| Vue d’aide | Exemple | Description |
|---|---|---|
|
|
La vue par défaut est affichée lorsque vous utilisez la commande |
|
|
La vue Pour plus d'informations sur les paramètres, consultez la rubrique Paramètres. |
|
|
La vue
Pour plus d'informations sur les paramètres, consultez la rubrique Paramètres. |
|
|
La vue |
En plus de cas quatre vues d’aide, l'environnement de ligne de commande Exchange Management Shell vous permet également d’accéder à la description et aux métadonnées d’un paramètre spécifique ou d’un ensemble spécifique de paramètres similaires. Vous pouvez spécifier le paramètre avec la commande Get-Help <cmdlet>. L’exemple suivant montre comment vous pouvez afficher la description du paramètre ForwardingAddress de la cmdlet Set-Mailbox :
Get-Help Set-Mailbox -Parameter ForwardingAddress
Vous pouvez également afficher un ensemble de paramètres similaires qui existent sur une cmdlet spécifique si vous spécifiez le nom partiel d’un paramètre ainsi qu’un caractère générique (*). L’exemple suivant montre comment vous pouvez afficher tous les paramètres de la cmdlet Set-Mailbox qui contiennent le mot « Quota » :
Get-Help Set-Mailbox -Parameter *Quota*
Notes
Lorsque vous utilisez le paramètre Parameter avec la cmdlet Get-Help pour récupérer l'aide d'une cmdlet n'ayant qu'un seul paramètre, la cmdlet Get-Help ne renvoie aucun résultat, même si vous utilisez le caractère générique (*). Il s'agit d'un problème connu dans Microsoft Windows PowerShell.
Paramètres Role, Component et Functionality
Lorsque vous appelez la cmdlet Get-Help sans spécifier de cmdlet spécifique, vous recevez une liste de toutes les cmdlets disponibles dans l'environnement de ligne de commande Exchange Management Shell. Toutefois, vous pouvez vouloir afficher une liste des cmdlets qui gèrent un rôle serveur ou une fonction de composant spécifique ou qui affecte des objets dans une certaine portée de fonctionnalités. La cmdlet Get-Help vous permet d’effectuer cela avec trois paramètres : Role, Component et Functionality.
Lorsque vous utilisez la cmdlet Get-Help avec le paramètre Role, Component ou Functionality, les valeurs que vous spécifiez pour ces paramètres doivent être en caractères génériques (*). Voici des exemples d’appel de Get-Help avec chaque paramètre :
Get-Help -Role *Mailbox*
Get-Help -Component *Recipient*
Get-Help -Functionality *Server*
Les tableaux suivants répertorient toutes les valeurs qui peuvent être utilisées avec les paramètres Role, Component et Functionality sous la cmdlet Get-Help. Le tableau 6 répertorie les valeurs qui peuvent être utilisées avec le paramètre Role.
Tableau 6 Valeurs valides pour Get-Help -Role
| Role | Valeur | Valeur de remplacement |
|---|---|---|
Mailbox |
|
|
Transport Hub |
|
|
Accès au client |
|
|
Messagerie unifiée |
|
|
Transport Edge |
|
|
Administrateur d'organisation |
|
|
Administrateur de serveur |
|
|
Administrateur des destinataires |
|
|
Administrateur Windows |
|
|
Lecture seule |
|
|
Le tableau 7 répertorie les valeurs qui peuvent être utilisées avec le paramètre Component.
Tableau 7 Valeurs valides pour Get-Help -Component
| Valeur | Valeur |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Le tableau 8 répertorie les valeurs qui peuvent être utilisées avec le paramètre Functionality.
Tableau 8 Valeurs valides pour Get-Help -Functionality
| Valeur |
|---|
|
|
|
Saisie semi-automatique
La saisie semi-automatique vous permet de réduire la saisie à effectuer lorsque vous utilisez l'environnement de ligne de commande Exchange Management Shell. Lorsque vous tapez un nom partiel de cmdlet, appuyez sur la touche TAB et l'environnement de ligne de commande Exchange Management Shell complète le nom de la cmdlet si une cmdlet correspondante est trouvée. Si plusieurs noms de cmdlet correspondants sont trouvés, un nom de cmdlet différent sera affiché à chaque fois que vous appuierez sur la touche TAB. Lorsque vous utilisez la saisie semi-automatique avec les noms de cmdlets, vous devez fournir au moins le verbe et le tiret (-). Les exemples suivants montrent comment vous pouvez utiliser la saisie semi-automatique lorsque vous entrez un nom de cmdlet.
Get-Transport<Tab>
Enable-<Tab>
Lorsque vous appuyez sur la touche TAB dans le premier exemple, l'environnement de ligne de commande Exchange Management Shell fait le tour de tous les noms de cmdlets commençant par Get-Transport. Dans le second exemple, l'environnement de ligne de commande Exchange Management Shell fait le tour de toutes les cmdlets avec le verbe Enable.
Comme pour les noms de cmdlets, vous pouvez également utiliser la saisie semi-automatique lorsque vous voulez que l'environnement de ligne de commande Exchange Management Shell complète le nom partiel de paramètre que vous avez entré. Lorsque vous utilisez la saisie semi-automatique avec les noms de paramètres, vous devez spécifier le nom complet de la cmdlet en le tapant directement ou à l’aide de la saisie semi-automatique. Les exemples suivants montrent comment vous pouvez utiliser la saisie semi-automatique lorsque vous entrez un nom de paramètre.
Set-Mailbox -Email<Tab>
New-TransportRule -Cond<Tab>
Lorsque vous appuyez sur la touche TAB dans le premier exemple, l'environnement de ligne de commande Exchange Management Shell fait le tour de tous les noms de paramètres commençant par Email dans la cmdlet Set-Mailbox. Dans le second exemple, lorsque vous appuyez sur la touche TAB, l'environnement de ligne de commande Exchange Management Shell termine le paramètre Condition de la cmdlet New-TransportRule.