Save-Help

El Save-Help cmdlet descarga los archivos de ayuda más recientes para los módulos de PowerShell y los guarda en un directorio que especifique. Esta característica le permite actualizar los archivos de ayuda en equipos que no tienen acceso a Internet y facilita la actualización de los archivos de ayuda en varios equipos. Este cmdlet se introdujo en Windows PowerShell 3.0.

A partir de Windows PowerShell 4.0, puede usar Save-Help para descargar archivos de ayuda para módulos instalados en equipos remotos. También es posible guardar un objeto PSModuleInfo mediante Export-Clixml en un equipo que no tenga acceso a Internet, importar el objeto en un equipo que tenga acceso a Internet y, a continuación, ejecutarlo Save-Help en el objeto PSModuleInfo . Una vez que tenga la ayuda guardada, puede copiarla en el equipo remoto e instalarla ejecutando Update-Help. Este proceso se puede usar para instalar ayuda en equipos que no tienen ningún tipo de acceso a la red.

Sin parámetros, un Save-Help comando descarga la ayuda más reciente para todos los módulos de la sesión y para los módulos que se instalan en el equipo en una ubicación que aparece en la variable de entorno PSModulePath . Esta acción omite los módulos que no admiten ayuda actualizable sin advertencia.

El Save-Help cmdlet comprueba la versión de los archivos de ayuda de la carpeta de destino. Si hay archivos de ayuda más recientes disponibles, este cmdlet descarga los archivos de ayuda más recientes de Internet y, a continuación, los guarda en la carpeta . El Save-Help cmdlet funciona igual que el Update-Help cmdlet, salvo que guarda el contenido descargado, en lugar de extraer los archivos de ayuda e instalarlos en el equipo.

La ayuda guardada para cada módulo consta de un archivo de información de ayuda (HelpInfo XML) y un archivo zip o contenedor (.cab o .zip) para los archivos de ayuda en cada idioma. En Windows, el comando descarga los archivos del gabinete. En Linux y macOS, el comando descarga archivos ZIP.

Para guardar los archivos de ayuda de los módulos en la carpeta de instalación de PowerShell ($PSHOME\Modules), inicie PowerShell mediante la opción Ejecutar como administrador. Debe ser miembro del grupo Administradores del equipo para descargar los archivos de ayuda de estos módulos.

Para instalar archivos de ayuda guardados, ejecute Update-Help con el parámetro SourcePath para especificar la carpeta que contiene los archivos de Ayuda guardados. Update-Help extrae los archivos de ayuda del archivo e los instala en la ubicación adecuada.

En este ejemplo se muestran tres maneras diferentes de usar Save-Help para guardar la ayuda del módulo DhcpServer desde un equipo cliente conectado a Internet, sin instalar el módulo DhcpServer ni el rol servidor DHCP en el equipo local.

# Option 1:
# 1. Run Invoke-Command to get the PSModuleInfo object for the DhcpServer module,
# 2. Save-Help on the PSModuleInfo object to save the help files to a folder on
#    the local computer.

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


# Option 2:
# 1. Open a PSSession to the remote computer that's running the DhcpServer module
# 2. Get the PSModuleInfo object from the remote computer
# 3. Save-Help on the PSModuleInfo object

$session = New-PSSession -ComputerName "RemoteServer"
$mod = Get-Module -PSSession $session -Name "DhcpServer" -ListAvailable
Save-Help -Module $mod -DestinationPath C:\SavedHelp


# Option 3:
# 1. Open a CimSession to the remote computer that's running the DhcpServer module
# 2. Get the PSModuleInfo object from the remote computer
# 3. Save-Help on the PSModuleInfo object
$cimsession = New-CimSession -ComputerName "RemoteServer"
$mod = Get-Module -CimSession $cimsession -Name "DhcpServer" -ListAvailable
Save-Help -Module $mod -DestinationPath "C:\SavedHelp"

En este ejemplo se muestra cómo instalar ayuda para un equipo que no está conectado a la red. En este ejemplo, el primer equipo no está conectado a una red accesible. Los archivos deben copiarse en él mediante medios extraíbles. El segundo equipo está conectado a Internet y puede descargar los archivos de ayuda.

# On the first computer, get the PSModuleInfo object for the module and save it to
# removable media.

Get-Module -Name "DhcpServer" -ListAvailable |
    Export-CliXml -Path E:\UsbFlashDrive\DhcpModule.xml

# Move the removable media to a computer that has internet access, and then import the
# PSModuleInfo object. Run Save-Help on the imported PSModuleInfo object and save the help
# files to the removable media.

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

# Finally, move the removable media back to the first computer and install the help.

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

Este comando descarga los archivos de ayuda más recientes para todos los módulos del equipo local. Guarda los archivos de ayuda en la \\Server01\Fileshare01 carpeta .

Save-Help -DestinationPath \\Server01\FileShare01

Este comando descarga los archivos de ayuda más recientes para el módulo ServerManager y, a continuación, los guarda en la \\Server01\Fileshare01 carpeta .

