C H A P T E; Eem Cli Library Command Extensions; Cli_Close; Cli_Exec - Cisco Catalyst 2960 series Configuration Manual

EEM CLI Library Command Extensions

All command-line interface (CLI) library command extensions belong to the ::cisco::eem namespace.
This library provides users the ability to run CLI commands and get the output of the commands in Tcl.
Users can use commands in this library to spawn an exec and open a virtual terminal channel to it, write the
command to execute to the channel so that the command will be executed by exec, and read back the output
of the command.
There are two types of CLI commands: interactive commands and non-interactive commands.
For interactive commands, after the command is entered, there will be a "Q&A" phase in which the device
will ask for different user options, and the user is supposed to enter the answer for each question. Only after
all the questions have been answered properly will the command run according to the user's options until
completion.
For noninteractive commands, once the command is entered, the command will run to completion. To run
different types of commands using an EEM script, different CLI library command sequences should be used,
which are documented in the "Using the CLI Library to Run a Noninteractive Command" section and in the
"Using the CLI Library to Run an Interactive Command" section in the cli_write Tcl command.
The vty lines are allocated from the pool of vty lines that are configured using the line vty CLI configuration
command. EEM will use a vty line when a vty line is not being used by EEM and there are available vty
lines. EEM will also use a vty line when EEM is already using a vty line and there are three or more vty
lines available. Be aware that the connection will fail when fewer than three vty lines are available, preserving
the remaining vty lines for Telnet use.
Your release may support XML-PI. For details about the XML-PI support, the new CLI library command
extensions, and some examples of how to implement XML-PI, see EEM CLI Library XML-PI Support.
• cli_close, page 1850
• cli_exec, page 1850
• cli_get_ttyname, page 1851
• cli_open, page 1851
• cli_read, page 1852
• cli_read_drain, page 1853
• cli_read_line, page 1853
• cli_read_pattern, page 1854
Consolidated Platform Configuration Guide, Cisco IOS Release 15.2(4)E (Catalyst 2960-X Switches)
74
C H A P T E R
1849