PowerShell传递字符串数组至函数失败：VM组启动命令报错

问题场景 #

我编写了用于管理VMware虚拟机的vms.ps1脚本，定义了VM路径映射$VMPaths、VM组映射$VMGroups，以及Start-VMs、List-VMs等管理函数；并在PowerShell的$PROFILE中定义了vm别名函数，用于调用这些VM管理功能。

执行vm list、vm start syslog、vm suspend syslog等命令均正常，但执行vm start --group goad时出现报错：

❯ vm start --group goad
MethodInvocationException: F:\vmware\vms.ps1:93
Line |
  93 |          if ($VMGroups.ContainsKey($groupName)) {
     |              ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     | Exception calling "ContainsKey" with "1" argument(s): "Value cannot be null. (Parameter 'key')"
VM não encontrada: --group

报错原因 #

脚本未正确解析--group命名参数，导致$groupName变量为null，触发ContainsKey方法的非空参数校验错误；同时脚本误将--group识别为VM名称，抛出“VM não encontrada: --group”的错误。

解决方案 #

方案1：使用PowerShell高级函数参数绑定 #

修改Start-VMs为支持命名参数的高级函数，同时调整vm别名函数传递参数：

1. 更新Start-VMs函数：

function Start-VMs {
    [CmdletBinding()]
    param(
        [Parameter(Position=0)]
        [string]$VMName,
        
        [Parameter()]
        [string]$Group
    )

    if ($Group) {
        if ($VMGroups.ContainsKey($Group)) {
            foreach ($vm in $VMGroups[$Group]) {
                # 替换为实际启动VM的逻辑（示例调用vmrun）
                Write-Host "启动虚拟机: $vm"
                # & "vmrun.exe" start "$($VMPaths[$vm])"
            }
        } else {
            Write-Error "组 '$Group' 不存在"
        }
    } elseif ($VMName) {
        if ($VMPaths.ContainsKey($VMName)) {
            Write-Host "启动虚拟机: $VMName"
            # & "vmrun.exe" start "$($VMPaths[$VMName])"
        } else {
            Write-Error "VM não encontrada: $VMName"
        }
    } else {
        Write-Error "请指定VM名称或使用--Group参数指定组"
    }
}

2. 更新vm别名函数：

function vm {
    param(
        [Parameter(Position=0)]
        [string]$Command,
        
        [Parameter(ValueFromRemainingArguments=$true)]
        [string[]]$Args
    )

    switch ($Command) {
        'list' { List-VMs @Args }
        'start' { Start-VMs @Args }
        'suspend' { Suspend-VMs @Args }
        default { Write-Error "未知命令: $Command" }
    }
}

修改后即可通过vm start --Group goad正常启动指定组内的所有VM。

方案2：手动解析命令行参数 #

如果不想使用高级函数，可在Start-VMs中手动识别--group参数：

1. 更新Start-VMs函数：

function Start-VMs {
    $groupName = $null
    $vmName = $null

    # 遍历参数，识别--group标记
    for ($i = 0; $i -lt $args.Count; $i++) {
        if ($args[$i] -eq '--group') {
            if ($i + 1 -lt $args.Count) {
                $groupName = $args[$i + 1]
                break
            } else {
                Write-Error "--group 参数必须指定组名称"
                return
            }
        } else {
            $vmName = $args[$i]
        }
    }

    if ($groupName) {
        if ($VMGroups.ContainsKey($groupName)) {
            foreach ($vm in $VMGroups[$groupName]) {
                Write-Host "启动虚拟机: $vm"
                # & "vmrun.exe" start "$($VMPaths[$vm])"
            }
        } else {
            Write-Error "组 '$groupName' 不存在"
        }
    } elseif ($vmName) {
        if ($VMPaths.ContainsKey($vmName)) {
            Write-Host "启动虚拟机: $vmName"
            # & "vmrun.exe" start "$($VMPaths[$vmName])"
        } else {
            Write-Error "VM não encontrada: $vmName"
        }
    } else {
        Write-Error "请指定VM名称或使用--group参数指定组"
    }
}

2. 更新vm别名函数：

function vm {
    if ($args.Count -eq 0) {
        Write-Error "请指定命令（list/start/suspend）"
        return
    }
    $command = $args[0]
    $remainingArgs = $args[1..($args.Count - 1)]

    switch ($command) {
        'list' { List-VMs @remainingArgs }
        'start' { Start-VMs @remainingArgs }
        'suspend' { Suspend-VMs @remainingArgs }
        default { Write-Error "未知命令: $command" }
    }
}

验证 #

修改完成后，重新加载vms.ps1和$PROFILE（执行. $PROFILE），运行vm start --group goad即可正确识别组名并启动组内所有VM。

内容的提问来源于stack exchange，提问作者Sandson Costa