Acerca de la ayuda actualizableAbout Updatable Help

Descripción breveShort description

Describe el sistema de ayuda actualizable en PowerShell.Describes the updatable help system in PowerShell.

Descripción largaLong description

PowerShell proporciona varias maneras de obtener acceso a los temas de ayuda más actualizados para los cmdlets y conceptos de PowerShell.PowerShell provides several different ways to access the most up-to-date help topics for PowerShell cmdlets and concepts.

El sistema de ayuda actualizable, presentado en PowerShell 3,0, está diseñado para garantizar que siempre tiene los temas de ayuda más recientes en el equipo local para que pueda leerlos en la línea de comandos.The Updatable Help system, introduced in PowerShell 3.0, is designed to assure that you always have the newest help topics on your local computer so that you can read them at the command line. Facilita la descarga e instalación de los archivos de ayuda y su actualización cada vez que haya nuevos archivos de ayuda disponibles.It makes it easy to download and install help files and to update them whenever newer help files become available.

Para proporcionar ayuda actualizada para varios equipos de una empresa y para equipos que no tienen acceso a Internet, la ayuda actualizable le permite descargar archivos de ayuda en un directorio del sistema de archivos o un recurso compartido de archivos y, a continuación, instalar los archivos de ayuda desde el recurso compartido de archivos.To provide updated help for multiple computers in an enterprise and for computers that do not have access to the internet, Updatable Help lets you download help files to a filesystem directory or file share, and then install the help files from the file share.

En PowerShell 4,0, la propiedad HelpInfoUri se conserva en la comunicación remota de Windows PowerShell, lo que permite Save-Help que funcione para los módulos que están instalados en un equipo remoto, pero que no están instalados necesariamente en el equipo local.In PowerShell 4.0, the HelpInfoUri property is preserved over Windows PowerShell remoting, which allows Save-Help to work for modules that are installed on a remote computer, but are not necessarily installed on the local computer. Puede guardar un objeto PSModuleInfo en un disco o en un medio extraíble (como una unidad USB) si ejecuta Export-Clixml en un equipo que no tiene acceso a Internet, importando el objeto PSModuleInfo en un equipo que tenga acceso a Internet y, a continuación, se ejecuta Save-Help en el objeto PSModuleInfo .You can save a PSModuleInfo object to disk or removable media (such as a USB drive) by running Export-Clixml on a computer that does not have internet access, importing the PSModuleInfo object on a computer that does have internet access, and then running Save-Help on the PSModuleInfo object. La ayuda guardada se puede copiar en el equipo remoto desconectado mediante un medio extraíble y, a continuación, instalarse mediante la ejecución de Update-Help .The saved help can be copied to the remote, disconnected computer by using removable media, and then installed by running Update-Help. Estas mejoras en la Save-Help funcionalidad permiten instalar la ayuda en equipos que no tienen ningún tipo de acceso a la red.These improvements in Save-Help functionality let you install help on computers that are without any kind of network access. Para obtener un ejemplo de cómo usar la nueva Save-Help funcionalidad, consulte Cómo actualizar la ayuda de un recurso compartido de archivos en este tema.For an example of how to use the new Save-Help functionality, see How to update help from a file share in this topic.

La ayuda actualizable también admite el acceso en línea a los temas de ayuda más recientes y a la ayuda básica de los cmdlets, incluso cuando no hay ningún archivo de ayuda en el equipo.Updatable Help also supports online access to the newest help topics and basic help for cmdlets, even when there are no help files on the computer.

PowerShell 3,0 no se incluye en los archivos de ayuda.PowerShell 3.0 does not come with Help files. Puede usar la característica de ayuda actualizable para instalar los archivos de ayuda de todos los comandos que se incluyen de forma predeterminada en PowerShell y para todos los módulos de Windows.You can use the Updatable Help feature to install the help files for all of the commands that are included by default in PowerShell and for all Windows modules.

