Compartir a través de

Import-Module

  • Referencia
Módulo:
Microsoft.PowerShell.Core

Agrega módulos a la sesión actual.

Syntax

Import-Module
      [-Global]
      [-Prefix <String>]
      [-Name] <String[]>
      [-Function <String[]>]
      [-Cmdlet <String[]>]
      [-Variable <String[]>]
      [-Alias <String[]>]
      [-Force]
      [-PassThru]
      [-AsCustomObject]
      [-MinimumVersion <Version>]
      [-MaximumVersion <String>]
      [-RequiredVersion <Version>]
      [-ArgumentList <Object[]>]
      [-DisableNameChecking]
      [-NoClobber]
      [-Scope <String>]
      [<CommonParameters>]
Import-Module
      [-Global]
      [-Prefix <String>]
      [-Name] <String[]>
      [-Function <String[]>]
      [-Cmdlet <String[]>]
      [-Variable <String[]>]
      [-Alias <String[]>]
      [-Force]
      [-PassThru]
      [-AsCustomObject]
      [-MinimumVersion <Version>]
      [-MaximumVersion <String>]
      [-RequiredVersion <Version>]
      [-ArgumentList <Object[]>]
      [-DisableNameChecking]
      [-NoClobber]
      [-Scope <String>]
      -PSSession <PSSession>
      [<CommonParameters>]
Import-Module
      [-Global]
      [-Prefix <String>]
      [-Name] <String[]>
      [-Function <String[]>]
      [-Cmdlet <String[]>]
      [-Variable <String[]>]
      [-Alias <String[]>]
      [-Force]
      [-PassThru]
      [-AsCustomObject]
      [-MinimumVersion <Version>]
      [-MaximumVersion <String>]
      [-RequiredVersion <Version>]
      [-ArgumentList <Object[]>]
      [-DisableNameChecking]
      [-NoClobber]
      [-Scope <String>]
      -CimSession <CimSession>
      [-CimResourceUri <Uri>]
      [-CimNamespace <String>]
      [<CommonParameters>]
Import-Module
      [-Global]
      [-Prefix <String>]
      [-FullyQualifiedName] <ModuleSpecification[]>
      [-Function <String[]>]
      [-Cmdlet <String[]>]
      [-Variable <String[]>]
      [-Alias <String[]>]
      [-Force]
      [-PassThru]
      [-AsCustomObject]
      [-ArgumentList <Object[]>]
      [-DisableNameChecking]
      [-NoClobber]
      [-Scope <String>]
      [<CommonParameters>]
Import-Module
      [-Global]
      [-Prefix <String>]
      [-FullyQualifiedName] <ModuleSpecification[]>
      [-Function <String[]>]
      [-Cmdlet <String[]>]
      [-Variable <String[]>]
      [-Alias <String[]>]
      [-Force]
      [-PassThru]
      [-AsCustomObject]
      [-ArgumentList <Object[]>]
      [-DisableNameChecking]
      [-NoClobber]
      [-Scope <String>]
      -PSSession <PSSession>
      [<CommonParameters>]
Import-Module
      [-Global]
      [-Prefix <String>]
      [-Assembly] <Assembly[]>
      [-Function <String[]>]
      [-Cmdlet <String[]>]
      [-Variable <String[]>]
      [-Alias <String[]>]
      [-Force]
      [-PassThru]
      [-AsCustomObject]
      [-ArgumentList <Object[]>]
      [-DisableNameChecking]
      [-NoClobber]
      [-Scope <String>]
      [<CommonParameters>]
Import-Module
      [-Global]
      [-Prefix <String>]
      [-Function <String[]>]
      [-Cmdlet <String[]>]
      [-Variable <String[]>]
      [-Alias <String[]>]
      [-Force]
      [-PassThru]
      [-AsCustomObject]
      [-ModuleInfo] <PSModuleInfo[]>
      [-ArgumentList <Object[]>]
      [-DisableNameChecking]
      [-NoClobber]
      [-Scope <String>]
      [<CommonParameters>]

Description

El Import-Module cmdlet agrega uno o varios módulos a la sesión actual. Los módulos que se importen deben estar instalados en el equipo local o en un equipo remoto.

A partir de PowerShell 3.0, los módulos instalados se importan automáticamente a la sesión cuando se usan comandos o proveedores en el módulo. Sin embargo, todavía puede usar el Import-Module comando para importar un módulo y puede habilitar y deshabilitar la importación automática de módulos mediante la variable de $PSModuleAutoloadingPreference preferencia. Para obtener más información sobre los módulos, consulte about_Modules. Para obtener más información sobre la $PSModuleAutoloadingPreference variable, vea about_Preference_Variables.

Un módulo es un paquete que contiene miembros que se pueden usar en PowerShell. Los miembros incluyen cmdlets, proveedores, scripts, funciones, variables y otras herramientas y archivos. Después de importar un módulo, se pueden usar los miembros de ese módulo en la sesión.

