get-input() Function (SLAX and XSLT) and get_input() (Python)
Namespaces
http://xml.juniper.net/junos/commit-scripts/1.0 http://xml.libslax.org/slax
Python Syntax
input = jcs.get_input('string')
SLAX Syntax
var $input = prefix:get-input(string);
XSLT Syntax
<xsl:variable name="input" select="prefix:get-input(string)"/>
Description
Invoke a CLI prompt and wait for user input. The user input is defined as a string for subsequent use. If the script is run non-interactively, the function returns an empty value. This function cannot be used with commit or event scripts.
The prefix associated with the namespace URI should be defined in the prefix-to-namespace mapping in the style sheet.
If the jcs.get_input
string
argument includes a null character sequence (\0
), Python automation scripts generate an Invalid number
of arguments
error.
Parameters
string |
CLI prompt text. |
Return Value
input |
Text typed by the user and stored as a string. The return value will be empty if the script is run non-interactively. |
Usage Examples
In the following SLAX example, the user is prompted to
enter a login name. The user’s input is stored in the variable $username
.
var $username = jcs:get-input("Enter login id: ");
In Python:
username = jcs.get_input("Enter login id: ")
Release Information
Function introduced in Junos OS Release 9.4.
Support for the slax namespace http://xml.libslax.org/slax added in Junos OS Release 12.2.
Support for Python added in Junos OS Release 16.1R1.