Cmdlets de ayuda actualizableUpdatable help cmdlets

  • Update-Help: Descarga los archivos de ayuda más recientes desde Internet o desde un recurso compartido de archivos y los instala en el equipo local.Update-Help: Downloads the newest help files from the internet or a file share, and installs them on the local computer.

  • Save-Help: Descarga los archivos de ayuda más recientes desde Internet y los guarda en un directorio del sistema de archivos o en un recurso compartido de archivos.Save-Help: Downloads the newest help files from the internet and saves them in a filesystem directory or file share. Para instalar los archivos de ayuda en los equipos, use Update-Help .To install the help files on computers, use Update-Help.

  • Get-Help: Muestra los temas de ayuda en la línea de comandos.Get-Help: Displays help topics at the command line. Obtiene ayuda de los archivos de ayuda del equipo.Gets help from the help files on the computer. Muestra la ayuda generada automáticamente para los cmdlets y las funciones que no tienen archivos de ayuda.Displays auto-generated help for cmdlets and functions that do not have help files. Abre los temas de ayuda en línea para los cmdlets, las funciones, los scripts y los flujos de trabajo en el explorador de Internet predeterminado.Opens online help topics for cmdlets, functions, scripts, and workflows in your default internet browser.

Ayuda generada automáticamente: ayuda sin archivos de ayudaAuto-generated help: help without help files

Si no tiene el archivo de ayuda de un cmdlet, función o flujo de trabajo en el equipo, el Get-Help cmdlet muestra la ayuda generada automáticamente y le pide que descargue los archivos de ayuda o que los lea en línea.If you do not have the help file for a cmdlet, function, or workflow on the computer, the Get-Help cmdlet displays auto-generated help and prompts you to download the help files or read them online.

La ayuda generada automáticamente incluye la sintaxis y los alias, y comentarios que explican cómo usar los cmdlets de ayuda actualizables y obtener acceso a los temas de ayuda en pantalla.Auto-generated help includes syntax and aliases, and remarks that explain how to use the Updatable Help cmdlets and to access the online help topics.

Por ejemplo, el comando siguiente obtiene la ayuda básica del Get-Culture cmdlet.For example, the following command gets basic help for the Get-Culture cmdlet. La salida muestra la Get-Help pantalla cuando no hay ningún archivo de ayuda en el equipo.The output shows the Get-Help display when there are no help files on the computer.

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.

Archivos de ayuda para módulosHelp files for modules

La unidad más pequeña de ayuda actualizable es ayuda para un módulo.The smallest unit of Updatable Help is help for a module. La ayuda del módulo incluye ayuda para todos los cmdlets, funciones, flujos de trabajo, proveedores, scripts y conceptos de un módulo.Module help includes help for all of the cmdlets, functions, workflows, providers, scripts, and concepts in a module. Puede actualizar la ayuda de todos los módulos instalados en el equipo, aunque no se hayan importado en la sesión actual.You can update help for all modules that are installed on the computer, even if they are not imported into the current session.

Puede actualizar la ayuda de todo el módulo, pero no puede actualizar la ayuda de cmdlets individuales.You can update help for the entire module, but you cannot update help for individual cmdlets.

Para buscar el módulo que contiene un cmdlet determinado, use el siguiente formato de comando:To find the module that contains a particular cmdlet, use the following command format:

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

Por ejemplo, para buscar el módulo que contiene el Set-ExecutionPolicy cmdlet, escriba:For example, to find the module that contains the Set-ExecutionPolicy cmdlet, type:

(Get-Command Set-ExecutionPolicy).ModuleName

Para actualizar la ayuda de un módulo determinado, escriba:To update help for a particular module, type:

Update-Help -Module <ModuleName>

Por ejemplo, para actualizar la ayuda para el módulo que contiene el cmdlet Set-ExecutionPolicy, escriba:For example, to update help for the module that contains the Set-ExecutionPolicy cmdlet, type:

Update-Help -Module Microsoft.PowerShell.Security

Permisos para la ayuda actualizablePermissions for updatable help