Para importar un módulo, use los parámetros Name, Assembly, ModuleInfo, MinimumVersion y RequiredVersion para identificar el módulo que se va a importar. De forma predeterminada, Import-Module importa todos los miembros que exporta el módulo, pero puede usar los parámetros Alias, Function, Cmdlet y Variable para restringir los miembros que se importan. También puede usar el parámetro NoClobber para evitar Import-Module importar miembros que tengan los mismos nombres que los miembros de la sesión actual.

Import-Module importa un módulo solo en la sesión actual. Para importar el módulo en todas las sesiones, agregue un Import-Module comando al perfil de PowerShell. Para obtener más información sobre los perfiles, consulte about_Profiles.

A partir de Windows PowerShell 3.0, puede usar Import-Module para importar módulos de Common Information Model (CIM), en los que los cmdlets se definen en archivos XML de definición de cmdlets (CDXML). Esta característica permite usar los cmdlets que se implementan en ensamblados de código no administrado, como los que se escriben en C++.

Con estas nuevas características, Import-Module el cmdlet se convierte en una herramienta principal para administrar empresas heterogéneas que incluyen equipos que ejecutan el sistema operativo Windows y los equipos que ejecutan otros sistemas operativos.

Para administrar equipos remotos que ejecutan el sistema operativo Windows con PowerShell y la comunicación remota de PowerShell habilitado, cree una PSSession en el equipo remoto y, a continuación, use el parámetro PSSession de para obtener los módulos de Get-Module PowerShell en PSSession. Al importar los módulos y, a continuación, usar los comandos importados en la sesión actual, los comandos se ejecutan implícitamente en la PSSession del equipo remoto. Puede recurrir a esta estrategia para administrar el equipo remoto.

Puede usar una estrategia similar para administrar equipos que no tienen habilitada la comunicación remota de PowerShell, incluidos los equipos que no ejecutan el sistema operativo Windows y los equipos Windows que tienen PowerShell habilitado, pero no tienen habilitada la comunicación remota de PowerShell.

Empiece por crear una sesión CIM en el equipo remoto, que es una conexión a Instrumental de administración de Windows (WMI) en el equipo remoto. A continuación, use el parámetro CIMSession de Import-Module para importar módulos CIM desde el equipo remoto. Al importar un módulo CIM y, a continuación, ejecutar los comandos importados, estos se ejecutan implícitamente en el equipo remoto. Puede recurrir a esta estrategia de WMI y CIM para administrar el equipo remoto.

Ejemplos

Ejemplo 1: Importación de los miembros de un módulo en la sesión actual

En este ejemplo se importan los miembros del módulo PSDiagnostics a la sesión actual. El nombre del parámetro Name es opcional y se puede omitir.

Import-Module -Name PSDiagnostics

De forma predeterminada, Import-Module no genera ninguna salida cuando importa un módulo. Para solicitar resultados, use los parámetros PassThru o AsCustomObject o el parámetro común Verbose.

Ejemplo 2: Importación de todos los módulos especificados por la ruta de acceso del módulo

En este ejemplo se importan todos los módulos disponibles en la ruta de acceso especificada por la $env:PSModulePath variable de entorno en la sesión actual.

Get-Module -ListAvailable | Import-Module

Ejemplo 3: Importación de los miembros de varios módulos en la sesión actual

En este ejemplo se importan los miembros de los módulos PSDiagnostics y Dism a la sesión actual.

$m = Get-Module -ListAvailable PSDiagnostics, Dism
Import-Module -ModuleInfo $m

El Get-Module cmdlet obtiene los módulos PSDiagnostics y Dism y guarda los objetos en la $m variable . El parámetro ListAvailable es necesario cuando se obtienen módulos que aún no se han importado a la sesión.

El parámetro ModuleInfo de Import-Module se usa para importar los módulos a la sesión actual.

Estos comandos son equivalentes a usar un operador de canalización (|) para enviar la salida de un Get-Module comando a Import-Module.

Ejemplo 4: Importación de todos los módulos especificados por una ruta de acceso

En este ejemplo se usa una ruta de acceso explícita para identificar el módulo que se va a importar.

Import-Module -Name c:\ps-test\modules\test -Verbose

VERBOSE: Loading module from path 'C:\ps-test\modules\Test\Test.psm1'.
VERBOSE: Exporting function 'my-parm'.
VERBOSE: Exporting function 'Get-Parameter'.
VERBOSE: Exporting function 'Get-Specification'.
VERBOSE: Exporting function 'Get-SpecDetails'.

El uso del parámetro Verbose hace Import-Module que notifique el progreso a medida que carga el módulo. Sin el parámetro Verbose, PassThru o AsCustomObject , Import-Module no genera ninguna salida cuando importa un módulo.

Ejemplo 5: Restringir los miembros del módulo importados a una sesión

En este ejemplo se muestra cómo restringir qué miembros del módulo se importan en la sesión y el efecto de este comando en la sesión.

Import-Module PSDiagnostics -Function Disable-PSTrace, Enable-PSTrace
(Get-Module PSDiagnostics).ExportedCommands

Key                          Value
---                          -----
Disable-PSTrace              Disable-PSTrace
Disable-PSWSManCombinedTrace Disable-PSWSManCombinedTrace
Disable-WSManTrace           Disable-WSManTrace
Enable-PSTrace               Enable-PSTrace
Enable-PSWSManCombinedTrace  Enable-PSWSManCombinedTrace
Enable-WSManTrace            Enable-WSManTrace
Get-LogProperties            Get-LogProperties
Set-LogProperties            Set-LogProperties
Start-Trace                  Start-Trace
Stop-Trace                   Stop-Trace

