Invoke-Command

Invoke-Command [-ScriptBlock] <scriptblock> [[-ComputerName] <string[]>] [-ApplicationName <string>] [-AsJob] [-Authentication {<Default> | <Basic> | <Negotiate> | <NegotiateWithImplicitCredential> | <Credssp> | <Digest> | <Kerberos>}] [-CertificateThumbprint <string>] [-ConfigurationName <string>] [-Credential <PSCredential>] [-HideComputerName] [-JobName <string>] [-Port <int>] [-SessionOption <PSSessionOption>] [-ThrottleLimit <int>] [-UseSSL] [-ArgumentList <Object[]>] [-InputObject <psobject>] [<CommonParameters>]

Invoke-Command [-FilePath] <string> [[-ComputerName] <string[]>] [-ApplicationName <string>] [-AsJob] [-Authentication {<Default> | <Basic> | <Negotiate> | <NegotiateWithImplicitCredential> | <Credssp> | <Digest> | <Kerberos>}] [-ConfigurationName <string>] [-Credential <PSCredential>] [-HideComputerName] [-JobName <string>] [-Port <int>] [-SessionOption <PSSessionOption>] [-ThrottleLimit <int>] [-UseSSL] [-ArgumentList <Object[]>] [-InputObject <psobject>] [<CommonParameters>]

Invoke-Command [-FilePath] <string> [[-Session] <PSSession[]>] [-AsJob] [-HideComputerName] [-JobName <string>] [-ThrottleLimit <int>] [-ArgumentList <Object[]>] [-InputObject <psobject>] [<CommonParameters>]

Invoke-Command [-FilePath] <string> [[-ConnectionURI] <Uri[]>] [-AllowRedirection] [-AsJob] [-Authentication {<Default> | <Basic> | <Negotiate> | <NegotiateWithImplicitCredential> | <Credssp> | <Digest> | <Kerberos>}] [-ConfigurationName <string>] [-Credential <PSCredential>] [-HideComputerName] [-JobName <string>] [-SessionOption <PSSessionOption>] [-ThrottleLimit <int>] [-ArgumentList <Object[]>] [-InputObject <psobject>] [<CommonParameters>]

Invoke-Command [-ScriptBlock] <scriptblock> [-ArgumentList <Object[]>] [-InputObject <psobject>] [<CommonParameters>]

Invoke-Command [-ScriptBlock] <scriptblock> [[-Session] <PSSession[]>] [-AsJob] [-HideComputerName] [-JobName <string>] [-ThrottleLimit <int>] [-ArgumentList <Object[]>] [-InputObject <psobject>] [<CommonParameters>]

Invoke-Command [-ScriptBlock] <scriptblock> [[-ConnectionURI] <Uri[]>] [-AllowRedirection] [-AsJob] [-Authentication {<Default> | <Basic> | <Negotiate> | <NegotiateWithImplicitCredential> | <Credssp> | <Digest> | <Kerberos>}] [-CertificateThumbprint <string>] [-ConfigurationName <string>] [-Credential <PSCredential>] [-HideComputerName] [-JobName <string>] [-SessionOption <PSSessionOption>] [-ThrottleLimit <int>] [-ArgumentList <Object[]>] [-InputObject <psobject>] [<CommonParameters>]

C:\PS>invoke-command -filepath c:\scripts\test.ps1 -computerName Server01

Disks: C:, D:, E:
Status: Warning, Normal, Normal

Descripción
-----------
Este comando ejecuta el script Test.ps1 en el equipo Servidor01. 

El comando utiliza el parámetro FilePath para especificar un script que se encuentra en el equipo local. El script se ejecuta en el equipo remoto y los resultados se devuelven en el equipo local.

C:\PS>invoke-command -computername server01 -credential domain01\user01 -scriptblock {get-culture}

Descripción
-----------
Este comando ejecuta un comando Get-Culture en el equipo remoto Server01. 

Utiliza el parámetro ComputerName para especificar el nombre de equipo y el parámetro Credential para ejecutar el comando en el contexto de seguridad de "Dominio01\Usuario01", un usuario con permiso para ejecutar comandos. Utiliza el parámetro ScriptBlock para especificar el comando que se va a ejecutar en el equipo remoto.

