Obtenir de l’aide

 

Sapplique à :Exchange Server 2013

Dans Microsoft Exchange Server 2013, l’environnement de ligne de commande Exchange Management Shell fournit de nombreuses ressources d’aide vous aidant à l’utiliser au mieux. Cette rubrique offre les sections suivantes, qui décrivent les ressources d’aide et de fonctionnalité :

  • Aide d’Exchange 2013    L’aide d’Exchange 2013 contient toutes les rubriques d’aide de cmdlet sous forme hiérarchique par rôle et par tâche. Les rubriques d’aide de cmdlet sont également liées aux rubriques relatives à la procédure vous indiquant comment effectuer des tâches spécifiques.

  • Cmdlets d’aide   L’environnement de ligne de commande Exchange Management Shell possède plusieurs cmdlets d’aide qui vous permettent de trouver les informations appropriées pour accomplir votre tâche.

  • Vues d’aide   L’aide dans l’environnement de ligne de commande Exchange Management Shell contient des informations complètes sur les cmdlets que vous pouvez utiliser. Les vues d’aide vous permettent d’accéder aux informations dont vous avez besoin à propos d’une cmdlet.

  • Saisie semi-automatique   Vous pouvez utiliser la fonction de saisie semi-automatique sur les noms de cmdlets et de paramètres pour réduire le nombre de caractères à taper à l’invite de commandes.

L’aide de Exchange 2013 contient les mêmes informations d’aide de cmdlet disponibles sur chaque cmdlet dans l’environnement de ligne de commande Exchange Mangement Shell. Toutefois, dans l’aide d’Exchange 2013, les rubriques d’aide pour toutes les cmdlets sont organisées par rôle de serveur et tâche d’administration. Ainsi, vous pouvez facilement rechercher des cmdlets spécifiques associées à la tâche que vous souhaitez effectuer. De plus, les rubriques sur les cmdlets de l’aide d’Exchange 2013 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 cmdlets disponibles dans l’aide d’Exchange 2013, consultez la rubrique Cmdlets Exchange 2013.

Les tableaux suivants fournissent des exemples sur la manière d’utiliser les cmdlets Get-Help et Get-Command pour accéder aux informations de l’aide disponibles pour chaque cmdlet dans l’environnement de ligne de commande Exchange Management Shell.

ImportantImportant :
Pour afficher une liste des cmdlets Exchange correspondant à une chaîne spécifiée, utilisez la cmdlet Get-ExCommand. Pour plus d’informations, voir le tableau « Exemples d’utilisation des commandes d’aide diverses » ultérieurement dans cette section.

Le tableau suivant fournit des exemples d’utilisation de la cmdlet Get-Help.

Exemples d’utilisation de la cmdlet Get-Help

Exemples Description

Get-Help

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.

Get-Help <cmdlet>

Lorsque vous attribuez à la cmdlet Get-Help une cmdlet 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.

Get-Help Get-SystemMessage

Get-Help About_*

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 cette ligne de commande. 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 les caractères génériques, utilisez la commande suivante.

RemarqueRemarque :
Vous devrez peut-être exécuter la cmdlet Update-Help pour télécharger les fichiers d’aide de Windows PowerShell-provided About_*.

Get-Help About_wildcards.

Get-Help <cmdlet> -Detailed

Pour obtenir une description, voir la section Vues d’aide plus loin dans cette rubrique.

Get-Help <cmdlet> -Full

Pour obtenir une description, voir la section Vues d’aide plus loin dans cette rubrique.

Get-Help <cmdlet> -Examples

Pour obtenir une description, voir la section Vues d’aide plus loin dans cette rubrique.

Get-Help <cmdlet> -Parameter <parameter name>

Pour obtenir une description, voir la section Paramètres de filtre plus loin dans cette rubrique.

Get-Help <cmdlet> -Online

Pour obtenir une description, voir la section Aide en ligne plus loin dans cette rubrique.

Le tableau suivant fournit des exemples d’utilisation de la cmdlet Get-Command.

Exemples d’utilisation de la cmdlet Get-Command

Exemples Description

Get-Command

La cmdlet Get-Command fournit une liste de toutes les cmdlets disponibles pour l’environnement de ligne de commande Exchange Management Shell. La cmdlet Get-Command permet l’extension des caractères génériques.

Get-Command *<string>*

Lorsque vous encadrez une chaîne avec des caractères génériques ( * ), la cmdlet Get-Command renvoie une liste de toutes les cmdlets et fonctions disponibles qui contiennent cette chaîne. Par exemple, pour rechercher toutes les cmdlets ou fonctions qui contiennent la chaîne « mailbox », utilisez la commande Get-Command *mailbox*.

Les cmdlets Exchange apparaissent comme des fonctions à la sortie de la cmdlet Get-Command.

Get-Command -Noun <CmdletNoun>

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-Command -Noun SystemMessage renvoie toutes les cmdlets disponibles pour la fonction SystemMessage.

Get-Command -Verb <CmdletVerb>

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-Command -Verb Enable retourne toutes les cmdlets disponibles qui effectuent l’action d’activation.

Le tableau suivant fournit des exemples d’utilisation des commandes d’aide diverses.

Exemples d’utilisation de diverses commandes d’aide

Exemples Description