Get-Command -Module PSDiagnostics

CommandType     Name                 Version    Source
-----------     ----                 -------    ------
Function        Disable-PSTrace      6.1.0.0    PSDiagnostics
Function        Enable-PSTrace       6.1.0.0    PSDiagnostics

El primer comando importa solo los Disable-PSTrace cmdlets y Enable-PSTrace del módulo PSDiagnostics . El parámetro Function limita los miembros que se importan desde el módulo. También puede usar los parámetros Alias, Variable y Cmdlet para restringir otros miembros que importa un módulo.

El Get-Module cmdlet obtiene el objeto que representa el módulo PSDiagnostics . La propiedad ExportedCmdlets enumera todos los cmdlets que exporta el módulo, aunque no se importaron todos.

En el tercer comando, el parámetro Module del Get-Command cmdlet obtiene los comandos importados desde el módulo PSDiagnostics . Los resultados confirman que solo se importaron los Disable-PSTrace cmdlets y Enable-PSTrace .

Ejemplo 6: Importar los miembros de un módulo y agregar un prefijo

En este ejemplo se importa el módulo PSDiagnostics en la sesión actual, se agrega un prefijo a los nombres de miembro y, a continuación, se muestran los nombres de miembro con prefijo. El prefijo solo se aplica a los miembros de la sesión actual. No modifica el módulo.

Import-Module PSDiagnostics -Prefix x -PassThru

