Douglas Schilling Landgraf has uploaded a new change for review. Change subject: engine-config: Adding man page ......................................................................
engine-config: Adding man page Adding engine-config.8 Change-Id: I546d90550ddf53707bc667c18e8c0d44e909593f Bug-Url: https://bugzilla.redhat.com/show_bug.cgi?id=742417 Signed-off-by: Douglas Schilling Landgraf <dougsl...@redhat.com> --- M Makefile A packaging/engine-config.8 2 files changed, 895 insertions(+), 0 deletions(-) git pull ssh://gerrit.ovirt.org:29418/ovirt-engine refs/changes/76/11176/1 diff --git a/Makefile b/Makefile index 509f763..6cc775a 100644 --- a/Makefile +++ b/Makefile @@ -370,6 +370,7 @@ # Install man pages install -m 644 packaging/engine-manage-domains.8 $(DESTDIR)$(MAN_DIR)/man8/ + install -m 644 packaging/engine-config.8 $(DESTDIR)$(MAN_DIR)/man8/ install_sysprep: @echo "*** Deploying sysperp" diff --git a/packaging/engine-config.8 b/packaging/engine-config.8 new file mode 100644 index 0000000..c89a272 --- /dev/null +++ b/packaging/engine-config.8 @@ -0,0 +1,894 @@ +.TH engine-config 8 "January 19, 2013" "" "" +.SH NAME +engine-config \- Engine management settings tool +.SH SYNOPSIS +.B engine-config ACTION [--cver=version] [-p | --properties=/path/to/alternate/property/fie] [-c | --config=/path/to/alternate/config/file] + +Where: + ACTION action to perform, \f see details below + version relevant configuration version to use. + -p, --properties= (optional) use the given alternate properties file. + -c, --config= (optional) use the given alternate configuration file. + +Available actions: + \fB\-l\fR, \fB\-\-list\fR + list available configuration keys. + + \fB\-a\fR, \fB\-\-all\fR + get all available configuration values. + + \fB\-g key\fR, \fB\-\-get\fR=key [--cversion=version] + get the value of the given key for the given version. If a version is not given, the values of all existing +versions are returned. + + \fB\-s\fR key=val --cver=version, \fB\-\-set\fR key=val --cver=version + set the value of the given key for the given version. The cver version is mandatory for this action + + \fB\-h\fR, \fB\-\-help\fR + list available configuration keys. + display this help and exit. + +.B NOTE: +In order for your change(s) to take effect, restart the oVirt engine + +.SH CONFIGURATION KEYS + +.B AsyncTaskPollingRate +- Async Task Polling Rate (in seconds) +.br +Possible values: Integer +.br +Description: +How often (in seconds) Engine should query the status of an async task currently running +Possible values: Integer + +.B AsyncTaskZombieTaskLifeInMinutes +- Zombie tasks life-time (in minutes) +.br +Possible values: Integer +.br +Description: +How long should a task be allowed to run before assuming it has become a zombie and should be killed. +.br +The value affects large storage manipulations especially. When using slow storage and large virtual images, +.br +or when a task is known to take longer than 3000 minutes (50 hours), +the value should be increased + +.B AuditLogAgingThreashold +- Audit Log Aging Threshold (in days) +.br +Possible values: Integer +.br +Description: +How long should an audit log be kept before being rotated + +.B AuditLogCleanupTime +- Time to check for Audit Log cleanup +.br +Possible values: Time +.br +Description: +At what time should the Audit Log be checked for Aging and cleaned up. + +.B AuthenticationMethod +- Authentication Method to be used by Engine +.br +Possible values: String +.br +Description: +The API to be used for querying users. Currently LDAP is the only supported value. + +.B BlockMigrationOnSwapUsagePercentage +- Host swap percentage threshold (for scheduling) +.br +Possible values: Integer +.br +Description: +The maximum percentage of swap on the host that a VM run or migration is allowed on this host. +.br +If The host is swapping beyond this percentage a VM will not migrate over and will not be started. + +.B CABaseDirectory +- CA Base Directory +.br +Possible values: String +.br +Description: +Where the Certificate Authority is located on the Engine host + +.B CertificateFileName +- Certificate File Name +.br +Possible values: String +.br +Description: +Points to the certificate file used by Engine for SSL/TLS communication with VDSM + +.B CertificateFingerPrint +- Certificate Finger Print +.br +Description: +Automatically populated with Certificate Finger Print + +.B CertificatePassword +- Certificate Password +.br +Description: +Automatically populated with Certificate Password + +.B CpuOverCommitDurationMinutes +- The duration in minutes of CPU consumption to activate selection algorithm +.br +Possible values: String +.br +Description: +When the cluster policy is set to Even Distribution, wait for this amount of minutes after detecting CPU overcommit, +.br +before triggering VM migrations to rebalance the host load. Đ¢his configuration value applies only for the default, +.br +in case user did not specify it during the cluster setup. +.br +NOTE: The current description specifies Even Distribution, this value is needed also for Power Saving + +.B DefaultWorkgroup +- Default Workgroup + +.B DisableFenceAtStartupInSec +- Disable Fence Operations At Engine Startup In Seconds +.br +Possible values: Integer +.br +Description: +Allow this long after Engine start for hosts to become detected, before assuming the hosts are non-responsive and starting to fence hosts. +.br +Should be increased when Engine is on a machine that has slow network startup. + +.B EnableSpiceRootCertificateValidation +- Enable Spice Root Certification Validation +.br +Possible values: String +.br +Description: +If 'true', the subject of the certificate of the Host on which the VM is running and the Engine setup CA certificate are +.br +sent to SPICE client when attempting to connect to the VM with SPICE, as an extra security mechanism + +.B EnableUSBAsDefault +- Enable USB devices attachment to the VM by default +.br +Possible values: String + +.B EnableVdsLoadBalancing +- Enables Host Load Balancing system +.br +Possible values: String +.br +Description: +This config value allows the user to turn on/off (true/false accordingly) the VM load balancing according to the policy +.br +the user configured for the cluster. + +.B FreeSpaceCriticalLowInGB +- Critical low disk space alert threshold (in GB) +.br +Possible values: Integer +.br +Description: +Will produce an alert when a Storage Domain has this amount of GB of space left. +.br +NOTE: This setting is also used in various preliminary tests for action sanity when user tries to use a storage domain, +.br +in order not to get into this critical amount of GB (means addDisk/import... will fail if not enough space is present +.br +according to this value) + +.B FreeSpaceLow +- Limit of percent free disk-space below which it is considered low +.br +Possible values: Integer + +.B HighUtilizationForEvenlyDistribute +- High Utilization Limit For Evenly Distribute selection algorithm +.br +Possible values: Integer +.br +Description: +Max. number of VMs per host in the Evenly Distribute algorithm + +.B HighUtilizationForPowerSave +- High Utilization Limit For Power Save selection algorithm +.br +Possible values: Integer +.br +Description: +A default for newly created clusters, in use with PowerSave load balancing algorithm, +.br +marks the higher limit of host utilization for populating hosts. + +.B LocalAdminPassword +- Local Administrator Password +.br +Possible values: Password +.br +Description: +The password for admin@internal default user + +.B LogPhysicalMemoryThresholdInMB +- Threshold for logging low host memory in MB +.br +Possible values: Integer +.br +Description: +How many MBs of RAM should be left before a host is considered low on memory. +.br +If host's RAM is lower than this setting, it will be logged to the audit log, no action is taken. + +.B LogXmlRpcData +- Log XML-RPC Data +.br +Description: +Unused. Since the move to JBoss the way to handle it is via log4j.xml settings. + +.B LowUtilizationForEvenlyDistribute +- Low Utilization Limit For Evenly Distribute selection algorithm +.br +Possible values: Integer +.br +Description: +Min. number of VMs per host in the Evenly Distribute algorithm + +.B LowUtilizationForPowerSave +- Low Utilization Limit For Power Save selection algorithm +.br +Possible values: Integer +.br +Description: +A default for newly created clusters, in use with PowerSave load balancing algorithm, marks the lower limit of host +.br +utilization for populating hosts. + +.B MacPoolRanges +- MAC Addresses Pool Ranges +.br +Possible values: String +.br +Description: +The MAC address pool range to be automatically assigned to VMs + +.B MaxDiskSize +- Max size of newly created disk (in GB) +.br +Possible values: Integer +.br +Description: +The maximum size (in GB) for a new virtual disk image assigned to VMs + +.B MaxMacsCountInPool +- Maximum MAC Addresses count in Pool +.br +Possible values: Integer +.br +Description: +How many MAC addresses are allowed at most in this mac-pool. + +.B MaxNumberOfHostsInStoragePool +- Max number of hosts in Storage Pool +.br +Possible values: Integer +.br +Description: +Limits the maximum amount of hosts assigned to the clusters of a single Data Center. +.br +Can be increased after testing with more hosts if required. + +.B MaxNumOfCpuPerSocket +- Max Number of CPU per socket +.br +Possible values: Integer +.br +Description: +Maximum number of virtual CPU cores that can be assigned to a single virtual CPU socket. + +.B MaxNumOfVmCpus +- Total Numbers of Virtual Machine CPUs +.br +Possible values: Integer +.br +Description: +Maximum total amount of CPU cores assigned to a VM (determined by Number of Cores multiplied by Number of Sockets) + +.B MaxNumOfVmSockets +- Max Number of Socket per Virtual Machine +.br +Possible values: Integer +.br +Description: +Maximum number of virtual CPU sockets assigned to a VM + +.B MaxRerunVmOnVdsCount +- Max Virtual Machine Rerun Attempts on a Host +.br +Possible values: Integer +.br +Description: +Maximum number of times a VM is attempted to be started on a host, before an error - "unable to start VM", is reported + +.B MaxStorageVdsDelayCheckSec +- Max delay for check of domain in seconds +.br +Possible values: Integer +.br +Description: +Maximum amount of seconds to wait for Storage Domain status to be returned, before reporting an error. + +.B MaxStorageVdsTimeoutCheckSec +- Max timeout for last check of domain in seconds +.br +Possible values: Integer +.br +Description: +When monitoring storage, VDSMD on the hosts reports a "lastCheck" value for each domain. +.br +This setting is used to decide whether the last check happened too long ago and domain is considered in error. + +.B MaxVdsMemOverCommit +- Max Host Memory Over-Commit (%) for Virtual Desktops load +.br +Possible values: Integer +.br +Description: +When using Virtual Desktop loads, by how many percent should Engine allow memory overcommit to occur. + +.B MaxVdsMemOverCommitForServers +- Max Host Memory Over-Commit (%) for Virtual Servers load +.br +Possible values: Integer +.br +Description: +When using Virtual Server loads, by how many percent should Engine allow memory overcommit to occur + +.B MaxVdsNameLength +- Max VDS name length +.br +Possible values: Integer +.br +Description: +Maximum name length for a Hypervisor host + +.B MaxVmNameLengthNonWindows +- Max VM name length for non-Windows OS +.br +Possible values: Integer +.br +Description: +Maximum name length for a non-Windows VM + +.B MaxVmNameLengthWindows +- Max VM name length in Windows +.br +Possible values: Integer +.br +Description: +Maximum name length for Windows VMs (limitation imposed by Windows hostnames) + +.B MaxVmsInPool +- Max VMs In Pool +.br +Possible values: Integer +.br +Description: +Maximum number of VMs in a single Data Center. + +.B NumberOfFailedRunsOnVds +- Number of Failed Runs on Host +.br +Possible values: Integer +.br +Description: +Number of attempts to run VMs on Host before setting its status to Error + +.B NumberOfVmsForTopSizeVms +- Number of VMs with highest disk size to display +.br +Possible values: Integer +.br +Description: +How many VMs to display in the Storage Domain, Virtual Machine sub-tab. +.br +Will display this amount of VMs, sorted by the most storage spaced used per VM. + +.B NumberVmRefreshesBeforeSave +- Number of Virtual Machine Data Refreshes Before Saving to Database +.br +Possible values: Integer +.br +Description: +The number of Host monitor iterations between refreshing VMs from VDSM +.br +(determines if VMs should be refreshed once upon each iteration) + +.B oVirtISOsRepositoryPath +- The Engine installation files path +.br +Possible values: String +.br +Description: +The location of hosts ISO images, that are used for upgrading hosts + +.B ProductKey2003 +Product Key (for Windows 2003) +.br +Possible values: String +.br +Description: +Windows Serial key to be used with sysprepped VMs created from a Template + +.B ProductKey2003x64 +Product Key (for Windows 2003 x64) +.br +Possible values: String +.br +Description: +Windows Serial key to be used with sysprepped VMs created from a Template + +.B ProductKey2008 +Product Key (for Windows 2008) +.br +Possible values: String +.br +Description: +Windows Serial key to be used with sysprepped VMs created from a Template + +.B ProductKey2008R2 +Product Key (for Windows 2008 R2) +.br +Possible values: String +.br +Description: +Windows Serial key to be used with sysprepped VMs created from a Template + +.B ProductKey2008x64 +Product Key (for Windows 2008 x64) +.br +Possible values: String +.br +Description: +Windows Serial key to be used with sysprepped VMs created from a Template + +.B ProductKey +Product Key for Windows XP +.br +Possible values: String +.br +Description: +Windows Serial key to be used with sysprepped VMs created from a Template + +.B ProductKeyWindows7 +Product Key (for Windows 7) +.br +Possible values: String +.br +Description: +Windows Serial key to be used with sysprepped VMs created from a Template + +.B ProductKeyWindows764 +Product Key (for Windows 7 x64) +.br +Possible values: String +.br +Description: +Windows Serial key to be used with sysprepped VMs created from a Template + +.B ProductRPMVersion +Engine RPM Version +.br +Possible values: String +.br +Description: +The RPM version of the currently used engine package + +.B RDPLoginWithFQN +.br +Possible values: String +.br +Description: +Connect to RDP console with Fully Qualified User-Name (user@domain) + +.B SANWipeAfterDelete +Initializing disk image is more secure but it is time consuming and I/O intensive (depends on the size of the image) +.br +Possible values: String +.br +Description: +Represents the default value (checked/unchecked) of the "wipe after delete" check-box in the "New Virtual Disk" dialog +.br +in case the newly-created Disk belongs to a SAN (FC/iSCSI) Data-Center (i.e. about to be created on a SAN storage domain). + +.B SearchResultsLimit +- Max Quantity of Search Results +.br +Possible values: Integer +.br +Description: +The nuber of results to return for search queries if no specific figure given by UI / REST. + +.B ServerRebootTimeout +- Host Reboot Timeout (in seconds) +.br +Possible values: Integer +.br +Description: +Wait this amount of seconds when a host is rebooted or fenced, before determining that the host is Non-Responsive. +.br +May be increased for hosts that take longer to boot. + +.B SpiceReleaseCursorKeys +.br +Possible values: String +.br +Description: +Keyboard keys combination that causes the mouse cursor to be released from its grab on SPICE. + +.B SpiceSecureChannels +- SPICE Secure Channels +.br +Possible values: String +.br +Description: +Which SPICE channels should be secured with SSL. Valid values are one or more of: +.br +smain,sinputs,scursor,splayback,srecord,sdisplay +.br + +.B SpiceToggleFullScreenKeys +.br +Possible values: String +.br +Description: +Keyboard keys combination that toggles the full-screen state of SPICE client window + +.B SpiceUsbAutoShare +- Enable USB devices sharing by default in SPICE +.br +Possible values: String +.br +Description: +Represents the default value (checked/unchecked) of the "Enable USB Auto-Share" check-box +.br +in the (SPICE) Console Options dialog in the user portal. + +.B SpmCommandFailOverRetries +- Number of retries to failover the Storage Pool Manager on failed commands +.br +Possible values: Integer +.br +Description: +Number of SPM selection failover retries. In case an SPM command fails, +.br +backend performs a failover - selects a new SPM and re-runs the command. + +.B SPMFailOverAttempts +- Number of attempts to connect to the Storage Pool Manager before Failover +.br +Possible values: Integer +.br +Description: +When monitoring a Storage Pool, if the current SPM fails, failover does not happen immediately +.br +(see description of SpmCommandFailOverRetries), instead this setting defines the amount of +.br +retries before deciding that the current SPM is down and a failover is required. + +.B SpmVCpuConsumption +- The CPU consumption of SPM embodied as number of VCPUs on the Host +.br +Possible values: Integer +.br +Description: +When a host is SPM it is considered to be using this amount of extra virtual CPUs, +.br +to make up for the overhead SPM operations generate + +.B SSHInactivityTimoutSeconds +- SSH Inactivity Timeout (in seconds) +.br +Possible values: Integer +.br +Description: +The maximum amount of time backend allows for an SSH session to remote hosts. +.br +After this timeout the session will be killed. + +.B SSLEnabled +.br +Possible values: String +.br +Description: +Whether or not the SPICE Secure Channels should be SSL encrypted. + +.B StorageDomainFalureTimeoutInMinutes +- Storage Domain failure timeout +.br +Possible values: Integer +.br +Description: +Defines the amount of time taken before deciding domain is problematic, +.br +starting at the first failure reported by VDSM (in minutes) + +.B StoragePoolRefreshTimeInSeconds +- Storage Pool Manager Polling Rate (in seconds) +.br +Possible values: Integer +.br +Description: +Storage Pool monitoring frequency. + +.B SysPrep2K3Path +- Path to a Windows 2003 machine Sys-Prep file +.br +Possible values: String +.br +Description: +Path to the OS specific sysprep file template + +.B SysPrep2K8Path +- Path to a Windows 2008 machine Sys-Prep file +.br +Possible values: String +.br +Description: +Path to the OS specific sysprep file template + +.B SysPrep2K8R2Path +- Path to a Windows 2008 R2 machine Sys-Prep file +.br +Possible values: String +.br +Description: +Path to the OS specific sysprep file template + +.B SysPrep2K8x64Path +- Path to a Windows 2008 x64 machine Sys-Prep file +.br +Possible values: String +.br +Description: +Path to the OS specific sysprep file template + +.B SysPrepWindows7Path +- Path to a Windows 7 machine Sys-Prep file +.br +Possible values: String +.br +Description: +Path to the OS specific sysprep file template + +.B SysPrepWindows7x64Path +- Path to a Windows 7 x64 machine Sys-Prep file +.br +Possible values: String +.br +Description: +Path to the OS specific sysprep file template + +.B SysPrepXPPath +- Path to a Windows XP machine Sys-Prep file +.br +Possible values: String +.br +Description: +Path to the OS specific sysprep file template + +.B TimeoutToResetVdsInSeconds +- Communication timeout in seconds before trying to reset +.br +Possible values: Integer +.br +Description: +How long should a host be Non-Responsive, before a fence command is issued. +.br +Used in conjunction with VDSAttemptsToResetCount + +.B TimeToReduceFailedRunOnVdsInMinutes +- Time to Reduce Failed Run on Host (in minutes) +.br +Possible values: Integer +.br +Description: +The amount of time that the host will be in Error status after failing to run VMs. + +.B UserDefinedVMProperties +- User defined VM properties +.br +Possible values: String +.br +Description: +Mostly used with VDSM hooks + +.B UserRefreshRate +- Refresh Rate of Users Data from Active Directory (in seconds) +.br +Possible values: Integer +.br +Description: +How often should the Directory Server be polled for user account updates + +.B UtilizationThresholdInPercent +- The Utilization Threshold (in percent) +.br +Possible values: Integer +.br +Description: +In load balancing, this is a default value, used to calculate the max CPU limit to determine +.br +if host is over utilized or not. This is the percent of the value that the user set in +.br high-utiliztion in the cluster. + +.B ValidNumOfMonitors +- Valid Numbers of Monitors +.br +Possible values: Integer +.br +Description: +What number of monitors are available for SPICE-enabled VMs + +.B VdcBootStrapUrl +- Host Installation Bootstrap Script URL +.br +Possible values: String +.br +Description: +The URL for the location of the host installation bootstrap scripts, used for adding Hypervisor hosts. + +.B VdcVersion +- Engine version + +.B VDSAttemptsToResetCount +- Number of attempts to communicate with Host before trying to reset +.br +Possible values: Integer +.br +Description: +How many times to retry communications with a host, before a fence command is issued. +.br +Used in conjunction with TimeoutToResetVdsInSeconds + +.B VdsLoadBalancingeIntervalInMinutes +- Host Load Balancing Interval (in minutes) +.br +Possible values: Integer +.br +Description: +The interval between running the VMs load balancer in minutes +.br +(Also defines the first invocation of the Load Balancer) + +.B VdsRecoveryTimeoutInMintues +- Host Timeout when Recovering (in minutes) +.br +Possible values: Integer +.br +Description: +When VDSM fails/restarts, it sometimes can be in recovering mode (VDSM reports "initializing" or "recovering from +crash") +.br +This is the timeout for this state, and after this timeout the host will move to non-operational. + +.B VdsRefreshRate +- Time interval in seconds to poll a Host status +.br +Possible values: Integer +.br +Description: +How often Hypervisor hosts status is checked + +.B vdsTimeout +- Host Control Communication Timeout (in seconds) +.br +Possible values: Integer +.br +Description: +Timeout for a VDSM call - the time Engine will wait for sync call to VDSM. + +.B VirtualMachineDomainName +- Virtual Machine Domain Name (Deprecated) + +.B VmGracefulShutdownMessage +- Message displayed in Virtual Machine when Virtual Machine is being shutdown from Engine +.br +Possible values: String + +.B VMMinMemorySizeInMB +- Minimal memory size of virtual machine in MB +.br +Possible values: Integer + +.B VncKeyboardLayout +- Keyboard Layout configuration for VNC +.br +Possible values: String +.br +Description: +Possible values: ar, da, de-ch, en-us, et, fo, fr-be, fr-ch, hu, it, lt, mk, nl, no, pt, ru, sv, tr, +.br +de, en-gb, es, fi, fr, fr-ca, hr, is, ja, lv, nl-be, pl, pt-br, sl, th + +.B WaitForVdsInitInSec +- Wait to a Host to complete init in SPM selection +.br +Possible values: Integer +.br +Description: +This is a timeout for initializing host as in VdsRecoveryTimeoutInMintues, but this timeout is shorter, +.br +and it is used during the SPM selection algorithm, in case selected host is initialized we wait +.br +for it to recover. + +.B FenceQuietTimeBetweenOperationsInSec +- Quiet time between Power Management operations in seconds +.br +Possible values: Integer +.br +Description: +The minimal time in seconds between two Power Management operations activated manually by a user. + +.B MaxAuditLogMessageLength +- Maximum length of an Audit Log message +.br +Possible values: Integer +.br + +.B SysPrepDefaultUser +- Default SysPrep user name +.br +Possible values: String +.br +Description: +This user is used if the domain for sysprep is unknown, or no domain specified. + +.B SysPrepDefaultPassword +- Default SysPrep user password +.br +Possible values: Password +.br +Description: +This password is used if the domain for sysprep is unknown, or no domain specified. + +.B UserSessionTimeOutInterval +- Session timeout interval in minutes +.br +Possible values: Integer +.br +Description: +User session timeout. Global for all types of access - User portal/Admin portal/Webadmin/API. + +.B AdminPassword +- Admin user password +.br +Possible values: Password +.br +Description: +Password of admin user (will be used if no directory service is used for authentication) + +.SH EXAMPLES + +.B List available configurations keys + # engine-config -l + +.B Shows the CA Base Directory + # engine-config -g CABaseDirectory + +.B Changing the Admin (internal domain) password + # engine-config -s AdminPassword=superSecret! + # service ovirt-engine restart + or + # systemctl restart ovirt-engine.service + +.SH BUGS +Report bugs to <http://bugzilla.redhat.com> + +.SH COPYRIGHT +Copyright 2010-2013 Red Hat, Inc. -- To view, visit http://gerrit.ovirt.org/11176 To unsubscribe, visit http://gerrit.ovirt.org/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I546d90550ddf53707bc667c18e8c0d44e909593f Gerrit-PatchSet: 1 Gerrit-Project: ovirt-engine Gerrit-Branch: master Gerrit-Owner: Douglas Schilling Landgraf <dougsl...@redhat.com> _______________________________________________ Engine-patches mailing list Engine-patches@ovirt.org http://lists.ovirt.org/mailman/listinfo/engine-patches
