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].

Table 1. Available commands for managing NXLog Platform
Command	Description
Install NXLog Platform
`nxp_manage.sh wizard`	On internet-connected deployments, installs and validates all NXLog Platform dependencies. On air-gapped deployments, validates that the required software dependencies are already installed and extracts the NXLog Platform container images.
`nxp_manage.sh install`	Install NXLog Platform.
`nxp_manage.sh license-import LICENSE_FILE=<path>`	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.
`nxp_manage.sh upgrade`	Upgrade the running NXLog Platform instance to match the version of the current `nxp_manage.sh` CLI installer. See how to upgrade NXLog Platform.
Manage and configure NXLog Platform
`nxp_manage.sh start`	Start NXLog Platform.
`nxp_manage.sh stop`	Stop NXLog Platform and remove all containers, including stale containers. This command preserves your NXLog Platform data volumes.
`nxp_manage.sh apply`	Apply the updated configurations in `master.cnf.sh` and run NXLog Platform.
`nxp_manage.sh import-cert`	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.
`nxp_manage.sh generate-usage-data`	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
`nxp_manage.sh container-log`	Display the log output of a specific container by selecting it from a menu.
`nxp_manage.sh logs`	Display the log output of all NXLog Platform containers.
`nxp_manage.sh follow-logs`	Display and follow the log output of all NXLog Platform containers.
`nxp_manage.sh stats`	Display real-time resource usage statistics of the NXLog Platform containers.
`nxp_manage.sh generate-debug-bundle`	Generate a compressed file containing logs and information to help debug NXLog Platform. Include this file when opening a support ticket.
Back up and restore NXLog Platform
`nxp_manage.sh backup`	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.
`nxp_manage.sh restore BACKUP_FILE=<path to backup file>`	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
`nxp_manage.sh prune`	Stop and remove all NXLog Platform containers and volumes. This command deletes all your NXLog Platform data.