Powershell互斥参数使用实例

时间:2022-11-21 11:18:41

有时Powershell的函数需要互斥,让用户只能在其中二选一。
要给脚本创建一组互斥的参数,可以给他们打上不同的属性标志,同时确保它们的唯一性(假设不能自动识别参数类型).

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
function Test-ParameterSet
{
 [CmdletBinding(DefaultParameterSetName='number')]
 param
 (
  [int]
  [Parameter(ParameterSetName='number', Position=0)]
  $id,
 
  [string]
  [Parameter(ParameterSetName='text', Position=0)]
  $name
 )
 
 $PSCmdlet.ParameterSetName
 $PSBoundParameters
}

 

上面函数有两个参数,-id和-name.用户只能使用其中一个,同时不能两个都用。同时这里例子也教了大家怎么去获取用户输入的参数。

多个互斥参数可以通过“ParameterSetName”来区分不同的参数设置(也包括集合参数)
事实上你也可以分配多个参数跟一个参数,即一个固定参数和一个可选参数。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
function Test-ParameterSet
{
 [CmdletBinding(DefaultParameterSetName='NonCredential')]
 param
 (
  $id,
 
  [Parameter(ParameterSetName='LocalOnly', Mandatory=$false)]
  $LocalAction,
 
  [Parameter(ParameterSetName='Credential', Mandatory=$true)]
  [Parameter(ParameterSetName='NonCredential', Mandatory=$false)]
  $ComputerName,
 
  [Parameter(ParameterSetName='Credential', Mandatory=$false)]
  $Credential
 )
 
 $PSCmdlet.ParameterSetName
 $PSBoundParameters
 
 if ($PSBoundParameters.ContainsKey('ComputerName'))
 {
  Write-Warning 'Remote Call!'
 }
}

 

Test-ParameterSet 函数告诉你:当使用“NonCredential”时,-ComputerName是可选;当用户使用“-Credential”参数时“-ComputerName”又变成必选参数,如果使用了“-LocalAction”参数,将不能使用-ComputerName和-Credential。