Commands for managing NXLog Platform

The table below lists the commands available on the NXLog Platform deployer to install, back up, and manage NXLog Platform. Run the command nxp_manage.sh help to see a list of the available commands and their descriptions.

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

Install and validate all NXLog Platform dependencies.

nxp_manage.sh install

Install NXLog Platform.

Manage and configure NXLog Platform

nxp_manage.sh start

Start NXLog Platform.

nxp_manage.sh stop

Stop NXLog Platform.

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.

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 and clean up NXLog Platform

nxp_manage.sh destroy-all

Stop and remove all NXLog Platform containers.

nxp_manage.sh prune

Stop and remove all NXLog Platform containers and volumes. This command deletes all your NXLog Platform data.

nxp_manage.sh clean

Clean up temporary files.