Title
Create new category
Edit page index title
Edit category
Edit link
Using the lbcli Utility
To use the lbcli utility, you will need to access the Linux operating system command line on the server that is running the Lightbits cluster. You can access the Linux server via a direct connection to the physical server or remotely via secure shell (SSH) to the server.
lbcli Command Syntax
The lbcli command syntax includes the following parameters.
lbcli {operation} {resource_type} {mandatory_parameters...} [optional_parameters...]
lbcli CLI Utility Command Syntax
Parameter Name | Description |
|---|---|
Operation | Specifies the operation performed on one or more resources. |
Resource Type | Sets the resource type that the command will address. |
Mandatory Parameters | The parameters that are required for command completeness. |
Optional Parameters | The parameters that are not required for command completeness. |
For example, the command syntax for creating a volume is as follows, where the operation is 'create', the resource type is 'volume', a mandatory parameter is 'name', and the optional parameter is 'ip-acl'.
There are additional mandatory parameters for this command.
Operations
The lbcli CLI utility uses operations to refer to the uppermost management level tasks that can be performed by lbcli. Operations such as create and delete are used for creating and deleting resources. Therefore, a resource type must be specified to use these operations. Other commands could require other sub-operations and parameters.
Command | Description |
|---|---|
login | Logs in to the Lightbits cluster using the IdP server (Beta). |
create | Creates a resource. |
delete | Deletes a resource. |
get | Retrieves information about a resource. |
list | Retrieves information about a list of resources. |
update | Updates information about resources. |
add | Adds an entity into the cluster. |
enable | Enables an entity, such as a cluster server. |
disable | Removes entities from the cluster. |
replace | Replaces entities. |
upgrade | Upgrades cluster/server operations. |
help | Displays help content about any command. |
version | Prints the lbcli version information. |
rollback | Rolls back to a previous snapshot. |
fetch | Fetches logs. |
completion | Generates the autocompletion script for the specified shell. |
set | Sets parameters for resource of type: [trusted-host-secrets]. |
logout | Logs out of the Lightbits cluster (Beta). |
All create/update Lightbits lbcli operations are asynchronous. Some operations take some time to complete. Additionally, some operations can only be done on resources that are in an active state. For example, you cannot update a volume that is not active (i.e., one that has an operation still being executed on it). Therefore it is advised to add a checking or polling mechanism to your API calls to ensure that the operation has succeeded. Deleting a snapshot is an exception, as this is a background operation. All list/get Lightbits lbcli operations are synchronous.
© 2026 Lightbits Labs™