Get-ExCommand

La commande Get-ExCommand renvoie une liste de toutes les cmdlets Exchange disponibles.

Get-ExCommand *<string>*

Lorsque vous encadrez une chaîne avec des caractères génériques ( * ), la commande Get-ExCommand renvoie une liste de toutes les cmdlets Exchange disponibles qui contiennent cette chaîne. Par exemple, pour rechercher toutes les cmdlets Exchange qui contiennent la chaîne « mailbox », utilisez la commande Get-ExCommand *mailbox*.

Les cmdlets Exchange apparaissent comme des fonctions à la sortie de la cmdlet Get-ExCommand.

QuickRef

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. Cette commande fonctionne uniquement si les outils de gestion de Exchange sont installés.

Pour ouvrir ce tableau directement, consulter la rubrique d’aide Référence rapide concernant l’environnement de ligne de commande Exchange Management Shell pour Exchange 2013.

<Cmdlet> -?

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 Get-SystemMessage -? pour afficher une aide détaillée pour la cmdlet Get-SystemMessage.

Get-Tip

La cmdlet Get-Tip génère une nouvelle Astuce du jour de l’environnement de ligne de commande Exchange Management Shell. Cette cmdlet est uniquement disponible si les outils de gestion Exchange sont installés.

Get-ExBlog

La cmdlet de Get-ExBlog ouvre votre navigateur par défaut pour afficher le blog de l’équipe Exchange. Cette cmdlet est uniquement disponible si les outils de gestion Exchange sont installés.

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 comporte quatre vues qui affichent différents types d’informations. Vous pouvez également récupérer un paramètre spécifique ou un ensemble spécifique de paramètres similaires.

Le tableau suivant indique les sections affichées dans chaque vue.

Vues d’aide dans l’environnement de ligne de commande Exchange Management Shell

Vue d’aide Valeur par défaut Détails Complet Exemples

Aperçu

X

X

X

X

Syntaxe

X

X

X

Description

X

X

X

Paramètres sans métadonnées

X

Paramètres avec métadonnées

X

Entrées

X

Sorties

X

Erreurs

X

Exemples

X

X

X

Liens associés

X

X

Remarques

X

X

Le tableau suivant décrit chaque vue et fournit un exemple de commande qui appelle chaque vue.

Exemples de vues de l’aide de l’environnement de ligne de commande Exchange Management Shell

Vue d’aide Exemples Description

Valeur par défaut

Get-Help Set-Mailbox

La vue par défaut est affichée lorsque vous utilisez la commande Get-Help <cmdlet>.

Detailed

Get-Help Set-Mailbox -Detailed

La vue Detailed est affichée lorsque vous utilisez la commande Get-Help <cmdlet> -Detailed. Les paramètres renvoyés dans la section Parameters n’incluent pas de métadonnées de paramètre.

Pour plus d’informations, voir Paramètres.

Full

Get-Help Set-Mailbox - Full

La vue Full est affichée lorsque vous utilisez la commande Get-Help <cmdlet> -Full. Les paramètres renvoyés dans la section Parameters incluent les métadonnées de paramètre suivantes :

  • Required?

  • Position?

  • Default value

  • Accept pipeline input?

  • Accept wildcard characters?

Pour plus d’informations, consultez la rubrique Paramètres.

Examples

Get-Help Set-Mailbox -Examples

La vue Examples est affichée lorsque vous utilisez la commande Get-Help <cmdlet> -Examples.

En plus de cas quatre vues d’aide, vous pouvez également 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*
RemarqueRemarque :
Lorsque vous utilisez le paramètre Parameter avec la cmdlet Get-Help pour récupérer les informations d’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.

Si une cmdlet contient de nombreux paramètres, il peut être difficile de lire les informations d’aide pour cette cmdlet dans l’environnement de ligne de commande Exchange Management Shell. Avec Exchange 2013, le commutateur Online a été rendu disponible. Le commutateur Online indique à l’environnement de ligne de commande Exchange Management Shell d’ouvrir votre navigateur Web par défaut et de parcourir la rubrique d’aide en ligne pour rechercher la cmdlet. La rubrique d’aide en ligne est similaire à la rubrique d’aide pour la cmdlet dans l’environnement de ligne de commande Exchange Management Shell avec l’avantage supplémentaire de pouvoir afficher la rubrique dans une fenêtre plus grande, de rechercher la rubrique pour les conditions d’utilisation ou de cliquer sur les liens associés intégrés à la rubrique. Par exemple, pour afficher l’aide en ligne pour la cmdlet Set-Mailbox, utilisez la commande suivante :

Get-Help Set-Mailbox -Online

L’utilisation du commutateur Online nécessite que votre ordinateur possède une connexion à Internet.

Vous pouvez utiliser la saisie semi-automatique pour réduire le nombre de caractères à taper 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 répertorie tous les noms de cmdlets commençant par Get-Transport. Dans le second exemple, l’environnement de ligne de commande Exchange Management Shell répertorie 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 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>

Chaque fois que vous appuyez sur la touche TAB dans le premier exemple, l’environnement de ligne de commande Exchange Management Shell répertorie tous les noms de paramètres commençant par Email sur 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 Conditions de la cmdlet New-TransportRule.

 
Afficher: