在 Op Scripts 中声明和使用命令行参数

如何定义操作脚本中的参数

您可以在 Python、SLAX 或 XSLT op 脚本中直接声明操作脚本的预期命令行参数。

要在 Python 操作脚本中声明命令行参数：

1. 声明一本名为 的 arguments全球字典。
2. 对于每个参数，定义一个名称值对，用于映射到论点名称和论点帮助文本。

Python 语法

注意：

要在 CLI 中显示参数，Python 脚本必须包括该 if __name__ == '__main__': 语句。

要在 SLAX 或 XSLT 操作脚本中声明命令行参数：

1. 声明名为 arguments的全球变量。
2. 对于每个参数，定义一个 <argument> 元素。
3. 在每个 <argument> 元素中：
   • <name>使用参数名称定义元素。
   • 可选定义 <description> 为该论点提供帮助文本的元素。

XSLT 语法

SLAX 语法

如何定义 Junos OS 配置中的参数

您可以在 Junos OS 配置中声明操作脚本的预期命令行参数，作为直接在操作脚本中声明参数的替代项。

要在配置中声明命令行参数：

1. 导航到 arguments 给定脚本的 [edit system scripts op file filename] 层次结构级别上的语句。
2. 配置参数名称。
3. 可选配置 description 语句以提供该论点的帮助文本。

例如：

如何在上下文敏感型帮助中显示参数

在操作脚本或配置中声明参数后，您可以使用 CLI 的上下文敏感帮助列出操作脚本参数。如果包含可选的论点说明，CLI 将显示带有参数名称的帮助文本。

您还可以创建操作脚本的隐藏参数，方法是不在操作脚本或配置中包含参数声明。您通常会在脚本中使用该参数，但是当您为该操作脚本请求环境敏感的帮助时，CLI 不会显示论点或帮助文本。

注意：

如果您在 Junos OS 配置中配置命令行参数，并在操作脚本中直接声明参数，则仍然可用在脚本中声明的参数，但是在发出 op filename ? 命令时，CLI 不会在其中Possible completions列出这些参数。这是因为管理 （mgd） 进程首先检查配置以进行参数，从而填充列表。只有在配置中未找到参数时，mgd 进程才会检查脚本进行参数处理。因此，如果在配置中声明参数，则脚本中声明的任何参数将隐藏在 CLI 中。

有关为操作脚本配置帮助文本的详细信息，请参阅 配置“帮助文本 for Op Scripts”。

如何在 Python Op Scripts 中使用参数

Python 操作脚本可使用标准命令行解析库来处理和使用命令行参数。例如，您可以使用 Python argparse 库轻松定义所需和可选参数，指定默认值，并处理脚本中的参数。

为了让用户更轻松地使用标准 Python 库解析命令行参数，我们修改了将参数传递到 Python 操作脚本的方式。从 Junos OS 版本 21.2R1 和 Junos OS Evolved 版本 21.2R1 开始，当设备将命令行参数传递到 Python op 脚本时，它将单个连字符 （-） 前缀为单个字符的论证名称，并将两个连字符 （--） 前缀为多字符论证名称。在早期版本中，设备会将单个连字符 （-） 前缀至所有参数名称。您应确保操作脚本正确处理特定版本的参数。

以下示例使用模块 argparse 处理脚本参数。这些示例定义了全局 arguments 字典，词典密钥用于定义解析器的预期参数。我们提供了两个示例脚本，用于适当处理指定版本中的参数。

Python 语法（Junos OS 版本 21.2R1 或更高版本）

Python 语法（Junos OS 版本 21.1 和更低版本）

如何在 SLAX 和 XSLT 操作脚本中使用参数

要在 SLAX 或 XSLT 操作脚本中使用命令行参数，必须：

1. 为每个参数包含参数声明
2. 确保参数名称与脚本中的 arguments 可变声明或 arguments Junos OS 配置中的语句中定义的名称相同。

XSLT 语法

SLAX 语法

op 脚本将每个脚本参数的值分配给相应的参数，然后可在整个脚本中参考。