CLI commands for managing NXLog Platform
| The information on this page only applies if you installed NXLog Platform on Linux using the CLI installer, including air-gapped installations. |
The NXLog Platform CLI installer provides the nxp_manage.sh script to manage NXLog Platform.
Run the command nxp_manage.sh help to see a list of the available commands and their descriptions.
This script is not available when deploying NXLog Platform in a Kubernetes cluster using Helm.
You must run the commands with root privileges, for example using sudo nxp_manage.sh [COMMAND].
|
| Command | Description |
|---|---|
Install NXLog Platform |
|
|
On internet-connected deployments, install and validate all NXLog Platform dependencies.
On air-gapped deployments, validate that the required software dependencies are installed, and extract the NXLog Platform container images and offline documentation. |
|
Install NXLog Platform. |
|
Import an offline license file to activate an air-gapped NXLog Platform instance. You must specify the path to the license file as an argument. |
|
Upgrade the running NXLog Platform instance to match the version of the current |
Manage and configure NXLog Platform |
|
|
Start NXLog Platform. |
|
Stop NXLog Platform and remove all containers, including stale containers. This command preserves your NXLog Platform data volumes. |
|
Restart NXLog Platform. |
|
Apply the updated configurations in |
|
Import your SSL certificate to NXLog Platform. The command asks you to specify the path to an existing SSL certificate file. See how to generate a custom certificate and private key pair. |
|
Generate a snapshot of the current usage data for an air-gapped NXLog Platform instance. Upload the generated file to your NXLog Platform account to submit usage data manually, since air-gapped instances can’t report usage automatically. |
Monitor and troubleshoot NXLog Platform |
|
|
Display the log output of a specific container by selecting it from a menu. |
|
Display the log output of all NXLog Platform containers. |
|
Display and follow the log output of all NXLog Platform containers. |
|
Display real-time resource usage statistics of the NXLog Platform containers. |
|
Generate a compressed file containing logs and information to help debug NXLog Platform. Include this file when opening a support ticket. |
|
Display the configuration currently applied to NXLog Platform. Sensitive values, such as the API key and the administrator password, are masked. |
Back up and restore NXLog Platform |
|
|
Back up the NXLog Platform data to a compressed file. This command temporarily stops NXLog Platform. See Back up and restore NXLog Platform for more information. |
|
Restore an NXLog Platform backup. You must specify the backup file as an argument to the command. See Back up and restore NXLog Platform for more information. |
Remove NXLog Platform |
|
|
Stop and remove all NXLog Platform containers and volumes. This command deletes all your NXLog Platform data. |