Como respuesta, Windows PowerShell muestra un cuadro de diálogo que solicita la contraseña y un método de autenticación para la cuenta de Usuario01. A continuación, ejecuta el comando en el equipo Server01 y devuelve el resultado.

C:\PS>$s = new-pssession -computername server02 -credential domain01\user01

C:\PS> invoke-command -session $s -scriptblock {get-culture}

Descripción
-----------
En este ejemplo se ejecuta el mismo comando "Get-Culture" en una sesión (una conexión persistente) en el equipo remoto Server02. Normalmente, se crea una sesión solo cuando se está ejecutando una serie de comandos en el equipo remoto.

El primer comando utiliza el cmdlet New-PSSession para crear una sesión en el equipo remoto Server02. A continuación, guarda la sesión en la variable $s.

El segundo comando usa el cmdlet Invoke-Command para ejecutar el comando Get-Culture en Server02. Utiliza el parámetro Session para especificar la sesión guardada en la variable $s. 

Como respuesta, Windows PowerShell ejecuta el comando en la sesión del equipo Server02.

C:\PS>invoke-command -computername Server02 -scriptblock {$p = get-process powershell}

C:\PS> invoke-command -computername Server02 -scriptblock {$p.virtualmemorysize}
C:\PS>

C:\PS> $s = new-pssession -computername Server02
C:\PS> invoke-command -session $s -scriptblock {$p = get-process powershell}
C:\PS> invoke-command -session $s -scriptblock {$p.virtualmemorysize}
17930240

Descripción
-----------
En este ejemplo se comparan los efectos de utilizar los parámetros ComputerName y Session de Invoke-Command. Muestra la forma de utilizar una sesión para ejecutar una serie de comandos que comparten los mismos datos.

Los dos primeros comandos utilizan el parámetro ComputerName de Invoke-Command para ejecutar comandos en el equipo remoto Server02. El primer comando utiliza el comando Get-Process para obtener el proceso de PowerShell en el equipo remoto y guardarlo en la variable $p. El segundo comando obtiene el valor de la propiedad VirtualMemorySize del proceso de PowerShell. 

El primer comando se ejecuta correctamente. Sin embargo, el segundo no, porque al utilizar el parámetro ComputerName, Windows PowerShell crea una conexión solamente para ejecutar el comando. A continuación, cierra la conexión cuando se completa el comando. La variable $p se creó en una conexión, pero no existe en la conexión creada para el segundo comando.

El problema se resuelve creando una sesión (una conexión persistente) en el equipo remoto y ejecutando los dos comandos relacionados en la misma sesión.

El tercer comando usa el cmdlet New-PSSession para crear una sesión en el equipo Server02. A continuación, guarda la sesión en la variable $s. Los comandos cuarto y quinto repiten la serie de comandos utilizada en el primer conjunto, pero en este caso, el comando Invoke-Command utiliza el parámetro Session para ejecutar los dos comandos en la misma sesión. 

En este caso, dado que ambos comandos se ejecutan en la misma sesión, el comando se ejecuta correctamente y el valor de $p sigue estando activo en la sesión $s para uso posterior.

C:\PS>$command = { get-eventlog -log "windows powershell" | where {$_.message -like "*certificate*"} }

C:\PS> invoke-command -computername S1, S2 -scriptblock $command

Descripción
-----------
En este ejemplo se muestra la forma de escribir un comando que se guarda en una variable local. 

Cuando el comando completo se guarda en una variable local, se puede especificar la variable como el valor del parámetro ScriptBlock. No es necesario utilizar la palabra clave "param" o la variable ArgumentList para enviar el valor de la variable local.

El primer comando guarda un comando Get-Eventlog en la variable $command. El formato del comando es el de un bloque de script.

El segundo comando usa el cmdlet Invoke-Command para ejecutar el comando en $command en los equipos remotos S1 y S2.

C:\PS>invoke-command -computername server01, server02, TST-0143, localhost -configurationname MySession.PowerShell -scriptblock {get-eventlog "windows powershell"}

Descripción
-----------
En este ejemplo se muestra la forma de utilizar el cmdlet Invoke-Command para ejecutar un solo comando en varios equipos. 

