package: freehdl

title: v2cc.libs(5)

text:
# v2cc.libs(5)

## NAME
v2cc.libs - VHDL library mapping file for the FreeHDL compiler/simulator.

## DESCRIPTION
FreeHDL is a compiler/simulator suite for the hardware description language VHDL. VHDL'93 as well as VHDL'87 standards are supported.

FreeHDL translates the original VHDL source FILEs into C++. Then, the C++ source can be compiled and linked to the kernel to build the simulation program. Starting the generated executable will simulate the corresponding VHDL model. The actual build process to generate the simulator from the VHDL source is a complex process which is handled by the gvhdl script.

FreeHDL does not have a opaque notion of design libraries. VHDL files are not pre-analyzed and checked into some library data base as in other VHDL compiler/simulator systems. Instead, whenever a reference to a design unit needs to be made, FreeHDL parses the VHDL code of that design unit from fresh. Therefore, it needs to be able to find the source file of a design unit given the VHDL name of that unit.

Thus, as far as FreeHDL is concerned, a design library is a mapping from VHDL identifiers to file names. There is also a mapping for getting library names from mapping files.

Such a mapping is specified via a "mapping file". It contains a list of pattern rules that each transform a certain class of identifiers into file names.

The syntax of a mapping file is:

Lexical:

litchar: 'a'..'z' | 'A'..'Z' | '0'..'9' | '_' | '/' | '-' | '.' escchar

escchar: '\' char

whitespace: ' ' | '\n' | '\v' | '\t' | comment

comment: '#' any_character* '\n'

opchar: ':' | ',' | '(' | ')'

specchar: every printable char except litchar, whitespace and opchar

symchar: litchar | specchar

symbol: symchar+

Grammar:

mapping: version patternrule*

version: "v2cc_mapfile" "0"

patternrule: symbol [ ':' symbol ]

Comments are ignored.

A mapping files specifies a sequence of pattern rules. When transforming an identifier, each rule is tried in turn and the first one that matches is chosen.

A rule looks like

pattern: filename

When the ": filename" part is omitted, it defaults to "patternEXT" where "EXT" is determined by the user of the mapping file.

The "pattern" can contain the special character "<" which introduces a `wildcard'. The "<" must be followed by a ">", with arbitrary characters inbetween. These characters form the name of the wildcard. A wildcard matches any sequence of characters. There can be any number of wildcards in the pattern, but each must have a unique name.

The "filename" can also contain the character "<", followed by a name, followed by ">". There, it introduces a `wildcard substitution'. It will be replaced with the characters that matched the wildcard with the same name in "pattern". When there is no wildcard in "pattern" with the right name, it will be replaced with nothing. While doing this replacement, the characters "#" and "/" are replaced as "##", and "#-" respectively. No other character translations are done, so if you have funny characters in your VHDL identifiers, you will have funny characters in your filenames.

Before doing the comparison with the patterns, the VHDL identifier is brought into a canonical form: when it is not an abstract identifier, all its characters are down-cased.

When the resulting filename is relative (does not begin with "/"), it is prefixed with the directory of the mapping file.

A non-existent mapping file is equivalent to the single rule

<>

An empty mapping file is just that: an empty mapping.

The mapping does not need to be reversible. It is OK when multiple identifiers map to a single filename.

No special character besides "<" and ">" is valid in "pattern" or "filename". They are reserved for future extensions.

The mapping files for going from design unit names to filenames are found by looking into directories specified by the `v2cc library path'. You can use the environment variable V2CC_LIBRARY_PATH and command line options to define the path. When the environment variable is not set, it defaults to a value that makes the standard libraries available that are distributed and installed with v2cc itself. When it is set, it completely overwrites this default value.

The variable V2CC_LIBRARY_PATH consists of ":" separated filenames. The filename "*" is replaced with the default value mentioned above.

In addition to the environment variable, you can use the "-L libdir" command line option with v2cc. The directories specified with "-L" are added in front of the ones specified by V2CC_LIBRARY_PATH. In the final library path, they appear in the same order as on the command line.

Looking for a design unit named UNIT in a library named LIB is done like this:

for each component of the library path, L

if L is a regular file

set LMAP to L

else if L is a directory

set LMAP to L/v2cc.libs

else

continue with next component

translate LIB into FLIB using LMAP with EXT=""

if FLIB.vhdl exists

terminate with FLIB.vhdl as the result

if FLIB.v2cc exists

set UMAP to FLIB.v2cc

else if FLIB is a directory

set UMAP to FLIB/v2cc.units

else

continue with next component

translate UNIT into FUNIT using UMAP with EXT=".vhdl"

terminate with FUNIT as the result

terminate unsuccessfully

This mechanism is used for all design units that are referenced from within VHDL code (or via other means). There is a complication with architectures and package bodies, though, because they are not uniquely identified by a single identifier. For them, a artificial identifier is constructed. Architectures get names of the form

<entity>(<architecture>)

while package bodies become

<package>(body)

For example, "architecture struct of model" is turned into "model(struct)" and "package body misc" is turned into "misc(body)".

When a design file contains multiple design units, they are all parsed, checked for correctness and remembered, but only the needed unit will be used for code generation. That is, when a design file contains both a package header and a package body and the package header is referenced from another design unit, no code will be generated for the package body. When one of the ignored units will be referenced later in the same invocation of v2cc, the design file will not be read again because all design units are retained in core.

## EXAMPLES
The simplest situation is when you have no mapping files at all. A design library is then a directory on your library path. The name of that directory is that of the library in VHDL. Each file in that directory with a ".vhdl" extension is used for a design unit with the same name as the file without the extension.

Say you have this directory structure

somedir/

std/

standard.vhdl

textio.vhdl

ieee/

numeric_bit.vhdl

std_logic_1164.vhdl

When you put "somedir" into your library path, you have access to the design units

STD.STANDARD

STD.TEXTIO

IEEE.NUMERIC_BIT

IEEE.STD_LOGIC_1164

In this situation, you have one file per design unit. When you have one file per design library, it would look like this

somedir/

fmf.vhdl

All references to design units in the FMF design library would be routed to "fmf.vhdl".

As another example assume that all VHDL libraries are mapped into subdirs starting from root directory "/foo". Further, assume that there are VHDL libraries named "lib1" and "lib2". They shall be mapped to subdir "/foo/lib1_dir" and "/foo/lib2_dir". Hence, the file/directory structure is as follows:

/foo <- library root directory /foo/v2cc.libs <- mapping control file /foo/lib1_dir <- library dir for VHDL library lib1 /foo/lib1_dir/comp1.vhdl <- file that contains VHDL model comp1 /foo/lib2_dir <- library dir for VHDL library lib2 /foo/lib2_dir/comp2.vhdl <- file that contains VHDL model comp2

Then, file "/foo/v2cc.libs" should contain:

v2cc_mapfile 0 lib1 : lib1_dir lib2 : lib2_dir

In order to compile a design named comp1 (stored in file comp1.vhdl) into VHDL library lib1 goto subdir "/foo/lib1_dir" and execute:

gvhdl -c -L .. -l lib1 comp1.vhdl

Note that option "-l lib1" forces the compiler to associate the model stored in "comp1.vhdl" with VHDL library lib1. Note further, that the compiler switch "-L .." specifies the path to the directory where "v2cc.libs" is stored. You may also specify an absolute path:

gvhdl -c -L /foo -l lib1 comp1.vhdl

Note that comp1 should reside in a file named "comp1.vhdl".

If lib2 contains a design comp2 that makes use of comp1 from lib1 then goto "/foo/lib2_dir" and run the following command to create an executable for model comp2:

gvhdl -L .. -l lib2 comp2.vhdl ../lib1_dir/comp1.o

## SEE ALSO
gvhdl(1), freehdl-v2cc(1), freehdl-config(1)

## AVAILABILITY
The latest version of FreeHDL can always be obtained from www.freehdl.seul.org

## REPORTING BUGS
Known bugs are documented within the BUGS file. If your report addresses a parser related topic then contact Marius Vollmer <mvo@zagadka.ping.de>. If it is related to the code generator or compiler then send an email to Edwin Naroska <edwin@ds.e-technik.uni-dortmund.de>. If your are not sure send it to Edwin. He will take care of forwarding your report to the appropriate recipient.

## COPYRIGHT
Edwin Naroska © 1999, 2000, 2001, 2002, 2003, 2004, 2005 <edwin@ds.e-technik.uni-dortmund.de>

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

## AUTHORS
Written by Marius Vollmer <mvo@zagadka.ping.de> and Edwin Naroska <edwin@ds.e-technik.uni-dortmund.de>.


default.conf

package: freeipa-client-common

title: default.conf(5)

summary: IPA configuration file

text:
# default.conf(5)

## NAME
default.conf - IPA configuration file

## SYNOPSIS
/etc/ipa/default.conf, ~/.ipa/default.conf, /etc/ipa/server.conf, /etc/ipa/cli.conf, /etc/ipa/installer.conf, /etc/ipa/cli_installer.conf

## DESCRIPTION
The default.conf configuration file is used to set system-wide defaults to be applied when running IPA clients and servers.

Users may create an optional configuration file in ~/.ipa/default.conf which will be merged into the system-wide defaults file.

The following files are read, in order:

```
    ~/.ipa/default.conf

    /etc/ipa/<context>.conf

    /etc/ipa/default.conf

    built-in constants
