<commit_before>.\" hosted-engine - Tool for handling hosted engine
.TH "HOSTED-ENGINE" "8" "2013-10-23" "oVirt" "oVirt Hosted Engine Setup Manual"
.SH "NAME"
hosted\-engine \- Tools for handling hosted engine
.SH "SYNOPSIS"
\fBhosted\-engine\fP [\-\-help] <command> [<command\-args>]
.PP
.SH "DESCRIPTION"
.PP
The \fBhosted\-engine\fP 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.
\&

.SH "OPTIONS"
.IP "\fB\-\-help\fP"
Show the help message and exit.\&

.IP "The following commands are available:"
.IP "\fB\-\-deploy [options]\fP"
Run the ovirt-hosted-engine-setup command to deploy the hosted-engine virtual
machine.\&
.IP "\fB\-\-vm-start [\-\-vm\-conf=<file>]\fP"
Start VM on this host.\&
\-\-vm\-conf=<file> can be optionally used to load an alternative vm.conf
file as a recovery action.
.IP "\fB\-\-vm-start-paused\fP"
Start VM on this host with qemu paused.\&
.IP "\fB\-\-vm-shutdown\fP"
Gracefully shutdown the VM on this host.\&
.IP "\fB\-\-vm-poweroff\fP"
Forcefully poweroff the VM on this host.\&
.IP "\fB\-\-vm-status [\-\-json]\fP"
Show the VM status, in machine-readable format if --json is given.\&
.IP "\fB\-\-add-console-password [\-\-password=<password>]\fP"
Create a temporary password for VNC/SPICE connections to the hosted-engine
virtual machine.\&
.IP "\fB\-\-console\fP"
Open the configured console using remote-viewer on localhost.\&
.IP "\fB\-\-check-deployed\fP"
Checks whether the hosted engine has been deployed.\&
.IP "\fB\-\-check-liveliness\fP"
Checks liveliness page of engine.\&
.IP "\fB\-\-connect-storage\fP"
Manually connect the storage domain to the local VDSM instance.\&
.IP "\fB\-\-set-maintenance \-\-mode=<mode>\fP"
Set maintenance status to the specified mode (global/local/none).\&
.IP "\fB\-\-clean_metadata [\-\-force\-cleanup] [\-\-host\-id=<id>]\fP"
Remove host's metadata from the global status database.\&
.IP "\fB\-\-reinitialize\-lockspace [\-\-force]\fP"
Reinitialize the sanlock lockspace file. This WIPES all locks.\&
.IP "\fB\-\-upgrade\-appliance\fP"
Upgrade the engine appliance.\&
.IP "\fB\-\-rollback\-upgrade\fP"
Rollback using a backup saved in a previous upgrade attempt.\&


.IP "For additional information about a specific command try:"
hosted\-engine <command> --help\&

.SH "SEE ALSO"
.BR ovirt\-hosted\-engine\-setup (8)<commit_msg>Added information about maintenance modes in the man page.<commit_after>.\" hosted-engine - Tool for handling hosted engine
.TH "HOSTED-ENGINE" "8" "2013-10-23" "oVirt" "oVirt Hosted Engine Setup Manual"
.SH "NAME"
hosted\-engine \- Tools for handling hosted engine
.SH "SYNOPSIS"
\fBhosted\-engine\fP [\-\-help] <command> [<command\-args>]
.PP
.SH "DESCRIPTION"
.PP
The \fBhosted\-engine\fP 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.
\&

.SH "OPTIONS"
.IP "\fB\-\-help\fP"
Show the help message and exit.\&

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


.IP "For additional information about a specific command try:"
hosted\-engine <command> --help\&

.SH "SEE ALSO"
.BR ovirt\-hosted\-engine\-setup (8)
{'fraction_non_alphanumeric': 0.15229989134371605, 'fraction_numerical': 0.004346251358203549, 'mean_word_length': 3.3215962441314555, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 19, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1313589', 'n_tokens_mistral': 1911, 'n_tokens_neox': 1854, 'n_words': 675}