防止在脚本中交互式提示输入参数值



我有一个脚本,pingtest.ps1,它进行以下调用:

Start-abc -SourceIpaddress x.y.x.z -Protocol TCP -DestinationIpAddress a.c.d.e

在执行期间,它会提示输入源端口和目标端口。

如何避免这些交互式提示,而是在同一脚本中传递值?

tl;博士

Start-abc调用中添加-SourcePort 42-DestinationPort 666之类的内容应该可以防止这些交互式提示(当然,您必须提供适当的值来代替此处使用的示例值42666)。

要确定这些参数的确切名称和背景信息,请继续阅读。


If 命令调用不会为其所有必需参数(需要值才能使命令运行的参数)提供参数:

  • PowerShell 通过设计以交互方式提示这些参数,
  • 并且仅当您提供所有必需的参数(使用有效值)时,命令才会实际执行。

注意:此提示机制在实践中很少使用,并且不适用于所有参数类型 - 请参阅 GitHub 问题 #4068。


如果只想阻止运行时出现交互式提示,请通过-noninteractive开头的新 PowerShell 实例运行命令:

powershell.exe -noninteractive -file C:pathtopingtest.ps1

这样,脚本就不会提示并报告错误,该错误指示未提供参数的(第一个)必需参数的名称。

警告:在默认错误处理生效的情况下,脚本执行仍将继续;设置$ErrorActionPreference = 'Stop'会阻止这种情况。


如果要在设计时确定哪些参数是必需的,请使用
Get-Command <command> -Syntax

如果必要且可用,请补充Get-Help -Detailed <command>(或-Full)或Get-Help -Parameter <parameterName> <command>以了解有关参数的详细信息。
但是请注意,自定义脚本和函数可能没有与之关联的帮助信息。

PowerShell 的语法关系图(记录在概念about_Command_Syntax帮助主题中)不是最容易破译的,但它们确实会告诉你哪些参数是必需的。

Get-Itemcmdlet 为例:

PS> Get-Command Get-Item -Syntax
Get-Item [-Path] <string[]> [-Filter <string>] [-Include <string[]>] [-Exclude <string[]>] [-Force] [-Credential <pscredential>] [-UseTransaction] [-Stream <string[]>] [<CommonParameters>]
Get-Item -LiteralPath <string[]> [-Filter <string>] [-Include <string[]>] [-Exclude <string[]>] [-Force] [-Credential <pscredential>] [-UseTransaction] [-Stream <string[]>] [<CommonParameters>]
  • 每个输出行表示一个不同的参数集

  • 将一个参数集与另一个参数集区分开来并不明显;在这种情况下,它是-Path与。-LiteralPath,这对于与提供程序相关的 cmdlet 很常见。

  • 在给定的参数集中,任何未包含在[...]整体中的参数(围绕参数名称(例如,-LiteralPath)和参数类型(例如,<string[]>))都是强制性的。

    • 如果只有参数名称包含在[...]中(例如,[-Path]),则参数也是必需的,但参数可以按位置指定- 也就是说,您可以省略参数名称而仅指定参数(要绑定到参数的值);例如,
      您可以只指定
      Get-Item foo.txt而不是Get-Item -Path foo.txt

根据上述情况,掌握以下信息:

  • 您将使用哪个参数集
  • 它的强制性参数是什么

然后,可以以为所有必需参数提供参数的方式调用命令,从而避免交互式提示。

最新更新