如何在参数化函数中使用飞溅？

Question

我正在编写一个参数化函数并尝试使用 splatting 来重用参数集。

$Computername='localhost'

$params = @{'computername'=$Computername;
           'credential'='administrator'}

function Get-Diskinfo {
    Param ($drive,$computername,$credential)

    Get-WmiObject win32_logicaldisk -Filter "DeviceID = '$drive'" @params
}

这样执行失败，无法识别用户输入的服务器名称。它仍然采用最初指定的$Computername 的值。

Get-Diskinfo -drive c: Server1 administrator

如何让它识别用户输入的计算机名？我错过了什么吗？

Answer 1

您需要使用 PowerShell 自动定义的东西来代替随机散列表：

function Get-Diskinfo {
Param ($drive,$computername,$credential)

# Need to remove any parameter that is used "internally" and don't exist on cmdlet
$PSBoundParameters.Remove('drive') | Out-Null

    Get-WmiObject win32_logicaldisk -Filter "DeviceID = '$drive'" @PSBoundParameters

}

Get-Diskinfo -drive c: Server1 administrator

或者：使用传递的参数在你的函数中构建 $parms：

function Get-Diskinfo {
Param ($drive,$computername,$credential)

$parms = @{
    computername = $Computername
    credential = $credential
}

Get-WmiObject win32_logicaldisk -Filter "DeviceID = '$drive'" @parms
}

Answer 2

在你的函数内部之前，你不会调用@parms。

这应该可以工作，使用函数中的参数来提取 WMI 查询：

$Computername='localhost'
$parms = @{'computername'=$Computername;
    'credential'='administrator'}

function Get-Diskinfo {
    Param ($drive,$computername,$credential)
    Get-WmiObject win32_logicaldisk -Filter "DeviceID = '$drive'" -ComputerName $computername -Credential $credential
    }

然后使用splatting运行函数：

Get-Diskinfo -drive c: @parm

函数还是可以直接使用参数运行的：

Get-Diskinfo -drive c: Server1 administrator

Answer 3

您的$params 哈希表在您创建它时获得它的价值，而不是在使用它时。您的 $computername,$credential 参数永远不会在您的函数中被引用，这意味着它们是死参数。

您不能同时对同一个参数使用 splatting 和普通函数调用。您应该只在函数脚本块中使用参数。喷溅仅适用于最终用户。 @Tim Ferril 向您展示了如何正确编写函数。

如果您需要能够同时使用两个默认值并且能够更改 ex. ComputerName 对于一个 cmdlet，那么您应该使用默认值而不是 splatting。例如：

function Test-Global {
param(
    $ComputerName = $global:PC,
    $Username = $global:username
)

"Computername is '$ComputerName'"
"Username is '$UserName'"
}

#Set the reusable variables in global scope and call your function
$global:Username = "Frode"
$global:PC = "MyPC"

PS C:\Users\Frode> Test-Global
Computername is 'MyPC'
Username is 'Frode'

#If I need to modify the server for one function, I'd simply specify that parameter
PS C:\Users\Frode> Test-Global -ComputerName server1
Computername is 'server1'
Username is 'Frode'

为了让用户更容易设置默认值，您也可以为此创建一个函数。

#Create your reusable parameters
function Set-Params {
param(
    $ComputerName,
    $Username
)
    if($Username) { $global:Username = $Username }
    if($ComputerName) { $global:PC = $ComputerName }
}

PS C:\Users\Frode> Set-Params -ComputerName Test1 -Username Test1

PS C:\Users\Frode> Test-Global
Computername is 'Test1'
Username is 'Test1'

PS C:\Users\Frode> Set-Params -ComputerName Test2

PS C:\Users\Frode> Test-Global
Computername is 'Test2'
Username is 'Test1'