Para actualizar la ayuda de los módulos del directorio $pshome/Modules , debe ser miembro del grupo administradores del equipo.To update help for the modules in the directory $pshome/Modules, you must be member of the Administrators group on the computer.

Si no es miembro del grupo administradores, no puede actualizar la ayuda de estos módulos; pero si tiene acceso a Internet, puede ver la ayuda en línea.If you are not a member of the Administrators group, you cannot update help for these modules; but if you have internet access, you can view help online.

La actualización de la ayuda para los módulos del directorio $home/Documents/PowerShell/Modules o los módulos de otros subdirectorios del $home directorio no requiere permisos especiales.Updating help for modules in the directory $home/Documents/PowerShell/Modules or modules in other subdirectories of the $home directory does not require special permissions.

Los Update-Help Save-Help cmdlets y tienen un parámetro UseDefaultCredentials que proporciona las credenciales explícitas del usuario actual.The Update-Help and Save-Help cmdlets have a UseDefaultCredentials parameter that provides the explicit credentials of the current user. Este parámetro está diseñado para tener acceso a ubicaciones seguras de Internet.This parameter is designed for accessing secure internet locations.

Los Update-Help Save-Help cmdlets y también tienen un parámetro de credencial que le permite ejecutar el comando en un equipo remoto y tener acceso a un recurso compartido de archivos en un tercer equipo.The Update-Help and Save-Help cmdlets also have a Credential parameter that allows you to run the command on a remote computer and access a file share on a third computer. El parámetro Credential solo es válido cuando se usan los parámetros SourcePath o LiteralPath de Update-Help y los parámetros DestinationPath o LiteralPath de Save-Help .The Credential parameter is valid only when you use the SourcePath or LiteralPath parameters of Update-Help and the DestinationPath or LiteralPath parameters of Save-Help.

Cómo instalar y actualizar los archivos de ayudaHow to install and update help files

Para descargar e instalar los archivos de ayuda por primera vez, o para actualizar los archivos de ayuda en el equipo, use el Update-Help cmdlet.To download and install help files for the first time, or to update the help files on your computer, use the Update-Help cmdlet.

El Update-Help cmdlet realiza todo el trabajo duro para usted, incluidas las siguientes tareas.The Update-Help cmdlet does all of the hard work for you, including the following tasks.

  • Determina qué módulos admiten la ayuda actualizable.Determines which modules support Updatable Help.
  • Busca la ubicación de Internet donde cada módulo almacena sus archivos de ayuda actualizables.Finds the internet location where each module stores its Updatable Help files.
  • Compara los archivos de ayuda de cada módulo del equipo con los archivos de ayuda más recientes que están disponibles para cada módulo.Compares the help files for each module on your computer to the newest help files that are available for each module.
  • Descarga los nuevos archivos de Internet.Downloads the new files from the internet.
  • Desencapsula el paquete del archivo de ayuda.Unwraps the help file package.
  • Comprueba que los archivos son archivos de ayuda válidos.Verifies that the files are valid help files.
  • Instala los archivos de ayuda en el subdirectorio específico del idioma del directorio del módulo.Installs the help files in the language-specific subdirectory of the module directory.

Para obtener acceso a los nuevos temas de ayuda, use el Get-Help cmdlet.To access the new help topics, use the Get-Help cmdlet. No es necesario reiniciar PowerShell.You do not need to restart PowerShell.

Para instalar o actualizar la ayuda de todos los módulos del equipo que admiten la ayuda actualizable, escriba:To install or update help for all modules on the computer that supports Updatable Help, type:

Update-Help

Para actualizar la ayuda de módulos concretos, agregue el parámetro Module de Update-Help .To update help for particular modules, add the Module parameter of Update-Help. Se permiten caracteres comodín en el nombre del módulo.Wildcard characters are permitted in the module name.

Por ejemplo, para actualizar la ayuda para el módulo ServerManager, escriba:For example, to update help for the ServerManager module, type:

Update-Help -Module ServerManager