El comando utiliza el parámetro ComputerName para especificar los equipos. Los nombres de equipo se presentan en una lista separada por comas. La lista de equipos incluye el valor "localhost", que representa el equipo local.

El comando utiliza el parámetro ConfigurationName para especificar una configuración de sesión alternativa para Windows PowerShell y el parámetro ScriptBlock para especificar el comando.

En este ejemplo, el comando del bloque de script obtiene los eventos del registro de eventos de Windows PowerShell en cada equipo remoto.

C:\PS>$version = invoke-command -computername (get-content machines.txt) -scriptblock {(get-host).version}

Descripción
-----------
Este comando obtiene la versión del host de Windows PowerShell que se ejecuta en 200 equipos remotos. 

Dado que solamente se ejecuta un comando, no es necesario crear conexiones persistentes (sesiones) para cada uno de los equipos. En su lugar, el comando utiliza el parámetro ComputerName para indicar los equipos.

El comando utiliza el cmdlet Invoke-Command para ejecutar un comando Get-Host. Utiliza la notación de puntos para obtener la propiedad Version del host de Windows PowerShell.

Para especificar los equipos, utiliza el cmdlet Get-Content para obtener el contenido del archivo Machine.txt, un archivo de nombres de equipo.

Estos comandos se ejecutan de forma sincrónica (de uno en uno). Cuando los comandos se completan, los resultados de los comandos de todos los equipos se guardan en la variable $version. Los resultados incluyen el nombre del equipo en el que se originaron los datos.

C:\PS>$s = new-pssession -computername Server01, Server02

C:\PS> invoke-command -session $s -scriptblock {get-eventlog system} -AsJob

Id   Name    State      HasMoreData   Location           Command
---  ----    -----      -----         -----------        --------             -------
1    Job1    Running    True          Server01,Server02  get-eventlog system


C:\PS> $j = Get-Job

C:\PS> $j | format-list -property *

HasMoreData   : True
StatusMessage :
Location      : Server01,Server02
Command       : get-eventlog system
JobStateInfo  : Running
Finished      : System.Threading.ManualResetEvent
InstanceId    : e124bb59-8cb2-498b-a0d2-2e07d4e030ca
Id            : 1
Name          : Job1
ChildJobs     : {Job2, Job3}
Output        : {}
Error         : {}
Progress      : {}
Verbose       : {}
Debug         : {}
Warning       : {}
StateChanged  :

C:\PS> $results = $j | Receive-Job

Descripción
-----------
Estos comandos ejecutan un trabajo en segundo plano en dos equipos remotos. Dado que el comando Invoke-Command utiliza el parámetro AsJob, los comandos se ejecutan en los equipos remotos, pero el trabajo reside en realidad en el equipo local y los resultados se transmiten al equipo local.

El primer comando utiliza el cmdlet New-PSSession para crear sesiones en los equipos remotos Server01 y Server02.

El segundo comando usa el cmdlet Invoke-Command para ejecutar un trabajo en segundo plano en cada una de las sesiones. El comando utiliza el parámetro AsJob para ejecutar el comando como un trabajo en segundo plano. Este comando devuelve un objeto de trabajo que contiene dos objetos de trabajo secundarios, uno para cada uno de los trabajos ejecutados en los dos equipos remotos.

El tercer comando usa un comando Get-Job para guardar el objeto de trabajo en la variable $j. 

El cuarto comando utiliza un operador de canalización (|) para enviar el valor de la variable $j al cmdlet Format-List, que muestra todas las propiedades del objeto de trabajo en una lista.

El quinto comando obtiene los resultados de los trabajos. Canaliza el objeto de trabajo contenido en $j al cmdlet Receive-Job y almacena los resultados en la variable $results.

C:\PS>$MWFO-LOg = Microsoft-Windows-Forwarding/Operational

C:\PS> invoke-command -computername server01 -scriptblock {param($log, $num) get-eventlog -logname $log -newest $num} -ArgumentList $MWFO-log, 10

Descripción
-----------
En este ejemplo se muestra la forma de incluir los valores de las variables locales en un comando que se ejecuta en un equipo remoto.

El primer comando guarda el nombre del registro de eventos Microsoft-Windows-Forwarding/Operational en la variable $MWFO-Log.

