Share via

about_Updatable_Help

  • Article

Description courte

Décrit le système d’aide pouvant être mis à jour dans PowerShell.

Description longue

PowerShell offre plusieurs façons d’accéder aux rubriques d’aide les plus à jour pour les applets de commande et les concepts PowerShell.

Le système d’aide pouvant être mis à jour, introduit dans PowerShell 3.0, est conçu pour vous assurer que vous disposez toujours des rubriques d’aide les plus récentes sur votre ordinateur local afin que vous puissiez les lire sur la ligne de commande. Il facilite le téléchargement et l’installation des fichiers d’aide et leur mise à jour chaque fois que de nouveaux fichiers d’aide deviennent disponibles.

Pour fournir une aide mise à jour pour plusieurs ordinateurs d’une entreprise et pour les ordinateurs qui n’ont pas accès à Internet, l’aide pouvant être mise à jour vous permet de télécharger des fichiers d’aide dans un répertoire de système de fichiers ou un partage de fichiers, puis d’installer les fichiers d’aide à partir du partage de fichiers.

Dans PowerShell 4.0, la propriété HelpInfoUri est conservée sur Windows PowerShell communication à distance, ce qui permet Save-Help de fonctionner pour les modules installés sur un ordinateur distant, mais qui ne sont pas nécessairement installés sur l’ordinateur local. Vous pouvez enregistrer un objet PSModuleInfo sur un disque ou un support amovible (par exemple, un lecteur USB) en exécutant Export-Clixml sur un ordinateur qui n’a pas accès à Internet, en important l’objet PSModuleInfo sur un ordinateur qui n’a pas accès à Internet, puis en s’exécutant Save-Help sur l’objet PSModuleInfo . L’aide enregistrée peut être copiée sur l’ordinateur distant et déconnecté à l’aide d’un support amovible, puis installée en exécutant Update-Help. Ces améliorations apportées aux Save-Help fonctionnalités vous permettent d’installer de l’aide sur des ordinateurs sans aucun type d’accès réseau. Pour obtenir un exemple d’utilisation de la nouvelle Save-Help fonctionnalité, consultez Comment mettre à jour l’aide à partir d’un partage de fichiers dans cette rubrique.

L’aide pouvant être mise à jour prend également en charge l’accès en ligne aux dernières rubriques d’aide et l’aide de base pour les applets de commande, même lorsqu’il n’existe aucun fichier d’aide sur l’ordinateur.

PowerShell 3.0 n’est pas fournis avec les fichiers d’aide. Vous pouvez utiliser la fonctionnalité d’aide pouvant être mise à jour pour installer les fichiers d’aide pour toutes les commandes incluses par défaut dans PowerShell et pour tous les modules Windows.

Applets de commande d’aide pouvant être mises à jour

  • Update-Help: télécharge les fichiers d’aide les plus récents à partir d’Internet ou d’un partage de fichiers et les installe sur l’ordinateur local.

  • Save-Help: télécharge les fichiers d’aide les plus récents à partir d’Internet et les enregistre dans un répertoire de système de fichiers ou un partage de fichiers. Pour installer les fichiers d’aide sur des ordinateurs, utilisez Update-Help.

  • Get-Help: affiche les rubriques d’aide sur la ligne de commande. Obtient de l’aide à partir des fichiers d’aide sur l’ordinateur. Affiche l’aide générée automatiquement pour les applets de commande et les fonctions qui n’ont pas de fichiers d’aide. Ouvre des rubriques d’aide en ligne pour les applets de commande, les fonctions, les scripts et les workflows dans votre navigateur Internet par défaut.

Aide générée automatiquement : aide sans fichiers d’aide

Si vous ne disposez pas du fichier d’aide d’une applet de commande, d’une fonction ou d’un workflow sur l’ordinateur, l’applet de commande affiche l’aide Get-Help générée automatiquement et vous invite à télécharger les fichiers d’aide ou à les lire en ligne.

L’aide générée automatiquement inclut la syntaxe et les alias, ainsi que des remarques qui expliquent comment utiliser les applets de commande d’aide pouvant être mises à jour et accéder aux rubriques d’aide en ligne.

