What are the commands available for the Virtual Appliance?

What are the commands available for the Virtual Appliance?

The table below lists the available configuration and management commands for the Lumu Virtual Appliance. Some commands will require privileges, in which case you will be prompted to enter the sudo credentials.

lumu-appliance [argument]

Argument

Description

-h or --help

Print all the available commands with their description.

-v or --version

Show the appliance version.

init

Initialize the appliance components and basic configuration.

set 

Manage the appliance configuration (networks, resolver, preferences, etc). Use -h to obtain help on additional arguments.

show

Print settings and statistics (networks, resolver, preferences, usage, etc). Use -h to obtain help on the additional arguments.

reset

Reset appliance configuration (activation code, etc). Use -h to obtain help on the available options.

start

Start the appliance’s components.

stop

Stop the appliance’s components.

reload

Reload the appliance. Some services may be restarted when using this command.

status

Print appliance’s status information.

logs

Connect the terminal to the appliance logs.

enable

Enable optional features such as proxy, reverse DNS, etc. Use -h to obtain help on the available options.

disable

Disable optional features. Use -h to obtain help on the available options.

check

Perform checks regarding connection mode, if the appliance is initialized, etc. Use -h to obtain help on the available options.

update

Update the appliance’s components. If the appliance is running, it will be stopped and it should be started manually via command.

upgrade

Check if a new version of the appliance is available. If yes, you can download and install it.

downgrade

Rollback to a previously installed version of the appliance. You should specify a target version. Use -h to obtain help on additional arguments.

send-heartbeat

Send heartbeat information to Lumu. It includes information that can be used for diagnosing and troubleshooting purposes.

collectors

Create or remove custom collectors hosted by the appliance. Use -h to obtain help on the available options. 

To learn more about Lumu Virtual Appliance, consult our documentation.