```

The IPA server does not read ~/.ipa/default.conf.

The first setting wins.

## SYNTAX
The configuration options are not case sensitive. The values may be case sensitive, depending on the option.

Blank lines are ignored. Lines beginning with # are comments and are ignored.

Valid lines consist of an option name, an equals sign and a value. Spaces surrounding equals sign are ignored. An option terminates at the end of a line.

Values should not be quoted, the quotes will not be stripped.

\# Wrong - don't include quotes

verbose = "True"

\# Right - Properly formatted options

verbose = True

verbose=True

Options must appear in the section named [global]. There are no other sections defined or used currently.

Options may be defined that are not used by IPA. Be careful of misspellings, they will not be rejected.

## OPTIONS
The following options are relevant for the server:

basedn <base>

Specifies the base DN to use when performing LDAP operations. The base must be in DN format (dc=example,dc=com).

ca_agent_port <port>

Specifies the secure CA agent port. The default is 8443.

ca_host <hostname>

Specifies the hostname of the dogtag CA server. The default is the hostname of the IPA server.

ca_port <port>

Specifies the insecure CA end user port. The default is 8090.

certmonger_wait_timeout <seconds>

The time to wait for a certmonger request to complete during installation. The default value is 300 seconds. To tune create/add to /etc/ipa/installer.conf.

context <context>

Specifies the context that IPA is being executed in. IPA may operate differently depending on the context. The current defined contexts are cli, server and dns. Additionally this value is used to load /etc/ipa/context.conf to provide context-specific configuration. For example, if you want to always perform client requests in verbose mode but do not want to have verbose enabled on the server, add the verbose option to /etc/ipa/cli.conf.

debug <boolean>

When True provides detailed information. Specifically this set the global log level to "debug". Default is False.

dogtag_version <version>

Stores the version of Dogtag. Value 9 is assumed if not specified otherwise.

domain <domain>

The domain of the IPA server e.g. example.com.

enable_ra <boolean>

Specifies whether the CA is acting as an RA agent, such as when dogtag is being used as the Certificate Authority. This setting only applies to the IPA server configuration.

fallback <boolean>

Specifies whether an IPA client should attempt to fall back and try other services if the first connection fails.

host <hostname>

Specifies the local system hostname.

http_timeout <seconds>

Timeout for HTTP blocking requests (e.g. connection). The default value is 30 seconds.

in_server <boolean>

Specifies whether requests should be forwarded to an IPA server or handled locally. This is used internally by IPA in a similar way as context. The same IPA framework is used by the ipa command-line tool and the server. This setting tells the framework whether it should execute the command as if on the server or forward it via XML-RPC to a remote server.

in_tree <boolean>

This is used in development and is generally a detected value. It means that the code is being executed within a source tree.

interactive <boolean>

Specifies whether values should be prompted for or not. The default is True.

kinit_lifetime <time duration spec>

Controls the lifetime of ticket obtained by users authenticating to the WebGUI using login/password. The expected format is a time duration string. Examples are "2 hours", "1h:30m", "10 minutes", "5min, 30sec". When the parameter is not set in default.conf, the ticket will have a duration inherited from the default value for kerberos clients, that can be set as ticket_lifetime in krb5.conf. When the ticket lifetime has expired, the ticket is not valid anymore and the GUI will prompt to re-login with a message "Your session has expired. Please re-login."

ldap_cache <boolean>

Enable a per-request LDAP cache. The default is True.

ldap_cache_size <integer>

The maximum number of entries cached if ldap_cache is True. Since this cache is per-request it is not expected to be very large. The default is 100. Setting the value < 1 effectively disables the cache regardless of the ldap_cache setting

ldap_cache_debug <boolean>

Log details on hits, misses, etc. for the LDAP cache if the cache is enabled.

ldap_uri <URI>

Specifies the URI of the IPA LDAP server to connect to. The URI scheme may be one of ldap or ldapi. The default is to use ldapi, e.g. ldapi://%2fvar%2frun%2fslapd-EXAMPLE-COM.socket

log_logger_XXX <comma separated list of regexps>

loggers matching regexp will be assigned XXX level.

Logger levels can be explicitly specified for specific loggers as opposed to a global logging level. Specific loggers are indicated by a list of regular expressions bound to a level. If a logger's name matches the regexp then it is assigned that level. This config item must begin with "log_logger_level_" and then be followed by a symbolic or numeric log level, for example:

log_logger_level_debug = ipalib\.dn\..*

log_logger_level_35 = ipalib\.plugins\.dogtag

The first line says any logger belonging to the ipalib.dn module will have it's level configured to debug.

The second line say the ipa.plugins.dogtag logger will be configured to level 35.

This config item is useful when you only want to see the log output from one or more selected loggers. Turning on the global debug flag will produce an enormous amount of output. This allows you to leave the global debug flag off and selectively enable output from a specific logger. Typically loggers are bound to classes and plugins.

Note: logger names are a dot ('.') separated list forming a path in the logger tree. The dot character is also a regular expression metacharacter (matches any character) therefore you will usually need to escape the dot in the logger names by preceding it with a backslash.

mode <mode>

Specifies the mode the server is running in. The currently support values are production and developer. When running in production mode some self-tests are skipped to improve performance.

mount_ipa <URI>

Specifies the mount point that the development server will register. The default is /ipa/

oidc_child_debug_level <debuglevel>

Specifies the debug level of oidc_child, a helper process used by ipa-otpd for OIDC/OAuth2 authentication. Level can be between 0 and 10, the higher the more details. If the level is 6 or higher HTTP debug output is added as well.

passkey_child_debug_level <debuglevel>

Specifies the debug level of passkey_child, a helper process used by ipa-otpd for passkey authentication. Level can be between 0 and 10, the higher the more details. If the level is 6 or higher libfido2 debug output is added as well.

prompt_all <boolean>

Specifies that all options should be prompted for in the IPA client, even optional values. Default is False.

ra_plugin <name>

Specifies the name of the CA back end to use. The current options are dogtag and none. This is a server-side setting. Changing this value is not recommended as the CA back end is only set up during initial installation.

realm <realm>

Specifies the Kerberos realm.

replication_wait_timeout <seconds>

The time to wait for a new entry to be replicated during replica installation. The default value is 300 seconds.

schema_ttl <seconds>

The number of seconds for the ipa tool to cache the IPA API and help schema. Reducing this value during development is helpful so that API changes are seen sooner in the tool. Setting this on a server will define the TTL for all client versions > 4.3.1. Client versions > 4.3.1 that connect to IPA servers older than 4.3.1 will use the client-side configuration value. The default is 3600 seconds. 0 disables the cache. A change in the ttl will not be immediately recognized by clients. They will use the new value once their current cache expires.

server <hostname>

Specifies the IPA Server hostname.

skip_version_check <boolean>

Skip client vs. server API version checking. Can lead to errors/strange behavior when newer clients talk to older servers. Use with caution.

startup_timeout <time in seconds>

Controls the amount of time waited when starting a service. The default value is 90 seconds, the same as the default systemd startup timeout. If configuring a CA the startup_timeout value will be added as an override for TimeoutStartSec in systemd. If installation times out when starting the CA create /etc/ipa/installer.conf with this value set.

startup_traceback <boolean>

If the IPA server fails to start and this value is True the server will attempt to generate a python traceback to make identifying the underlying problem easier.

validate_api <boolean>

Used internally in the IPA source package to verify that the API has not changed. This is used to prevent regressions. If it is true then some errors are ignored so enough of the IPA framework can be loaded to verify all of the API, even if optional components are not installed. The default is False.

verbose <boolean>

When True provides more information. Specifically this sets the global log level to "info".

wait_for_dns <number of attempts>

Controls whether the IPA commands dnsrecord-{add,mod,del} work synchronously or not. The DNS commands will repeat DNS queries up to the specified number of attempts until the DNS server returns an up-to-date answer to a query for modified records. Delay between retries is one second.

The DNS commands will raise a DNSDataMismatch exception if the answer doesn't match the expected value even after the specified number of attempts.

The DNS queries will be sent to the resolver configured in /etc/resolv.conf on the IPA server.

Do not enable this in production! This will cause problems if the resolver on IPA server uses a caching server instead of a local authoritative server or e.g. if DNS answers are modified by DNS64. The default is disabled (the option is not present).

xmlrpc_uri <URI>

Specifies the URI of the XML-RPC server for a client. This may be used by IPA, and is used by some external tools, such as ipa-getcert. Example: https://ipa.example.com/ipa/xml

jsonrpc_uri <URI>

Specifies the URI of the JSON server for a client. This is used by IPA. If not given, it is derived from xmlrpc_uri. Example: https://ipa.example.com/ipa/json

rpc_protocol <URI>

Specifies the type of RPC calls IPA makes: 'jsonrpc' or 'xmlrpc'. Defaults to 'jsonrpc'.

The following define the containers for the IPA server. Containers define where in the DIT that objects can be found. The full location is the value of container + basedn.

container_accounts: cn=accounts

container_applications: cn=applications,cn=configs,cn=policies

container_automount: cn=automount

container_configs: cn=configs,cn=policies

container_dns: cn=dns

container_group: cn=groups,cn=accounts

container_hbac: cn=hbac

container_hbacservice: cn=hbacservices,cn=hbac

container_hbacservicegroup: cn=hbacservicegroups,cn=hbac

container_host: cn=computers,cn=accounts

container_hostgroup: cn=hostgroups,cn=accounts

container_netgroup: cn=ng,cn=alt

container_permission: cn=permissions,cn=pbac

container_policies: cn=policies

container_policygroups: cn=policygroups,cn=configs,cn=policies

container_policylinks: cn=policylinks,cn=configs,cn=policies

container_privilege: cn=privileges,cn=pbac

container_rolegroup: cn=roles,cn=accounts

container_roles: cn=roles,cn=policies

container_service: cn=services,cn=accounts

container_sudocmd: cn=sudocmds,cn=sudo

container_sudocmdgroup: cn=sudocmdgroups,cn=sudo

container_sudorule: cn=sudorules,cn=sudo

container_user: cn=users,cn=accounts

container_vault: cn=vaults,cn=kra

container_virtual: cn=virtual operations,cn=etc

## FILES
/etc/ipa/default.conf

system-wide IPA configuration file

$HOME/.ipa/default.conf

user IPA configuration file

It is also possible to define context-specific configuration files. The context is set when the IPA api is initialized. The currently defined contexts in IPA are cli, server and dns. This is helpful, for example, if you only want debug enabled on the server and not in the client. If this is set to True in default.conf it will affect both the ipa client tool and the IPA server. If it is only set in server.conf then only the server will have debug set. These files will be loaded if they exist:

/etc/ipa/cli.conf

system-wide IPA client configuration file

/etc/ipa/server.conf

system-wide IPA server configuration file

/etc/ipa/installer.conf

IPA configuration used while installing an IPA server or replica

/etc/ipa/cli_installer.conf

IPA configuration used while installing an IPA client

## EXAMPLES
An example of a context-specific configuration file is /etc/ipa/dns.conf to be used to increase debug output of the IPA DNSSEC daemons.

[global] debug = True

## SEE ALSO
ipa(1)


epn.conf

package: freeipa-client-epn

title: epn.conf(5)

text:
# epn.conf(5)

## NAME
epn.conf - Expiring Password Notification configuration file

## SYNOPSIS
/etc/ipa/epn.conf

## DESCRIPTION
The epn.conf configuration file is used to set the options for the ipa-epn tool to notify users of upcoming password expiration.

## SYNTAX
The configuration options are not case sensitive. The values may be case sensitive, depending on the option.

Blank lines are ignored. Lines beginning with # are comments and are ignored.

Valid lines consist of an option name, an equals sign and a value. Spaces surrounding equals sign are ignored. An option terminates at the end of a line.

Values should not be quoted, the quotes will not be stripped.

\# Wrong - don't include quotes

verbose = "True"

\# Right - Properly formatted options

verbose = True

verbose=True

Options must appear in the section named [global]. There are no other sections defined or used currently.

Options may be defined that are not used by IPA. Be careful of misspellings, they will not be rejected.

## OPTIONS
smtp_server <fqdn>

Specifies the SMTP server to use. The default is localhost.

smtp_port <port>

Specifies the SMTP port. The default is 25.

smtp_user <user>

Specifies the id of the user to authenticate with the SMTP server. Default None.

smtp_password <password>

Specifies the password for the authorized user. Default None.

smtp_client_cert <certificate>

Specifies the path to a single file in PEM format containing the certificate. Default None.

smtp_client_key <private key>

Specifies the path to a file containing the private key in. Otherwise the private key will be taken from certfile as well. Default None.

smtp_client_key_pass <private key password>

Specifies the password for decrypting the private key. Default None.

smtp_timeout <seconds>

Specifies the number of seconds to wait for SMTP to respond. Default 60.

smtp_security <security>

Specifies the type of secure connection to make. Options are: none, starttls and ssl. The default is none.

smtp_admin <address>

Specifies the From e-mail address value in the e-mails sent. The default is root@localhost. Bounces will be sent here.

smtp_delay <milliseconds>

Time to wait, in milliseconds, between each e-mail sent to try to avoid overloading the mail queue. The default is 0.

mail_from <address>

Specifies the From: e-mail address value in the e-mails sent. The default is noreply@ipadefaultemaildomain. This value can be found by running ipa config-show

mail_from_name <name>

Specifies the From: name value in the e-mails sent. The default is IPA-EPN.

notify_ttls <list of days>

This is the list of days before a password expiration when ipa-epn should notify a user that their password will soon require a reset. If this value is not specified then the default list will be used: 28, 14, 7, 3, 1.

msg_subject <subject>

Specifies the subject of the e-mails sent. The default is "Your password will expire soon."

msg_charset <type>

Set the character set of the message. The default is utf8. This will result in he body of the message being base64-encoded.

msg_subtype <type>

Set the message's MIME sub-content type. The default is plain.

## FILES
/etc/ipa/epn.conf

Configuration file

## SEE ALSO
ipa-epn(1)


ipahealthcheck.conf

package: freeipa-healthcheck

title: ipahealthcheck.conf(5)

summary: ipa-healthcheck configuration file

text:
# ipahealthcheck.conf(5)

## NAME
ipahealthcheck.conf - ipa-healthcheck configuration file

## SYNOPSIS
/etc/ipahealthcheck/ipahealthcheck.conf

## DESCRIPTION
The ipahealthcheck.conf configuration file is used to set the defaults when running ipa-healthcheck.

## SYNTAX
The configuration options are not case sensitive. The values may be case sensitive, depending on the option.

Blank lines are ignored. Lines beginning with # are comments and are ignored.

Valid lines consist of an option name, an equals sign and a value. Spaces surrounding equals sign are ignored. An option terminates at the end of a line.

Values should not be quoted, the quotes will not be stripped.

\# Wrong - don't include quotes

verbose = "True"

\# Right - Properly formatted options

verbose = True

verbose=True

Options must appear in the section named [default]. There are no other sections defined or used currently.

Options may be defined that are not used. Be careful of misspellings, they will not be rejected.

## EXCLUDES
There may be reasons that a user will want to suppress some results. One example is a customer certificate that is generating a warning because it is unknown to IPA. Excluding a result key does not prevent it from running, it is filtered from the reported results. Excluding by source or check will prevent it from running at all. Services will not be excluded because other checks may rely on them (ipahealthcheck.meta.services).

Each excludes type may be listed multiple times. Invalid sources, checks and/or keys will not be flagged. These configuration options are only processed when found in the EXCLUDES section and are otherwise ignored.

Users are encouraged to annotate the reason for excluding the results so the reason is not lost.

Results can be suppressed or excluded in three ways:

• source, e.g. ipahealthcheck.ipa.certs

• check, e.g. IPADNSSystemRecordsCheck

• report key, e.g. 20210910141457 (certmonger tracking id)

## OPTIONS
The following options are relevant in each section.

[default]

cert_expiration_days

The number of days left before a certificate expires to start displaying a warning. The default is 28.

timeout

The time allowed in seconds for each check to run before being considered an error. The default is 10.

[excludes]

source

Filter results based on the check source.

check

Filter results based on the check name.

key

Filter results based on the result key in the healthcheck output.

All command-line options may be included in the configuration file. Dashes must be converted to underscore for the configuration file, e.g. --output-type becomes output_type. All options, including those that don't make sense in a config file, like --list-sources, are allowed. Let the buyer beware.

The purpose of allowing command-line options to be in the configuration file is for automation without having to tweak the automation script. For example, if you want the default output type to be human for the systemd timer automated runs, settting output_type=human in the configuration file will do this. When loading configuration the first option wins, so if any option is in the configuration file then it cannot be overridden by the command-line unless a different configuration file is specified (see --config).

There may be conflicting exceptions. For example, if all=True is set in the configuration file, and the command-line contains --failures-only, then only failures will be displayed because of the way the option evaluation is done.

Options that don't make sense for the configuration file include --list-sources and --input-file.

## FILES
/etc/ipahealthcheck/ipahealthcheck.conf

configuration file

## EXAMPLES
7 days left before a certificate expires to start displaying a warning:

[default]

cert_expiration_days=7

Exclude all certificate checks:

[excludes]

source=ipahealthcheck.ipa.certs

Don't warn about a custom certificate being tracked by certmonger:

[excludes]

key=20210910141452

## SEE ALSO
ipa-healthcheck(8)


freeipmi.conf

package: freeipmi

title: freeipmi.conf(5)

summary: specify default values to FreeIPMI

text:
# freeipmi.conf(5)

## NAME
freeipmi.conf - specify default values to FreeIPMI

## DESCRIPTION
The FreeIPMI configuration file can be used to set alternate default values to many FreeIPMI tools so values don't have to be configured on the command line. This allows users to avoid typing in a long list of command line options every time a command is executed. It can also be used to hide usernames, passwords, and other sensitive information from the ps(1) command.

Currently, the tools that can be configured with the configuration file are: bmc-device(8), bmc-info(8), bmc-watchdog(8), ipmi-chassis(8), ipmi-config(8), ipmi-fru(8), ipmi-oem(8), ipmi-pet(8), ipmi-raw(8), ipmi-sel(8), ipmi-sensors(8), ipmiconsole(8), and ipmipower(8).

By default, the configuration file is stored at /etc/freeipmi//freeipmi.conf. But users may select a different configuration file at the command line with the --config-file option.

Values specified on the command line override the configuration values specified in the configuration file.

## FORMAT
The configuration options that can be specified in the configuration file are listed below. Each configuration option must be listed on a separate line. Arguments for an option are separated by any amount of whitespace. Multiple arguments are also separated by whitespace. Comments can be marked by using the pound sign ("#") character, and lines can be continued on the next using backslash ("\").

Note that it is possible to list the username, password and other potentially sensitive information in the configuration file. If this data is stored in a configuration file, system administrators should limit access to this file.

## GENERAL OPTIONS
The following options are options generally available to all tools, although specific options may be ignored by some. (For example, ipmiconsole(8) and ipmipower(8) do not perform in-band communication, therefore they would ignore in-band communication options. Similarly bmc-watchdog(8) does not perform out-of-band communication, therefore it would ignore all out-of-band options).

driver-type IPMIDRIVER

Specify the default driver type to use.

disable-auto-probe ENABLE|DISABLE

Specify if IPMI devices should be probed for default settings.

driver-address DRIVER-ADDRESS

Specify the default in-band driver address to use.

driver-device DEVICE

Specify the default in-band driver device path to use.

register-spacing REGISTER-SPACING

Specify the default in-band driver register spacing to use.

target-channel-number CHANNEL-NUMBER

Specify the default in-band driver target channel number.

target-slave-address SLAVE-ADDRESS

Specify the default in-band driver target slave address.

username USERNAME

Specify the default username to use.

password PASSWORD

Specify the default password to use.

k_g str

Specify the default BMC key (K_g) to use. Prefix with '0x' to enter the key in hex.

session-timeout MILLISECONDS

Specify the default session timeout length to use in milliseconds.

retransmission-timeout MILLISECONDS

Specify the default retransmission timeout length to use in milliseconds.

authentication-type AUTHENTICATION-TYPE

Specify the default authentication type to use. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.

cipher-suite-id CIPHER-SUITE-ID

Specify the default cipher suite id to use. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.

privilege-level PRIVILEGE-LEVEL

Specify the default privilege type to use. The following privilege levels are supported: USER, OPERATOR, ADMIN.

workaround-flags WORKAROUNDS

Specify default workaround flags to use. Multiple workarounds can be specified separated by whitespace. Please see tool manpages for details about available workarounds for each tool. The following workarounds are supported: assumeio, spinpoll, idzero, forcepermsg, unexpectedauth, endianseq, noauthcodecheck, authcap, nochecksumcheck, intel20, supermicro20, sun20, opensesspriv, integritycheckvalue, assumemaxsdrrecordcount, solpayloadsize, solport, solstatus, solchannelsupport, serialalertsdeferred, solpacketseq, skipchecks, assumesystemevent, discretereading, ignorescanningdisabled, assumebmcowner, albridging, ignoreauthcode, slowcommit, veryslowcommit, solchannelassumelanchannel, ignorestateflag, malformedack, guidformat, ipmiping.

## SDR OPTIONS
The following options are specific to tools that use the sensor data repository (SDR). They will be ignored by all other tools.

quiet-cache ENABLE|DISABLE

Specify if cache creation/deletion information should not be output by default.

sdr-cache-directory DIRECTORY

Specify the default sdr cache directory to use.

## TIME OPTIONS
The following options are specific to tools that may output time values. They will be ignored by all other tools.

utc-to-localtime ENABLE|DISABLE

Specify if time should be converted from assumed UTC to localtime by default.

localtime-to-utc ENABLE|DISABLE

Specify if time should be converted from localtime to UTC by default.

utc-offset SECONDS

Specify a default UTC offset to be added to timestamps.

## HOSTRANGED OPTIONS
The following options are specific to tools that support hostranged output. They will be ignored by all other tools.

buffer-output ENABLE|DISABLE

Specify if hostranged output should be buffered by default.

consolidate-output ENABLE|DISABLE

Specify if hostranged output should be consolidated by default.

fanout COUNT

Specify the default multiple host fanout to use.

eliminate ENABLE|DISABLE

Specify if undetected hosts should be eliminated by default.

always-prefix ENABLE|DISABLE

Specify if output should be always prefixed by default.

## BMC-DEVICE OPTIONS
The following options are specific to bmc-device(8). They will be ignored by other tools.

bmc-device-username USERNAME

Specify the default username to use for bmc-device(8). If specified, will override the general option username above.

bmc-device-password PASSWORD

Specify the default password to use for bmc-device(8). If specified, will override the general option password above.

bmc-device-k_g str

Specify the default BMC key (K_g) to use for bmc-device(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.

bmc-device-authentication-type AUTHENTICATION-TYPE

Specify the default authentication type to use for bmc-device(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.

bmc-device-cipher-suite-id CIPHER-SUITE-ID

Specify the default cipher suite id to use for bmc-device(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.

bmc-device-privilege-level PRIVILEGE-LEVEL

Specify the default privilege type to use for bmc-device(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.

bmc-device-workaround-flags WORKAROUNDS

Specify default workaround flags to use for bmc-device(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see bmc-device(8) manpage for available workarounds.

## BMC-INFO OPTIONS
The following options are specific to bmc-info(8). They will be ignored by other tools.

bmc-info-username USERNAME

Specify the default username to use for bmc-info(8). If specified, will override the general option username above.

bmc-info-password PASSWORD

Specify the default password to use for bmc-info(8). If specified, will override the general option password above.

bmc-info-k_g str

Specify the default BMC key (K_g) to use for bmc-info(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.

bmc-info-authentication-type AUTHENTICATION-TYPE

Specify the default authentication type to use for bmc-info(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.

bmc-info-cipher-suite-id CIPHER-SUITE-ID

Specify the default cipher suite id to use for bmc-info(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.

bmc-info-privilege-level PRIVILEGE-LEVEL

Specify the default privilege type to use for bmc-info(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.

bmc-info-workaround-flags WORKAROUNDS

Specify default workaround flags to use for bmc-info(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see bmc-info(8) manpage for available workarounds.

bmc-info-interpret-oem-data ENABLE|DISABLE

Specify if bmc-info should attempt to interpret OEM data by default or not.

## BMC-WATCHDOG OPTIONS
The following options are specific to bmc-watchdog(8). They will be ignored by other tools.

bmc-watchdog-workaround-flags WORKAROUNDS

Specify default workaround flags to use for bmc-watchdog(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see bmc-watchdog(8) manpage for available workarounds.

bmc-watchdog-verbose-logging ENABLE|DISABLE

Specify if logging will be verbose by default.

bmc-watchdog-no-logging ENABLE|DISABLE

Specify if logging will be disabled by default.

## IPMI-CHASSIS OPTIONS
The following options are specific to ipmi-chassis(8). They will be ignored by other tools.

ipmi-chassis-username USERNAME

Specify the default username to use for ipmi-chassis(8). If specified, will override the general option username above.

ipmi-chassis-password PASSWORD

Specify the default password to use for ipmi-chassis(8). If specified, will override the general option password above.

ipmi-chassis-k_g str

Specify the default BMC key (K_g) to use for ipmi-chassis(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.

ipmi-chassis-authentication-type AUTHENTICATION-TYPE

Specify the default authentication type to use for ipmi-chassis(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.

ipmi-chassis-cipher-suite-id CIPHER-SUITE-ID

Specify the default cipher suite id to use for ipmi-chassis(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.

ipmi-chassis-privilege-level PRIVILEGE-LEVEL

Specify the default privilege type to use for ipmi-chassis(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.

ipmi-chassis-workaround-flags WORKAROUNDS

Specify default workaround flags to use for ipmi-chassis(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-chassis(8) manpage for available workarounds.

## IPMI-CONFIG OPTIONS
The following options are specific to ipmi-config(8). They will be ignored by other tools.

ipmi-config-username USERNAME

Specify the default username to use for ipmi-config(8). If specified, will override the general option username above.

ipmi-config-password PASSWORD

Specify the default password to use for ipmi-config(8). If specified, will override the general option password above.

ipmi-config-k_g str

Specify the default IPMI key (K_g) to use for ipmi-config(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.

ipmi-config-authentication-type AUTHENTICATION-TYPE

Specify the default authentication type to use for ipmi-config(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.

ipmi-config-cipher-suite-id CIPHER-SUITE-ID

Specify the default cipher suite id to use for ipmi-config(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.

ipmi-config-privilege-level PRIVILEGE-LEVEL

Specify the default privilege type to use for ipmi-config(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.

ipmi-config-workaround-flags WORKAROUNDS

Specify default workaround flags to use for ipmi-config(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-config(8) manpage for available workarounds.

ipmi-config-verbose-count COUNT

Specify default verbose count to use for ipmi-config(8).

## IPMI-DCMI OPTIONS
The following options are specific to ipmi-dcmi(8). They will be ignored by other tools.

ipmi-dcmi-username USERNAME

Specify the default username to use for ipmi-dcmi(8). If specified, will override the general option username above.

ipmi-dcmi-password PASSWORD

Specify the default password to use for ipmi-dcmi(8). If specified, will override the general option password above.

ipmi-dcmi-k_g str

Specify the default BMC key (K_g) to use for ipmi-dcmi(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.

ipmi-dcmi-authentication-type AUTHENTICATION-TYPE

Specify the default authentication type to use for ipmi-dcmi(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.

ipmi-dcmi-cipher-suite-id CIPHER-SUITE-ID

Specify the default cipher suite id to use for ipmi-dcmi(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.

ipmi-dcmi-privilege-level PRIVILEGE-LEVEL

Specify the default privilege type to use for ipmi-dcmi(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.

ipmi-dcmi-workaround-flags WORKAROUNDS

Specify default workaround flags to use for ipmi-dcmi(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-dcmi(8) manpage for available workarounds.

ipmi-dcmi-interpret-oem-data ENABLE|DISABLE

Specify if ipmi-dcmi should attempt to interpret OEM data by default or not.

## IPMI-FRU OPTIONS
The following options are specific to ipmi-fru(8). They will be ignored by other tools.

ipmi-fru-username USERNAME

Specify the default username to use for ipmi-fru(8). If specified, will override the general option username above.

ipmi-fru-password PASSWORD

Specify the default password to use for ipmi-fru(8). If specified, will override the general option password above.

ipmi-fru-k_g str

Specify the default BMC key (K_g) to use for ipmi-fru(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.

ipmi-fru-authentication-type AUTHENTICATION-TYPE

Specify the default authentication type to use for ipmi-fru(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.

ipmi-fru-cipher-suite-id CIPHER-SUITE-ID

Specify the default cipher suite id to use for ipmi-fru(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.

ipmi-fru-privilege-level PRIVILEGE-LEVEL

Specify the default privilege type to use for ipmi-fru(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.

ipmi-fru-workaround-flags WORKAROUNDS

Specify default workaround flags to use for ipmi-fru(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-fru(8) manpage for available workarounds.

ipmi-fru-verbose-count COUNT

Specify default verbose count to use for ipmi-fru(8).

ipmi-fru-bridge-fru ENABLE|DISABLE

Specify if FRU entries on other controllers should be read by default or not.

ipmi-fru-interpret-oem-data ENABLE|DISABLE

Specify if ipmi-fru should attempt to interpret OEM data by default or not.

## IPMI-OEM OPTIONS
The following options are specific to ipmi-oem(8). They will be ignored by other tools.

ipmi-oem-username USERNAME

Specify the default username to use for ipmi-oem(8). If specified, will override the general option username above.

ipmi-oem-password PASSWORD

Specify the default password to use for ipmi-oem(8). If specified, will override the general option password above.

ipmi-oem-k_g str

Specify the default BMC key (K_g) to use for ipmi-oem(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.

ipmi-oem-authentication-type AUTHENTICATION-TYPE

Specify the default authentication type to use for ipmi-oem(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.

ipmi-oem-cipher-suite-id CIPHER-SUITE-ID

Specify the default cipher suite id to use for ipmi-oem(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.

ipmi-oem-privilege-level PRIVILEGE-LEVEL

Specify the default privilege type to use for ipmi-oem(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.

ipmi-oem-workaround-flags WORKAROUNDS

Specify default workaround flags to use for ipmi-oem(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-oem(8) manpage for available workarounds.

ipmi-oem-verbose-count COUNT

Specify default verbose count to use for ipmi-oem(8).

## IPMI-PET OPTIONS
The following options are specific to ipmi-pet(8). They will be ignored by other tools.

ipmi-pet-username USERNAME

Specify the default username to use for ipmi-pet(8). If specified, will override the general option username above.

ipmi-pet-password PASSWORD

Specify the default password to use for ipmi-pet(8). If specified, will override the general option password above.

ipmi-pet-k_g str

Specify the default BMC key (K_g) to use for ipmi-pet(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.

ipmi-pet-authentication-type AUTHENTICATION-TYPE

Specify the default authentication type to use for ipmi-pet(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.

ipmi-pet-cipher-suite-id CIPHER-SUITE-ID

Specify the default cipher suite id to use for ipmi-pet(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.

ipmi-pet-privilege-level PRIVILEGE-LEVEL

Specify the default privilege type to use for ipmi-pet(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.

ipmi-pet-workaround-flags WORKAROUNDS

Specify default workaround flags to use for ipmi-pet(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-pet(8) manpage for available workarounds.

ipmi-pet-verbose-count COUNT

Specify default verbose count to use for ipmi-pet(8).

ipmi-pet-output-event-severity ENABLE|DISABLE

Specify if ipmi-pet should output the event severity state by default.

ipmi-pet-output-event-state ENABLE|DISABLE

Specify if ipmi-pet should output the event state state by default.

ipmi-pet-event-state-config-file FILE

Specify the default event state configuration file.

ipmi-pet-interpret-oem-data ENABLE|DISABLE

Specify if ipmi-pet should attempt to interpret OEM data by default or not.

ipmi-pet-entity-sensor-names ENABLE|DISABLE

Specify if output of sensor names should include entity ids and instances by default or not.

ipmi-pet-no-sensor-type-output ENABLE|DISABLE

Specify if output of the sensor type should be output by default or not.

ipmi-pet-comma-separated-output ENABLE|DISABLE

Specify if output should be comma separated by default or not.

ipmi-pet-no-header-output ENABLE|DISABLE

Specify if column headers should be output by default or not.

ipmi-pet-non-abbreviated-units ENABLE|DISABLE

Specify if output should have units abbreviated by default or not.

## IPMI-RAW OPTIONS
The following options are specific to ipmi-raw(8). They will be ignored by other tools.

ipmi-raw-username USERNAME

Specify the default username to use for ipmi-raw(8). If specified, will override the general option username above.

ipmi-raw-password PASSWORD

Specify the default password to use for ipmi-raw(8). If specified, will override the general option password above.

ipmi-raw-k_g str

Specify the default BMC key (K_g) to use for ipmi-raw(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.

ipmi-raw-authentication-type AUTHENTICATION-TYPE

Specify the default authentication type to use for ipmi-raw(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.

ipmi-raw-cipher-suite-id CIPHER-SUITE-ID

Specify the default cipher suite id to use for ipmi-raw(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.

ipmi-raw-privilege-level PRIVILEGE-LEVEL

Specify the default privilege type to use for ipmi-raw(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.

ipmi-raw-workaround-flags WORKAROUNDS

Specify default workaround flags to use for ipmi-raw(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-raw(8) manpage for available workarounds.

## IPMI-SEL OPTIONS
The following options are specific to ipmi-sel(8). They will be ignored by other tools.

ipmi-sel-username USERNAME

Specify the default username to use for ipmi-sel(8). If specified, will override the general option username above.

ipmi-sel-password PASSWORD

Specify the default password to use for ipmi-sel(8). If specified, will override the general option password above.

ipmi-sel-k_g str

Specify the default BMC key (K_g) to use for ipmi-sel(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.

ipmi-sel-authentication-type AUTHENTICATION-TYPE

Specify the default authentication type to use for ipmi-sel(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.

ipmi-sel-cipher-suite-id CIPHER-SUITE-ID

Specify the default cipher suite id to use for ipmi-sel(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.

ipmi-sel-privilege-level PRIVILEGE-LEVEL

Specify the default privilege type to use for ipmi-sel(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.

ipmi-sel-workaround-flags WORKAROUNDS

Specify default workaround flags to use for ipmi-sel(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-sel(8) manpage for available workarounds.

ipmi-sel-verbose-count COUNT

Specify default verbose count to use for ipmi-sel(8).

ipmi-sel-types TYPE-LIST

Specify default types to show SEL events for. Multiple types can be specified separated by whitespace. Users may specify sensor types by string or by number (decimal or hex). Please see ipmi-sel(8) --list-types option to see possible string input types.

ipmi-sel-exclude-types ENSOR-TYPES-LIST Specify

default sensor types to not show SEL events for. Multiple sensor types can be specified separated by whitespace. Users may specify sensor types by string or by number. Please see ipmi-sel(8) --list-types option to see possible string input types.

ipmi-sel-system-event-only ENABLE|DISABLE

Specify if output should only include system event records.

ipmi-sel-oem-event-only ENABLE|DISABLE

Specify if output should only include OEM event records.

ipmi-sel-output-manufacturer-id ENABLE|DISABLE

Specify if output of OEM event records should include manufacturer ID by default or not.

ipmi-sel-output-event-state ENABLE|DISABLE

Specify if ipmi-sel should output the event state state by default.

ipmi-sel-event-state-config-file FILE

Specify the default event state configuration file.

ipmi-sel-interpret-oem-data ENABLE|DISABLE

Specify if ipmi-sel should attempt to interpret OEM data by default or not.

ipmi-sel-output-oem-event-strings ENABLE|DISABLE

Specify if ipmi-sel should output OEM event strings by default or not.

ipmi-sel-entity-sensor-names ENABLE|DISABLE

Specify if output of sensor names should include entity ids and instances by default or not.

ipmi-sel-no-sensor-type-output ENABLE|DISABLE

Specify if output of the sensor type should be output by default or not.

ipmi-sel-comma-separated-output ENABLE|DISABLE

Specify if output should be comma separated by default or not.

ipmi-sel-no-header-output ENABLE|DISABLE

Specify if column headers should be output by default or not.

ipmi-sel-non-abbreviated-units ENABLE|DISABLE

Specify if output should have units abbreviated by default or not.

ipmi-sel-legacy-output ENABLE|DISABLE

Specify if output should be in legacy format by default or not.

## IPMI-SENSORS OPTIONS
The following options are specific to ipmi-sensors(8). They will be ignored by other tools.

ipmi-sensors-username USERNAME

Specify the default username to use for ipmi-sensors(8). If specified, will override the general option username above.

ipmi-sensors-password PASSWORD

Specify the default password to use for ipmi-sensors(8). If specified, will override the general option password above.

ipmi-sensors-k_g str

Specify the default BMC key (K_g) to use for ipmi-sensors(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.

ipmi-sensors-authentication-type AUTHENTICATION-TYPE

Specify the default authentication type to use for ipmi-sensors(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.

ipmi-sensors-cipher-suite-id CIPHER-SUITE-ID

Specify the default cipher suite id to use for ipmi-sensors(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.

ipmi-sensors-privilege-level PRIVILEGE-LEVEL

Specify the default privilege type to use for ipmi-sensors(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.

ipmi-sensors-workaround-flags WORKAROUNDS

Specify default workaround flags to use for ipmi-sensors(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-sensors(8) manpage for available workarounds.

ipmi-sensors-verbose-count COUNT

Specify default verbose count to use for ipmi-sensors(8).

ipmi-sensors-quiet-readings ENABLE|DISABLE

Specify if sensor reading values and thresholds should not be output by default.

ipmi-sensors-record-ids ECORD-IDS-LIST

Specify default record ids to show sensor outputs for. Multiple record ids can be specified separated by whitespace.

ipmi-sensors-exclude-record-ids ECORD-IDS-LIST

Specify default record ids to not show sensor outputs for. Multiple record ids can be specified separated by whitespace.

ipmi-sensors-types TYPE-LIST

Specify default types to show sensor outputs for. Multiple types can be specified separated by whitespace. Users may specify sensor types by string or by number (decimal or hex). Please see ipmi-sensors(8) --list-types option to see possible string input types.

ipmi-sensors-exclude-types ENSOR-TYPES-LIST Specify

default sensor types to not show sensor outputs for. Multiple sensor types can be specified separated by whitespace. Users may specify sensor types by string or by number. Please see ipmi-sensors(8) --list-types option to see possible string input types.

ipmi-sensors-bridge-sensors ENABLE|DISABLE

Specify if non-BMC sensors should be bridged by default or not.

ipmi-sensors-shared-sensors ENABLE|DISABLE

Specify if shared sensors should be output by default or not.

ipmi-sensors-interpret-oem-data ENABLE|DISABLE

Specify if ipmi-sensors should attempt to interpret OEM data by default or not.

ipmi-sensors-ignore-not-available-sensors ENABLE|DISABLE

Specify if ipmi-sensors should ignore not-available (i.e. N/A) sensors by default.

ipmi-sensors-ignore-unrecognized-events ENABLE|DISABLE

Specify if ipmi-sensors should ignore unrecognized events (i.e. 'Unrecognized Event') in sensors output by default.

ipmi-sensors-output-event-bitmask ENABLE|DISABLE

Specify if ipmi-sensors should output event bitmasks instead of string representations by default.

ipmi-sensors-output-sensor-state ENABLE|DISABLE

Specify if ipmi-sensors should output the sensor state by default.

ipmi-sensors-sensor-state-config-file FILE

Specify the default sensor state configuration file.

ipmi-sensors-entity-sensor-names ENABLE|DISABLE

Specify if output of sensor names should include entity ids and instances by default or not.

ipmi-sensors-output-sensor-thresholds ENABLE|DISABLE

Specify if ipmi-sensors should output sensor thresholds by default.

ipmi-sensors-no-sensor-type-output ENABLE|DISABLE

Specify if output of the sensor type should be output by default or not.

ipmi-sensors-comma-separated-output ENABLE|DISABLE

Specify if output should be comma separated by default or not.

ipmi-sensors-no-header-output ENABLE|DISABLE

Specify if column headers should be output by default or not.

ipmi-sensors-non-abbreviated-units ENABLE|DISABLE

Specify if output should have units abbreviated by default or not.

ipmi-sensors-legacy-output ENABLE|DISABLE

Specify if output should be in legacy format by default or not.

ipmi-sensors-ipmimonitoring-legacy-output ENABLE|DISABLE

Specify if output should be in ipmimonitoring legacy format by default or not.

## IPMICONSOLE OPTIONS
The following options are specific to ipmiconsole(8). They will be ignored by other tools.

ipmiconsole-username USERNAME

Specify the default username to use for ipmiconsole(8). If specified, will override the general option username above.

ipmiconsole-password PASSWORD

Specify the default password to use for ipmiconsole(8). If specified, will override the general option password above.

ipmiconsole-k_g str

Specify the default BMC key (K_g) to use for ipmiconsole(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.

ipmiconsole-authentication-type AUTHENTICATION-TYPE

Specify the default authentication type to use for ipmiconsole(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.

ipmiconsole-cipher-suite-id CIPHER-SUITE-ID

Specify the default cipher suite id to use for ipmiconsole(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.

ipmiconsole-privilege-level PRIVILEGE-LEVEL

Specify the default privilege type to use for ipmiconsole(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.

ipmiconsole-workaround-flags WORKAROUNDS

Specify default workaround flags to use for ipmiconsole(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmiconsole(8) manpage for available workarounds.

ipmiconsole-escape-char CHAR

Specify the default escape character.

ipmiconsole-dont-steal ENABLE|DISABLE

Specify if in use SOL sessions should not be stolen by default.

ipmiconsole-serial-keepalive ENABLE|DISABLE

Specify if serial keepalive should be enabled by default.

ipmiconsole-serial-keepalive-empty ENABLE|DISABLE

Specify if serial keepalive empty should be enabled by default.

ipmiconsole-sol-payload-instance NUM

Specify the default SOL payload instance.

ipmiconsole-deactivate-all-instances ENABLE|DISABLE

Specify if SOL deactivate should deactivate all instances by default.

ipmiconsole-lock-memory ENABLE|DISABLE

Specify if memory should be locked by default.

## IPMIPOWER OPTIONS
The following options are specific to ipmipower(8). They will be ignored by other tools.

ipmipower-username USERNAME

Specify the default username to use for ipmipower(8). If specified, will override the general option username above.

ipmipower-password PASSWORD

Specify the default password to use for ipmipower(8). If specified, will override the general option password above.

ipmipower-k_g str

Specify the default BMC key (K_g) to use for ipmipower(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.

ipmipower-authentication-type AUTHENTICATION-TYPE

Specify the default authentication type to use for ipmipower(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.

ipmipower-cipher-suite-id CIPHER-SUITE-ID

Specify the default cipher suite id to use for ipmipower(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.

ipmipower-privilege-level PRIVILEGE-LEVEL

Specify the default privilege type to use for ipmipower(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.

ipmipower-workaround-flags WORKAROUNDS

Specify default workaround flags to use for ipmipower(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmipower(8) manpage for available workarounds.

ipmipower-on-if-off ENABLE|DISABLE

Specify if on-if-off functionality is enabled or disabled by default.

ipmipower-wait-until-on ENABLE|DISABLE

Specify if wait-until-on functionality is enabled or disabled by default.

ipmipower-wait-until-off ENABLE|DISABLE

Specify if wait-until-off functionality is enabled or disabled by default.

ipmipower-oem-power-type OEM-POWER-TYPE

Specify OEM power type to be used.

ipmipower-retransmission-wait-timeout MILLISECONDS

Specify the default retransmission wait timeout length to use in milliseconds.

ipmipower-retransmission-backoff-count COUNT

Specify the default retransmission backoff count to use for retransmissions.

ipmipower-ping-interval MILLISECONDS

Specify the default ping interval length to use in milliseconds.

ipmipower-ping-timeout MILLISECONDS

Specify the default ping timeout length to use in milliseconds.

ipmipower-ping-packet-count COUNT

Specify the default ping packet count size to use.

ipmipower-ping-percent PERCENT

Specify the default ping percent value to use.

ipmipower-ping-consec-count COUNT

Specify the default ping consecutive count value to use.

## FILES
/etc/freeipmi//freeipmi.conf

## REPORTING BUGS
Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.

## COPYRIGHT
Copyright © 2003-2015 FreeIPMI Core Team.

FreeIPMI is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

## SEE ALSO
freeipmi(7), bmc-device(8), bmc-info(8), bmc-watchdog(8), ipmi-chassis(8), ipmi-config(8), ipmi-fru(8), ipmi-oem(8), ipmi-raw(8), ipmi-sel(8), ipmi-sensors(8), ipmiconsole(8), ipmipower(8)

http://www.gnu.org/software/freeipmi/