Par exemple, la commande suivante obtient de l’aide de base pour l’applet de Get-Culture commande. La sortie affiche l’affichage Get-Help lorsqu’il n’y a aucun fichier d’aide sur l’ordinateur.

Get-Help Get-Culture

NAME
    Get-Culture

SYNTAX
    Get-Culture [<CommonParameters>]

ALIASES
    None

REMARKS
    To get the latest Help content including descriptions and examples
    type: Update-Help.

Fichiers d’aide pour les modules

La plus petite unité de l’aide pouvant être mise à jour est l’aide pour un module. L’aide du module inclut de l’aide pour tous les applets de commande, fonctions, workflows, fournisseurs, scripts et concepts d’un module. Vous pouvez mettre à jour l’aide pour tous les modules installés sur l’ordinateur, même s’ils ne sont pas importés dans la session active.

Vous pouvez mettre à jour l’aide pour l’ensemble du module, mais vous ne pouvez pas mettre à jour l’aide pour les applets de commande individuelles.

Pour rechercher le module qui contient une applet de commande particulière, utilisez le format de commande suivant :

(Get-Command <cmdlet-name>).ModuleName

Par exemple, pour rechercher le module qui contient l’applet de Set-ExecutionPolicy commande, tapez :

(Get-Command Set-ExecutionPolicy).ModuleName

Pour mettre à jour l’aide d’un module particulier, tapez :

Update-Help -Module <ModuleName>

Par exemple, pour mettre à jour l’aide du module qui contient l’applet de commande Set-ExecutionPolicy, tapez :

Update-Help -Module Microsoft.PowerShell.Security

Autorisations pour l’aide pouvant être mise à jour

Pour mettre à jour l’aide des modules du répertoire $pshome/Modules, vous devez être membre du groupe Administrateurs sur l’ordinateur.

Si vous n’êtes pas membre du groupe Administrateurs, vous ne pouvez pas mettre à jour l’aide pour ces modules ; mais si vous avez accès à Internet, vous pouvez afficher de l’aide en ligne.

La mise à jour de l’aide pour les modules dans le répertoire $home/Documents/PowerShell/Modules ou les modules d’autres sous-répertoires du $home répertoire ne nécessite pas d’autorisations spéciales.

Les Update-Help applets de commande et Save-Help ont un paramètre UseDefaultCredentials qui fournit les informations d’identification explicites de l’utilisateur actuel. Ce paramètre est conçu pour accéder à des emplacements Internet sécurisés.

Les Update-Help applets de commande et Save-Help ont également un paramètre Credential qui vous permet d’exécuter la commande sur un ordinateur distant et d’accéder à un partage de fichiers sur un troisième ordinateur. Le paramètre Credential est valide uniquement lorsque vous utilisez les paramètres SourcePath ou LiteralPath de Update-Help et les paramètres DestinationPath ou LiteralPath de Save-Help.

Comment installer et mettre à jour des fichiers d’aide

Pour télécharger et installer des fichiers d’aide pour la première fois, ou pour mettre à jour les fichiers d’aide sur votre ordinateur, utilisez l’applet de Update-Help commande .

L’applet Update-Help de commande effectue tout le travail acharné pour vous, y compris les tâches suivantes.

  • Détermine les modules qui prennent en charge l’aide pouvant être mise à jour.
  • Recherche l’emplacement Internet où chaque module stocke ses fichiers d’aide pouvant être mis à jour.
  • Compare les fichiers d’aide de chaque module sur votre ordinateur aux fichiers d’aide les plus récents disponibles pour chaque module.
  • Télécharge les nouveaux fichiers à partir d’Internet.
  • Désencapsule le package de fichier d’aide.
  • Vérifie que les fichiers sont des fichiers d’aide valides.
  • Installe les fichiers d’aide dans le sous-répertoire spécifique à la langue du répertoire du module.

Pour accéder aux nouvelles rubriques d’aide, utilisez l’applet de Get-Help commande. Vous n’avez pas besoin de redémarrer PowerShell.