Sin parámetros, Update-Help actualiza la ayuda de todos los módulos de la sesión y de todos los módulos instalados que admiten la ayuda actualizable.Without parameters, Update-Help updates help for all modules in the session and for all installed modules that support Updatable Help. Para incluirlos, los módulos se deben instalar en los directorios que se enumeran en el valor de la variable de entorno PSModulePath.To be included, modules must be installed in directories that are listed in the value of the PSModulePath environment variable. También son módulos devueltos por un comando "Get-Help-ListAvailable".These are also modules that are returned by a "Get-Help -ListAvailable" command.

Si el valor del parámetro Module es * (All), Update-Help intenta actualizar la ayuda de todos los módulos instalados, incluidos los módulos que no admiten ayuda actualizable.If the value of the Module parameter is * (all), Update-Help attempts to update help for all installed modules, including modules that do not support Updatable Help. Este comando normalmente genera muchos errores, ya que el cmdlet detecta módulos que no admiten ayuda actualizable.This command typically generates many errors as the cmdlet encounters modules that do not support Updatable Help.

Cómo actualizar la ayuda desde un recurso compartido de archivosHow to update help from a file share

Para admitir equipos que no están conectados a Internet, o para controlar o mejorar la actualización de la ayuda en una empresa, use el Save-Help cmdlet.To support computers that are not connected to the internet, or to control or streamline help updating in an enterprise, use the Save-Help cmdlet. El Save-Help cmdlet descarga los archivos de ayuda de Internet y los guarda en un directorio del sistema de archivos que especifique.The Save-Help cmdlet downloads help files from the internet and saves them in a filesystem directory that you specify.

Save-Help compara los archivos de ayuda del directorio especificado con los archivos de ayuda más recientes que están disponibles para cada módulo.Save-Help compares the help files in the specified directory to the newest help files that are available for each module. Si el directorio no tiene ningún archivo de ayuda o hay archivos de ayuda más recientes disponibles para el módulo, el Save-Help cmdlet descarga los archivos nuevos desde Internet.If the directory has no help files or newer help files are available for the module, the Save-Help cmdlet downloads the new files from the internet. Sin embargo, no se desencapsulan ni se instalan los archivos de ayuda.However, it does not unwrap or install the help files.

Para instalar o actualizar los archivos de ayuda en un equipo desde archivos de ayuda que se guardaron en un directorio del sistema de archivos, use el parámetro SourcePath del Update-Help cmdlet.To install or update the help files on a computer from help files that were saved to a filesystem directory, use the SourcePath parameter of the Update-Help cmdlet. El Update-Help cmdlet identifica los archivos de ayuda más recientes, los desencapsula y valida y los instala en los subdirectorios específicos del idioma de los directorios del módulo.The Update-Help cmdlet identifies the newest help files, unwraps and validates them, and installs them in the language-specific subdirectories of the module directories.

Por ejemplo, para guardar la ayuda de todos los módulos instalados en el \\Server\Share directorio, escriba:For example, to save help for all installed modules to the \\Server\Share directory, type:

Save-Help -DestinationPath \\Server\Share

A continuación, para actualizar la ayuda desde el \\Server\Share directorio, escriba:Then, to update help from the \\Server\Share directory, type:

Update-Help -SourcePath \\Server\Share

En los siguientes ejemplos se muestra el uso de Save-Help para guardar la ayuda de los módulos que no están instalados en el equipo local.The following examples show the use of Save-Help to save help for modules that are not installed on the local computer. En este ejemplo, el administrador ejecuta Save-Help para guardar la ayuda del módulo dhcpserver desde un equipo cliente conectado a Internet, sin instalar el módulo dhcpserver o el rol de servidor DHCP en el equipo local.In this example, the administrator runs Save-Help to save the help for the DhcpServer module from an internet-connected client computer, without installing the DhcpServer module or DHCP Server role on the local computer.

