Configuration Reference

[DEFAULT]

control_exchange = openstack

(String) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.

default_publisher_id = None

(String) Default publisher_id for outgoing notifications

transport_url = None

(String) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.

[DEFAULT]

auth_strategy = keystone

(String) This determines the strategy to use for authentication: keystone or noauth2. 'noauth2' is designed for testing only, as it does no actual credential checking. 'noauth2' provides administrative credentials only if 'admin' is specified as the username.

[keystone_authtoken]

admin_password = None

(String) Service user password.

admin_tenant_name = admin

(String) Service tenant name.

admin_token = None

(String) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use admin_user and admin_password instead.

admin_user = None

(String) Service username.

auth_admin_prefix =

(String) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.

auth_host = 127.0.0.1

(String) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.

auth_port = 35357

(Integer) Port of the admin Identity API endpoint. Deprecated, use identity_uri.

auth_protocol = https

(String) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri.

auth_section = None

(Unknown) Config Section from which to load plugin specific options

auth_type = None

(Unknown) Authentication type to load

auth_uri = None

(String) Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint.

auth_version = None

(String) API version of the admin Identity API endpoint.

cache = None

(String) Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the memcached_servers option instead.

cafile = None

(String) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.

certfile = None

(String) Required if identity server requires client certificate

check_revocations_for_cached = False

(Boolean) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.

delay_auth_decision = False

(Boolean) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.

enforce_token_bind = permissive

(String) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.

hash_algorithms = md5

(List) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.

http_connect_timeout = None

(Integer) Request timeout value for communicating with Identity API server.

http_request_max_retries = 3

(Integer) How many times are we trying to reconnect when communicating with Identity API Server.

identity_uri = None

(String) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/

include_service_catalog = True

(Boolean) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.

insecure = False

(Boolean) Verify HTTPS connections.

keyfile = None

(String) Required if identity server requires client certificate

memcache_pool_conn_get_timeout = 10

(Integer) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.

memcache_pool_dead_retry = 300

(Integer) (Optional) Number of seconds memcached server is considered dead before it is tried again.

memcache_pool_maxsize = 10

(Integer) (Optional) Maximum total number of open connections to every memcached server.

memcache_pool_socket_timeout = 3

(Integer) (Optional) Socket timeout in seconds for communicating with a memcached server.

memcache_pool_unused_timeout = 60

(Integer) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.

memcache_secret_key = None

(String) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.

memcache_security_strategy = None

(String) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.

memcache_use_advanced_pool = False

(Boolean) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.

memcached_servers = None

(List) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.

region_name = None

(String) The region in which the identity server can be found.

revocation_cache_time = 10

(Integer) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. Only valid for PKI tokens.

signing_dir = None

(String) Directory used to cache files related to PKI tokens.

token_cache_time = 300

(Integer) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.

[DEFAULT]

db_driver = SERVICE.db

(String) DEPRECATED: The driver to use for database access

[database]

backend = sqlalchemy

(String) The back end to use for the database.

connection = None

(String) The SQLAlchemy connection string to use to connect to the database.

connection_debug = 0

(Integer) Verbosity of SQL debugging information: 0=None, 100=Everything.

connection_trace = False

(Boolean) Add Python stack traces to SQL as comment strings.

db_inc_retry_interval = True

(Boolean) If True, increases the interval between retries of a database operation up to db_max_retry_interval.

db_max_retries = 20

(Integer) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.

db_max_retry_interval = 10

(Integer) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.

db_retry_interval = 1

(Integer) Seconds between retries of a database transaction.

idle_timeout = 3600

(Integer) Timeout before idle SQL connections are reaped.

max_overflow = 50

(Integer) If set, use this value for max_overflow with SQLAlchemy.

max_pool_size = None

(Integer) Maximum number of SQL connections to keep open in a pool.

max_retries = 10

(Integer) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.

min_pool_size = 1

(Integer) Minimum number of SQL connections to keep open in a pool.

mysql_sql_mode = TRADITIONAL

(String) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=

pool_timeout = None

(Integer) If set, use this value for pool_timeout with SQLAlchemy.

retry_interval = 10

(Integer) Interval between retries of opening a SQL connection.

slave_connection = None

(String) The SQLAlchemy connection string to use to connect to the slave database.

sqlite_db = oslo.sqlite

(String) The file name to use with SQLite.

sqlite_synchronous = True

(Boolean) If True, SQLite uses synchronous mode.

use_db_reconnect = False

(Boolean) Enable the experimental use of database reconnect on connection lost.

use_tpool = False

(Boolean) Enable the experimental use of thread pooling for all DB API calls

[DEFAULT]

debug = False

(Boolean) If set to true, the logging level will be set to DEBUG instead of the default INFO level.

default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN, keystoneauth=WARN, oslo.cache=INFO, dogpile.core.dogpile=INFO

(List) List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.

fatal_deprecations = False

(Boolean) Enables or disables fatal status of deprecations.

fatal_exception_format_errors = False

(Boolean) Make exception message format errors fatal

instance_format = "[instance: %(uuid)s] "

(String) The format for an instance that is passed with the log message.

instance_uuid_format = "[instance: %(uuid)s] "

(String) The format for an instance UUID that is passed with the log message.

log_config_append = None

(String) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string).

log_date_format = %Y-%m-%d %H:%M:%S

(String) Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.

log_dir = None