Pour installer ou mettre à jour l’aide pour tous les modules sur l’ordinateur qui prend en charge l’aide pouvant être mise à jour, tapez :

Update-Help

Pour mettre à jour l’aide de modules particuliers, ajoutez le paramètre Module de Update-Help. Les caractères génériques sont autorisés dans le nom du module.

Par exemple, pour mettre à jour l’aide du module ServerManager, tapez :

Update-Help -Module ServerManager

Sans paramètres, Update-Help les mises à jour aident tous les modules de la session et tous les modules installés qui prennent en charge l’aide pouvant être mise à jour. Pour être inclus, les modules doivent être installés dans des répertoires répertoriés dans la valeur de la variable d’environnement PSModulePath. Il s’agit également de modules retournés par une commande « Get-Help -ListAvailable ».

Si la valeur du paramètre Module est * (all), Update-Help tente de mettre à jour l’aide pour tous les modules installés, y compris les modules qui ne prennent pas en charge l’aide pouvant être mise à jour. Cette commande génère généralement de nombreuses erreurs lorsque l’applet de commande rencontre des modules qui ne prennent pas en charge l’aide pouvant être mise à jour.

Comment mettre à jour l’aide à partir d’un partage de fichiers

Pour prendre en charge les ordinateurs qui ne sont pas connectés à Internet, ou pour contrôler ou simplifier la mise à jour dans une entreprise, utilisez l’applet de Save-Help commande. L’applet Save-Help de commande télécharge les fichiers d’aide à partir d’Internet et les enregistre dans un répertoire de système de fichiers que vous spécifiez.

Save-Help compare les fichiers d’aide du répertoire spécifié aux fichiers d’aide les plus récents disponibles pour chaque module. Si le répertoire n’a pas de fichiers d’aide ou si des fichiers d’aide plus récents sont disponibles pour le module, l’applet Save-Help de commande télécharge les nouveaux fichiers à partir d’Internet. Toutefois, il ne désenrape pas ni n’installe les fichiers d’aide.

Pour installer ou mettre à jour les fichiers d’aide sur un ordinateur à partir de fichiers d’aide enregistrés dans un répertoire de système de fichiers, utilisez le paramètre SourcePath de l’applet Update-Help de commande. L’applet Update-Help de commande identifie les fichiers d’aide les plus récents, les désactive et les valide, puis les installe dans les sous-répertoires spécifiques au langage des répertoires de modules.

Par exemple, pour enregistrer de l’aide pour tous les modules installés dans le \\Server\Share répertoire, tapez :

Save-Help -DestinationPath \\Server\Share

Ensuite, pour mettre à jour l’aide à partir du \\Server\Share répertoire, tapez :

Update-Help -SourcePath \\Server\Share

Les exemples suivants illustrent l’utilisation de pour enregistrer l’aide Save-Help pour les modules qui ne sont pas installés sur l’ordinateur local. Dans cet exemple, l’administrateur s’exécute Save-Help pour enregistrer l’aide du module DhcpServer à partir d’un ordinateur client connecté à Internet, sans installer le module DhcpServer ou le rôle serveur DHCP sur l’ordinateur local.

Option 1 : Exécutez Invoke-Command pour obtenir l’objet PSModuleInfo pour le module distant, enregistrez-le dans une variable, $m, puis exécutez Save-Help sur l’objet PSModuleInfo en spécifiant la variable $m comme nom de module.

$m = Invoke-Command -ComputerName RemoteServer -ScriptBlock
{ Get-Module -Name DhcpServer -ListAvailable }
Save-Help -Module $m -DestinationPath C:\SavedHelp

Option 2 : Ouvrez une session PSSession ciblant l’ordinateur qui exécute le module serveur DHCP, pour obtenir l’objet PSModuleInfo pour le module, enregistrez-le dans une variable $m, puis exécutez Save-Help sur l’objet enregistré dans la $m variable.

$s = New-PSSession -ComputerName RemoteServer
$m = Get-Module -PSSession $s -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp

Option 3 : Ouvrez une session CIM, ciblée sur l’ordinateur qui exécute le module serveur DHCP, pour obtenir l’objet PSModuleInfo pour le module, enregistrez-le dans une variable $m, puis exécutez Save-Help sur l’objet enregistré dans la $m variable.

$c = New-CimSession -ComputerName RemoteServer
$m = Get-Module -CimSession $c -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp

Dans l’exemple suivant, l’administrateur installe l’aide pour le module serveur DHCP sur un ordinateur qui n’a pas d’accès réseau.

Tout d’abord, exécutez Export-Clixml pour exporter l’objet PSModuleInfo vers un dossier partagé ou vers un support amovible.

$m = Get-Module -Name DhcpServer -ListAvailable
Export-Clixml -Path E:\UsbFlashDrive\DhcpModule.xml -InputObject $m

Ensuite, transportez le média amovible vers un ordinateur disposant d’un accès à Internet, puis importez l’objet PSModuleInfo avec Import-Clixml. Exécutez Save-Help pour enregistrer l’aide de l’objet PSModuleInfo du module DhcpServer importé.

$deserialized_m = Import-Clixml E:\UsbFlashDrive\DhcpModule.xml
Save-Help -Module $deserialized_m -DestinationPath E:\UsbFlashDrive\SavedHelp

Enfin, transportez le média amovible vers l’ordinateur qui n’a pas d’accès réseau, puis installez l’aide en exécutant Update-Help.

Update-Help -Module DhcpServer -SourcePath E:\UsbFlashDrive\SavedHelp

Sans paramètres, Save-Help télécharge l’aide pour tous les modules de la session et pour tous les modules installés qui prennent en charge l’aide pouvant être mise à jour. Pour être inclus, les modules doivent être installés dans des répertoires répertoriés dans la valeur de la $env:PSModulePath variable d’environnement, sur l’ordinateur local ou sur un ordinateur distant pour lequel vous souhaitez enregistrer de l’aide. Il s’agit également de modules qui sont retournés en exécutant une Get-Help -ListAvailable commande.

Comment mettre à jour des fichiers d’aide dans différentes langues

Par défaut, les applets de Update-Help commande et Save-Help téléchargent de l’aide dans la culture et la langue de l’interface utilisateur définies pour Windows sur l’ordinateur local. Si les fichiers d’aide pour les modules spécifiés ne sont pas disponibles dans la culture d’interface utilisateur locale, Update-Help et Save-Help utilisez les règles de secours de la langue Windows pour trouver la meilleure langue prise en charge.

Toutefois, vous pouvez utiliser les paramètres UICulture des applets de Update-Help commande et Save-Help pour télécharger et installer des fichiers d’aide dans toutes les cultures d’interface utilisateur dans lesquelles ils sont disponibles.

Par exemple, pour enregistrer les fichiers d’aide les plus récents pour tous les modules de la session en japonais (Ja-jp) et Français (fr-FR), tapez :

Save-Help -Path \Server\Share -UICulture ja-jp, fr-fr

Si les fichiers d’aide des modules ne sont pas disponibles dans les langues que vous avez spécifiées, les Update-Help applets de commande et Save-Help retournent un message d’erreur qui répertorie les langues dans lesquelles l’aide pour chaque module est disponible afin que vous puissiez choisir l’alternative qui répond le mieux à vos besoins.

Notes

Actuellement, le contenu de l’aide pouvant être mis à jour n’est publié qu’en anglais (en-US). Sur certains systèmes non Windows, vous devez utiliser le paramètre UICulture pour demander explicitement le en-US contenu.

Utilisation de l’aide en ligne

Si vous ne pouvez pas ou choisissez de ne pas mettre à jour les fichiers d’aide sur votre ordinateur local, vous pouvez toujours obtenir les fichiers d’aide les plus récents en ligne.

Pour ouvrir la rubrique d’aide en ligne pour une applet de commande ou une fonction, utilisez le paramètre Online de l’applet Get-Help de commande.