ModuleType Version    Name               ExportedCommands
---------- -------    ----               ----------------
Script     6.1.0.0    PSDiagnostics      {Disable-xPSTrace, Disable-xPSWSManCombinedTrace, Disable-xW...

Get-Command -Module PSDiagnostics

CommandType     Name                                   Version    Source
-----------     ----                                   -------    ------
Function        Disable-xPSTrace                       6.1.0.0    PSDiagnostics
Function        Disable-xPSWSManCombinedTrace          6.1.0.0    PSDiagnostics
Function        Disable-xWSManTrace                    6.1.0.0    PSDiagnostics
Function        Enable-xPSTrace                        6.1.0.0    PSDiagnostics
Function        Enable-xPSWSManCombinedTrace           6.1.0.0    PSDiagnostics
Function        Enable-xWSManTrace                     6.1.0.0    PSDiagnostics
Function        Get-xLogProperties                     6.1.0.0    PSDiagnostics
Function        Set-xLogProperties                     6.1.0.0    PSDiagnostics
Function        Start-xTrace                           6.1.0.0    PSDiagnostics
Function        Stop-xTrace                            6.1.0.0    PSDiagnostics

Usa el parámetro Prefix de Import-Module agrega el prefijo x a todos los miembros que se importan desde el módulo y el parámetro PassThru para devolver un objeto de módulo que representa el módulo importado.

Cmdlet Get-Command para obtener los miembros que se han importado desde el módulo. El resultado muestra que los miembros de módulo incluyen el prefijo correctamente.

Ejemplo 7: Obtener y usar un objeto personalizado

Estos comandos muestran cómo obtener y usar el objeto personalizado que Import-Module devuelve.

Los objetos personalizados incluyen miembros sintéticos que representan cada uno de los miembros de módulo importados. Por ejemplo, los cmdlets y funciones en un módulo se convierten en métodos de script del objeto personalizado.

Los objetos personalizados son muy útiles en el scripting. También son útiles cuando hay varios objetos importados que tienen el mismo nombre. Usar el método de script de un objeto equivale a especificar el nombre completo de un miembro importado, incluido su nombre de módulo.

El parámetro AsCustomObject se puede usar solo al importar un módulo de script, por lo que la primera tarea consistirá en saber cuál de los módulos disponibles es un módulo de script.

Get-Module -List | Format-Table -Property Name, ModuleType -AutoSize

Name          ModuleType
----          ----------
Show-Calendar     Script
BitsTransfer    Manifest
PSDiagnostics   Manifest
TestCmdlets       Script

$a = Import-Module -Name Show-Calendar -AsCustomObject -Passthru
$a | Get-Member

TypeName: System.Management.Automation.PSCustomObject
Name          MemberType   Definition
----          ----------   ----------
Equals        Method       bool Equals(System.Object obj)
GetHashCode   Method       int GetHashCode()
GetType       Method       type GetType()
ToString      Method       string ToString()
Show-Calendar ScriptMethod System.Object Show-Calendar();

$a."Show-Calendar"()

El primer comando usa el Get-Module cmdlet para obtener los módulos disponibles. El comando usa un operador de canalización para pasar los objetos de módulo al Format-Table cmdlet , que enumera name yModuleType de cada módulo de una tabla.

El segundo comando usa el Import-Module cmdlet para importar el módulo de script Show-Calendar . El comando usa el parámetro AsCustomObject para solicitar un objeto personalizado y el parámetro PassThru para devolver el objeto. El comando guarda el objeto personalizado resultante en la $a variable .

El tercer comando usa un operador de canalización para enviar la $a variable al Get-Member cmdlet , que obtiene las propiedades y métodos del PSCustomObject en $a. La salida muestra un método de script Show-Calendar().

El último comando usa el método de script Show-Calendar. El nombre del método debe ir entre comillas, ya que incluye un guión.

Ejemplo 8: Volver a importar un módulo en la misma sesión

En este ejemplo se muestra cómo usar el parámetro Force de Import-Module al volver a importar un módulo en la misma sesión.

Import-Module PSDiagnostics
Import-Module PSDiagnostics -Force -Prefix PS

El primer comando importa el módulo PSDiagnostics . El segundo comando importa el módulo de nuevo, esta vez mediante el parámetro Prefix.

Con el parámetro Force , quita el módulo y, a continuación, Import-Module lo importa de nuevo. Sin este parámetro, la sesión incluiría dos copias de cada cmdlet PSDiagnostics , uno con el nombre estándar y otro con el nombre con el prefijo.

Ejemplo 9: Ejecución de comandos ocultos por comandos importados

En este ejemplo se muestra cómo ejecutar comandos que han sido ocultados por comandos importados. Módulo TestModule . incluye una función denominada Get-Date que devuelve el año y el día del año.

Get-Date

Thursday, August 15, 2019 2:26:12 PM

Import-Module TestModule
Get-Date

19227

Get-Command Get-Date -All | Format-Table -Property CommandType, Name, ModuleName -AutoSize

CommandType     Name         ModuleName
-----------     ----         ----------
Function        Get-Date     TestModule
Cmdlet          Get-Date     Microsoft.PowerShell.Utility

Microsoft.PowerShell.Utility\Get-Date

Thursday, August 15, 2019 2:26:12 PM

El primer Get-Datecmdlet returns a **DateTime** object with the current date. After importing the **TestModule** module,Get-Date' devuelve el año y el día del año.

Con el parámetro All de Get-Command se obtienen todos los Get-Date comandos de la sesión. Los resultados muestran que hay dos Get-Date comandos en la sesión, una función del módulo TestModule y un cmdlet del módulo Microsoft.PowerShell.Utility .

Dado que las funciones tienen prioridad sobre los cmdlets, la Get-Date función del módulo TestModule se ejecuta, en lugar del Get-Date cmdlet . Para ejecutar la versión original de , debe calificar el nombre del Get-Date comando con el nombre del módulo.

Para más información sobre la precedencia de comandos en PowerShell, consulte about_Command_Precedence.

Ejemplo 10: Importación de una versión mínima de un módulo

Import-Module -Name PSWorkflow -MinimumVersion 3.0.0.0

Este comando importa el módulo PSWorkflow . Usa el parámetro MinimumVersion de Import-Module para importar solo la versión 3.0.0.0 o posterior del módulo.

También puede usar el parámetro RequiredVersion para importar una versión determinada de un módulo o usar los parámetros Module y Version de la #Requires palabra clave para requerir una versión determinada de un módulo en un script.

Ejemplo 11: Importación de un módulo desde un equipo remoto

En este ejemplo se muestra cómo usar el Import-Module cmdlet para importar un módulo desde un equipo remoto. Este comando usa la característica de comunicación remota implícita de PowerShell.

Al importar módulos desde otra sesión, se pueden usar los cmdlets de la sesión actual. Sin embargo, los comandos que usan los cmdlets se ejecutan realmente en la sesión remota.

$s = New-PSSession -ComputerName Server01
Get-Module -PSSession $s -ListAvailable -Name NetSecurity

ModuleType Name                                ExportedCommands
---------- ----                                ----------------
Manifest   NetSecurity                         {New-NetIPsecAuthProposal, New-NetIPsecMainModeCryptoProposal, New-Ne...

Import-Module -PSSession $s -Name NetSecurity
Get-Command -Module NetSecurity -Name Get-*Firewall*

CommandType     Name                                               ModuleName
-----------     ----                                               ----------
Function        Get-NetFirewallAddressFilter                       NetSecurity
Function        Get-NetFirewallApplicationFilter                   NetSecurity
Function        Get-NetFirewallInterfaceFilter                     NetSecurity
Function        Get-NetFirewallInterfaceTypeFilter                 NetSecurity
Function        Get-NetFirewallPortFilter                          NetSecurity
Function        Get-NetFirewallProfile                             NetSecurity
Function        Get-NetFirewallRule                                NetSecurity
Function        Get-NetFirewallSecurityFilter                      NetSecurity
Function        Get-NetFirewallServiceFilter                       NetSecurity
Function        Get-NetFirewallSetting                             NetSecurity

Get-NetFirewallRule -DisplayName "Windows Remote Management*" | Format-Table -Property DisplayName, Name -AutoSize

DisplayName                                              Name
-----------                                              ----
Windows Remote Management (HTTP-In)                      WINRM-HTTP-In-TCP
Windows Remote Management (HTTP-In)                      WINRM-HTTP-In-TCP-PUBLIC
Windows Remote Management - Compatibility Mode (HTTP-In) WINRM-HTTP-Compat-In-TCP

El primer comando usa el New-PSSession cmdlet para crear una sesión remota (PSSession) en el equipo Server01. El comando guarda la PSSession en la $s variable .

El segundo comando usa el parámetro PSSession del Get-Module cmdlet para obtener el módulo NetSecurity en la sesión de la $s variable . Este comando equivale a usar el Invoke-Command cmdlet para ejecutar un Get-Module comando en la sesión de $s (Invoke-Command $s {Get-Module -ListAvailable -Name NetSecurity). La salida muestra que el módulo NetSecurity está instalado en el equipo y está disponible para la sesión en la $s variable .

El tercer comando usa el parámetro PSSession del Import-Module cmdlet para importar el módulo NetSecurity de la sesión de la $s variable en la sesión actual.

El cuarto comando usa el Get-Command cmdlet para obtener comandos que comienzan por Get e incluyen Firewall desde el módulo NetSecurity . La salida obtiene los comandos y confirma que el módulo y sus cmdlets se importaron en la sesión actual.

El quinto comando usa el Get-NetFirewallRule cmdlet para obtener las reglas de firewall de administración remota de Windows en el equipo Server01. Este comando equivale a usar el Invoke-Command cmdlet para ejecutar un Get-NetFirewallRule comando en la sesión de la $s variable .

Ejemplo 12: Administración del almacenamiento en un equipo remoto sin el sistema operativo Windows

En este ejemplo, y debido a que el administrador del equipo ha instalado al proveedor de WMI de detección de módulos, los comandos de CIM pueden usar los valores predeterminados, que están diseñados para el proveedor.

Los comandos de este ejemplo permiten administrar los sistemas de almacenamiento de un equipo remoto que no ejecuta el sistema operativo Windows.

El primer comando usa el New-CimSession cmdlet para crear una sesión en el equipo remoto RSDGF03. La sesión se conecta a WMI en el equipo remoto. El comando guarda la sesión CIM en la $cs variable .

El segundo comando usa la sesión CIM en la $cs variable para ejecutar un Import-Module comando en el equipo RSDGF03. El comando usa el parámetro Name para especificar el módulo CIM Storage.

El tercer comando ejecuta el Get-Command comando en el Get-Disk comando del módulo Storage . Al importar un módulo CIM en la sesión local, PowerShell convierte los archivos CDXML de cada comando en scripts de PowerShell, que aparecen como funciones en la sesión local.

El cuarto comando ejecuta el Get-Disk comando . Aunque el comando se escribe en la sesión local, se ejecuta implícitamente en el equipo remoto desde el que se importó. El comando obtiene objetos del equipo remoto y los devuelve a la sesión local.

$cs = New-CimSession -ComputerName RSDGF03
Import-Module -CimSession $cs -Name Storage
# Importing a CIM module, converts the CDXML files for each command into PowerShell scripts.
# These appear as functions in the local session.
Get-Command Get-Disk

CommandType     Name                  ModuleName
-----------     ----                  ----------
Function        Get-Disk              Storage

# Use implicit remoting to query disks on the remote computer from which the module was imported.
Get-Disk

Number Friendly Name              OperationalStatus          Total Size Partition Style
------ -------------              -----------------          ---------- ---------------
0      Virtual HD ATA Device      Online                          40 GB MBR

Parámetros

-Alias

Especifica los alias que este cmdlet importa desde el módulo a la sesión actual. Escriba una lista separada por comas de alias. Se permite el uso de caracteres comodín.

Algunos módulos exportan automáticamente los alias seleccionados a la sesión cuando dichos módulos se importan. Este parámetro permite seleccionar de entre los alias exportados.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ArgumentList

Especifica una matriz de argumentos o valores de parámetro que se pasan a un módulo de script durante el Import-Module comando. Este parámetro es válido solo cuando se importa un módulo de script.

También puede hacer referencia al parámetro ArgumentList por su alias, args. Para más información, vea about_Aliases.

Type:Object[]
Aliases:Args
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AsCustomObject

Indica que este cmdlet devuelve un objeto personalizado con miembros que representan los miembros del módulo importados. Este parámetro es válido únicamente para módulos de script.

Cuando se usa el parámetro AsCustomObject , importa los miembros del módulo a la sesión y, a continuación, Import-Module devuelve un objeto PSCustomObject en lugar de un objeto PSModuleInfo . Puede guardar el objeto personalizado en una variable y usar la notación de punto para invocar a los miembros.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Assembly

Especifica una matriz de objetos de ensamblado. Este cmdlet importa los cmdlets y proveedores implementados en los objetos de ensamblado especificados. Especifique una variable que contenga objetos de ensamblado o escriba un comando o expresión que cree objetos de ensamblado. También puede canalizar un objeto de ensamblado a Import-Module.

Cuando se usa este parámetro, se importan solo los cmdlets y proveedores implementados por los ensamblados especificados. Si el módulo contiene otros archivos, no se importarán, por lo que podría estar perdiendo miembros importantes del módulo. Use este parámetro para depurar y probar el módulo, o bien cuando el creador del módulo le indique que lo use.

Type:Assembly[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-CimNamespace

Especifica el espacio de nombres de otro proveedor de CIM que expone módulos CIM. El valor predeterminado es el espacio de nombres del proveedor de WMI de detección de módulos.

Use este parámetro para importar módulos CIM desde equipos y dispositivos que no ejecutan un sistema operativo Windows.

Este parámetro se incorporó en Windows PowerShell 3.0.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CimResourceUri

Especifica una ubicación alternativa para los módulos CIM. El valor predeterminado es el URI de recurso del proveedor WMI de detección de módulos en el equipo remoto.

Use este parámetro para importar módulos CIM desde equipos y dispositivos que no ejecutan un sistema operativo Windows.

Este parámetro se incorporó en Windows PowerShell 3.0.

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CimSession

Especifica una sesión CIM en el equipo remoto. Escriba una variable que contenga la sesión CIM o un comando que obtiene la sesión CIM, como un comando Get-CimSession .

Import-Module usa la conexión de sesión CIM para importar módulos desde el equipo remoto a la sesión actual. Al usar los comandos de los módulos importados en la sesión actual, estos comandos se ejecutan realmente en el equipo remoto.

Puede usar este parámetro para importar módulos de equipos y dispositivos que no ejecutan el sistema operativo Windows y equipos Windows que tienen PowerShell, pero no tienen habilitada la comunicación remota de PowerShell.

Este parámetro se incorporó en Windows PowerShell 3.0.

Type:CimSession
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Cmdlet

Especifica una matriz de cmdlets que este cmdlet importa desde el módulo a la sesión actual. Se permite el uso de caracteres comodín.

Algunos módulos exportan automáticamente los cmdlets seleccionados a la sesión cuando dichos módulos se importan. Este parámetro permite seleccionar de entre los cmdlets exportados.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-DisableNameChecking

Indica que este cmdlet suprime el mensaje que le advierte al importar un cmdlet o una función cuyo nombre incluye un verbo no aprobado o un carácter prohibido.

De forma predeterminada, cuando un módulo que importa exporta cmdlets o funciones que tienen verbos no aprobados en sus nombres, PowerShell muestra el siguiente mensaje de advertencia:

ADVERTENCIA: Algunos nombres de comandos importados incluyen verbos no aprobados que podrían hacer que sean menos reconocibles. Utilice el parámetro Verbose para obtener más detalles o escriba Get-Verb para ver la lista de verbos aprobados.

Este mensaje es sólo una advertencia. El módulo completo se importa de todos modos, incluidos los comandos que no cumplen las especificaciones. Aunque el mensaje se muestra a los usuarios del módulo, el autor del módulo debe corregir el problema de nomenclatura.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Este parámetro hace que se cargue un módulo, o se vuelva a cargar, encima del actual.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FullyQualifiedName

Especifica el nombre completo de la especificación del módulo.

Type:ModuleSpecification[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Function

Especifica una matriz de funciones que este cmdlet importa desde el módulo a la sesión actual. Se permite el uso de caracteres comodín.

Algunos módulos exportan automáticamente las funciones seleccionadas a la sesión cuando dichos módulos se importan. Este parámetro permite seleccionar de entre las funciones exportadas.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Global

Indica que este cmdlet importa módulos en el estado de sesión global para que estén disponibles para todos los comandos de la sesión.

De forma predeterminada, cuando Import-Module se llama al cmdlet desde el símbolo del sistema, el archivo de script o el bloque de scripts, todos los comandos se importan en el estado de sesión global.

Cuando se invoca desde otro módulo, Import-Module el cmdlet importa los comandos de un módulo, incluidos los comandos de los módulos anidados, en el estado de sesión del autor de la llamada.

Sugerencia

Debe evitar llamar Import-Module desde dentro de un módulo. En su lugar, declare el módulo de destino como módulo anidado en el manifiesto del módulo primario. Declarar módulos anidados mejora la detectabilidad de las dependencias.

El parámetro Global es equivalente al parámetro Scope con un valor de Global.

Para restringir los comandos que exporta un módulo, use un Export-ModuleMember comando en el módulo de script.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaximumVersion

Especifica una versión máxima. Este cmdlet importa solo una versión del módulo menor o igual que el valor especificado. Si no hay ninguna versión calificado, Import-Module genera un error.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MinimumVersion

Especifica una versión mínima. Este cmdlet importa solo una versión del módulo que es mayor o igual que el valor especificado. Si no hay ninguna versión calificado, Import-Module genera un error.

De forma predeterminada, Import-Module importa el módulo sin comprobar el número de versión.

Use el nombre del parámetro MinimumVersion o su alias, Version.

Para especificar una versión exacta, use el parámetro RequiredVersion. También puede usar los parámetros Module y Version de la palabra clave #Requires para requerir una versión específica de un módulo en un script.

Este parámetro se incorporó en Windows PowerShell 3.0.

Type:Version
Aliases:Version
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ModuleInfo

Especifica una matriz de objetos de módulo que se van a importar. Escriba una variable que contenga los objetos del módulo o un comando que obtiene los objetos de módulo, como el siguiente comando: Get-Module -ListAvailable. También puede canalizar objetos de módulo a Import-Module.

Type:PSModuleInfo[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Especifica los nombres de los módulos que se van a importar. Escriba el nombre del módulo o el nombre de un archivo en el módulo, como un archivo .psd1, .psm1, .dll o .ps1. Las rutas de acceso de archivo son opcionales. No se admite el uso de caracteres comodín. También puede canalizar nombres de módulo y nombres de archivo a Import-Module.

Si omite una ruta de acceso, Import-Module busca el módulo en las rutas de acceso guardadas en la $env:PSModulePath variable de entorno.

Especifique solo el nombre del módulo siempre que sea posible. Cuando se especifica un nombre de archivo, solo se importan los miembros que se han implementado en ese archivo. Si el módulo contiene otros archivos, no se importarán, por lo que podría estar perdiendo miembros importantes del módulo.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-NoClobber

Indica que este cmdlet no importa comandos que tienen los mismos nombres que los comandos existentes en la sesión actual. De forma predeterminada, Import-Module importa todos los comandos de módulo exportados.

Los comandos que tienen los mismos nombres pueden ocultar o reemplazar comandos en la sesión. A fin de evitar conflictos de nombre de comando en una sesión, use los parámetros Prefix o NoClobber. Para más información sobre los conflictos de nombre y la precedencia de comandos, consulte la sección sobre módulos y conflictos de nombre en about_Modules y about_Command_Precedence.

Este parámetro se incorporó en Windows PowerShell 3.0.

Type:SwitchParameter
Aliases:NoOverwrite
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Prefix

Especifica un prefijo que este cmdlet agrega a los nombres de los nombres de los miembros del módulo importados.

Use este parámetro para evitar los conflictos de nombre que se pueden producir cuando distintos miembros de la sesión tienen el mismo nombre. Este parámetro no cambia el módulo y no afecta a los archivos que el módulo importa para su propio uso. Estos se conocen como módulos anidados. Este cmdlet afecta solo a los nombres de los miembros de la sesión actual.

Por ejemplo, si especifica el prefijo UTC e importa un Get-Date cmdlet, el cmdlet se conoce en la sesión como Get-UTCDatey no se confunde con el cmdlet original Get-Date .

El valor de este parámetro tiene precedencia sobre la propiedad DefaultCommandPrefix del módulo, que especifica el prefijo predeterminado.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PSSession

Especifica una sesión administrada por el usuario (PSSession) de PowerShell desde la que este cmdlet importa módulos a la sesión actual. Escriba una variable que contenga una PSSession o un comando que obtiene una PSSession, como un Get-PSSession comando.

Al importar un módulo desde una sesión diferente a la sesión actual, puede usar los cmdlets del módulo de la sesión actual, del mismo modo en que usaría los cmdlets de un módulo local. Los comandos que usan los cmdlets remotos se ejecutan realmente en la sesión remota, pero PowerShell administra los detalles de comunicación remota en segundo plano.

Este parámetro usa la característica de comunicación remota implícita de PowerShell. Equivale a usar el Import-PSSession cmdlet para importar módulos concretos desde una sesión.

Import-Module no puede importar módulos de PowerShell Core desde otra sesión. Los módulos de PowerShell Core tienen nombres que comienzan por Microsoft.PowerShell.

Este parámetro se incorporó en Windows PowerShell 3.0.

Type:PSSession
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RequiredVersion

Especifica una versión del módulo que importa este cmdlet. Si la versión no está instalada, Import-Module genera un error.

De forma predeterminada, Import-Module importa el módulo sin comprobar el número de versión.

Para especificar una versión mínima, use el parámetro MinimumVersion. También puede usar los parámetros Module y Version de la palabra clave #Requires para requerir una versión específica de un módulo en un script.

Este parámetro se incorporó en Windows PowerShell 3.0.

Los scripts que usan RequiredVersion para importar módulos que se incluyen con versiones existentes del sistema operativo Windows no se ejecutan automáticamente en futuras versiones del sistema operativo Windows. Esto se debe a que los números de versión del módulo de PowerShell en versiones futuras del sistema operativo Windows son superiores a los números de versión del módulo en las versiones existentes del sistema operativo Windows.

Type:Version
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scope

Especifica un ámbito en el que este cmdlet importa el módulo.

Los valores permitidos para este parámetro son los siguientes:

  • Global. disponible para todos los comandos de la sesión. Equivale al parámetro Global.
  • Local. disponible solo en el ámbito actual.

De forma predeterminada, cuando Import-Module se llama al cmdlet desde el símbolo del sistema, el archivo de script o el bloque de scripts, todos los comandos se importan en el estado de sesión global. Puede usar el parámetro -Scope con el valor de Local para importar el contenido del módulo en el ámbito de script o scriptblock.

Cuando se invoca desde otro módulo, Import-Module el cmdlet importa los comandos de un módulo, incluidos los comandos de los módulos anidados, en el estado de sesión del autor de la llamada. Especificar -Scope Global o -Global indica que este cmdlet importa módulos en el estado de sesión global para que estén disponibles para todos los comandos de la sesión.

El parámetro Global es equivalente al parámetro Scope con un valor de Global.

Este parámetro se incorporó en Windows PowerShell 3.0.

Type:String
Accepted values:Local, Global
Position:Named
Default value:Current scope
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Variable

Especifica una matriz de variables que este cmdlet importa desde el módulo a la sesión actual. Escriba una lista de variables. Se permite el uso de caracteres comodín.

Algunos módulos exportan automáticamente las variables seleccionadas a la sesión cuando dichos módulos se importan. Este parámetro permite seleccionar de entre las variables exportadas.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

Entradas

System.String, System.Management.Automation.PSModuleInfo, System.Reflection.Assembly

Puede canalizar un nombre de módulo, un objeto de módulo o un objeto de ensamblado a este cmdlet.

Salidas

None, System.Management.Automation.PSModuleInfo, or System.Management.Automation.PSCustomObject

Este cmdlet devuelve un PSModuleInfo o PSCustomObject. De forma predeterminada, Import-Module no genera ninguna salida. Si especifica el parámetro PassThru , el cmdlet genera un objeto System.Management.Automation.PSModuleInfo que representa el módulo. Si especifica el parámetro AsCustomObject , genera un objeto PSCustomObject .

Notas

  • Para poder importar un módulo, el módulo debe estar instalado en el equipo local. Es decir, el directorio del módulo debe copiarse en un directorio al que se pueda acceder al equipo local. Para obtener más información, consulte about_Modules.

    También se pueden usar los parámetros PSSession y CIMSession para importar los módulos instalados en equipos remotos. Sin embargo, los comandos que usen los cmdlets en estos módulos se ejecutan realmente en la sesión remota en el equipo remoto.

  • Si importa miembros con el mismo nombre y el mismo tipo en la sesión, PowerShell usa el miembro importado por última vez de forma predeterminada. Las variables y los alias se reemplazan y no se podrá acceder a los originales. Las funciones, los cmdlets y los proveedores son simplemente sombreados por los nuevos miembros. Se puede acceder a ellos calificando el nombre del comando con el nombre de su complemento, módulo o ruta de acceso de función.

  • Para actualizar los datos de formato de los comandos que se han importado desde un módulo, use el Update-FormatData cmdlet . Update-FormatData también actualiza los datos de formato de los comandos de la sesión que se importaron desde los módulos. Si cambia el archivo de formato de un módulo, puede ejecutar un Update-FormatData comando para actualizar los datos de formato de los comandos importados. No es necesario volver a importar el módulo.

  • A partir de Windows PowerShell 3.0, los comandos principales que se instalan con PowerShell se empaquetan en módulos. En Windows PowerShell 2.0 y en programas host que crean sesiones de estilo anterior en versiones posteriores de PowerShell, los comandos principales se empaquetan en complementos (PSSnapins). La excepción es Microsoft.PowerShell.Core, que siempre es un complemento. Además, las sesiones remotas, como las iniciadas por el New-PSSession cmdlet, son sesiones de estilo anterior que incluyen complementos principales.

    Para obtener información sobre el método CreateDefault2 que crea sesiones de estilo más reciente con módulos principales, consulte el método CreateDefault2.

  • Import-Module no puede importar módulos de PowerShell Core desde otra sesión. Los módulos de PowerShell Core tienen nombres que comienzan por Microsoft.PowerShell.

  • En Windows PowerShell 2.0, algunos de los valores de propiedad del objeto module, como los valores de propiedad ExportedCmdlets y NestedModules, no se rellenaron hasta que se importó el módulo y no estaban disponibles en el objeto de módulo que devuelve el parámetro PassThru. En Windows PowerShell 3.0, se rellenan todos los valores de propiedad del módulo.

  • Si intenta importar un módulo que contiene ensamblados en modo mixto que no son compatibles con Windows PowerShell 3.0, Import-Module devuelve un mensaje de error similar al siguiente.

    Import-Module : el ensamblado de modo mixto se compila con la versión "v2.0.50727" del runtime y no se puede cargar en el entorno de ejecución 4.0 sin información de configuración adicional.

    Este error se produce cuando un módulo diseñado para Windows PowerShell 2.0 contiene al menos un ensamblado de módulo mixto, es decir, un ensamblado que incluye código administrado y no administrado, como C++ y C#.

    Para importar un módulo que contiene ensamblados en modo mixto, inicie Windows PowerShell 2.0 mediante el siguiente comando y vuelva a intentarloImport-Module.

    PowerShell.exe -Version 2.0

  • Para usar la característica de sesión CIM, el equipo remoto debe disponer de comunicación remota de WS-Management y de Instrumental de administración de Windows (WMI), que es la implementación de Microsoft del Modelo de información común (CIM) estándar. El equipo también debe contar con el proveedor de WMI de detección de módulos o con otro proveedor de CIM que posea las mismas características básicas.

    Puede usar la característica de sesión CIM en equipos que no ejecutan un sistema operativo Windows y en equipos Windows que tienen PowerShell, pero no tienen habilitada la comunicación remota de PowerShell.

    También puede usar los parámetros CIM para obtener módulos CIM de equipos que tienen habilitada la comunicación remota de PowerShell, incluido el equipo local. Al crear una sesión CIM en el equipo local, PowerShell usa DCOM, en lugar de WMI, para crear la sesión.