TechLibrary

Navigation

Supported Platforms

Summary of Extension Functions in the jcs and slax Namespaces

The Junos OS and SLAX extension functions are summarized in Table 1.

A function in the jcs namespace is defined in the namespace URI http://xml.juniper.net/junos/commit-scripts/1.0 .

A function in the slax namespace is defined in the namespace URI http://xml.libslax.org/slax . Functions using the slax namespace are supported starting with Junos OS Release 12.2.

Functions introduced in version 1.0 of the SLAX language can be used in SLAX scripts that include either a "version 1.0" statement or a "version 1.1" statement, but functions introduced in version 1.1 of the SLAX language can only be used in SLAX scripts that include the "version 1.1" statement. Scripts written in version 1.1 of the SLAX language are supported starting in Junos OS Release 12.2.

Table 1: Extension Functions in the jcs and slax Namespaces

Function	Name- spaces	SLAX Version	Type	Description
base64-decode()	slax	1.1	Data manipulation	Decode BASE64 encoded data and return a string.
base64-encode()	slax	1.1	Data manipulation	Encode a string of data in the BASE64 encoding format.
break-lines()	jcs, slax	1.0	Data manipulation	Break a simple element into multiple elements, delimited by newlines.
close()	jcs	1.0	Utility	Close a previously opened connection handle.
dampen()	jcs, slax	1.0	Utility	Prevent the same operation from being repeatedly executed within a script.
document()	slax	1.1	Input/output control	Read data from a file or URL and return a string.
empty()	jcs, slax	1.0	Logic	Evaluate a node set or string argument to determine if it is an empty value.
evaluate()	slax	1.1	Input/output control	Evaluate a SLAX expression and return the result.
execute()	jcs	1.0	Utility	Execute a remote procedure call (RPC) within the context of a specified connection handle.
first-of()	jcs, slax	1.0	Logic	Return the first nonempty (non-null) item in a list, If all objects in the list are empty, the default expression is returned.
get-command()	jcs, slax	1.1	Input/output control	Prompt the user for command input and return the input as a string.
get-hello()	jcs	1.0	Utility	Return the session ID and the capabilities of the NETCONF server during a NETCONF session.
get-input()	jcs, slax	1.0	Input/output control	Invoke a CLI prompt and wait for user input. If the script is run non-interactively, the function returns an empty value. This function cannot be used with event scripts.
get-protocol()	jcs	1.0	Utility	Return the session protocol associated with the connection handle.
get-secret()	jcs, slax	1.0	Input/output control	Invoke a CLI prompt and wait for user input. The input is not echoed back to the user.
hostname()	jcs	1.0	Utility	Return the fully qualified domain name associated with a given IPv4 or IPv6 address, provided the DNS server is configured on the device.
invoke()	jcs	1.0	Utility	Invoke an RPC on a local device running Junos OS.
open()	jcs	1.0	Utility	Return a connection handle that can be used to execute RPCs.
output()	jcs, slax	1.0	Input/output control	Generate unformatted output text that is immediately sent to the CLI session.
parse-ip()	jcs	1.0	Data manipulation	Parse an IPv4 or IPv6 address and return the host IP address, protocol family, prefix length, network address, and network mask.
printf()	jcs, slax	1.0	Input/output control	Generate formatted output text. Most standard printf formats are supported, in addition to some Junos OS-specific formats. The function returns a formatted string but does not print it on call.
progress()	jcs, slax	1.0	Input/output control	Issue a progress message containing the single argument immediately to the CLI session provided that the detail flag was specified when the script was invoked.
regex()	jcs, slax	1.0	Data manipulation	Evaluate a regular expression against a given string argument and return any matches.
sleep()	jcs, slax	1.0	Utility	Cause the script to sleep for a specified time.
split()	jcs, slax	1.0	Data manipulation	Split a string into an array of substrings delimited by a regular expression pattern.
sysctl()	jcs, slax	1.0	Utility	Return the value of the given sysctl value as a string or an integer.
syslog()	jcs, slax	1.0	Input/output control	Log messages with the specified priority to the system log file.
trace()	jcs, slax	1.0	Input/output control	Issue a trace message, which is sent to the trace file.

TechLibrary

Supported Platforms

Related Documentation

Summary of Extension Functions in the jcs and slax Namespaces

Related Documentation

Published: 2013-03-05

Supported Platforms

Related Documentation

Published: 2013-03-05