Opción 1: ejecute Invoke-Command para obtener el objeto PSModuleInfo para el módulo remoto, guárdelo en una variable, $m y, a continuación, ejecute Save-Help en el objeto PSModuleInfo especificando la variable $m como el nombre del módulo.Option 1: Run Invoke-Command to get the PSModuleInfo object for the remote module, save it in a variable, $m, and then run Save-Help on the PSModuleInfo object by specifying the variable $m as the module name.

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

Opción 2: abrir una PSSession destinada al equipo que está ejecutando el módulo de servidor DHCP, para obtener el objeto PSModuleInfo para el módulo, guárdelo en una variable $m y, a continuación, ejecute Save-Help en el objeto que se guarda en la $m variable.Option 2: Open a PSSession targeted at the computer that is running the DHCP Server module, to get the PSModuleInfo object for the module, save it in a variable $m, and then run Save-Help on the object that is saved in the $m variable.

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

Opción 3: abrir una sesión CIM, destinada al equipo que está ejecutando el módulo de servidor DHCP, para obtener el objeto PSModuleInfo para el módulo, guárdelo en una variable $m y, a continuación, ejecute Save-Help en el objeto que se guarda en la $m variable.Option 3: Open a CIM session, targeted at the computer that is running the DHCP Server module, to get the PSModuleInfo object for the module, save it in a variable $m, and then run Save-Help on the object that is saved in the $m variable.

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

En el ejemplo siguiente, el administrador instala la ayuda para el módulo de servidor DHCP en un equipo que no tiene acceso de red.In the following example, the administrator installs help for the DHCP Server module on a computer that does not have network access.

En primer lugar, ejecute Export-Clixml para exportar el objeto PSModuleInfo a una carpeta compartida o a un medio extraíble.First, run Export-Clixml to export the PSModuleInfo object to a shared folder or to removable media.

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

A continuación, transporte el medio extraíble a un equipo que tenga acceso a Internet y, a continuación, importe el objeto PSModuleInfo con Import-Clixml .Next, transport the removable media to a computer that has internet access, and then import the PSModuleInfo object with Import-Clixml. Ejecute Save-Help para guardar la ayuda del objeto PSModuleInfo del módulo DhcpServer importado.Run Save-Help to save the Help for the imported DhcpServer module PSModuleInfo object.

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

Por último, vuelva a transportar el medio extraíble al equipo que no tenga acceso a la red y, a continuación, instale la ayuda ejecutando Update-Help .Finally, transport the removable media back to the computer that does not have network access, and then install the help by running Update-Help.

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

Sin parámetros, Save-Help descarga la ayuda de todos los módulos de la sesión y de todos los módulos instalados que admiten la ayuda actualizable.Without parameters, Save-Help downloads help for all modules in the session and for all installed modules that support Updatable Help. Para que se incluyan, los módulos se deben instalar en los directorios que aparecen en el valor de la $env:PSModulePath variable de entorno, en el equipo local o en un equipo remoto para el que desea guardar la ayuda.To be included, modules must be installed in directories that are listed in the value of the $env:PSModulePath environment variable, on either the local computer or on a remote computer for which you want to save help. También son módulos que se devuelven al ejecutar un Get-Help -ListAvailable comando.These are also modules that are returned by running a Get-Help -ListAvailable command.

Cómo actualizar los archivos de ayuda en distintos idiomasHow to update help files in different languages

De forma predeterminada, Update-Help los Save-Help cmdlets y descargan ayuda en la referencia cultural de la interfaz de usuario y el idioma que se establece para Windows en el equipo local.By default, the Update-Help and Save-Help cmdlets download help in the UI culture and language that is set for Windows on the local computer. Si los archivos de ayuda de los módulos especificados no están disponibles en la referencia cultural de la interfaz de usuario local Update-Help y Save-Help usan las reglas de reserva del idioma de Windows para encontrar el mejor idioma admitido.If help files for the specified modules are not available in the local UI culture, Update-Help and Save-Help use the Windows language fallback rules to find the best supported language.

