如何使用 Invoke-Command 传递命名参数？

Question

我有一个可以通过 Invoke-Command 远程运行的脚本，

Invoke-Command -ComputerName (Get-Content C:\Scripts\Servers.txt) `
               -FilePath C:\Scripts\ArchiveEventLogs\ver5\ArchiveEventLogs.ps1

只要我使用默认参数，它就可以正常工作。但是，该脚本有 2 个命名的 [switch] 参数（-Debug 和 -Clear）

如何通过 Invoke-Command 传递切换的参数？我已经尝试过 -ArgumentList 但出现错误，所以我一定是语法错误或其他问题。非常感谢任何帮助。

Answer 1

-ArgumentList 基于与 scriptblock 命令的使用，例如：

Invoke-Command -Cn (gc Servers.txt) {param($Debug=$False, $Clear=$False) C:\Scripts\ArchiveEventLogs\ver5\ArchiveEventLogs.ps1 } -ArgumentList $False,$True

当您使用 -File 调用它时，它仍然像哑巴一样传递参数大批。我已经提交了 功能请求将其添加到命令中（请投票赞成）。

因此，您有两个选择：

如果您有一个如下所示的脚本，位于可从远程计算机访问的网络位置（请注意，隐含 -Debug ，因为当我使用 Parameter< /code> 属性，脚本隐式获取 CmdletBinding，因此获取所有常用参数）：

param(
   [Parameter(Position=0)]
   $one
,
   [Parameter(Position=1)]
   $two
,
   [Parameter()]
   [Switch]$Clear
)

"The test is for '$one' and '$two' ... and we $(if($DebugPreference -ne 'SilentlyContinue'){"will"}else{"won't"}) run in debug mode, and we $(if($Clear){"will"}else{"won't"}) clear the logs after."

无需纠结于 $Clear 的含义...如果您想调用它，您可以使用以下任一 Invoke-Command 语法：

icm -cn (gc Servers.txt) { 
    param($one,$two,$Debug=$False,$Clear=$False)
    C:\Scripts\ArchiveEventLogs\ver5\ArchiveEventLogs.ps1 @PSBoundParameters
} -ArgumentList "uno", "dos", $false, $true

在该语法中，我在 脚本块 中复制我关心的所有参数，以便可以传递值。如果我可以对它们进行硬编码（这就是我实际所做的），则无需这样做并使用 PSBoundParameters，我只需传递我需要的参数即可。在下面的第二个示例中，我将传递 $Clear 一个，只是为了演示如何传递开关参数：

icm -cn $Env:ComputerName { 
    param([bool]$Clear)
    C:\Scripts\ArchiveEventLogs\ver5\ArchiveEventLogs.ps1 "uno" "dos" -Debug -Clear:$Clear
} -ArgumentList $(Test-Path $Profile)

另一个选项

如果脚本位于本地计算机上，并且您不想将参数更改为位置参数，或者您想要指定常见参数的参数（因此您无法控制它们），您将需要获取该脚本的内容并将其嵌入到您的脚本块中：

$script = [scriptblock]::create( @"
param(`$one,`$two,`$Debug=`$False,`$Clear=`$False)
&{ $(Get-Content C:\Scripts\ArchiveEventLogs\ver5\ArchiveEventLogs.ps1 -delimiter ([char]0)) } @PSBoundParameters
"@ )

Invoke-Command -Script $script -Args "uno", "dos", $false, $true

PostScript：

如果您确实需要要传入脚本名称的变量，您要做的事情取决于该变量是本地定义的还是远程定义的。一般来说，如果您有一个带有脚本名称的变量 $Script 或环境变量 $Env:Script ，您可以使用调用运算符 (& ): &$Script 或 &$Env:Script

如果它是已在远程计算机上定义的环境变量，则仅此而已。如果它是一个本地变量，那么您必须将其传递给远程脚本块：

Invoke-Command -cn $Env:ComputerName { 
    param([String]$Script, [bool]$Clear)
    & $ScriptPath "uno" "dos" -Debug -Clear:$Clear
} -ArgumentList $ScriptPath, (Test-Path $Profile)

Answer 2

我的解决方案是使用 [scriptblock]:Create 动态编写脚本块：

# Or build a complex local script with MARKERS here, and do substitutions
# I was sending install scripts to the remote along with MSI packages
# ...for things like Backup and AV protection etc.

$p1 = "good stuff"; $p2 = "better stuff"; $p3 = "best stuff"; $etc = "!"
$script = [scriptblock]::Create("MyScriptOnRemoteServer.ps1 $p1 $p2 $etc")
#strings get interpolated/expanded while a direct scriptblock does not

# the $parms are now expanded in the script block itself
# ...so just call it:
$result = invoke-command $computer -script $script

传递参数非常令人沮丧，尝试了各种方法，例如，
-arguments、$using:p1 等，这只是按预期工作，没有任何问题。

由于我以这种方式控制创建 [scriptblock] （或脚本文件）的字符串的内容和变量扩展，因此“invoke-command”咒语没有真正的问题。

（这不应该那么难。:)）

Answer 3

我怀疑这是自创建这篇文章以来的一个新功能 - 使用 $Using:var 将参数传递给脚本块。然后，只要脚本已经在机器上或相对于机器的已知网络位置，传递参数就很简单了，

主要示例如下：

icm -cn $Env:ComputerName { 
    C:\Scripts\ArchiveEventLogs\ver5\ArchiveEventLogs.ps1 -one "uno" -two "dos" -Debug -Clear $Using:Clear
}

Answer 4

我需要一些东西来调用带有命名参数的脚本。我们的政策是不使用参数的顺序定位并要求参数名称。

我的方法与上面的方法类似，但获取要调用的脚本文件的内容并发送包含参数和值的参数块。

这样做的优点之一是您可以选择将哪些参数发送到脚本文件，从而允许使用默认值的非强制参数。

假设临时路径中有一个名为“MyScript.ps1”的脚本，该脚本具有以下参数块：

[CmdletBinding(PositionalBinding = $False)]
param
(
    [Parameter(Mandatory = $True)] [String] $MyNamedParameter1,
    [Parameter(Mandatory = $True)] [String] $MyNamedParameter2,
    [Parameter(Mandatory = $False)] [String] $MyNamedParameter3 = "some default value"
)

这就是我从另一个脚本调用此脚本的方式：

$params = @{
    MyNamedParameter1 = $SomeValue
    MyNamedParameter2 = $SomeOtherValue
}

If ($SomeCondition)
{
    $params['MyNamedParameter3'] = $YetAnotherValue
}

$pathToScript = Join-Path -Path $env:Temp -ChildPath MyScript.ps1

$sb = [scriptblock]::create(".{$(Get-Content -Path $pathToScript -Raw)} $(&{
        $args
} @params)")
Invoke-Command -ScriptBlock $sb

我已经在很多场景中使用了它，并且效果非常好。
您偶尔需要做的一件事是在参数值分配块周围加上引号。当值中存在空格时，总是会出现这种情况。

例如，此参数块用于调用脚本，该脚本将各种模块复制到 PowerShell C:\Program Files\WindowsPowerShell\Modules 使用的标准位置，其中包含空格字符。

$params = @{
        SourcePath      = "$WorkingDirectory\Modules"
        DestinationPath = "'$(Join-Path -Path $([System.Environment]::GetFolderPath('ProgramFiles')) -ChildPath 'WindowsPowershell\Modules')'"
    }

希望这有帮助！

Answer 5

这是一个不幸的情况。位置参数起作用。

# test.ps1
param($myarg1, $myarg2, $myarg3)

"myarg1 $myarg1"
"myarg2 $myarg2"
"myarg3 $myarg3"

# elevated prompt
invoke-command localhost test.ps1 -args 1,$null,3

myarg1 1
myarg2
myarg3 3

或者您可以硬编码默认值。

# test2.ps1
param($myarg='foo2')

dir $myarg

invoke-command localhost test2.ps1

Cannot find path 'C:\Users\js\Documents\foo2' because it does not exist.

或者将脚本复制到那里：

$s = New-PSSession localhost
copy-item test2.ps1 $home\documents -ToSession $s
icm $s { .\test2.ps1 -myarg foo3 }

Cannot find path 'C:\Users\js\Documents\foo3' because it does not exist.