hosted-engine (8) - Linux Man Pages

hosted-engine: Tools for handling hosted engine

NAME

hosted-engine - Tools for handling hosted engine

SYNOPSIS

hosted-engine [--help] <command> [<command-args>]

DESCRIPTION

The hosted-engine command deploys a virtual machine that you can install oVirt Open Virtualization Manager on to. The Manager installation on your hosted-engine virtual machine can manage the host it is running on. The hosted-engine command can also be used to start, stop and access the hosted-engine virtual machine.

OPTIONS

--help
Show the help message and exit.

The following commands are available:
--deploy [options]
Run the ovirt-hosted-engine-setup command to deploy the hosted-engine virtual machine.
--vm-start [--vm-conf=<file>]
Start VM on this host. --vm-conf=<file> can be optionally used to load an alternative vm.conf file as a recovery action.
--vm-start-paused
Start VM on this host with qemu paused.
--vm-shutdown
Gracefully shutdown the VM on this host.
--vm-poweroff
Forcefully poweroff the VM on this host.
--vm-status [--json]
Show the VM status, in machine-readable format if --json is given.
--add-console-password [--password=<password>]
Create a temporary password for VNC/SPICE connections to the hosted-engine virtual machine.
--console
Open the configured console using virsh on localhost.
--check-deployed
Checks whether the hosted engine has been deployed.
--check-liveliness
Checks liveliness page of engine.
--connect-storage
Manually connect the storage domain to the local VDSM instance.
--set-maintenance --mode=<mode>
Set maintenance status to the specified mode:
global - Allow the administrator to start/stop/modify the engine VM without any worry of interference from the HA agents.
local - Allow the administrator to maintain this host. Note that if you have only 2 nodes and one is in maintenance, there is only one host available to run the engine VM.
none - Resume HA functionality.
--clean_metadata [--force-cleanup] [--host-id=<id>]
Remove host's metadata from the global status database.
--reinitialize-lockspace [--force]
Reinitialize the sanlock lockspace file. This WIPES all locks.
--upgrade-appliance
Upgrade the engine appliance.
--rollback-upgrade
Rollback using a backup saved in a previous upgrade attempt.

For additional information about a specific command try:
hosted-engine <command> --help