El segundo comando usa el cmdlet Invoke-Command para ejecutar un comando Get-EventLog en el equipo remoto Server01 que obtiene los 10 eventos más recientes del registro de eventos Microsoft-Windows-Forwarding/Operational en Server01.

Este comando utiliza la palabra clave "param" para crear dos variables, $log y $num, que se utilizan como marcadores de posición en el comando Get-EventLog. Estos marcadores de posición tienen nombres arbitrarios que no necesitan coincidir con los nombres de las variables locales que proporcionan sus valores.

Los valores del parámetro ArgumentList muestran las dos maneras diferentes de especificar valores en la lista de argumentos. El valor del marcador de posición $log es la variable $MFWO-Log, que se define en el primer comando. El valor de la variable $num es 10.

Antes de que el comando se envíe al equipo remoto, las variables se reemplazan por los valores especificados.

C:\PS>invoke-command -computername S1, S2 -scriptblock {get-process powershell} 

PSComputerName    Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id   ProcessName
--------------    -------  ------    -----      ----- -----   ------     --   -----------
S1                575      15        45100      40988   200     4.68     1392 powershell
S2                777      14        35100      30988   150     3.68     67   powershell


C:\PS> invoke-command -computername S1, S2 -scriptblock {get-process powershell} -HideComputerName

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id   ProcessName
-------  ------    -----      ----- -----   ------     --   -----------
575      15        45100      40988   200     4.68     1392 powershell
777      14        35100      30988   150     3.68     67   powershell

Descripción
-----------
En este ejemplo se muestra el efecto de utilizar el parámetro HideComputerName de Invoke-Command. 

Los dos primeros comandos utilizan el cmdlet Invoke-Command para ejecutar un comando Get-Process para el proceso de PowerShell. Los resultados del primer comando incluyen la propiedad PsComputerName, que contiene el nombre del equipo en el que se ejecutó el comando. El resultado del segundo comando, que utiliza el parámetro HideComputerName, no incluye la columna PsComputerName.

El uso del parámetro HideComputerName no implica que cambie el objeto. Puede seguir usando los cmdlets Format para mostrar la propiedad PsComputerName de cualquiera de los objetos afectados.

C:\PS>invoke-command -comp (get-content servers.txt) -filepath c:\scripts\sample.ps1 -argumentlist Process, Service

Descripción
-----------
En este ejemplo se utiliza el cmdlet Invoke-Command para ejecutar el script Sample.ps1 en todos los equipos enumerados en el archivo Servers.txt. El comando utiliza el parámetro FilePath para especificar el archivo de script. Este comando permite ejecutar el script en los equipos remotos, aunque el archivo de script no esté accesible a los equipos remotos.

Cuando se envía el comando, el contenido del archivo Sample.ps1 se copia en un bloque de script y el bloque de script se ejecuta en cada uno de los equipos remotos. Este procedimiento es equivalente a utilizar el parámetro ScriptBlock para enviar el contenido del script.

C:\PS>$LiveCred = Get-Credential

C:\PS> Invoke-Command -ConfigurationName Microsoft.Exchange `
         -ConnectionUri https://ps.exchangelabs.com/powershell `
         -Credential $LiveCred  -Authentication Basic `
         -scriptblock {Invoke-Command {Set-Mailbox dan -DisplayName "Dan Park"}

Descripción
-----------
En este ejemplo se muestra la forma de ejecutar un comando en un equipo remoto que está identificado por un URI (dirección de Internet). En este ejemplo concreto se ejecuta un comando Set-Mailbox en un servidor Exchange remoto. El carácter de acento grave (`) en el comando es el carácter de continuación de Windows PowerShell.

El primer comando utiliza el cmdlet Get-Credential para almacenar las credenciales de identificador de Windows Live ID de la variable $LiveCred. Cuando el cuadro de diálogo de credenciales aparezca, escriba las credenciales de identificador de Windows Live.

El segundo comando usa el cmdlet Invoke-Command para ejecutar un comando Set-Mailbox. El comando utiliza el parámetro ConfigurationName para especificar que el comando se debe ejecutar en una sesión que utiliza la configuración de sesión Microsoft.Exchange. El parámetro ConnectionURI especifica la dirección URL del extremo de servidor Exchange. 