$saveHelpSplat = @{
    Module = 'ServerManager'
    DestinationPath = '\\Server01\FileShare01'
    Credential = 'Domain01/Admin01'
}
Save-Help @saveHelpSplat

Cuando se instala un módulo en el equipo, puede escribir el nombre del módulo como valor del parámetro Module , incluso si el módulo no se importa en la sesión actual.

El comando usa el parámetro Credential para proporcionar las credenciales de un usuario que tiene permiso para escribir en el recurso compartido de archivos.

Estos comandos descargan los archivos de ayuda más recientes para el módulo CustomSQL y los guardan en la \\Server01\Fileshare01 carpeta .

Invoke-Command -ComputerName Server02 { Get-Module -Name CustomSQL -ListAvailable } |
    Save-Help -DestinationPath \\Server01\FileShare01 -Credential Domain01\Admin01

Dado que el módulo CustomSQL no está instalado en el equipo, la secuencia incluye un Invoke-Command comando que obtiene el objeto de módulo para el módulo CustomSQL del equipo Server02 y, a continuación, canaliza el objeto de módulo al Save-Help cmdlet .

Cuando un módulo no está instalado en el equipo, Save-Help necesita el objeto module, que incluye información sobre la ubicación de los archivos de ayuda más recientes.

Este comando guarda ayuda para los módulos principales de PowerShell en cuatro referencias culturales de interfaz de usuario diferentes. Los paquetes de idioma de estas configuraciones regionales no tienen que instalarse en el equipo.

$saveHelpSplat = @{
    Module = 'Microsoft.PowerShell*'
    UICulture = 'de-DE', 'en-US', 'fr-FR', 'ja-JP'
    DestinationPath = "D:\Help"
}
Save-Help @saveHelpSplat

Save-Help puede descargar archivos de ayuda para módulos en diferentes referencias culturales de la interfaz de usuario solo cuando el propietario del módulo hace que los archivos traducidos estén disponibles en Internet.

Este comando guarda la ayuda de todos los módulos instalados en el equipo. El comando especifica el parámetro Force para invalidar la regla que impide que el Save-Help cmdlet descargue ayuda más de una vez en cada período de 24 horas.

Save-Help -Force -DestinationPath \\Server3\AdminShare\Help

El parámetro Force también invalida la restricción de 1 GB y evita la comprobación de versiones. Por lo tanto, puede descargar archivos incluso si la versión no es posterior a la versión de la carpeta de destino.

El comando usa el Save-Help cmdlet para descargar y guardar los archivos de ayuda en la carpeta especificada. El parámetro Force es necesario cuando tiene que ejecutar un comando más de una Save-Help vez cada día.

PSModuleInfo

Puede canalizar un objeto de módulo a este cmdlet.

None

Este cmdlet no devuelve ninguna salida.

• Para guardar la ayuda de los módulos en la carpeta $PSHOME\Modules, inicie PowerShell mediante la opción Ejecutar como administrador. Solo los miembros del grupo Administradores del equipo pueden descargar ayuda para los módulos de la carpeta $PSHOME\Modules.
• La ayuda guardada para cada módulo consta de un archivo de información de ayuda (HelpInfo XML) y un archivo de gabinete (.cab) para los archivos de ayuda de cada referencia cultural de la interfaz de usuario. No tiene que extraer los archivos de ayuda del archivo de gabinete. El Update-Help cmdlet extrae los archivos de ayuda, valida el XML y, a continuación, instala los archivos de ayuda y el archivo de información de ayuda en una subcarpeta específica del lenguaje de la carpeta del módulo.
• El Save-Help cmdlet puede guardar la ayuda de los módulos que no están instalados en el equipo. Sin embargo, dado que los archivos de ayuda están instalados en la carpeta del módulo, el cmdlet puede instalar el Update-Help archivo de ayuda actualizado solo para los módulos instalados en el equipo.
• Si Save-Help no encuentra archivos de ayuda actualizados para un módulo o no encuentra archivos de ayuda actualizados en el idioma especificado, continúa silenciosamente sin mostrar un mensaje de error. Para ver qué archivos guardó el comando, especifique el parámetro Verbose .
• Los módulos son la unidad más pequeña de ayuda actualizable. No puede guardar la ayuda de un cmdlet determinado, solo para todos los cmdlets del módulo. Para buscar el módulo que contiene un cmdlet determinado, use la propiedad ModuleName junto con el Get-Command cmdlet , por ejemplo, (Get-Command \<cmdlet-name\>).ModuleName
• Save-Help admite todos los módulos y los complementos principales de PowerShell. No admite ningún otro complemento.
• Los cmdlets Update-Help y Save-Help usan los siguientes puertos para descargar archivos de ayuda: Puerto 80 para HTTP y puerto 443 para HTTPS.
• Los cmdlets Update-Help y Save-Help no se admiten en el entorno de preinstalación de Windows (Windows PE).