Chapter 4. Configuring Hammer
The default location for global hammer
configuration is:
-
/etc/hammer/cli_config.yml for general
hammer
settings - /etc/hammer/cli.modules.d/ for CLI module configuration files
You can set user specific directives for hammer
(in ~/.hammer/cli_config.yml) as well as for CLI modules (in respective .yml files under ~/.hammer/cli.modules.d/).
To see the order in which configuration files are loaded, as well as versions of loaded modules, use:
$ hammer -d --version
Loading configuration for many CLI modules can slow down the execution of hammer
commands. In such a case, consider disabling CLI modules that are not regularly used.
Apart from saving credentials as described in Chapter 3, Hammer authentication, you can set several other options in the ~/.hammer/ configuration directory. For example, you can change the default log level and set log rotation with the following directives in ~/.hammer/cli_config.yml. These directives affect only the current user and are not applied globally.
:log_level: 'warning' :log_size: 5 #in MB
Similarly, you can configure user interface settings. For example, set the number of entries displayed per request in the Hammer output by changing the following line:
:per_page: 30
This setting is an equivalent of the --per-page
Hammer option.
4.1. Setting a default organization and location context
Many hammer
commands are organization specific. You can set a default organization and location for hammer
commands so that you do not have to specify them every time with the --organization
and --location
options.
Specifying a default organization is useful when you mostly manage a single organization, as it makes your commands shorter. However, when you switch to a different organization, you must use hammer
with the --organization
option to specify it.
Procedure
Set a default organization:
# hammer defaults add --param-name organization \ --param-value "Your_Organization"
You can find the name of your organization with the
hammer organization list
command.Optional: Set a default location:
# hammer defaults add --param-name location \ --param-value "Your_Location"
You can find the name of your location with the
hammer location list
command.
Verification
Review the currently specified default settings:
# hammer defaults list
4.2. Increasing the logging level for Hammer
You can find the log in ~/.hammer/log/hammer.log
.
Procedure
-
In
/etc/hammer/cli_config.yml
, set the:log_level:
option todebug
:
:log_level: 'debug'