Par exemple, la commande suivante ouvre la rubrique d’aide en ligne pour l’applet de Get-Job commande dans votre navigateur Internet par défaut :

Get-Help Get-Job -Online

Pour obtenir de l’aide en ligne pour un script, utilisez le paramètre Online et le chemin d’accès complet au script.

Le paramètre Online ne fonctionne pas avec les rubriques À propos de. Pour consulter les rubriques relatives à PowerShell, y compris les rubriques d’aide sur le langage PowerShell, consultez PowerShell À propos de Topics.

Comment réduire ou empêcher les téléchargements sur Internet

Pour réduire les téléchargements Sur Internet et fournir de l’aide pouvant être mise à jour aux utilisateurs qui ne sont pas connectés à Internet, utilisez l’applet de Save-Help commande. Téléchargez de l’aide à partir d’Internet et enregistrez-la dans un partage réseau. Ensuite, créez un paramètre stratégie de groupe ou un travail planifié qui exécute une Update-Help commande sur tous les ordinateurs. Définissez la valeur du paramètre SourcePath de l’applet Update-Help de commande sur le partage réseau.

Pour empêcher les utilisateurs disposant d’un accès à Internet de télécharger l’aide pouvant être mise à jour à partir d’Internet, utilisez le paramètre Définir le chemin d’accès source par défaut pour Update-Help stratégie de groupe.

Ce paramètre stratégie de groupe ajoute implicitement le paramètre SourcePath, avec l’emplacement du système de fichiers que vous spécifiez, à chaque Update-Help commande sur chaque ordinateur affecté. Les utilisateurs peuvent utiliser le paramètre SourcePath explicitement pour spécifier un autre emplacement de système de fichiers, mais ils ne peuvent pas exclure le paramètre SourcePath et télécharger de l’aide à partir d’Internet.

Notes

Le paramètre De stratégie de groupe Set the default source path for Update-Helps’affiche sous Configuration de l’ordinateur et Configuration utilisateur. Toutefois, seul le paramètre de stratégie sous Configuration de l’ordinateur est effectif. Le paramètre de stratégie sous Configuration utilisateur est ignoré.

Pour plus d’informations, consultez about_Group_Policy_Settings.

Comment mettre à jour l’aide pour les modules non standard

Pour mettre à jour ou enregistrer l’aide d’un module qui n’est pas retourné par le paramètre ListAvailable de l’applet Get-Module de commande, importez le module dans la session active avant d’exécuter une Update-Help commande ou Save-Help . Sur un ordinateur distant, avant d’exécuter la Save-Help commande, importez le module dans le bloc session ou Invoke-Command script actif connecté à l’ordinateur distant.

Lorsque le module se trouve dans la session active, exécutez les Update-Help applets de commande ou Save-Help sans paramètres, ou utilisez le paramètre Module pour spécifier le nom du module.

Les paramètres module des applets de commande et Save-Help n’acceptent Update-Help qu’un nom de module. Ils n’acceptent pas le chemin d’accès à un fichier de module.

Utilisez cette technique pour mettre à jour ou enregistrer de l’aide pour tout module qui n’est pas retourné par le paramètre ListAvailable de l’applet Get-Module de commande, par exemple un module installé à un emplacement qui n’est pas répertorié dans la $env:PSModulePath variable d’environnement ou un module qui n’est pas correctement formé (le répertoire de module ne contient pas au moins un fichier dont le nom de base est identique au nom du répertoire).

Comment prendre en charge l’aide pouvant être mise à jour

Si vous créez un module, vous pouvez prendre en charge l’aide en ligne et l’aide pouvant être mise à jour pour vos modules. Pour plus d’informations, consultez Prise en charge de l’aide pouvant être mise à jour et Prise en charge de l’aide en ligne dans le Microsoft Docs.

L’aide pouvant être mise à jour n’est pas disponible pour les composants logiciels enfichables PowerShell ou l’aide basée sur les commentaires.

Remarques

Les Update-Help applets de commande et Save-Help ne sont pas prises en charge sur l’environnement de préinstallation Windows (Windows PE).

Voir aussi