about_Updatable_Help

  • Article

Description courte

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

Description longue

PowerShell fournit 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 de pouvoir 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 des fichiers d’aide plus récents sont 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 ou un partage de fichiers de système 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 la communication à distance Windows PowerShell, ce qui permet Save-Help de travailler 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 média amovible (tel qu’un lecteur USB) en s’exécutant Export-Clixml sur un ordinateur qui n’a pas d’accès à Internet, en important l’objet PSModuleInfo sur un ordinateur disposant d’un accès à Internet, puis en exécutant Save-Help l’objet PSModuleInfo . L’aide enregistrée peut être copiée sur l’ordinateur distant, 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 des nouvelles Save-Help fonctionnalités, consultez Comment mettre à jour l’aide d’un partage de fichiers dans cette rubrique.

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

PowerShell n’est pas associé aux 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 les ordinateurs, utilisez Update-Help.

  • Get-Help: affiche les rubriques d’aide sur la ligne de commande. Obtient de l’aide 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 les rubriques d’aide en ligne pour les applets de commande, les fonctions, les scripts et les flux de travail dans votre navigateur Internet par défaut.

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

Si vous n’avez pas le fichier d’aide pour une applet de commande, une fonction ou un flux de travail sur l’ordinateur, l’applet Get-Help de commande affiche l’aide 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 updatables 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 en l’absence de fichiers 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é d’aide pouvant être mise à jour est l’aide d’un module. L’aide du module inclut de l’aide pour toutes les applets de commande, fonctions, workflows, fournisseurs, scripts et concepts d’un module. Vous pouvez mettre à jour l’aide de 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 Set-ExecutionPolicy de 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 dans le répertoire$pshome/Modules, vous devez être membre du groupe Administration istrators sur l’ordinateur.

Si vous n’êtes pas membre du groupe Administration istrators, 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 ou les modules d’autres sous-répertoires $HOME/Documents/PowerShell/Modules du $HOME répertoire ne nécessite pas d’autorisations spéciales.

Les Update-Help applets de commande ont Save-Help 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 les applets de commande 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 des Update-Helpparamè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 Update-Help de commande.

L’applet Update-Help de commande effectue tout le travail dur 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.
  • Annule le package du 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 pour des modules particuliers, ajoutez le paramètre Module de Update-Help. Les caractères génériques carte 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 sont utiles 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 variable d’environnement PSModulePath. Il s’agit également de modules retournés par une Get-Module -ListAvailable commande.

Si la valeur du paramètre Module est * (toutes), 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.

Guide pratique pour 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 Save-Help de 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 dans le 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 de 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ésencapsule 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, et les installe dans les sous-répertoires spécifiques au langage des répertoires de module.

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 montrent l’utilisation de l’aide pour enregistrer de Save-Help l’aide 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, $mpuis exécutez Save-Help sur l’objet PSModuleInfo en spécifiant la variable $m comme nom du module.

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

Option 2 : Ouvrez une session PSSession ciblée sur l’ordinateur exécutant le module serveur DHCP, pour obtenir l’objet PSModuleInfo pour le module, enregistrez-le dans une variable $m, puis exécutez-le 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 exécutant le module serveur DHCP, pour obtenir l’objet PSModuleInfo du module, enregistrez-le dans une variable $m, puis exécutez-le 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 média amovible.

$m = Get-Module -Name DhcpServer -ListAvailable
Export-Clixml -Path E:\UsbDrive\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 pour l’objet PSModuleInfo du module DhcpServer importé.

$deserialized_m = Import-Clixml E:\UsbDrive\DhcpModule.xml
Save-Help -Module $deserialized_m -DestinationPath E:\UsbDrive\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:\UsbDrive\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 retournés par l’exécution d’une Get-Help -ListAvailable commande.

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

Par défaut, les applets de Save-Help commande téléchargent l’aide Update-Help 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 de l’interface utilisateur locale et Update-HelpSave-Help utilisez les règles de secours de 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 télécharger et installer des fichiers d’aide dans toutes les cultures d’interface utilisateur dans lesquelles elles 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 pour les modules ne sont pas disponibles dans les langues que vous avez spécifiées, les Update-HelpSave-Help applets de commande retournent un message d’erreur qui répertorie les langues dans lesquelles l’aide de chaque module est disponible afin de choisir l’alternative qui répond le mieux à vos besoins.

Remarque

Actuellement, le contenu d’aide pouvant être mis à jour est publié uniquement en anglais (en-US).

Comment utiliser 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 derniers fichiers d’aide en ligne.

Pour ouvrir la rubrique d’aide en ligne pour n’importe quelle applet de commande ou 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 Get-Job de 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 complet du script.

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

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

Pour réduire les téléchargements Internet et fournir une aide pouvant être mise à jour aux utilisateurs qui ne sont pas connectés à Internet, utilisez l’applet Save-Help de commande. Téléchargez de l’aide à partir d’Internet et enregistrez-la sur un partage réseau. Ensuite, créez un paramètre de 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 chemin d’accès source par défaut pour le paramètre de stratégie de groupe Update-Help .

Ce paramètre de stratégie de groupe ajoute implicitement le paramètre SourcePath , avec l’emplacement du système de fichiers que vous spécifiez, à chaque commande sur chaque Update-Help ordinateur concerné. 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 l’aide à partir d’Internet.

Remarque

Le paramètre Définir le chemin d’accès source par défaut pour le paramètre de stratégie de groupe Update-Help s’affiche sous Configuration de l’ordinateur et Configuration utilisateur. Toutefois, seul le paramètre de stratégie sous Configuration 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 de l’aide pour 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 ou Save-Help une Update-Help commande. Sur un ordinateur distant, avant d’exécuter la Save-Help commande, importez le module dans la session active ou Invoke-Command le bloc de script connecté à l’ordinateur distant.

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

Les paramètres de module des applets de Update-Help commande et Save-Help acceptent uniquement 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, tel qu’un module installé dans un emplacement qui n’est pas répertorié dans la $env:PSModulePath variable d’environnement ou un module qui n’est pas bien formé (le répertoire du 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 de l’aide en ligne de prise en charge.

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

Notes

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

Voir aussi