CLI Overview
The Lightbits Command Line Interface (lbcli) allows you to run system administration commands against a Lightbits system. This guide includes a complete list of all commands and their format.
Lightbits offers a simple solution for presenting high-performance NVMe SSD storage to TCP connected client systems. The flow of operations that a user should follow to install, configure, and connect Lightbits-enabled servers includes the following:
- Install and configure the Lightbits software on a supported storage server. This process is detailed in the Introduction and involves installing the Lightbits software.
- Connect Application Clients to the Lightbits storage server(s) via NVMe/TCP. On the client-side standard, NVMe commands are used to discover and connect to the Lightbits servers over a standard TCP network.
- Perform maintenance and administrative tasks on the Lightbits servers. The Introduction provides information about operations that you can perform using the Lightbits lbcli CLI command and REST API.
To complete these steps, you must follow this process for getting started with Lightbits.
- Follow the instructions in the Introduction to install and configure the Lightbits software on a storage server, and install NVMe/TCP software on application servers.
- Use the Introduction to learn more about using the Lightbits management interfaces for day to day storage administration tasks.
This Lightbits User Manual is part of a documentation set that provides complete information about using Lightbits products. This document set includes:
| Document | Description |
|---|---|
| Introduction | Contains the instructions to install and configure the Lightbits software onto a storage server. |
| Lightbits Installation Customer Addendum | Includes customer-specific passwords to access installation files. This also captures customer-specific configuration details if needed. |
| Introduction | All detailed process flow examples for using the lbctl CLI and REST API for system administration and maintenance. |
| User’s Manual: Lightbits REST and CLI API | Lists the low-level details for the REST API and CLI command usage. This document is typically used as a reference manual when building and administering the system. |
The following diagram shows how to use the documents to install, test, and maintain Lightbits products, and how the above-referenced documents can be used to support the typical user experience.