Sin embargo, puede usar los parámetros UICulture de los Update-Help Save-Help cmdlets y para descargar e instalar los archivos de ayuda en cualquier referencia cultural de la interfaz de usuario en la que estén disponibles.However, you can use the UICulture parameters of the Update-Help and Save-Help cmdlets to download and install help files in any UI cultures in which they are available.

Por ejemplo, para guardar los archivos de ayuda más recientes para todos los módulos de la sesión en japonés (ja-JP) y francés (fr-FR), escriba:For example, to save the newest help files for all modules on the session in Japanese (Ja-jp) and French (fr-FR), type:

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

Si los archivos de ayuda de los módulos no están disponibles en los idiomas especificados, Update-Help los Save-Help cmdlets y devuelven un mensaje de error que muestra los idiomas en los que está disponible la ayuda de cada módulo para que pueda elegir la alternativa que mejor se adapte a sus necesidades.If help files for the modules are not available in the languages that you specified, the Update-Help and Save-Help cmdlets return an error message that lists the languages in which help for each module is available so you can choose the alternative that best meets your needs.

Nota

Actualmente, el contenido de la ayuda actualizable solo se publica en inglés (en-US).Currently, Updateable Help content is only published in English (en-US). En algunos sistemas que no son de Windows, debe usar el parámetro UICulture para solicitar explícitamente el en-US contenido.On some non-Windows systems you must use the UICulture parameter to explicitly request the en-US content.

Cómo usar la ayuda en líneaHow to use online help

Si no puede o no desea actualizar los archivos de ayuda en el equipo local, puede obtener los archivos de ayuda más recientes en línea.If you cannot or choose not to update the help files on your local computer, you can still get the newest help files online.

Para abrir el tema de ayuda en línea para cualquier cmdlet o función, use el parámetro online del Get-Help cmdlet.To open the online help topic for any cmdlet or function, use the Online parameter of the Get-Help cmdlet.

Por ejemplo, el siguiente comando abre el tema de ayuda en pantalla para el Get-Job cmdlet en el explorador de Internet predeterminado:For example, the following command opens the online help topic for the Get-Job cmdlet in your default internet browser:

Get-Help Get-Job -Online

Para obtener ayuda en línea para un script, use el parámetro online y la ruta de acceso completa al script.To get online help for a script, use the Online parameter and the full path to the script.

El parámetro online no funciona con los temas de about.The Online parameter does not work with About topics. Para ver los temas acerca de PowerShell, incluidos los temas de ayuda sobre el lenguaje de PowerShell, consulte los temas sobre PowerShell.To see the about topics for PowerShell, including help topics about the PowerShell language, see PowerShell About Topics.

Cómo minimizar o evitar descargas de InternetHow to minimize or prevent internet downloads

Para minimizar las descargas de Internet y proporcionar ayuda actualizable a los usuarios que no estén conectados a Internet, use el Save-Help cmdlet.To minimize internet downloads and provide Updatable Help to users who are not connected to the internet, use the Save-Help cmdlet. Descargue la ayuda de Internet y guárdela en un recurso compartido de red.Download help from the internet and save it to a network share. A continuación, cree un directiva de grupo configuración o un trabajo programado que ejecute un Update-Help comando en todos los equipos.Then, create a Group Policy setting or scheduled job that runs an Update-Help command on all computers. Establezca el valor del parámetro SourcePath del Update-Help cmdlet en el recurso compartido de red.Set the value of the SourcePath parameter of the Update-Help cmdlet to the network share.

Para evitar que los usuarios que tienen acceso a Internet descarguen ayuda actualizable de Internet, use la configuración establecer la ruta de acceso de origen predeterminada para Update-Help Directiva de grupo.To prevent users who have internet access from downloading Updatable Help from the internet, use the Set the default source path for Update-Help Group Policy setting.

