about_Remote_Variables

  • Artykuł

Krótki opis

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

Długi opis

Zmienne można używać w poleceniach uruchamianych na komputerach zdalnych. Przypisz wartość do zmiennej, a następnie użyj zmiennej zamiast 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 jest uruchamiane polecenie.

W tym przykładzie zmienna jest definiowana $ps w sesji tymczasowej, w której Get-WinEvent jest uruchamiane 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

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

Począwszy od programu PowerShell 3.0, możesz użyć Using modyfikatora zakresu, aby zidentyfikować zmienną lokalną w poleceniu zdalnym.

Składnia Using jest 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. Using Modyfikator zakresu identyfikuje $ps się jako zmienną lokalną.

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

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

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

Odwołanie do zmiennej, takie jak $using:var rozszerzenie do wartości zmiennej $var z kontekstu obiektu 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 ramach programu PSSession. Na przykład następujący 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 Usingprogramu , zobacz about_Scopes

Używanie splattingu

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 $Splat splatting jest tabelą skrótu skonfigurowaną na komputerze lokalnym. Program Invoke-Command łączy się z sesją komputera zdalnego. Element ScriptBlock używa Using modyfikatora zakresu z symbolem At (@), aby reprezentować zmienną splatted.

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

Inne sytuacje, w których jest wymagany modyfikator zakresu "Używanie"

W przypadku dowolnego skryptu lub polecenia wykonywanego poza sesją potrzebny jest Using modyfikator zakresu do osadzania wartości zmiennych z zakresu sesji wywołującej, dzięki czemu kod sesji poza sesją może uzyskiwać do nich dostęp. Modyfikator Using zakresu jest obsługiwany w następujących kontekstach:

  • Polecenia wykonywane zdalnie, uruchamiane Invoke-Command przy użyciu parametrów ComputerName, HostName, SSHConnection lub Session (sesja zdalna)
  • Zadania w tle, rozpoczęte (sesja poza procesem Start-Job )
  • Zadania wątków, uruchamiane za pośrednictwem Start-ThreadJob lub ForEach-Object -Parallel (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 procesem są one zawsze niezależnymi kopiami. W sesjach wątków są przekazywane przez odwołanie.

Serializacja wartości zmiennych

Polecenia wykonywane zdalnie i zadania w tle kończą się poza procesem. Sesje poza procesem używają serializacji opartej na formacie XML i deserializacji, aby udostępnić wartości zmiennych w granicach procesu. Proces serializacji konwertuje obiekty na obiekt PSObject , który zawiera oryginalne właściwości obiektów, ale nie jego metody.

W przypadku ograniczonego zestawu typów deserializacja przywraca obiekty z powrotem do oryginalnego typu. Obiekt ponownie wypełniania jest kopią oryginalnego wystąpienia obiektu. Ma właściwości i metody typu. 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 wypełnianie obiektów certyfikatów nie obejmuje klucza prywatnego.

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

Używanie zmiennych lokalnych z parametrem ArgumentList

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

  • 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 param słowo kluczowe w poleceniu .

  • Użyj parametru Invoke-CommandArgumentList 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 zdalnym poleceniu. Polecenie używa $log jako 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ż