(String) (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.

log_file = None

(String) (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.

logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s

(String) Format string to use for log messages with context.

logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d

(String) Additional data to append to log message when logging level for the message is DEBUG.

logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s

(String) Format string to use for log messages when context is undefined.

logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s

(String) Prefix each line of exception output with this format.

logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s

(String) Defines the format string for %(user_identity)s that is used in logging_context_format_string.

publish_errors = False

(Boolean) Enables or disables publication of error events.

syslog_log_facility = LOG_USER

(String) Syslog facility to receive log lines. This option is ignored if log_config_append is set.

use_stderr = True

(Boolean) Log output to standard error. This option is ignored if log_config_append is set.

use_syslog = False

(Boolean) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.

verbose = True

(Boolean) DEPRECATED: If set to false, the logging level will be set to WARNING instead of the default INFO level.

watch_log_file = False

(Boolean) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.

[oslo_policy]

policy_default_rule = default

(String) Default rule. Enforced when a requested rule is not found.

policy_dirs = ['policy.d']

(Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.

policy_file = policy.json

(String) The JSON file that defines policies.

[DEFAULT]

notification_format = both

(String) Specifies which notification format shall be used by nova.

rpc_backend = rabbit

(String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq.

rpc_cast_timeout = -1

(Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq.

rpc_conn_pool_size = 30

(Integer) Size of RPC connection pool.

rpc_poll_timeout = 1

(Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.

rpc_response_timeout = 60

(Integer) Seconds to wait for a response from a call.

[cells]

rpc_driver_queue_base = cells.intercell

(String) RPC driver queue base When sending a message to another cell by JSON-ifying the message and making an RPC cast to 'process_message', a base queue is used. This option defines the base queue name to be used when communicating between cells. Various topics by message type will be appended to this.

Possible values: * The base queue name to be used when communicating between cells. Services which consume this: * nova-cells

Related options: * None

[oslo_concurrency]

disable_process_locking = False

(Boolean) Enables or disables inter-process locks.

lock_path = None

(String) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set.

[oslo_messaging]

event_stream_topic = neutron_lbaas_event

(String) topic name for receiving events from a queue

[oslo_messaging_amqp]

allow_insecure_clients = False

(Boolean) Accept clients using either SSL or plain TCP

broadcast_prefix = broadcast

(String) address prefix used when broadcasting to all servers

container_name = None

(String) Name for the AMQP container

group_request_prefix = unicast

(String) address prefix when sending to any server in group

idle_timeout = 0

(Integer) Timeout for inactive connections (in seconds)

password =

(String) Password for message broker authentication

sasl_config_dir =

(String) Path to directory that contains the SASL configuration

sasl_config_name =

(String) Name of configuration file (without .conf suffix)

sasl_mechanisms =

(String) Space separated list of acceptable SASL mechanisms

server_request_prefix = exclusive

(String) address prefix used when sending to a specific server

ssl_ca_file =

(String) CA certificate PEM file to verify server certificate

ssl_cert_file =

(String) Identifying certificate PEM file to present to clients

ssl_key_file =

(String) Private key PEM file used to sign cert_file certificate

ssl_key_password = None

(String) Password for decrypting ssl_key_file (if encrypted)

trace = False

(Boolean) Debug: dump AMQP frames to stdout

username =

(String) User name for message broker authentication

[oslo_messaging_notifications]

driver = []

(Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop

topics = notifications

(List) AMQP topic used for OpenStack notifications.

transport_url = None

(String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.

[upgrade_levels]

baseapi = None

(String) Set a version cap for messages sent to the base api in any service

[agent]

agent_api_version = v1

(String) API version to use for communicating with the ramdisk agent.

deploy_logs_collect = on_failure

(String) Whether Ironic should collect the deployment logs on deployment failure (on_failure), always or never.

deploy_logs_local_path = /var/log/ironic/deploy

(String) The path to the directory where the logs should be stored, used when the deploy_logs_storage_backend is configured to "local".

deploy_logs_storage_backend = local

(String) The name of the storage backend where the logs will be stored.

deploy_logs_swift_container = ironic_deploy_logs_container

(String) The name of the Swift container to store the logs, used when the deploy_logs_storage_backend is configured to "swift".

deploy_logs_swift_days_to_expire = 30

(Integer) Number of days before a log object is marked as expired in Swift. If None, the logs will be kept forever or until manually deleted. Used when the deploy_logs_storage_backend is configured to "swift".

manage_agent_boot = True

(Boolean) Whether Ironic will manage booting of the agent ramdisk. If set to False, you will need to configure your mechanism to allow booting the agent ramdisk.

memory_consumed_by_agent = 0

(Integer) The memory size in MiB consumed by agent when it is booted on a bare metal node. This is used for checking if the image can be downloaded and deployed on the bare metal node after booting agent ramdisk. This may be set according to the memory consumed by the agent ramdisk image.

post_deploy_get_power_state_retries = 6

(Integer) Number of times to retry getting power state to check if bare metal node has been powered off after a soft power off.

post_deploy_get_power_state_retry_interval = 5

(Integer) Amount of time (in seconds) to wait between polling power state after trigger soft poweroff.

stream_raw_images = True

(Boolean) Whether the agent ramdisk should stream raw images directly onto the disk or not. By streaming raw images directly onto the disk the agent ramdisk will not spend time copying the image to a tmpfs partition (therefore consuming less memory) prior to writing it to the disk. Unless the disk where the image will be copied to is really slow, this option should be set to True. Defaults to True.

[amt]

action_wait = 10

(Integer) Amount of time (in seconds) to wait, before retrying an AMT operation

awake_interval = 60

(Integer) Time interval (in seconds) for successive awake call to AMT interface, this depends on the IdleTimeout setting on AMT interface. AMT Interface will go to sleep after 60 seconds of inactivity by default. IdleTimeout=0 means AMT will not go to sleep at all. Setting awake_interval=0 will disable awake call.

max_attempts = 3

(Integer) Maximum number of times to attempt an AMT operation, before failing

protocol = http

(String) Protocol used for AMT endpoint

[api]

api_workers = None

(Integer) Number of workers for OpenStack Ironic API service. The default is equal to the number of CPUs available if that can be determined, else a default worker count of 1 is returned.

enable_ssl_api = False

(Boolean) Enable the integrated stand-alone API to service requests via HTTPS instead of HTTP. If there is a front-end service performing HTTPS offloading from the service, this option should be False; note, you will want to change public API endpoint to represent SSL termination URL with 'public_endpoint' option.

host_ip = 0.0.0.0

(String) The IP address on which ironic-api listens.

max_limit = 1000

(Integer) The maximum number of items returned in a single response from a collection resource.

port = 6385

(Port number) The TCP port on which ironic-api listens.

public_endpoint = None

(String) Public URL to use when building the links to the API resources (for example, "https://ironic.rocks:6384"). If None the links will be built using the request’s host URL. If the API is operating behind a proxy, you will want to change this to represent the proxy’s URL. Defaults to None.

ramdisk_heartbeat_timeout = 300

(Integer) Maximum interval (in seconds) for agent heartbeats.

restrict_lookup = True

(Boolean) Whether to restrict the lookup API to only nodes in certain states.

[oslo_middleware]

enable_proxy_headers_parsing = False

(Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.

max_request_body_size = 114688

(Integer) The maximum body size for each request, in bytes.

secure_proxy_ssl_header = X-Forwarded-Proto

(String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.

[oslo_versionedobjects]

fatal_exception_format_errors = False

(Boolean) Make exception message format errors fatal

[audit]

audit_map_file = /etc/ironic/api_audit_map.conf

(String) Path to audit map file for ironic-api service. Used only when API audit is enabled.

enabled = False

(Boolean) Enable auditing of API requests (for ironic-api service).

ignore_req_list =

(String) Comma separated list of Ironic REST API HTTP methods to be ignored during audit logging. For example: auditing will not be done on any GET or POST requests if this is set to "GET,POST". It is used only when API audit is enabled.

namespace = openstack

(String) namespace prefix for generated id

[audit_middleware_notifications]

driver = None

(String) The Driver to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop. If not specified, then value from oslo_messaging_notifications conf section is used.

topics = None

(List) List of AMQP topics used for OpenStack notifications. If not specified, then value from oslo_messaging_notifications conf section is used.

transport_url = None

(String) A URL representing messaging driver to use for notification. If not specified, we fall back to the same configuration used for RPC.

[cimc]

action_interval = 10

(Integer) Amount of time in seconds to wait in between power operations

max_retry = 6

(Integer) Number of times a power operation needs to be retried

[cisco_ucs]

action_interval = 5

(Integer) Amount of time in seconds to wait in between power operations

max_retry = 6

(Integer) Number of times a power operation needs to be retried

[DEFAULT]

bindir = /usr/local/bin

(String) Directory where ironic binaries are installed.

debug_tracebacks_in_api = False

(Boolean) Return server tracebacks in the API response for any error responses. WARNING: this is insecure and should not be used in a production environment.

default_boot_interface = None

(String) Default boot interface to be used for nodes that do not have boot_interface field set. A complete list of boot interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.boot" entrypoint.

default_console_interface = None

(String) Default console interface to be used for nodes that do not have console_interface field set. A complete list of console interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.console" entrypoint.

default_deploy_interface = None

(String) Default deploy interface to be used for nodes that do not have deploy_interface field set. A complete list of deploy interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.deploy" entrypoint.

default_inspect_interface = None

(String) Default inspect interface to be used for nodes that do not have inspect_interface field set. A complete list of inspect interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.inspect" entrypoint.

default_management_interface = None

(String) Default management interface to be used for nodes that do not have management_interface field set. A complete list of management interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.management" entrypoint.

default_network_interface = None

(String) Default network interface to be used for nodes that do not have network_interface field set. A complete list of network interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.network" entrypoint.

default_portgroup_mode = active-backup

(String) Default mode for portgroups. Allowed values can be found in the linux kernel documentation on bonding: https://www.kernel.org/doc/Documentation/networking/bonding.txt.

default_power_interface = None

(String) Default power interface to be used for nodes that do not have power_interface field set. A complete list of power interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.power" entrypoint.

default_raid_interface = None

(String) Default raid interface to be used for nodes that do not have raid_interface field set. A complete list of raid interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.raid" entrypoint.

default_vendor_interface = None

(String) Default vendor interface to be used for nodes that do not have vendor_interface field set. A complete list of vendor interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.vendor" entrypoint.

enabled_boot_interfaces = pxe

(List) Specify the list of boot interfaces to load during service initialization. Missing boot interfaces, or boot interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one boot interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented boot interfaces. A complete list of boot interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.boot" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled boot interfaces on every ironic-conductor service.

enabled_console_interfaces = no-console

(List) Specify the list of console interfaces to load during service initialization. Missing console interfaces, or console interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one console interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented console interfaces. A complete list of console interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.console" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled console interfaces on every ironic-conductor service.

enabled_deploy_interfaces = iscsi, direct

(List) Specify the list of deploy interfaces to load during service initialization. Missing deploy interfaces, or deploy interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one deploy interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented deploy interfaces. A complete list of deploy interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.deploy" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled deploy interfaces on every ironic-conductor service.

enabled_drivers = pxe_ipmitool

(List) Specify the list of drivers to load during service initialization. Missing drivers, or drivers which fail to initialize, will prevent the conductor service from starting. The option default is a recommended set of production-oriented drivers. A complete list of drivers present on your system may be found by enumerating the "ironic.drivers" entrypoint. An example may be found in the developer documentation online.

enabled_hardware_types = ipmi

(List) Specify the list of hardware types to load during service initialization. Missing hardware types, or hardware types which fail to initialize, will prevent the conductor service from starting. This option defaults to a recommended set of production-oriented hardware types. A complete list of hardware types present on your system may be found by enumerating the "ironic.hardware.types" entrypoint.

enabled_inspect_interfaces = no-inspect

(List) Specify the list of inspect interfaces to load during service initialization. Missing inspect interfaces, or inspect interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one inspect interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented inspect interfaces. A complete list of inspect interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.inspect" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled inspect interfaces on every ironic-conductor service.

enabled_management_interfaces = ipmitool

(List) Specify the list of management interfaces to load during service initialization. Missing management interfaces, or management interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one management interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented management interfaces. A complete list of management interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.management" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled management interfaces on every ironic-conductor service.

enabled_network_interfaces = flat, noop

(List) Specify the list of network interfaces to load during service initialization. Missing network interfaces, or network interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one network interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented network interfaces. A complete list of network interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.network" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled network interfaces on every ironic-conductor service.

enabled_power_interfaces = ipmitool

(List) Specify the list of power interfaces to load during service initialization. Missing power interfaces, or power interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one power interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented power interfaces. A complete list of power interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.power" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled power interfaces on every ironic-conductor service.

enabled_raid_interfaces = agent, no-raid

(List) Specify the list of raid interfaces to load during service initialization. Missing raid interfaces, or raid interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one raid interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented raid interfaces. A complete list of raid interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.raid" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled raid interfaces on every ironic-conductor service.

enabled_storage_interfaces = noop

(List) Specify the list of storage interfaces to load during service initialization. Missing storage interfaces, or storage interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one storage interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented storage interfaces. A complete list of storage interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.storage" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled storage interfaces on every ironic-conductor service.

enabled_vendor_interfaces = no-vendor

(List) Specify the list of vendor interfaces to load during service initialization. Missing vendor interfaces, or vendor interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one vendor interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented vendor interfaces. A complete list of vendor interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.vendor" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled vendor interfaces on every ironic-conductor service.

executor_thread_pool_size = 64

(Integer) Size of executor thread pool.

fatal_exception_format_errors = False

(Boolean) Used if there is a formatting error when generating an exception message (a programming error). If True, raise an exception; if False, use the unformatted message.

force_raw_images = True

(Boolean) If True, convert backing images to "raw" disk image format.

grub_config_template = $pybasedir/common/grub_conf.template

(String) Template file for grub configuration file.

hash_distribution_replicas = 1

(Integer) [Experimental Feature] Number of hosts to map onto each hash partition. Setting this to more than one will cause additional conductor services to prepare deployment environments and potentially allow the Ironic cluster to recover more quickly if a conductor instance is terminated.

hash_partition_exponent = 5

(Integer) Exponent to determine number of hash partitions to use when distributing load across conductors. Larger values will result in more even distribution of load and less load when rebalancing the ring, but more memory usage. Number of partitions per conductor is (2^hash_partition_exponent). This determines the granularity of rebalancing: given 10 hosts, and an exponent of the 2, there are 40 partitions in the ring.A few thousand partitions should make rebalancing smooth in most cases. The default is suitable for up to a few hundred conductors. Configuring for too many partitions has a negative impact on CPU usage.

hash_ring_reset_interval = 180

(Integer) Interval (in seconds) between hash ring resets.

host = localhost

(String) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address.

isolinux_bin = /usr/lib/syslinux/isolinux.bin

(String) Path to isolinux binary file.

isolinux_config_template = $pybasedir/common/isolinux_config.template

(String) Template file for isolinux configuration file.

my_ip = 127.0.0.1

(String) IP address of this host. If unset, will determine the IP programmatically. If unable to do so, will use "127.0.0.1".

notification_level = None

(String) Specifies the minimum level for which to send notifications. If not set, no notifications will be sent. The default is for this option to be unset.

parallel_image_downloads = False

(Boolean) Run image downloads and raw format conversions in parallel.

pybasedir = /usr/lib/python/site-packages/ironic/ironic

(String) Directory where the ironic python module is installed.

rootwrap_config = /etc/ironic/rootwrap.conf

(String) Path to the rootwrap configuration file to use for running commands as root.

state_path = $pybasedir

(String) Top-level directory for maintaining ironic’s state.

tempdir = /tmp

(String) Temporary working directory, default is Python temp dir.

[healthcheck]

backends =

(List) Additional backends that can perform health checks and report that information back as part of a request.

detailed = False

(Boolean) Show more detailed information as part of the response

disable_by_file_path = None

(String) Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin.

disable_by_file_paths =

(List) Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin.

path = /healthcheck

(String) DEPRECATED: The path to respond to healtcheck requests on.

[ironic_lib]

fatal_exception_format_errors = False

(Boolean) Make exception message format errors fatal.

root_helper = sudo ironic-rootwrap /etc/ironic/rootwrap.conf

(String) Command that is prefixed to commands that are run as root. If not specified, no commands are run as root.

[conductor]

api_url = None

(String) URL of Ironic API service. If not set ironic can get the current value from the keystone service catalog. If set, the value must start with either http:// or https://.

automated_clean = True

(Boolean) Enables or disables automated cleaning. Automated cleaning is a configurable set of steps, such as erasing disk drives, that are performed on the node to ensure it is in a baseline state and ready to be deployed to. This is done after instance deletion as well as during the transition from a "manageable" to "available" state. When enabled, the particular steps performed to clean a node depend on which driver that node is managed by; see the individual driver’s documentation for details. NOTE: The introduction of the cleaning operation causes instance deletion to take significantly longer. In an environment where all tenants are trusted (eg, because there is only one tenant), this option could be safely disabled.

check_provision_state_interval = 60

(Integer) Interval between checks of provision timeouts, in seconds.

clean_callback_timeout = 1800

(Integer) Timeout (seconds) to wait for a callback from the ramdisk doing the cleaning. If the timeout is reached the node will be put in the "clean failed" provision state. Set to 0 to disable timeout.

configdrive_swift_container = ironic_configdrive_container

(String) Name of the Swift container to store config drive data. Used when configdrive_use_swift is True.

configdrive_use_swift = False

(Boolean) Whether to upload the config drive to Swift.

deploy_callback_timeout = 1800

(Integer) Timeout (seconds) to wait for a callback from a deploy ramdisk. Set to 0 to disable timeout.

force_power_state_during_sync = True

(Boolean) During sync_power_state, should the hardware power state be set to the state recorded in the database (True) or should the database be updated based on the hardware state (False).

heartbeat_interval = 10

(Integer) Seconds between conductor heart beats.

heartbeat_timeout = 60

(Integer) Maximum time (in seconds) since the last check-in of a conductor. A conductor is considered inactive when this time has been exceeded.

inspect_timeout = 1800

(Integer) Timeout (seconds) for waiting for node inspection. 0 - unlimited.

node_locked_retry_attempts = 3

(Integer) Number of attempts to grab a node lock.

node_locked_retry_interval = 1

(Integer) Seconds to sleep between node lock attempts.

periodic_max_workers = 8

(Integer) Maximum number of worker threads that can be started simultaneously by a periodic task. Should be less than RPC thread pool size.

power_state_sync_max_retries = 3

(Integer) During sync_power_state failures, limit the number of times Ironic should try syncing the hardware node power state with the node power state in DB

send_sensor_data = False

(Boolean) Enable sending sensor data message via the notification bus

send_sensor_data_interval = 600

(Integer) Seconds between conductor sending sensor data message to ceilometer via the notification bus.

send_sensor_data_types = ALL

(List) List of comma separated meter types which need to be sent to Ceilometer. The default value, "ALL", is a special value meaning send all the sensor data.

send_sensor_data_wait_timeout = 300

(Integer) The time in seconds to wait for send sensors data periodic task to be finished before allowing periodic call to happen again. Should be less than send_sensor_data_interval value.

send_sensor_data_workers = 4

(Integer) The maximum number of workers that can be started simultaneously for send data from sensors periodic task.

soft_power_off_timeout = 600

(Integer) Timeout (in seconds) of soft reboot and soft power off operation. This value always has to be positive.

sync_local_state_interval = 180

(Integer) When conductors join or leave the cluster, existing conductors may need to update any persistent local state as nodes are moved around the cluster. This option controls how often, in seconds, each conductor will check for nodes that it should "take over". Set it to a negative value to disable the check entirely.

sync_power_state_interval = 60

(Integer) Interval between syncing the node power state to the database, in seconds.

workers_pool_size = 100

(Integer) The size of the workers greenthread pool. Note that 2 threads will be reserved by the conductor itself for handling heart beats and periodic tasks.

[console]

subprocess_checking_interval = 1

(Integer) Time interval (in seconds) for checking the status of console subprocess.

subprocess_timeout = 10

(Integer) Time (in seconds) to wait for the console subprocess to start.

terminal = shellinaboxd

(String) Path to serial console terminal program. Used only by Shell In A Box console.

terminal_cert_dir = None

(String) Directory containing the terminal SSL cert (PEM) for serial console access. Used only by Shell In A Box console.

terminal_pid_dir = None

(String) Directory for holding terminal pid files. If not specified, the temporary directory will be used.

[DEFAULT]

pecan_debug = False

(Boolean) Enable pecan debug mode. WARNING: this is insecure and should not be used in a production environment.

[deploy]

continue_if_disk_secure_erase_fails = False

(Boolean) Defines what to do if an ATA secure erase operation fails during cleaning in the Ironic Python Agent. If False, the cleaning operation will fail and the node will be put in clean failed state. If True, shred will be invoked and cleaning will continue.

default_boot_option = None

(String) Default boot option to use when no boot option is requested in node’s driver_info. Currently the default is "netboot", but it will be changed to "local" in the future. It is recommended to set an explicit value for this option.

erase_devices_metadata_priority = None

(Integer) Priority to run in-band clean step that erases metadata from devices, via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 99 for the GenericHardwareManager). If set to 0, will not run during cleaning.

erase_devices_priority = None

(Integer) Priority to run in-band erase devices via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 10 for the GenericHardwareManager). If set to 0, will not run during cleaning.

http_root = /httpboot

(String) ironic-conductor node’s HTTP root path.

http_url = None

(String) ironic-conductor node’s HTTP server URL. Example: http://192.1.2.3:8080

power_off_after_deploy_failure = True

(Boolean) Whether to power off a node after deploy failure. Defaults to True.

shred_final_overwrite_with_zeros = True

(Boolean) Whether to write zeros to a node’s block devices after writing random data. This will write zeros to the device even when deploy.shred_random_overwrite_iterations is 0. This option is only used if a device could not be ATA Secure Erased. Defaults to True.

shred_random_overwrite_iterations = 1

(Integer) During shred, overwrite all block devices N times with random data. This is only used if a device could not be ATA Secure Erased. Defaults to 1.

[dhcp]

dhcp_provider = neutron

(String) DHCP provider to use. "neutron" uses Neutron, and "none" uses a no-op provider.

[disk_partitioner]

check_device_interval = 1

(Integer) After Ironic has completed creating the partition table, it continues to check for activity on the attached iSCSI device status at this interval prior to copying the image to the node, in seconds

check_device_max_retries = 20

(Integer) The maximum number of times to check that the device is not accessed by another process. If the device is still busy after that, the disk partitioning will be treated as having failed.

[disk_utils]

bios_boot_partition_size = 1

(Integer) Size of BIOS Boot partition in MiB when configuring GPT partitioned systems for local boot in BIOS.

dd_block_size = 1M

(String) Block size to use when writing to the nodes disk.

efi_system_partition_size = 200

(Integer) Size of EFI system partition in MiB when configuring UEFI systems for local boot.

iscsi_verify_attempts = 3

(Integer) Maximum attempts to verify an iSCSI connection is active, sleeping 1 second between attempts.

[drac]

query_raid_config_job_status_interval = 120

(Integer) Interval (in seconds) between periodic RAID job status checks to determine whether the asynchronous RAID configuration was successfully finished or not.

[glance]

allowed_direct_url_schemes =

(List) A list of URL schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file].

auth_section = None

(Unknown) Config Section from which to load plugin specific options

auth_strategy = keystone

(String) Authentication strategy to use when connecting to glance.

auth_type = None

(Unknown) Authentication type to load

cafile = None

(String) PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile = None

(String) PEM encoded client certificate cert file

glance_api_insecure = False

(Boolean) Allow to perform insecure SSL (https) requests to glance.

glance_api_servers = None

(List) A list of the glance api servers available to ironic. Prefix with https:// for SSL-based glance API servers. Format is [hostname|IP]:port.

glance_api_version = 2

(Integer) Glance API version to use. Only version 2 is supported.

glance_cafile = None

(String) Optional path to a CA certificate bundle to be used to validate the SSL certificate served by glance. It is used when glance_api_insecure is set to False.

glance_host = $my_ip

(String) Default glance hostname or IP address.

glance_num_retries = 0

(Integer) Number of retries when downloading an image from glance.

glance_port = 9292

(Port number) Default glance port.

glance_protocol = http

(String) Default protocol to use when connecting to glance. Set to https for SSL.

insecure = False

(Boolean) Verify HTTPS connections.

keyfile = None

(String) PEM encoded client certificate key file

swift_account = None

(String) The account that Glance uses to communicate with Swift. The format is "AUTH_uuid". "uuid" is the UUID for the account configured in the glance-api.conf. Required for temporary URLs when Glance backend is Swift. For example: "AUTH_a422b2-91f3-2f46-74b7-d7c9e8958f5d30". Swift temporary URL format: "endpoint_url/api_version/[account/]container/object_id"

swift_api_version = v1

(String) The Swift API version to create a temporary URL for. Defaults to "v1". Swift temporary URL format: "endpoint_url/api_version/[account/]container/object_id"

swift_container = glance

(String) The Swift container Glance is configured to store its images in. Defaults to "glance", which is the default in glance-api.conf. Swift temporary URL format: "endpoint_url/api_version/[account/]container/object_id"

swift_endpoint_url = None

(String) The "endpoint" (scheme, hostname, optional port) for the Swift URL of the form "endpoint_url/api_version/[account/]container/object_id". Do not include trailing "/". For example, use "https://swift.example.com". If using RADOS Gateway, endpoint may also contain /swift path; if it does not, it will be appended. Required for temporary URLs.

swift_store_multiple_containers_seed = 0

(Integer) This should match a config by the same name in the Glance configuration file. When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a single-tenant store will use multiple containers to store images, and this value will determine how many containers are created.

swift_temp_url_cache_enabled = False

(Boolean) Whether to cache generated Swift temporary URLs. Setting it to true is only useful when an image caching proxy is used. Defaults to False.

swift_temp_url_duration = 1200

(Integer) The length of time in seconds that the temporary URL will be valid for. Defaults to 20 minutes. If some deploys get a 401 response code when trying to download from the temporary URL, try raising this duration. This value must be greater than or equal to the value for swift_temp_url_expected_download_start_delay

swift_temp_url_expected_download_start_delay = 0

(Integer) This is the delay (in seconds) from the time of the deploy request (when the Swift temporary URL is generated) to when the IPA ramdisk starts up and URL is used for the image download. This value is used to check if the Swift temporary URL duration is large enough to let the image download begin. Also if temporary URL caching is enabled this will determine if a cached entry will still be valid when the download starts. swift_temp_url_duration value must be greater than or equal to this option’s value. Defaults to 0.

swift_temp_url_key = None

(String) The secret token given to Swift to allow temporary URL downloads. Required for temporary URLs.

temp_url_endpoint_type = swift

(String) Type of endpoint to use for temporary URLs. If the Glance backend is Swift, use "swift"; if it is CEPH with RADOS gateway, use "radosgw".

timeout = None

(Integer) Timeout value for http requests

[iboot]

max_retry = 3

(Integer) Maximum retries for iBoot operations

reboot_delay = 5

(Integer) Time (in seconds) to sleep between when rebooting (powering off and on again).

retry_interval = 1

(Integer) Time (in seconds) between retry attempts for iBoot operations

[ilo]

ca_file = None

(String) CA certificate file to validate iLO.

clean_priority_clear_secure_boot_keys = 0

(Integer) Priority for clear_secure_boot_keys clean step. This step is not enabled by default. It can be enabled to clear all secure boot keys enrolled with iLO.

clean_priority_erase_devices = None

(Integer) DEPRECATED: Priority for erase devices clean step. If unset, it defaults to 10. If set to 0, the step will be disabled and will not run during cleaning. This configuration option is duplicated by [deploy] erase_devices_priority, please use that instead.

clean_priority_reset_bios_to_default = 10

(Integer) Priority for reset_bios_to_default clean step.

clean_priority_reset_ilo = 0

(Integer) Priority for reset_ilo clean step.

clean_priority_reset_ilo_credential = 30

(Integer) Priority for reset_ilo_credential clean step. This step requires "ilo_change_password" parameter to be updated in nodes’s driver_info with the new password.

clean_priority_reset_secure_boot_keys_to_default = 20

(Integer) Priority for reset_secure_boot_keys clean step. This step will reset the secure boot keys to manufacturing defaults.

client_port = 443

(Port number) Port to be used for iLO operations

client_timeout = 60

(Integer) Timeout (in seconds) for iLO operations

default_boot_mode = auto

(String) Default boot mode to be used in provisioning when "boot_mode" capability is not provided in the "properties/capabilities" of the node. The default is "auto" for backward compatibility. When "auto" is specified, default boot mode will be selected based on boot mode settings on the system.

power_retry = 6

(Integer) Number of times a power operation needs to be retried

power_wait = 2

(Integer) Amount of time in seconds to wait in between power operations

swift_ilo_container = ironic_ilo_container

(String) The Swift iLO container to store data.

swift_object_expiry_timeout = 900

(Integer) Amount of time in seconds for Swift objects to auto-expire.

use_web_server_for_images = False

(Boolean) Set this to True to use http web server to host floppy images and generated boot ISO. This requires http_root and http_url to be configured in the [deploy] section of the config file. If this is set to False, then Ironic will use Swift to host the floppy images and generated boot_iso.

[inspector]

auth_section = None

(Unknown) Config Section from which to load plugin specific options

auth_type = None

(Unknown) Authentication type to load

cafile = None

(String) PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile = None

(String) PEM encoded client certificate cert file

enabled = False

(Boolean) whether to enable inspection using ironic-inspector. This option does not affect new-style dynamic drivers and the fake_inspector driver.

insecure = False

(Boolean) Verify HTTPS connections.

keyfile = None

(String) PEM encoded client certificate key file

service_url = None

(String) ironic-inspector HTTP endpoint. If this is not set, the service catalog will be used.

status_check_period = 60

(Integer) period (in seconds) to check status of nodes on inspection

timeout = None

(Integer) Timeout value for http requests

[ipmi]

min_command_interval = 5

(Integer) Minimum time, in seconds, between IPMI operations sent to a server. There is a risk with some hardware that setting this too low may cause the BMC to crash. Recommended setting is 5 seconds.

retry_timeout = 60

(Integer) Maximum time in seconds to retry IPMI operations. There is a tradeoff when setting this value. Setting this too low may cause older BMCs to crash and require a hard reset. However, setting too high can cause the sync power state periodic task to hang when there are slow or unresponsive BMCs.

[irmc]

auth_method = basic

(String) Authentication method to be used for iRMC operations

client_timeout = 60

(Integer) Timeout (in seconds) for iRMC operations

port = 443

(Port number) Port to be used for iRMC operations

remote_image_server = None

(String) IP of remote image server

remote_image_share_name = share

(String) share name of remote_image_server

remote_image_share_root = /remote_image_share_root

(String) Ironic conductor node’s "NFS" or "CIFS" root path

remote_image_share_type = CIFS

(String) Share type of virtual media

remote_image_user_domain =

(String) Domain name of remote_image_user_name

remote_image_user_name = None

(String) User name of remote_image_server

remote_image_user_password = None

(String) Password of remote_image_user_name

sensor_method = ipmitool

(String) Sensor data retrieval method.

snmp_community = public

(String) SNMP community. Required for versions "v1" and "v2c"

snmp_polling_interval = 10

(Integer) SNMP polling interval in seconds

snmp_port = 161

(Port number) SNMP port

snmp_security = None

(String) SNMP security name. Required for version "v3"

snmp_version = v2c

(String) SNMP protocol version

[iscsi]

portal_port = 3260

(Port number) The port number on which the iSCSI portal listens for incoming connections.

[keystone]

region_name = None

(String) The region used for getting endpoints of OpenStack services.

[metrics]

agent_backend = noop

(String) Backend for the agent ramdisk to use for metrics. Default possible backends are "noop" and "statsd".

agent_global_prefix = None

(String) Prefix all metric names sent by the agent ramdisk with this value. The format of metric names is [global_prefix.][uuid.][host_name.]prefix.metric_name.

agent_prepend_host = False

(Boolean) Prepend the hostname to all metric names sent by the agent ramdisk. The format of metric names is [global_prefix.][uuid.][host_name.]prefix.metric_name.

agent_prepend_host_reverse = True

(Boolean) Split the prepended host value by "." and reverse it for metrics sent by the agent ramdisk (to better match the reverse hierarchical form of domain names).

agent_prepend_uuid = False

(Boolean) Prepend the node’s Ironic uuid to all metric names sent by the agent ramdisk. The format of metric names is [global_prefix.][uuid.][host_name.]prefix.metric_name.

backend = noop

(String) Backend to use for the metrics system.

global_prefix = None

(String) Prefix all metric names with this value. By default, there is no global prefix. The format of metric names is [global_prefix.][host_name.]prefix.metric_name.

prepend_host = False

(Boolean) Prepend the hostname to all metric names. The format of metric names is [global_prefix.][host_name.]prefix.metric_name.

prepend_host_reverse = True

(Boolean) Split the prepended host value by "." and reverse it (to better match the reverse hierarchical form of domain names).

[metrics_statsd]

agent_statsd_host = localhost

(String) Host for the agent ramdisk to use with the statsd backend. This must be accessible from networks the agent is booted on.

agent_statsd_port = 8125

(Port number) Port for the agent ramdisk to use with the statsd backend.

statsd_host = localhost

(String) Host for use with the statsd backend.

statsd_port = 8125

(Port number) Port to use with the statsd backend.

[neutron]

auth_section = None

(Unknown) Config Section from which to load plugin specific options

auth_strategy = keystone

(String) Authentication strategy to use when connecting to neutron. Running neutron in noauth mode (related to but not affected by this setting) is insecure and should only be used for testing.

auth_type = None

(Unknown) Authentication type to load

cafile = None

(String) PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile = None

(String) PEM encoded client certificate cert file

cleaning_network = None

(String) Neutron network UUID or name for the ramdisk to be booted into for cleaning nodes. Required for "neutron" network interface. It is also required if cleaning nodes when using "flat" network interface or "neutron" DHCP provider. If a name is provided, it must be unique among all networks or cleaning will fail.

cleaning_network_security_groups =

(List) List of Neutron Security Group UUIDs to be applied during cleaning of the nodes. Optional for the "neutron" network interface and not used for the "flat" or "noop" network interfaces. If not specified, default security group is used.

insecure = False

(Boolean) Verify HTTPS connections.

keyfile = None

(String) PEM encoded client certificate key file

port_setup_delay = 0

(Integer) Delay value to wait for Neutron agents to setup sufficient DHCP configuration for port.

provisioning_network = None

(String) Neutron network UUID or name for the ramdisk to be booted into for provisioning nodes. Required for "neutron" network interface. If a name is provided, it must be unique among all networks or deploy will fail.

provisioning_network_security_groups =

(List) List of Neutron Security Group UUIDs to be applied during provisioning of the nodes. Optional for the "neutron" network interface and not used for the "flat" or "noop" network interfaces. If not specified, default security group is used.

retries = 3

(Integer) Client retries in the case of a failed request.

timeout = None

(Integer) Timeout value for http requests

url = None

(String) URL for connecting to neutron. Default value translates to 'http://$my_ip:9696' when auth_strategy is 'noauth', and to discovery from Keystone catalog when auth_strategy is 'keystone'.

url_timeout = 30

(Integer) Timeout value for connecting to neutron in seconds.

[oneview]

allow_insecure_connections = False

(Boolean) Option to allow insecure connection with OneView.

enable_periodic_tasks = True

(Boolean) Whether to enable the periodic tasks for OneView driver be aware when OneView hardware resources are taken and released by Ironic or OneView users and proactively manage nodes in clean fail state according to Dynamic Allocation model of hardware resources allocation in OneView.

manager_url = None

(String) URL where OneView is available.

max_polling_attempts = 12

(Integer) Max connection retries to check changes on OneView.

password = None

(String) OneView password to be used.

periodic_check_interval = 300

(Integer) Period (in seconds) for periodic tasks to be executed when enable_periodic_tasks=True.

tls_cacert_file = None

(String) Path to CA certificate.

username = None

(String) OneView username to be used.

[pxe]

default_ephemeral_format = ext4

(String) Default file system format for ephemeral partition, if one is created.

image_cache_size = 20480

(Integer) Maximum size (in MiB) of cache for master images, including those in use.

image_cache_ttl = 10080

(Integer) Maximum TTL (in minutes) for old master images in cache.

images_path = /var/lib/ironic/images/

(String) On the ironic-conductor node, directory where images are stored on disk.

instance_master_path = /var/lib/ironic/master_images

(String) On the ironic-conductor node, directory where master instance images are stored on disk. Setting to <None> disables image caching.

ip_version = 4

(String) The IP version that will be used for PXE booting. Defaults to 4. EXPERIMENTAL

ipxe_boot_script = $pybasedir/drivers/modules/boot.ipxe

(String) On ironic-conductor node, the path to the main iPXE script file.

ipxe_enabled = False

(Boolean) Enable iPXE boot.

ipxe_timeout = 0

(Integer) Timeout value (in seconds) for downloading an image via iPXE. Defaults to 0 (no timeout)

ipxe_use_swift = False

(Boolean) Download deploy images directly from swift using temporary URLs. If set to false (default), images are downloaded to the ironic-conductor node and served over its local HTTP server. Applicable only when 'ipxe_enabled' option is set to true.

pxe_append_params = nofb nomodeset vga=normal

(String) Additional append parameters for baremetal PXE boot.

pxe_bootfile_name = pxelinux.0

(String) Bootfile DHCP parameter.

pxe_bootfile_name_by_arch = {}

(Dict) Bootfile DHCP parameter per node architecture. For example: aarch64:grubaa64.efi

pxe_config_template = $pybasedir/drivers/modules/pxe_config.template

(String) On ironic-conductor node, template file for PXE configuration.

pxe_config_template_by_arch = {}

(Dict) On ironic-conductor node, template file for PXE configuration per node architecture. For example: aarch64:/opt/share/grubaa64_pxe_config.template

tftp_master_path = /tftpboot/master_images

(String) On ironic-conductor node, directory where master TFTP images are stored on disk. Setting to <None> disables image caching.

tftp_root = /tftpboot

(String) ironic-conductor node’s TFTP root path. The ironic-conductor must have read/write access to this path.

tftp_server = $my_ip

(String) IP address of ironic-conductor node’s TFTP server.

uefi_pxe_bootfile_name = bootx64.efi

(String) Bootfile DHCP parameter for UEFI boot mode.

uefi_pxe_config_template = $pybasedir/drivers/modules/pxe_grub_config.template

(String) On ironic-conductor node, template file for PXE configuration for UEFI boot loader.

[matchmaker_redis]

check_timeout = 20000

(Integer) Time in ms to wait before the transaction is killed.

host = 127.0.0.1

(String) DEPRECATED: Host to locate redis. Replaced by [DEFAULT]/transport_url

password =

(String) DEPRECATED: Password for Redis server (optional). Replaced by [DEFAULT]/transport_url

port = 6379

(Port number) DEPRECATED: Use this port to connect to redis host. Replaced by [DEFAULT]/transport_url

sentinel_group_name = oslo-messaging-zeromq

(String) Redis replica set name.

sentinel_hosts =

(List) DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode), e.g., [host:port, host1:port …​ ] Replaced by [DEFAULT]/transport_url

socket_timeout = 10000

(Integer) Timeout in ms on blocking socket operations.

wait_timeout = 2000

(Integer) Time in ms to wait between connection attempts.

[seamicro]

action_timeout = 10

(Integer) Seconds to wait for power action to be completed

max_retry = 3

(Integer) Maximum retries for SeaMicro operations

[service_catalog]

auth_section = None

(Unknown) Config Section from which to load plugin specific options

auth_type = None

(Unknown) Authentication type to load

cafile = None

(String) PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile = None

(String) PEM encoded client certificate cert file

insecure = False

(Boolean) Verify HTTPS connections.

keyfile = None

(String) PEM encoded client certificate key file

timeout = None

(Integer) Timeout value for http requests

[snmp]

power_timeout = 10

(Integer) Seconds to wait for power action to be completed

reboot_delay = 0

(Integer) Time (in seconds) to sleep between when rebooting (powering off and on again)

[ssh]

get_vm_name_attempts = 3

(Integer) Number of attempts to try to get VM name used by the host that corresponds to a node’s MAC address.

get_vm_name_retry_interval = 3

(Integer) Number of seconds to wait between attempts to get VM name used by the host that corresponds to a node’s MAC address.

libvirt_uri = qemu:///system

(String) libvirt URI.

[swift]

auth_section = None

(Unknown) Config Section from which to load plugin specific options

auth_type = None

(Unknown) Authentication type to load

cafile = None

(String) PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile = None

(String) PEM encoded client certificate cert file

insecure = False

(Boolean) Verify HTTPS connections.

keyfile = None

(String) PEM encoded client certificate key file

swift_max_retries = 2

(Integer) Maximum number of times to retry a Swift request, before failing.

timeout = None

(Integer) Timeout value for http requests

[virtualbox]

port = 18083

(Port number) Port on which VirtualBox web service is listening.

[DEFAULT] default_boot_interface = None

(StrOpt) Default boot interface to be used for nodes that do not have boot_interface field set. A complete list of boot interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.boot" entrypoint.

[DEFAULT] default_console_interface = None

(StrOpt) Default console interface to be used for nodes that do not have console_interface field set. A complete list of console interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.console" entrypoint.

[DEFAULT] default_deploy_interface = None

(StrOpt) Default deploy interface to be used for nodes that do not have deploy_interface field set. A complete list of deploy interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.deploy" entrypoint.

[DEFAULT] default_inspect_interface = None

(StrOpt) Default inspect interface to be used for nodes that do not have inspect_interface field set. A complete list of inspect interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.inspect" entrypoint.

[DEFAULT] default_management_interface = None

(StrOpt) Default management interface to be used for nodes that do not have management_interface field set. A complete list of management interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.management" entrypoint.

[DEFAULT] default_portgroup_mode = active-backup

(StrOpt) Default mode for portgroups. Allowed values can be found in the linux kernel documentation on bonding: https://www.kernel.org/doc/Documentation/networking/bonding.txt.

[DEFAULT] default_power_interface = None

(StrOpt) Default power interface to be used for nodes that do not have power_interface field set. A complete list of power interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.power" entrypoint.

[DEFAULT] default_raid_interface = None

(StrOpt) Default raid interface to be used for nodes that do not have raid_interface field set. A complete list of raid interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.raid" entrypoint.

[DEFAULT] default_vendor_interface = None

(StrOpt) Default vendor interface to be used for nodes that do not have vendor_interface field set. A complete list of vendor interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.vendor" entrypoint.

[DEFAULT] enabled_boot_interfaces = pxe

(ListOpt) Specify the list of boot interfaces to load during service initialization. Missing boot interfaces, or boot interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one boot interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented boot interfaces. A complete list of boot interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.boot" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled boot interfaces on every ironic-conductor service.

[DEFAULT] enabled_console_interfaces = no-console

(ListOpt) Specify the list of console interfaces to load during service initialization. Missing console interfaces, or console interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one console interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented console interfaces. A complete list of console interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.console" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled console interfaces on every ironic-conductor service.

[DEFAULT] enabled_deploy_interfaces = iscsi, direct

(ListOpt) Specify the list of deploy interfaces to load during service initialization. Missing deploy interfaces, or deploy interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one deploy interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented deploy interfaces. A complete list of deploy interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.deploy" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled deploy interfaces on every ironic-conductor service.

[DEFAULT] enabled_hardware_types = ipmi

(ListOpt) Specify the list of hardware types to load during service initialization. Missing hardware types, or hardware types which fail to initialize, will prevent the conductor service from starting. This option defaults to a recommended set of production-oriented hardware types. A complete list of hardware types present on your system may be found by enumerating the "ironic.hardware.types" entrypoint.

[DEFAULT] enabled_inspect_interfaces = no-inspect

(ListOpt) Specify the list of inspect interfaces to load during service initialization. Missing inspect interfaces, or inspect interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one inspect interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented inspect interfaces. A complete list of inspect interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.inspect" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled inspect interfaces on every ironic-conductor service.

[DEFAULT] enabled_management_interfaces = ipmitool

(ListOpt) Specify the list of management interfaces to load during service initialization. Missing management interfaces, or management interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one management interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented management interfaces. A complete list of management interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.management" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled management interfaces on every ironic-conductor service.

[DEFAULT] enabled_power_interfaces = ipmitool

(ListOpt) Specify the list of power interfaces to load during service initialization. Missing power interfaces, or power interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one power interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented power interfaces. A complete list of power interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.power" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled power interfaces on every ironic-conductor service.

[DEFAULT] enabled_raid_interfaces = agent, no-raid

(ListOpt) Specify the list of raid interfaces to load during service initialization. Missing raid interfaces, or raid interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one raid interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented raid interfaces. A complete list of raid interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.raid" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled raid interfaces on every ironic-conductor service.

[DEFAULT] enabled_storage_interfaces = noop

(ListOpt) Specify the list of storage interfaces to load during service initialization. Missing storage interfaces, or storage interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one storage interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented storage interfaces. A complete list of storage interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.storage" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled storage interfaces on every ironic-conductor service.

[DEFAULT] enabled_vendor_interfaces = no-vendor

(ListOpt) Specify the list of vendor interfaces to load during service initialization. Missing vendor interfaces, or vendor interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one vendor interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented vendor interfaces. A complete list of vendor interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.vendor" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled vendor interfaces on every ironic-conductor service.

[conductor] send_sensor_data_wait_timeout = 300

(IntOpt) The time in seconds to wait for send sensors data periodic task to be finished before allowing periodic call to happen again. Should be less than send_sensor_data_interval value.

[conductor] send_sensor_data_workers = 4

(IntOpt) The maximum number of workers that can be started simultaneously for send data from sensors periodic task.

[conductor] soft_power_off_timeout = 600

(IntOpt) Timeout (in seconds) of soft reboot and soft power off operation. This value always has to be positive.

[deploy] default_boot_option = None

(StrOpt) Default boot option to use when no boot option is requested in node’s driver_info. Currently the default is "netboot", but it will be changed to "local" in the future. It is recommended to set an explicit value for this option.

[glance] glance_api_version = 2

(IntOpt) Glance API version to use. Only version 2 is supported.

[irmc] snmp_polling_interval = 10

(IntOpt) SNMP polling interval in seconds

[neutron] cleaning_network = None

(StrOpt) Neutron network UUID or name for the ramdisk to be booted into for cleaning nodes. Required for "neutron" network interface. It is also required if cleaning nodes when using "flat" network interface or "neutron" DHCP provider. If a name is provided, it must be unique among all networks or cleaning will fail.

[neutron] cleaning_network_security_groups =

(ListOpt) List of Neutron Security Group UUIDs to be applied during cleaning of the nodes. Optional for the "neutron" network interface and not used for the "flat" or "noop" network interfaces. If not specified, default security group is used.

[neutron] provisioning_network = None

(StrOpt) Neutron network UUID or name for the ramdisk to be booted into for provisioning nodes. Required for "neutron" network interface. If a name is provided, it must be unique among all networks or deploy will fail.

[neutron] provisioning_network_security_groups =

(ListOpt) List of Neutron Security Group UUIDs to be applied during provisioning of the nodes. Optional for the "neutron" network interface and not used for the "flat" or "noop" network interfaces. If not specified, default security group is used.

[pxe] pxe_bootfile_name_by_arch = {}

(DictOpt) Bootfile DHCP parameter per node architecture. For example: aarch64:grubaa64.efi

[pxe] pxe_config_template_by_arch = {}

(DictOpt) On ironic-conductor node, template file for PXE configuration per node architecture. For example: aarch64:/opt/share/grubaa64_pxe_config.template

[audit] audit_map_file

/etc/ironic/ironic_api_audit_map.conf

/etc/ironic/api_audit_map.conf

[audit] ignore_req_list

None

[DEFAULT] rpc_thread_pool_size

[DEFAULT] executor_thread_pool_size

[DEFAULT] use_syslog

None

[keystone_authtoken] cafile

[glance] cafile

[keystone_authtoken] cafile

[swift] cafile

[keystone_authtoken] cafile

[neutron] cafile

[keystone_authtoken] cafile

[service_catalog] cafile

[keystone_authtoken] cafile

[inspector] cafile

[keystone_authtoken] certfile

[service_catalog] certfile

[keystone_authtoken] certfile

[neutron] certfile

[keystone_authtoken] certfile

[glance] certfile

[keystone_authtoken] certfile

[inspector] certfile

[keystone_authtoken] certfile

[swift] certfile

[keystone_authtoken] insecure

[glance] insecure

[keystone_authtoken] insecure

[inspector] insecure

[keystone_authtoken] insecure

[swift] insecure

[keystone_authtoken] insecure

[service_catalog] insecure

[keystone_authtoken] insecure

[neutron] insecure

[keystone_authtoken] keyfile

[inspector] keyfile

[keystone_authtoken] keyfile

[swift] keyfile

[keystone_authtoken] keyfile

[neutron] keyfile

[keystone_authtoken] keyfile

[glance] keyfile

[keystone_authtoken] keyfile

[service_catalog] keyfile

[neutron] cleaning_network_uuid

[neutron] cleaning_network

[neutron] provisioning_network_uuid

[neutron] provisioning_network

[DEFAULT]

api_rate_limit = True

(Boolean) Enables or disables rate limit of the API.

az_cache_duration = 3600

(Integer) Cache volume availability zones in memory for the provided duration in seconds

backend_host = None

(String) Backend override of host value.

default_timeout = 31536000

(Integer) Default timeout for CLI operations in minutes. For example, LUN migration is a typical long running operation, which depends on the LUN size and the load of the array. An upper bound in the specific deployment can be set to avoid unnecessary long wait. By default, it is 365 days long.

enable_v1_api = False

(Boolean) DEPRECATED: Deploy v1 of the Cinder API.

enable_v2_api = True

(Boolean) DEPRECATED: Deploy v2 of the Cinder API.

enable_v3_api = True

(Boolean) Deploy v3 of the Cinder API.

extra_capabilities = {}

(String) User defined capabilities, a JSON formatted string specifying key/value pairs. The key/value pairs can be used by the CapabilitiesFilter to select between backends when requests specify volume types. For example, specifying a service level or the geographical location of a backend, then creating a volume type to allow the user to select by these different properties.

ignore_pool_full_threshold = False

(Boolean) Force LUN creation even if the full threshold of pool is reached. By default, the value is False.

management_ips =

(String) List of Management IP addresses (separated by commas)

message_ttl = 2592000

(Integer) message minimum life in seconds.

osapi_max_limit = 1000

(Integer) The maximum number of items that a collection resource returns in a single response

osapi_volume_base_URL = None

(String) Base URL that will be presented to users in links to the OpenStack Volume API

osapi_volume_ext_list =

(List) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions

osapi_volume_extension = ['cinder.api.contrib.standard_extensions']

(Multi-valued) osapi volume extension to load

osapi_volume_listen = 0.0.0.0

(String) IP address on which OpenStack Volume API listens

osapi_volume_listen_port = 8776

(Port number) Port on which OpenStack Volume API listens

osapi_volume_use_ssl = False

(Boolean) Wraps the socket in a SSL context if True is set. A certificate file and key file must be specified.

osapi_volume_workers = None

(Integer) Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available.

per_volume_size_limit = -1

(Integer) Max size allowed per volume, in gigabytes

public_endpoint = None

(String) Public url to use for versions endpoint. The default is None, which will use the request’s host_url attribute to populate the URL base. If Cinder is operating behind a proxy, you will want to change this to represent the proxy’s URL.

query_volume_filters = name, status, metadata, availability_zone, bootable, group_id

(List) Volume filter options which non-admin user could use to query volumes. Default values are: ['name', 'status', 'metadata', 'availability_zone' ,'bootable', 'group_id']

transfer_api_class = cinder.transfer.api.API

(String) The full class name of the volume transfer API class

volume_api_class = cinder.volume.api.API

(String) The full class name of the volume API class to use

volume_name_prefix = openstack-

(String) Prefix before volume name to differentiate DISCO volume created through openstack and the other ones

volume_name_template = volume-%s

(String) Template string to be used to generate volume names

volume_number_multiplier = -1.0

(Floating point) Multiplier used for weighing volume number. Negative numbers mean to spread vs stack.

volume_transfer_key_length = 16

(Integer) The number of characters in the autogenerated auth key.

volume_transfer_salt_length = 8

(Integer) The number of characters in the salt.

[oslo_middleware]

enable_proxy_headers_parsing = False

(Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.

max_request_body_size = 114688

(Integer) The maximum body size for each request, in bytes.

secure_proxy_ssl_header = X-Forwarded-Proto

(String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.

[oslo_versionedobjects]

fatal_exception_format_errors = False

(Boolean) Make exception message format errors fatal

[DEFAULT]

auth_strategy = keystone

(String) The strategy to use for auth. Supports noauth or keystone.

[DEFAULT]

backup_ceph_chunk_size = 134217728

(Integer) The chunk size, in bytes, that a backup is broken into before transfer to the Ceph object store.

backup_ceph_conf = /etc/ceph/ceph.conf

(String) Ceph configuration file to use.

backup_ceph_pool = backups

(String) The Ceph pool where volume backups are stored.

backup_ceph_stripe_count = 0

(Integer) RBD stripe count to use when creating a backup image.

backup_ceph_stripe_unit = 0

(Integer) RBD stripe unit to use when creating a backup image.

backup_ceph_user = cinder

(String) The Ceph user to connect with. Default here is to use the same user as for Cinder volumes. If not using cephx this should be set to None.

restore_discard_excess_bytes = True

(Boolean) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes.

[DEFAULT]

backup_gcs_block_size = 32768

(Integer) The size in bytes that changes are tracked for incremental backups. backup_gcs_object_size has to be multiple of backup_gcs_block_size.

backup_gcs_bucket = None

(String) The GCS bucket to use.

backup_gcs_bucket_location = US

(String) Location of GCS bucket.

backup_gcs_credential_file = None

(String) Absolute path of GCS service account credential file.

backup_gcs_enable_progress_timer = True

(Boolean) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the GCS backend storage. The default value is True to enable the timer.

backup_gcs_num_retries = 3

(Integer) Number of times to retry.

backup_gcs_object_size = 52428800

(Integer) The size in bytes of GCS backup objects.

backup_gcs_project_id = None

(String) Owner project id for GCS bucket.

backup_gcs_proxy_url = None

(URI) URL for http proxy access.

backup_gcs_reader_chunk_size = 2097152

(Integer) GCS object will be downloaded in chunks of bytes.

backup_gcs_retry_error_codes = 429

(List) List of GCS error codes.

backup_gcs_storage_class = NEARLINE

(String) Storage class of GCS bucket.

backup_gcs_user_agent = gcscinder

(String) Http user-agent string for gcs api.

backup_gcs_writer_chunk_size = 2097152

(Integer) GCS object will be uploaded in chunks of bytes. Pass in a value of -1 if the file is to be uploaded as a single chunk.

[DEFAULT]

backup_container = None

(String) Custom directory to use for backups.

backup_enable_progress_timer = True

(Boolean) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the backend storage. The default value is True to enable the timer.

backup_file_size = 1999994880

(Integer) The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files.backup_file_size must be a multiple of backup_sha_block_size_bytes.

backup_mount_options = None

(String) Mount options passed to the NFS client. See NFS man page for details.

backup_mount_point_base = $state_path/backup_mount

(String) Base dir containing mount point for NFS share.

backup_sha_block_size_bytes = 32768

(Integer) The size in bytes that changes are tracked for incremental backups. backup_file_size has to be multiple of backup_sha_block_size_bytes.

backup_share = None

(String) NFS share in hostname:path, ipv4addr:path, or "[ipv6addr]:path" format.

[DEFAULT]

backup_container = None

(String) Custom directory to use for backups.

backup_enable_progress_timer = True

(Boolean) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the backend storage. The default value is True to enable the timer.

backup_file_size = 1999994880

(Integer) The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files.backup_file_size must be a multiple of backup_sha_block_size_bytes.

backup_posix_path = $state_path/backup

(String) Path specifying where to store backups.

backup_sha_block_size_bytes = 32768

(Integer) The size in bytes that changes are tracked for incremental backups. backup_file_size has to be multiple of backup_sha_block_size_bytes.

[DEFAULT]

backup_api_class = cinder.backup.api.API

(String) The full class name of the volume backup API class

backup_compression_algorithm = zlib

(String) Compression algorithm (None to disable)

backup_driver = cinder.backup.drivers.swift

(String) Driver to use for backups.

backup_manager = cinder.backup.manager.BackupManager

(String) Full class name for the Manager for volume backup

backup_metadata_version = 2

(Integer) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version.

backup_name_template = backup-%s

(String) Template string to be used to generate backup names

backup_object_number_per_notification = 10

(Integer) The number of chunks or objects, for which one Ceilometer notification will be sent

backup_service_inithost_offload = True

(Boolean) Offload pending backup delete during backup service startup. If false, the backup service will remain down until all pending backups are deleted.

backup_timer_interval = 120

(Integer) Interval, in seconds, between two progress notifications reporting the backup status

backup_use_same_host = False

(Boolean) Backup services use same backend.

backup_use_temp_snapshot = False

(Boolean) If this is set to True, the backup_use_temp_snapshot path will be used during the backup. Otherwise, it will use backup_use_temp_volume path.

snapshot_check_timeout = 3600

(Integer) How long we check whether a snapshot is finished before we give up

snapshot_name_template = snapshot-%s

(String) Template string to be used to generate snapshot names

snapshot_same_host = True

(Boolean) Create volume from snapshot at the host where snapshot resides

[DEFAULT]

backup_swift_auth = per_user

(String) Swift authentication mechanism

backup_swift_auth_version = 1

(String) Swift authentication version. Specify "1" for auth 1.0, or "2" for auth 2.0 or "3" for auth 3.0

backup_swift_block_size = 32768

(Integer) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size.

backup_swift_ca_cert_file = None

(String) Location of the CA certificate file to use for swift client requests.

backup_swift_container = volumebackups

(String) The default Swift container to use

backup_swift_enable_progress_timer = True

(Boolean) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the Swift backend storage. The default value is True to enable the timer.

backup_swift_key = None

(String) Swift key for authentication

backup_swift_object_size = 52428800

(Integer) The size in bytes of Swift backup objects

backup_swift_project = None

(String) Swift project/account name. Required when connecting to an auth 3.0 system

backup_swift_project_domain = None

(String) Swift project domain name. Required when connecting to an auth 3.0 system

backup_swift_retry_attempts = 3

(Integer) The number of retries to make for Swift operations

backup_swift_retry_backoff = 2

(Integer) The backoff time in seconds between Swift retries

backup_swift_tenant = None

(String) Swift tenant/account name. Required when connecting to an auth 2.0 system

backup_swift_url = None

(URI) The URL of the Swift endpoint

backup_swift_user = None

(String) Swift user name

backup_swift_user_domain = None

(String) Swift user domain name. Required when connecting to an auth 3.0 system

keystone_catalog_info = identity:Identity Service:publicURL

(String) Info to match when looking for keystone in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if backup_swift_auth_url is unset

swift_catalog_info = object-store:swift:publicURL

(String) Info to match when looking for swift in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if backup_swift_url is unset

[DEFAULT]

backup_tsm_compression = True

(Boolean) Enable or Disable compression for backups

backup_tsm_password = password

(String) TSM password for the running username

backup_tsm_volume_prefix = backup

(String) Volume prefix for the backup id when backing up to TSM

[DEFAULT]

available_devices =

(List) List of all available devices

[DEFAULT]

cb_account_name = None

(String) CloudByte storage specific account name. This maps to a project name in OpenStack.

cb_add_qosgroup = {'latency': '15', 'iops': '10', 'graceallowed': 'false', 'iopscontrol': 'true', 'memlimit': '0', 'throughput': '0', 'tpcontrol': 'false', 'networkspeed': '0'}

(Dict) These values will be used for CloudByte storage’s addQos API call.

cb_apikey = None

(String) Driver will use this API key to authenticate against the CloudByte storage’s management interface.

cb_auth_group = None

(String) This corresponds to the discovery authentication group in CloudByte storage. Chap users are added to this group. Driver uses the first user found for this group. Default value is None.

cb_confirm_volume_create_retries = 3

(Integer) Will confirm a successful volume creation in CloudByte storage by making this many number of attempts.

cb_confirm_volume_create_retry_interval = 5

(Integer) A retry value in seconds. Will be used by the driver to check if volume creation was successful in CloudByte storage.

cb_confirm_volume_delete_retries = 3

(Integer) Will confirm a successful volume deletion in CloudByte storage by making this many number of attempts.

cb_confirm_volume_delete_retry_interval = 5

(Integer) A retry value in seconds. Will be used by the driver to check if volume deletion was successful in CloudByte storage.

cb_create_volume = {'compression': 'off', 'deduplication': 'off', 'blocklength': '512B', 'sync': 'always', 'protocoltype': 'ISCSI', 'recordsize': '16k'}

(Dict) These values will be used for CloudByte storage’s createVolume API call.

cb_tsm_name = None

(String) This corresponds to the name of Tenant Storage Machine (TSM) in CloudByte storage. A volume will be created in this TSM.

cb_update_file_system = compression, sync, noofcopies, readonly

(List) These values will be used for CloudByte storage’s updateFileSystem API call.

cb_update_qos_group = iops, latency, graceallowed

(List) These values will be used for CloudByte storage’s updateQosGroup API call.

[DEFAULT]

coho_rpc_port = 2049

(Integer) RPC port to connect to Coho Data MicroArray

[DEFAULT]

allow_availability_zone_fallback = False

(Boolean) If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing.

chap = disabled

(String) CHAP authentication mode, effective only for iscsi (disabled|enabled)

chap_password =

(String) Password for specified CHAP account name.

chap_username =

(String) CHAP user name.

chiscsi_conf = /etc/chelsio-iscsi/chiscsi.conf

(String) Chiscsi (CXT) global defaults configuration file

cinder_internal_tenant_project_id = None

(String) ID of the project which will be used as the Cinder internal tenant.

cinder_internal_tenant_user_id = None

(String) ID of the user to be used in volume operations as the Cinder internal tenant.

cluster = None

(String) Name of this cluster. Used to group volume hosts that share the same backend configurations to work in HA Active-Active mode. Active-Active is not yet supported.

compute_api_class = cinder.compute.nova.API

(String) The full class name of the compute API class to use

connection_type = iscsi

(String) Connection type to the IBM Storage Array

consistencygroup_api_class = cinder.consistencygroup.api.API

(String) The full class name of the consistencygroup API class

default_availability_zone = None

(String) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes.

default_group_type = None

(String) Default group type to use

default_volume_type = None

(String) Default volume type to use

driver_client_cert = None

(String) The path to the client certificate for verification, if the driver supports it.

driver_client_cert_key = None

(String) The path to the client certificate key for verification, if the driver supports it.

driver_data_namespace = None

(String) Namespace for driver private data values to be saved in.

driver_ssl_cert_path = None

(String) Can be used to specify a non default path to a CA_BUNDLE file or directory with certificates of trusted CAs, which will be used to validate the backend

driver_ssl_cert_verify = False

(Boolean) If set to True the http client will validate the SSL certificate of the backend endpoint.

enable_force_upload = False

(Boolean) Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it.

enable_new_services = True

(Boolean) Services to be added to the available pool on create

enable_unsupported_driver = False

(Boolean) Set this to True when you want to allow an unsupported driver to start. Drivers that haven’t maintained a working CI system and testing are marked as unsupported until CI is working again. This also marks a driver as deprecated and may be removed in the next release.

end_time = None

(String) If this option is specified then the end time specified is used instead of the end time of the last completed audit period.

enforce_multipath_for_image_xfer = False

(Boolean) If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path.

executor_thread_pool_size = 64

(Integer) Size of executor thread pool.

fatal_exception_format_errors = False

(Boolean) Make exception message format errors fatal.

group_api_class = cinder.group.api.API

(String) The full class name of the group API class

host = localhost

(String) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address.

iet_conf = /etc/iet/ietd.conf

(String) IET configuration file

iscsi_secondary_ip_addresses =

(List) The list of secondary IP addresses of the iSCSI daemon

max_over_subscription_ratio = 20.0

(Floating point) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. The ratio has to be a minimum of 1.0.

monkey_patch = False

(Boolean) Enable monkey patching

monkey_patch_modules =

(List) List of modules/decorators to monkey patch

my_ip = 10.0.0.1

(String) IP address of this host

no_snapshot_gb_quota = False

(Boolean) Whether snapshots count against gigabyte quota

num_shell_tries = 3

(Integer) Number of times to attempt to run flakey shell commands

os_privileged_user_auth_url = None

(URI) Auth URL associated with the OpenStack privileged account.

os_privileged_user_name = None

(String) OpenStack privileged account username. Used for requests to other services (such as Nova) that require an account with special rights.

os_privileged_user_password = None

(String) Password associated with the OpenStack privileged account.

os_privileged_user_tenant = None

(String) Tenant name associated with the OpenStack privileged account.

periodic_fuzzy_delay = 60

(Integer) Range, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)

periodic_interval = 60

(Integer) Interval, in seconds, between running periodic tasks

replication_device = None

(Unknown) Multi opt of dictionaries to represent a replication target device. This option may be specified multiple times in a single config section to specify multiple replication target devices. Each entry takes the standard dict config form: replication_device = target_device_id:<required>,key1:value1,key2:value2…​

report_discard_supported = False

(Boolean) Report to clients of Cinder that the backend supports discard (aka. trim/unmap). This will not actually change the behavior of the backend or the client directly, it will only notify that it can be used.

report_interval = 10

(Integer) Interval, in seconds, between nodes reporting state to datastore

reserved_percentage = 0

(Integer) The percentage of backend capacity is reserved

rootwrap_config = /etc/cinder/rootwrap.conf

(String) Path to the rootwrap configuration file to use for running commands as root

send_actions = False

(Boolean) Send the volume and snapshot create and delete notifications generated in the specified period.

service_down_time = 60

(Integer) Maximum time since last check-in for a service to be considered up

ssh_hosts_key_file = $state_path/ssh_known_hosts

(String) File containing SSH host keys for the systems with which Cinder needs to communicate. OPTIONAL: Default=$state_path/ssh_known_hosts

start_time = None

(String) If this option is specified then the start time specified is used instead of the start time of the last completed audit period.

state_path = /var/lib/cinder

(String) Top-level directory for maintaining cinder’s state

storage_availability_zone = nova

(String) Availability zone of this node

storage_protocol = iscsi

(String) Protocol for transferring data between host and storage back-end.

strict_ssh_host_key_policy = False

(Boolean) Option to enable strict host key checking. When set to "True" Cinder will only connect to systems with a host key present in the configured "ssh_hosts_key_file". When set to "False" the host key will be saved upon first connection and used for subsequent connections. Default=False

suppress_requests_ssl_warnings = False

(Boolean) Suppress requests library SSL certificate warnings.

tcp_keepalive = True

(Boolean) Sets the value of TCP_KEEPALIVE (True/False) for each server socket.

tcp_keepalive_count = None

(Integer) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X.

tcp_keepalive_interval = None

(Integer) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X.

until_refresh = 0

(Integer) Count of reservations until usage is refreshed

use_chap_auth = False

(Boolean) Option to enable/disable CHAP authentication for targets.

use_forwarded_for = False

(Boolean) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.

[healthcheck]

backends =

(List) Additional backends that can perform health checks and report that information back as part of a request.

detailed = False

(Boolean) Show more detailed information as part of the response

disable_by_file_path = None

(String) Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin.

disable_by_file_paths =

(List) Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin.

path = /healthcheck

(String) DEPRECATED: The path to respond to healtcheck requests on.

[key_manager]

api_class = castellan.key_manager.barbican_key_manager.BarbicanKeyManager

(String) The full class name of the key manager API class

fixed_key = None

(String) Fixed key returned by key manager, specified in hex

[DEFAULT]

nova_api_insecure = False

(Boolean) Allow to perform insecure SSL requests to nova

nova_ca_certificates_file = None

(String) Location of ca certificates file to use for nova client requests.

nova_catalog_admin_info = compute:Compute Service:adminURL

(String) Same as nova_catalog_info, but for admin endpoint.

nova_catalog_info = compute:Compute Service:publicURL

(String) Match this value when searching for nova in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type>

nova_endpoint_admin_template = None

(String) Same as nova_endpoint_template, but for admin endpoint.

nova_endpoint_template = None

(String) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s

os_region_name = None

(String) Region name of this node

[coordination]

backend_url = file://$state_path

(String) The backend URL to use for distributed coordination.

heartbeat = 1.0

(Floating point) Number of seconds between heartbeats for distributed coordination.

initial_reconnect_backoff = 0.1

(Floating point) Initial number of seconds to wait after failed reconnection.

max_reconnect_backoff = 60.0

(Floating point) Maximum number of seconds between sequential reconnection retries.

[DEFAULT]

trace_flags = None

(List) List of options that control which trace info is written to the DEBUG log level to assist developers. Valid values are method and api.

[DEFAULT]

dell_sc_api_port = 3033

(Port number) Dell API port

dell_sc_server_folder = openstack

(String) Name of the server folder to use on the Storage Center

dell_sc_ssn = 64702

(Integer) Storage Center System Serial Number

dell_sc_verify_cert = False

(Boolean) Enable HTTPS SC certificate verification

dell_sc_volume_folder = openstack

(String) Name of the volume folder to use on the Storage Center

dell_server_os = Red Hat Linux 6.x

(String) Server OS type to use when creating a new server on the Storage Center.

excluded_domain_ip = None

(Unknown) Domain IP to be excluded from iSCSI returns.

secondary_san_ip =

(String) IP address of secondary DSM controller

secondary_san_login = Admin

(String) Secondary DSM user name

secondary_san_password =

(String) Secondary DSM user password name

secondary_sc_api_port = 3033

(Port number) Secondary Dell API port

[DEFAULT]

check_max_pool_luns_threshold = False

(Boolean) Report free_capacity_gb as 0 when the limit to maximum number of pool LUNs is reached. By default, the value is False.

cinder_emc_config_file = /etc/cinder/cinder_emc_config.xml

(String) Use this file for cinder emc plugin config data

destroy_empty_storage_group = False

(Boolean) To destroy storage group when the last LUN is removed from it. By default, the value is False.

force_delete_lun_in_storagegroup = False

(Boolean) Delete a LUN even if it is in Storage Groups. By default, the value is False.

initiator_auto_deregistration = False

(Boolean) Automatically deregister initiators after the related storage group is destroyed. By default, the value is False.

initiator_auto_registration = False

(Boolean) Automatically register initiators. By default, the value is False.

io_port_list = None

(List) Comma separated iSCSI or FC ports to be used in Nova or Cinder.

iscsi_initiators = None

(String) Mapping between hostname and its iSCSI initiator IP addresses.

max_luns_per_storage_group = 255

(Integer) Default max number of LUNs in a storage group. By default, the value is 255.

multi_pool_support = False

(String) Use this value to specify multi-pool support for VMAX3

naviseccli_path = None

(String) Naviseccli Path.

storage_vnx_authentication_type = global

(String) VNX authentication scope type. By default, the value is global.

storage_vnx_pool_names = None

(List) Comma-separated list of storage pool names to be used.

storage_vnx_security_file_dir = None

(String) Directory path that contains the VNX security file. Make sure the security file is generated first.

[DEFAULT]

sio_max_over_subscription_ratio = 10.0

(Floating point) max_over_subscription_ratio setting for the ScaleIO driver. This replaces the general max_over_subscription_ratio which has no effect in this driver.Maximum value allowed for ScaleIO is 10.0.

sio_protection_domain_id = None

(String) Protection Domain ID.

sio_protection_domain_name = None

(String) Protection Domain name.

sio_rest_server_port = 443

(String) REST server port.

sio_round_volume_capacity = True

(Boolean) Round up volume capacity.

sio_server_certificate_path = None

(String) Server certificate path.

sio_storage_pool_id = None

(String) Storage Pool ID.

sio_storage_pool_name = None

(String) Storage Pool name.

sio_storage_pools = None

(String) Storage Pools.

sio_unmap_volume_before_deletion = False

(Boolean) Unmap volume before deletion.

sio_verify_server_certificate = False

(Boolean) Verify server certificate.

[DEFAULT]

xtremio_array_busy_retry_count = 5

(Integer) Number of retries in case array is busy

xtremio_array_busy_retry_interval = 5

(Integer) Interval between retries in case array is busy

xtremio_cluster_name =

(String) XMS cluster id in multi-cluster environment

xtremio_volumes_per_glance_cache = 100

(Integer) Number of volumes created from each cached glance image

[DEFAULT]

eqlx_cli_max_retries = 5

(Integer) Maximum retry count for reconnection. Default is 5.

eqlx_group_name = group-0

(String) Group name to use for creating volumes. Defaults to "group-0".

eqlx_pool = default

(String) Pool in which volumes will be created. Defaults to "default".

[DEFAULT]

cinder_eternus_config_file = /etc/cinder/cinder_fujitsu_eternus_dx.xml

(String) config file for cinder eternus_dx volume driver

[DEFAULT]

flashsystem_connection_protocol = FC

(String) Connection protocol should be FC. (Default is FC.)

flashsystem_iscsi_portid = 0

(Integer) Default iSCSI Port ID of FlashSystem. (Default port is 0.)

flashsystem_multihostmap_enabled = True

(Boolean) Allows vdisk to multi host mapping. (Default is True)

flashsystem_multipath_enabled = False

(Boolean) DEPRECATED: This option no longer has any affect. It is deprecated and will be removed in the next release.

[DEFAULT]

hitachi_add_chap_user = False

(Boolean) Add CHAP user

hitachi_async_copy_check_interval = 10

(Integer) Interval to check copy asynchronously

hitachi_auth_method = None

(String) iSCSI authentication method

hitachi_auth_password = HBSD-CHAP-password

(String) iSCSI authentication password

hitachi_auth_user = HBSD-CHAP-user

(String) iSCSI authentication username

hitachi_copy_check_interval = 3

(Integer) Interval to check copy

hitachi_copy_speed = 3

(Integer) Copy speed of storage system

hitachi_default_copy_method = FULL

(String) Default copy method of storage system

hitachi_group_range = None

(String) Range of group number

hitachi_group_request = False

(Boolean) Request for creating HostGroup or iSCSI Target

hitachi_horcm_add_conf = True

(Boolean) Add to HORCM configuration

hitachi_horcm_numbers = 200,201

(String) Instance numbers for HORCM

hitachi_horcm_password = None

(String) Password of storage system for HORCM

hitachi_horcm_resource_lock_timeout = 600

(Integer) Timeout until a resource lock is released, in seconds. The value must be between 0 and 7200.

hitachi_horcm_user = None

(String) Username of storage system for HORCM

hitachi_ldev_range = None

(String) Range of logical device of storage system

hitachi_pool_id = None

(Integer) Pool ID of storage system

hitachi_serial_number = None

(String) Serial number of storage system

hitachi_target_ports = None

(String) Control port names for HostGroup or iSCSI Target

hitachi_thin_pool_id = None

(Integer) Thin pool ID of storage system

hitachi_unit_name = None

(String) Name of an array unit

hitachi_zoning_request = False

(Boolean) Request for FC Zone creating HostGroup

[DEFAULT]

hds_hnas_iscsi_config_file = /opt/hds/hnas/cinder_iscsi_conf.xml

(String) DEPRECATED: Legacy configuration file for HNAS iSCSI Cinder plugin. This is not needed if you fill all configuration on cinder.conf

hds_hnas_nfs_config_file = /opt/hds/hnas/cinder_nfs_conf.xml

(String) DEPRECATED: Legacy configuration file for HNAS NFS Cinder plugin. This is not needed if you fill all configuration on cinder.conf

hnas_chap_enabled = True

(Boolean) Whether the chap authentication is enabled in the iSCSI target or not.

hnas_cluster_admin_ip0 = None

(String) The IP of the HNAS cluster admin. Required only for HNAS multi-cluster setups.

hnas_mgmt_ip0 = None

(IP) Management IP address of HNAS. This can be any IP in the admin address on HNAS or the SMU IP.

hnas_password = None

(String) HNAS password.

hnas_ssc_cmd = ssc

(String) Command to communicate to HNAS.

hnas_ssh_port = 22

(Port number) Port to be used for SSH authentication.

hnas_ssh_private_key = None

(String) Path to the SSH private key used to authenticate in HNAS SMU.

hnas_svc0_hdp = None

(String) Service 0 HDP

hnas_svc0_iscsi_ip = None

(IP) Service 0 iSCSI IP

hnas_svc0_pool_name = None

(String) Service 0 pool name

hnas_svc1_hdp = None

(String) Service 1 HDP

hnas_svc1_iscsi_ip = None

(IP) Service 1 iSCSI IP

hnas_svc1_pool_name = None

(String) Service 1 pool name

hnas_svc2_hdp = None

(String) Service 2 HDP

hnas_svc2_iscsi_ip = None

(IP) Service 2 iSCSI IP

hnas_svc2_pool_name = None

(String) Service 2 pool name

hnas_svc3_hdp = None

(String) Service 3 HDP

hnas_svc3_iscsi_ip = None

(IP) Service 3 iSCSI IP

hnas_svc3_pool_name = None

(String) Service 3 pool name:

hnas_username = None

(String) HNAS username.

[DEFAULT]

vsp_async_copy_check_interval = 10

(Integer) Interval in seconds at which volume pair synchronization status is checked when volume pairs are deleted.

vsp_auth_password = None

(String) Password corresponding to vsp_auth_user.

vsp_auth_user = None

(String) Name of the user used for CHAP authentication performed in communication between hosts and iSCSI targets on the storage ports.

vsp_compute_target_ports = None

(List) IDs of the storage ports used to attach volumes to compute nodes. To specify multiple ports, connect them by commas (e.g. CL1-A,CL2-A).

vsp_copy_check_interval = 3

(Integer) Interval in seconds at which volume pair synchronization status is checked when volume pairs are created.

vsp_copy_speed = 3

(Integer) Speed at which data is copied by Shadow Image. 1 or 2 indicates low speed, 3 indicates middle speed, and a value between 4 and 15 indicates high speed.

vsp_default_copy_method = FULL

(String) Method of volume copy. FULL indicates full data copy by Shadow Image and THIN indicates differential data copy by Thin Image.

vsp_group_request = False

(Boolean) If True, the driver will create host groups or iSCSI targets on storage ports as needed.

vsp_horcm_add_conf = True

(Boolean) If True, the driver will create or update the Command Control Interface configuration file as needed.

vsp_horcm_numbers = 200, 201

(List) Command Control Interface instance numbers in the format of 'xxx,yyy'. The second one is for Shadow Image operation and the first one is for other purposes.

vsp_horcm_pair_target_ports = None

(List) IDs of the storage ports used to copy volumes by Shadow Image or Thin Image. To specify multiple ports, connect them by commas (e.g. CL1-A,CL2-A).

vsp_horcm_password = None

(String) Password corresponding to vsp_horcm_user.

vsp_horcm_user = None

(String) Name of the user on the storage system.

vsp_ldev_range = None

(String) Range of the LDEV numbers in the format of 'xxxx-yyyy' that can be used by the driver. Values can be in decimal format (e.g. 1000) or in colon-separated hexadecimal format (e.g. 00:03:E8).

vsp_pool = None

(String) Pool number or pool name of the DP pool.

vsp_storage_id = None

(String) Product number of the storage system.

vsp_target_ports = None

(List) IDs of the storage ports used to attach volumes to the controller node. To specify multiple ports, connect them by commas (e.g. CL1-A,CL2-A).

vsp_thin_pool = None

(String) Pool number or pool name of the Thin Image pool.

vsp_use_chap_auth = False

(Boolean) If True, CHAP authentication will be applied to communication between hosts and any of the iSCSI targets on the storage ports.

vsp_zoning_request = False

(Boolean) If True, the driver will configure FC zoning between the server and the storage system provided that FC zoning manager is enabled.

[DEFAULT]

hpe3par_api_url =

(String) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1

hpe3par_cpg = OpenStack

(List) List of the CPG(s) to use for volume creation

hpe3par_cpg_snap =

(String) The CPG to use for Snapshots for volumes. If empty the userCPG will be used.

hpe3par_debug = False

(Boolean) Enable HTTP debugging to 3PAR

hpe3par_iscsi_chap_enabled = False

(Boolean) Enable CHAP authentication for iSCSI connections.

hpe3par_iscsi_ips =

(List) List of target iSCSI addresses to use.

hpe3par_password =

(String) 3PAR password for the user specified in hpe3par_username

hpe3par_snapshot_expiration =

(String) The time in hours when a snapshot expires and is deleted. This must be larger than expiration

hpe3par_snapshot_retention =

(String) The time in hours to retain a snapshot. You can’t delete it before this expires.

hpe3par_username =

(String) 3PAR username with the 'edit' role

[DEFAULT]

hpelefthand_api_url = None

(URI) HPE LeftHand WSAPI Server Url like https://<LeftHand ip>:8081/lhos

hpelefthand_clustername = None

(String) HPE LeftHand cluster name

hpelefthand_debug = False

(Boolean) Enable HTTP debugging to LeftHand

hpelefthand_iscsi_chap_enabled = False

(Boolean) Configure CHAP authentication for iSCSI connections (Default: Disabled)

hpelefthand_password = None

(String) HPE LeftHand Super user password

hpelefthand_ssh_port = 16022

(Port number) Port number of SSH service.

hpelefthand_username = None

(String) HPE LeftHand Super user username

[DEFAULT]

cinder_huawei_conf_file = /etc/cinder/cinder_huawei_conf.xml

(String) The configuration file for the Cinder Huawei driver.

hypermetro_devices = None

(String) The remote device hypermetro will use.

metro_domain_name = None

(String) The remote metro device domain name.

metro_san_address = None

(String) The remote metro device request url.

metro_san_password = None

(String) The remote metro device san password.

metro_san_user = None

(String) The remote metro device san user.

metro_storage_pools = None

(String) The remote metro device pool names.

[DEFAULT]

ds8k_devadd_unitadd_mapping =

(String) Mapping between IODevice address and unit address.

ds8k_host_type = auto

(String) Set to zLinux if your OpenStack version is prior to Liberty and you’re connecting to zLinux systems. Otherwise set to auto. Valid values for this parameter are: 'auto', 'AMDLinuxRHEL', 'AMDLinuxSuse', 'AppleOSX', 'Fujitsu', 'Hp', 'HpTru64', 'HpVms', 'LinuxDT', 'LinuxRF', 'LinuxRHEL', 'LinuxSuse', 'Novell', 'SGI', 'SVC', 'SanFsAIX', 'SanFsLinux', 'Sun', 'VMWare', 'Win2000', 'Win2003', 'Win2008', 'Win2012', 'iLinux', 'nSeries', 'pLinux', 'pSeries', 'pSeriesPowerswap', 'zLinux', 'iSeries'.

ds8k_ssid_prefix = FF

(String) Set the first two digits of SSID

proxy = cinder.volume.drivers.ibm.ibm_storage.proxy.IBMStorageProxy

(String) Proxy driver that connects to the IBM Storage Array

san_clustername =

(String) Cluster name to use for creating volumes

san_ip =

(String) IP address of SAN controller

san_login = admin

(String) Username for SAN controller

san_password =

(String) Password for SAN controller

[DEFAULT]

allowed_direct_url_schemes =

(List) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file, cinder].

glance_api_insecure = False

(Boolean) Allow to perform insecure SSL (https) requests to glance (https will be used but cert validation will not be performed).

glance_api_servers = None

(List) A list of the URLs of glance API servers available to cinder ([http[s]://][hostname|ip]:port). If protocol is not specified it defaults to http.

glance_api_ssl_compression = False

(Boolean) Enables or disables negotiation of SSL layer compression. In some cases disabling compression can improve data throughput, such as when high network bandwidth is available and you use compressed image formats like qcow2.

glance_api_version = 2

(Integer) Version of the glance API to use

glance_ca_certificates_file = None

(String) Location of ca certificates file to use for glance client requests.

glance_catalog_info = image:glance:publicURL

(String) Info to match when looking for glance in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if glance_api_servers are not provided.

glance_core_properties = checksum, container_format, disk_format, image_name, image_id, min_disk, min_ram, name, size

(List) Default core properties of image

glance_num_retries = 0

(Integer) Number retries when downloading an image from glance

glance_request_timeout = None

(Integer) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used.

image_conversion_dir = $state_path/conversion

(String) Directory used for temporary storage during image conversion

image_upload_use_cinder_backend = False

(Boolean) If set to True, upload-to-image in raw format will create a cloned volume and register its location to the image service, instead of uploading the volume content. The cinder backend and locations support must be enabled in the image service, and glance_api_version must be set to 2.

image_upload_use_internal_tenant = False

(Boolean) If set to True, the image volume created by upload-to-image will be placed in the internal tenant. Otherwise, the image volume is created in the current context’s tenant.

image_volume_cache_enabled = False

(Boolean) Enable the image volume cache for this backend.

image_volume_cache_max_count = 0

(Integer) Max number of entries allowed in the image volume cache. 0 ⇒ unlimited.

image_volume_cache_max_size_gb = 0

(Integer) Max size of the image volume cache for this backend in GB. 0 ⇒ unlimited.

use_multipath_for_image_xfer = False

(Boolean) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers?

[DEFAULT]

infinidat_pool_name = None

(String) Name of the pool from which volumes are allocated

[DEFAULT]

auto_calc_max_oversubscription_ratio = False

(Boolean) K2 driver will calculate max_oversubscription_ratio on setting this option as True.

[DEFAULT]

lvm_conf_file = /etc/cinder/lvm.conf

(String) LVM conf file to use for the LVM driver in Cinder; this setting is ignored if the specified file does not exist (You can also specify 'None' to not use a conf file even if one exists).

lvm_max_over_subscription_ratio = 1.0

(Floating point) max_over_subscription_ratio setting for the LVM driver. If set, this takes precedence over the general max_over_subscription_ratio option. If None, the general option is used.

lvm_mirrors = 0

(Integer) If >0, create LVs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space

lvm_suppress_fd_warnings = False

(Boolean) Suppress leaked file descriptor warnings in LVM commands.

lvm_type = default

(String) Type of LVM volumes to deploy; (default, thin, or auto). Auto defaults to thin if thin is supported.

volume_group = cinder-volumes

(String) Name for the VG that will contain exported volumes

[DEFAULT]

nas_host =

(String) IP address or Hostname of NAS system.

nas_login = admin

(String) User name to connect to NAS system.

nas_mount_options = None

(String) Options used to mount the storage backend file system where Cinder volumes are stored.

nas_password =

(String) Password to connect to NAS system.

nas_private_key =

(String) Filename of private key to use for SSH authentication.

nas_secure_file_operations = auto

(String) Allow network-attached storage systems to operate in a secure environment where root level access is not permitted. If set to False, access is as the root user and insecure. If set to True, access is not as root. If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.

nas_secure_file_permissions = auto

(String) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.

nas_share_path =

(String) Path to the share to use for storing Cinder volumes. For example: "/srv/export1" for an NFS server export available at 10.0.5.10:/srv/export1 .

nas_ssh_port = 22

(Port number) SSH port to use to connect to NAS system.

[DEFAULT]

nec_actual_free_capacity = False

(Boolean) Return actual free capacity.

nec_backend_max_ld_count = 1024

(Integer) Maximum number of managing sessions.

nec_backup_ldname_format = LX:%s

(String) M-Series Storage LD name format for snapshots.

nec_backup_pools =

(List) M-Series Storage backup pool number to be used.

nec_diskarray_name =

(String) Diskarray name of M-Series Storage.

nec_iscsi_portals_per_cont = 1

(Integer) Number of iSCSI portals.

nec_ismcli_fip = None

(IP) FIP address of M-Series Storage iSMCLI.

nec_ismcli_password =

(String) Password for M-Series Storage iSMCLI.

nec_ismcli_privkey =

(String) Filename of RSA private key for M-Series Storage iSMCLI.

nec_ismcli_user =

(String) User name for M-Series Storage iSMCLI.

nec_ismview_alloptimize = False

(Boolean) Use legacy iSMCLI command with optimization.

nec_ismview_dir = /tmp/nec/cinder

(String) Output path of iSMview file.

nec_ldname_format = LX:%s

(String) M-Series Storage LD name format for volumes.

nec_ldset =

(String) M-Series Storage LD Set name for Compute Node.

nec_ldset_for_controller_node =

(String) M-Series Storage LD Set name for Controller Node.

nec_pools =

(List) M-Series Storage pool numbers list to be used.