Declaring Arguments in Op Scripts

There are two ways to declare arguments to an op script: by including XSLT or SLAX instructions in the script or by including statements in the Junos configuration. Script-generated and configuration-generated arguments have the same operational impact.

To declare arguments within a script, declare a global variable named arguments, containing <argument> tag elements. Within each <argument> tag element, include the required <name> tag element and the optional <description> tag element:

<xsl:variable name="arguments">
    <argument>
        <name>name</name>
        <description>name</description>
    </argument>
</xsl:variable>

var $arguments = {
    <argument> {
        <name> "name";
        <description> "descriptive-text";
    }
}

If you include the optional <description> tag element or the description statement, the text of the description appears in the command-line interface (CLI) as a help-text string to describe the purpose of the argument, as discussed in Configuring Help Text for Op Scripts.

<xsl:param name="name"/>

param $name;

You can create a hidden argument by including the <xsl:param name="name"/> instruction without listing the argument in the arguments variable or in the configuration.

Possible completions:
  argument-name        description
  argument-name        description

Note: If you specify an argument that the script does not recognize, the script ignores the argument. If you configure arguments by including the arguments statement in the configuration, any arguments that you declare directly in the script are still available, but are not listed among the Possible completions when you issue the op filename ? command. If you declare all arguments in the script (and none in the configuration), then the arguments do appear in the Possible completions list. This is because the management (mgd) process populates the Possible completions list by first checking the configuration for arguments. The mgd process looks in the script for arguments only if no arguments are found in the configuration. Thus, if arguments are declared in the configuration, the arguments declared in the script become hidden in the CLI.

There are several standard arguments which are available to every script. The standard arguments provide valuable information about the Junos environment. Table 15 describes the built-in arguments

You can access the standard arguments in your script by including the XSLT xsl:param tag or the SLAX param statement at the global level of the script.

You can then access the parameters throughout the script as you would access any variable.

Example: Declaring Arguments

<xsl:param name="interface"/>

<xsl:param name="protocol"/>

<xsl:variable name="arguments">
    <argument>
        <name>interface</name>
        <description>Name of interface to display</description>
    </argument>
    <argument>
        <name>protocol</name>
        <description>Protocol to display (inet, inet6)</description>
    </argument>
</xsl:variable>