A.2. Configuration Tool

During installation, only a subset of Red Hat Enterprise Virtualization Manager's configuration settings are modified from their defaults. You make further changes with the included configuration tool, rhevm-config.
The configuration tool does not require JBoss or Red Hat Enterprise Virtualization Manager to be running to update the configuration. Configuration key values are stored in the database and as such it must be operational for configuration changes to be saved. Changes are only applied once JBoss is restarted.
The manager's configuration is stored as a series of key to value pair mappings. The configuration tool allows you to:
  • list all available configuration keys,
  • list all available configuration values,
  • get the value of a specific configuration key, and
  • set the value of a specific configuration key.
The configuration tool also allows you to maintain multiple versions of the manager's configuration. When getting or setting the value for a configuration key the --cver parameter is used to specify which configuration version is to be used. The default configuration version is general.

A.2.1. Syntax

You will find the configuration tool on the machine to which Red Hat Enterprise Virtualization Manager was installed. Common usage examples are discussed within this guide. For full usage information consult the rhevm-config command's help output:
# rhevm-config --help

Common Tasks

List Available Configuration Keys
Use the --list parameter to list available configuration keys.
# rhevm-config --list
The tool lists each available configuration key by name. It also returns a description of each key's purpose.
List Available Configuration Values
Use the --all parameter to list available configuration values.
# rhevm-config --all
The tool lists each available configuration key by name as well as the current value of the key, and the configuration version.
Get Value of Configuration Key
Use the --get parameter to get the value of a specific key.
# rhevm-config --get KEY_NAME
Replace KEY_NAME with the name of the key to retrieve. The tool returns the key name, value, and the configuration version. Optionally the --cver parameter is used to specify the configuration version from which the value should be retrieved.
Set Value of Configuration Key
Use the --set parameter to set the value of a specific key. You must also set the configuration version to which the change is to apply using the --cver parameter.
# rhevm-config --set KEY_NAME=KEY_VALUE --cver=VERSION
Replace KEY_NAME with the name of the key to set, and replace KEY_VALUE with the value to assign to it. In an environment with more than one configuration version you must also take care to replace VERSION with the name of the configuration version in use.