Introduction to the CLI: Toolkit PowerPack

Download this manual as a PDF file 

This section describes how to use the "CLI: Toolkit" PowerPack.

The "CLI: Toolkit" PowerPack has been superseded by the "Low-code Tools" PowerPack, a single PowerPack that provides CLI, REST, and Prometheus collection steps together. ScienceLogic recommends the "Low-code Tools" PowerPack for all new Snippet Framework development. For more information, see the Low-code Tools PowerPack manual.

What is the CLI: Toolkit PowerPack?

The "CLI: Toolkit" PowerPack adds command-line and SSH collection capabilities to the Snippet Framework. The Snippet Framework is the standard method for building Snippet Dynamic Applications in Skylar One. Rather than writing Python code to collect data, you use Snippet Arguments to define what to collect, and the framework runs a series of prebuilt steps to perform the collection. A toolkit is a PowerPack that supplies a set of these prebuilt steps for a particular collection method. The "CLI: Toolkit" PowerPack supplies the steps used to collect data from devices through command-line and SSH commands, which reduces or removes the need to write Python for CLI-based monitoring. These steps are commonly used with Unix commands.

If you are not already familiar with the Snippet Framework, see the Snippet Framework manual before using this PowerPack. The "Introduction to Snippet Framework" chapter explain what the framework is and how it works, the "Snippet Framework Collection Pipeline" chapter explains steps and the execution model, and the "Snippet Framework Toolkits and Execution Environments" chapter explains how toolkits such as the "CLI: Toolkit" PowerPack supply steps to the framework.

The "CLI: Toolkit" PowerPack adds support for agent devices, though several features are limited when collecting from agents. For details, see the "Agent Limitations" section in the CLI: Toolkit developer documentation.

The minimum Skylar One version for this PowerPack is 11.3.0.

What Does the CLI: Toolkit PowerPack Include?

The "CLI: Toolkit" PowerPack includes:

  • An execution environment with the CLI and SSH steps for building Dynamic Applications for CLI and SSH devices. An execution environment is the runtime in which the framework runs the steps. These steps are used to build monitoring PowerPacks.

  • A template Dynamic Application that demonstrates the CLI steps.

Execution environments, steps, caching, and pagination are Snippet Framework concepts. For more information, see the Snippet Framework Collection Pipeline and Snippet Framework Toolkits and Execution Environments chapters of the Snippet Framework manual, and the Snippet Framework Advanced Topics chapter for caching and pagination.

Installing the CLI: Toolkit PowerPack

To use the CLI collection steps described in this manual, you must import and install the latest version of the "CLI: Toolkit" PowerPack.

This PowerPack will not export from Skylar One versions 11.1 and above.

To download and install a PowerPack:

  1. Search for and download the PowerPack from the PowerPacks page at the ScienceLogic Support Center (Skylar One > PowerPacks, login required).
  2. Go to the PowerPack Manager page (System > Manage > PowerPacks).
  3. In the PowerPack Manager page, click the Actions button, then select Import PowerPack.
  4. The Import PowerPack dialog box appears.
  5. Click the [Browse] button and navigate to the PowerPack file.
  6. When the PowerPack Installer modal appears, click the Install button to install the PowerPack.

If you exit the PowerPack Installer without installing the imported PowerPack, the imported PowerPack will not appear in the PowerPack Manager page. However, the imported PowerPack will appear in the Imported PowerPacks page. This page appears when you click the Actions menu and select Install PowerPack.

Migrating to the Low-code Tools PowerPack

ScienceLogic recommends the "Low-code Tools" PowerPack for all new Snippet Framework development. The "Low-code Tools" PowerPack provides the CLI collection steps described in this manual, along with steps for REST, SNMP, Prometheus, JMX, WinRM, and PowerShell collection, in a single PowerPack. If you are starting new development, use the "Low-code Tools" PowerPack rather than the "CLI: Toolkit" PowerPack. For more information, see the Low-code Tools PowerPack manual.

Documentation for the "CLI: Toolkit" PowerPack

Full reference documentation for the "CLI: Toolkit" PowerPack, including the complete list of available steps, CLI and SSH best practices, and suggested steps, is provided in the CLI: Toolkit developer documentation.