Esta configuración directiva de grupo agrega implícitamente el parámetro SourcePath , con la ubicación del sistema de archivos que especifique, a cada Update-Help comando de cada equipo afectado.This Group Policy setting implicitly adds the SourcePath parameter, with the filesystem location that you specify, to every Update-Help command on every affected computer. Los usuarios pueden usar el parámetro SourcePath explícitamente para especificar una ubicación del sistema de archivos diferente, pero no pueden excluir el parámetro SourcePath y descargar la ayuda de Internet.Users can use the SourcePath parameter explicitly to specify a different filesystem location, but they cannot exclude the SourcePath parameter and download help from the internet.

Nota

La configuración de directiva de grupo establecer la ruta de acceso de origen predeterminada para Update-Help aparece en configuración del equipo y configuración de usuario.The Set the default source path for Update-Help group policy setting appears under Computer Configuration and User Configuration. Sin embargo, solo la configuración de directiva en configuración del equipo es efectiva.However, only the policy setting under Computer Configuration is effective. Se omite la configuración de directiva en configuración de usuario .The policy setting under User Configuration is ignored.

Para más información, consulte about_Group_Policy_Settings.For more information, see about_Group_Policy_Settings.

Cómo actualizar la ayuda para módulos no estándarHow to update help for non-standard modules

Para actualizar o guardar la ayuda de un módulo que no se devuelve mediante el parámetro ListAvailable del Get-Module cmdlet, importe el módulo en la sesión actual antes de ejecutar Update-Help un Save-Help comando o.To update or save help for a module that is not returned by the ListAvailable parameter of the Get-Module cmdlet, import the module into the current session before running an Update-Help or Save-Help command. En un equipo remoto, antes de ejecutar el Save-Help comando, importe el módulo en la sesión actual o en un Invoke-Command bloque de script que esté conectado al equipo remoto.On a remote computer, before running the Save-Help command, import the module into the current Session, or Invoke-Command script block, that is connected to the remote computer.

Cuando el módulo se encuentra en la sesión actual, ejecute Update-Help los Save-Help cmdlets o sin parámetros, o use el parámetro Module para especificar el nombre del módulo.When the module is in the current session, run the Update-Help or Save-Help cmdlets without parameters, or use the Module parameter to specify the module name.

Los parámetros de módulo de Update-Help los Save-Help cmdlets y solo aceptan un nombre de módulo.The Module parameters of the Update-Help and Save-Help cmdlets accept only a module name. No aceptan la ruta de acceso a un archivo de módulo.They do not accept the path to a module file.

Use esta técnica para actualizar o guardar la ayuda de cualquier módulo que no sea devuelto por el parámetro ListAvailable del Get-Module cmdlet, como un módulo que está instalado en una ubicación que no aparece en la $env:PSModulePath variable de entorno, o un módulo que no tiene el formato correcto (el directorio del módulo no contiene al menos un archivo cuyo basename sea el mismo que el nombre del directorio).Use this technique to update or save help for any module that is not returned by the ListAvailable parameter of the Get-Module cmdlet, such as a module that is installed in a location that is not listed in the $env:PSModulePath environment variable, or a module that is not well-formed (the module directory does not contain at least one file whose basename is the same as the directory name).

Cómo admitir la ayuda actualizableHow to support updatable help

Si crea un módulo, puede admitir la ayuda en línea y la ayuda actualizable de los módulos.If you author a module, you can support online help and Updatable Help for your modules. Para obtener más información, consulte compatibilidad con la ayuda actualizable y soporte técnico en línea en el Microsoft docs.For more information, see Supporting Updatable Help and Supporting Online Help in the Microsoft Docs.

La ayuda actualizable no está disponible para los complementos de PowerShell ni para la ayuda basada en Comentarios.Updatable help not available for PowerShell snap-ins or comment-based help.

ObservacionesRemarks

Los Update-Help Save-Help cmdlets y no se admiten en entorno de preinstalación de Windows (Windows PE).The Update-Help and Save-Help cmdlets are not supported on Windows Preinstallation Environment (Windows PE).

Consulte tambiénSee also

Get-HelpGet-Help

Save-HelpSave-Help

Update-HelpUpdate-Help