El parámetro de credencial especifica las credenciales de Windows Live almacenadas en la variable $LiveCred. El parámetro AuthenticationMechanism especifica el uso de la autenticación básica. El parámetro ScriptBlock especifica un bloque de script que contiene el comando.

C:\PS>$max = New-PSSessionOption -MaximumRedirection 1

C:\PS> Invoke-Command -ConnectionUri https://ps.exchangelabs.com/powershell `
         -scriptblock {Invoke-Command {Get-Mailbox dan} `
         -AllowRedirection -SessionOption $max

Descripción
-----------
Este comando muestra cómo utilizar parámetros SessionOption y AllowRedirection para administrar la redirección de identificadores URI en un comando remoto.

El primer comando utiliza el cmdlet New-PSSessionOption para crear un objeto PSSessionOpption que guarda en la variable $max. El comando utiliza el parámetro MaximumRedirection para establecer en 1 la propiedad MaximumConnectionRedirectionCount del objeto PSSessionOption. 

El segundo comando usa el cmdlet Invoke-Command para ejecutar un comando Get-Mailbox en un servidor remoto donde se ejecuta Microsoft Exchange Server. El comando utiliza el parámetro AllowRedirection para proporcionar permiso explícito para redirigir la conexión a un extremo alternativo. También utiliza el parámetro SessionOption para especificar el objeto de sesión de la variable $max.

Como consecuencia, si el equipo remoto especificado por el parámetro ConnectionURI devuelve un mensaje de redirección, Windows PowerShell redirigirá la conexión, pero si el nuevo destino devuelve otro mensaje de redirección, se superará el valor de recuento de redirección 1 e Invoke-Command devolverá un error que no es de terminación.

C:\PS>$so = New-PSSessionOption -SkipCACheck

PS C:\> invoke-command $s { get-hotfix } -SessionOption $so -credential server01\user01

Descripción
-----------
En este ejemplo se muestra la forma de crear y utilizar un parámetro SessionOption. 

El primer comando utiliza el cmdlet New-PSSessionOption para crear una opción de sesión. Guarda el objeto SessionOption resultante en el parámetro $so.

El segundo comando usa el cmdlet Invoke-Command para ejecutar un comando Get-Hotfix de forma remota. El valor del parámetro SessionOption es el objeto SessionOption en la variable $so.

C:\PS>enable-wsmanCredSSP -delegate server02

C:\PS> connect-wsman Server02

C:\PS> set-item wsman:\server02*\service\auth\credSSP -value $true

C:\PS> $s = new-pssession server02

C:\PS> invoke-command -session $s -script {get-item \\Net03\Scripts\LogFiles.ps1} -authentication credssp -credential domain01\admin01

Descripción
-----------
En este ejemplo se muestra cómo tener acceso a un recurso compartido de red desde una sesión remota. 

El comando requiere que la delegación CredSSP esté habilitada en la configuración del cliente en el equipo local y en la configuración del servicio en el equipo remoto. Para ejecutar los comandos de este ejemplo, el usuario debe ser miembro del grupo Administradores en el equipo local y en el equipo remoto.

El primer comando utiliza el cmdlet Enable-WSManCredSSP para habilitar la delegación CredSSP desde el equipo local Server01 en el equipo remoto Server02. Con ello se establece la configuración del cliente de CredSSP en el equipo local.

El segundo comando usa el cmdlet Connect-WSman para conectarse al equipo Server02. Esta acción agrega un nodo para el equipo Server02 a la unidad WSMan: del equipo local; esto permite ver y cambiar la configuración de WS-Management en el equipo Server02.

El tercer comando utiliza el cmdlet Set-Item para cambiar a True el valor del elemento CredSSP en el nodo Service del equipo Server02. Esta acción habilita CredSSP en la configuración del servicio del equipo remoto.

El cuarto comando utiliza el cmdlet New-PSSession para crear una PSSession en el equipo Server02. Guarda la PSSession en la variable $s.

El quinto comando utiliza el cmdlet Invoke-Command para ejecutar un comando Get-Item en la sesión contenida en $s que obtiene un script desde el recurso compartido de red Net03\Scripts. El comando utiliza el parámetro Credential, y también el parámetro Authentication con el valor CredSSP.