about_Remote_Variables

Krótki opis

Wyjaśnia, jak używać zmiennych lokalnych i zdalnych w poleceniach zdalnych.

Długi opis

Zmiennych można używać w poleceniach uruchamianych na komputerach zdalnych. Przypisz wartość do zmiennej, a następnie użyj zmiennej w miejsce wartości .

Domyślnie zmienne w poleceniach zdalnych są definiowane w sesji, która uruchamia polecenie. Zmienne zdefiniowane w sesji lokalnej muszą być identyfikowane jako zmienne lokalne w poleceniu .

Używanie zmiennych zdalnych

Program PowerShell zakłada, że zmienne używane w poleceniach zdalnych są definiowane w sesji, w której polecenie jest uruchamiane.

W tym przykładzie zmienna $ps jest definiowana w sesji tymczasowej, w której jest uruchamiane Get-WinEvent polecenie.

Invoke-Command -ComputerName S1 -ScriptBlock {
  $ps = "*PowerShell*"; Get-WinEvent -LogName $ps
}

Gdy polecenie jest uruchamiane w sesji trwałej PSSession, zmienna zdalna musi być zdefiniowana w tej sesji.

$s = New-PSSession -ComputerName S1
Invoke-Command -Session $s -ScriptBlock {$ps = "*PowerShell*"}
Invoke-Command -Session $s -ScriptBlock {Get-WinEvent -LogName $ps}

Używanie zmiennych lokalnych

Zmiennych lokalnych można używać w poleceniach zdalnych, ale zmienna musi być zdefiniowana w sesji lokalnej.

Począwszy od programu PowerShell 3.0, Using można użyć modyfikatora zakresu do identyfikowania zmiennej lokalnej w poleceniu zdalnym.

Składnia polecenia jest Using następująca:

$Using:<VariableName>

W poniższym przykładzie zmienna $ps jest tworzona w sesji lokalnej, ale jest używana w sesji, w której jest uruchamiane polecenie. Modyfikator Using zakresu jest identyfikowany $ps jako zmienna lokalna.

$ps = "*PowerShell*"
Invoke-Command -ComputerName S1 -ScriptBlock {
  Get-WinEvent -LogName $Using:ps
}

Modyfikator Using zakresu może być używany w pssession.

$s = New-PSSession -ComputerName S1
$ps = "*PowerShell*"
Invoke-Command -Session $s -ScriptBlock {Get-WinEvent -LogName $Using:ps}

Odwołanie do zmiennej, takie $using:var jak , rozszerza się do wartości zmiennej $var z kontekstu wywołującego. Nie uzyskujesz dostępu do obiektu zmiennej obiektu wywołującego. Modyfikator Using zakresu nie może służyć do modyfikowania zmiennej lokalnej w sesji PSSession. Na przykład poniższy kod nie działa:

$s = New-PSSession -ComputerName S1
$ps = "*PowerShell*"
Invoke-Command -Session $s -ScriptBlock {$Using:ps = 'Cannot assign new value'}

Aby uzyskać więcej informacji na temat Usingabout_Scopes

Korzystanie z narzędzia splatting

Splatting programu PowerShell przekazuje kolekcję nazw parametrów i wartości do polecenia. Aby uzyskać więcej informacji, zobacz about_Splatting.

W tym przykładzie zmienna splatting jest $Splat tabelą skrótów, która jest ustawiana na komputerze lokalnym. Łączy Invoke-Command się z sesją komputera zdalnego. ScriptBlock używa modyfikatora Using zakresu z symbolem At (@) do reprezentowania zmiennej splatted.

$Splat = @{ Name = "Win*"; Include = "WinRM" }
Invoke-Command -Session $s -ScriptBlock { Get-Service @Using:Splat }

Inne sytuacje, w których jest potrzebny modyfikator zakresu "Using"

W przypadku dowolnego skryptu lub polecenia, które jest wykonywane poza sesją, potrzebny jest modyfikator zakresu do Using osadzania wartości zmiennych z zakresu sesji wywołującej, aby kod poza sesją był w stanie uzyskać do nich dostęp. Modyfikator Using zakresu jest obsługiwany w następujących kontekstach:

  • Polecenia wykonywane zdalnie, rozpoczęte przy Invoke-Command użyciu parametru ComputerName lub Session (sesja zdalna)
  • Zadania w tle, rozpoczęte z Start-Job (sesja poza procesem)
  • Zadania wątków uruchomione za pośrednictwem Start-ThreadJob (oddzielna sesja wątku)

W zależności od kontekstu osadzone wartości zmiennych są niezależnymi kopiami danych w zakresie obiektu wywołującego lub odwołaniami do niego. W sesjach zdalnych i poza procesami są one zawsze niezależnymi kopiami. W sesjach wątków są one przekazywane przez odwołanie.

Serializacja wartości zmiennych

Zdalnie wykonywane polecenia i zadania w tle są wykonywane poza procesem. Sesje poza procesem używają serializacji i deserializacji opartej na formacie XML, aby udostępnić wartości zmiennych w granicach procesu. Proces serializacji konwertuje obiekty do obiektu PSObject , który zawiera właściwości oryginalnych obiektów, ale nie jego metody.

W przypadku ograniczonego zestawu typów deserializacja ponownie dodaje obiekty do oryginalnego typu. Ponownie nawodniony obiekt jest kopią oryginalnego wystąpienia obiektu. Ma właściwości typu i metody. W przypadku prostych typów, takich jak System.Version, kopia jest dokładna. W przypadku typów złożonych kopia jest niedoskonała. Na przykład ponownie pozysłane obiekty certyfikatów nie zawierają klucza prywatnego.

Wystąpienia wszystkich innych typów to wystąpienia obiektu PSObject . Właściwość PSTypeNames zawiera oryginalną nazwę typu poprzedzoną prefiksem Deserialized, na przykład Deserialized.System.Data.DataTable

Używanie zmiennych lokalnych z parametrem ArgumentList

Zmiennych lokalnych można używać w zdalnym poleceniu, definiując parametry zdalnego polecenia i używając parametru ArgumentList Invoke-Command polecenia cmdlet, aby określić zmienną lokalną jako wartość parametru.

  • Użyj słowa kluczowego param , aby zdefiniować parametry polecenia zdalnego. Nazwy parametrów są symbolami zastępczymi, które nie muszą być zgodne z nazwą zmiennej lokalnej.

  • Użyj parametrów zdefiniowanych przez słowo kluczowe param w poleceniu .

  • Użyj ArgumentList parametru Invoke-Command polecenia cmdlet, aby określić zmienną lokalną jako wartość parametru.

Na przykład następujące polecenia definiują zmienną $ps w sesji lokalnej, a następnie używają jej w poleceniu zdalnym. Polecenie używa jako $log nazwy parametru i zmiennej lokalnej , $psjako wartości.

$ps = "*PowerShell*"
Invoke-Command -ComputerName S1 -ScriptBlock {
  param($log)
  Get-WinEvent -LogName $log
} -ArgumentList $ps

Zobacz też