Configuration Options

Configuration Options

The following is an overview of all available configuration options in Ironic. For a sample configuration file, refer to Sample Configuration File.

DEFAULT

backdoor_port
Type:string
Default:<None>

Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service’s log file.

backdoor_socket
Type:string
Default:<None>

Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with ‘backdoor_port’ in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option.

log_options
Type:boolean
Default:true

Enables or disables logging values of all registered options when starting a service (at DEBUG level).

graceful_shutdown_timeout
Type:integer
Default:60

Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait.

run_external_periodic_tasks
Type:boolean
Default:true

Some periodic tasks can be run in a separate process. Should we run them here?

rpc_conn_pool_size
Type:integer
Default:30

Size of RPC connection pool.

Deprecated Variations
Group Name
DEFAULT rpc_conn_pool_size
conn_pool_min_size
Type:integer
Default:2

The pool size limit for connections expiration policy

conn_pool_ttl
Type:integer
Default:1200

The time-to-live in sec of idle connections in the pool

rpc_zmq_bind_address
Type:string
Default:*

ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The “host” option should point or resolve to this address.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_bind_address
rpc_zmq_matchmaker
Type:string
Default:redis
Valid Values:redis, sentinel, dummy

MatchMaker driver.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_matchmaker
rpc_zmq_contexts
Type:integer
Default:1

Number of ZeroMQ contexts, defaults to 1.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_contexts
rpc_zmq_topic_backlog
Type:integer
Default:<None>

Maximum number of ingress messages to locally buffer per topic. Default is unlimited.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_topic_backlog
rpc_zmq_ipc_dir
Type:string
Default:/var/run/openstack

Directory for holding IPC sockets.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_ipc_dir
rpc_zmq_host
Type:string
Default:localhost

Name of this node. Must be a valid hostname, FQDN, or IP address. Must match “host” option, if running Nova.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_host
zmq_linger
Type:integer
Default:-1

Number of seconds to wait before all pending messages will be sent after closing a socket. 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. Positive values specify an upper bound for the linger period.

Deprecated Variations
Group Name
DEFAULT rpc_cast_timeout
rpc_poll_timeout
Type:integer
Default:1

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

Deprecated Variations
Group Name
DEFAULT rpc_poll_timeout
zmq_target_expire
Type:integer
Default:300

Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).

Deprecated Variations
Group Name
DEFAULT zmq_target_expire
zmq_target_update
Type:integer
Default:180

Update period in seconds of a name service record about existing target.

Deprecated Variations
Group Name
DEFAULT zmq_target_update
use_pub_sub
Type:boolean
Default:false

Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.

Deprecated Variations
Group Name
DEFAULT use_pub_sub
use_router_proxy
Type:boolean
Default:false

Use ROUTER remote proxy.

Deprecated Variations
Group Name
DEFAULT use_router_proxy
use_dynamic_connections
Type:boolean
Default:false

This option makes direct connections dynamic or static. It makes sense only with use_router_proxy=False which means to use direct connections for direct message types (ignored otherwise).

zmq_failover_connections
Type:integer
Default:2

How many additional connections to a host will be made for failover reasons. This option is actual only in dynamic connections mode.

rpc_zmq_min_port
Type:port number
Default:49153
Minimum Value:0
Maximum Value:65535

Minimal port number for random ports range.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_min_port
rpc_zmq_max_port
Type:integer
Default:65536
Minimum Value:1
Maximum Value:65536

Maximal port number for random ports range.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_max_port
rpc_zmq_bind_port_retries
Type:integer
Default:100

Number of retries to find free port number before fail with ZMQBindError.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_bind_port_retries
rpc_zmq_serialization
Type:string
Default:json
Valid Values:json, msgpack

Default serialization mechanism for serializing/deserializing outgoing/incoming messages

Deprecated Variations
Group Name
DEFAULT rpc_zmq_serialization
zmq_immediate
Type:boolean
Default:true

This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it.

zmq_tcp_keepalive
Type:integer
Default:-1

Enable/disable TCP keepalive (KA) mechanism. The default value of -1 (or any other negative value) means to skip any overrides and leave it to OS default; 0 and 1 (or any other positive value) mean to disable and enable the option respectively.

zmq_tcp_keepalive_idle
Type:integer
Default:-1

The duration between two keepalive transmissions in idle condition. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

zmq_tcp_keepalive_cnt
Type:integer
Default:-1

The number of retransmissions to be carried out before declaring that remote end is not available. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

zmq_tcp_keepalive_intvl
Type:integer
Default:-1

The duration between two successive keepalive retransmissions, if acknowledgement to the previous keepalive transmission is not received. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

rpc_thread_pool_size
Type:integer
Default:100

Maximum number of (green) threads to work concurrently.

rpc_message_ttl
Type:integer
Default:300

Expiration timeout in seconds of a sent/received message after which it is not tracked anymore by a client/server.

rpc_use_acks
Type:boolean
Default:false

Wait for message acknowledgements from receivers. This mechanism works only via proxy without PUB/SUB.

rpc_ack_timeout_base
Type:integer
Default:15

Number of seconds to wait for an ack from a cast/call. After each retry attempt this timeout is multiplied by some specified multiplier.

rpc_ack_timeout_multiplier
Type:integer
Default:2

Number to multiply base ack timeout by after each retry attempt.

rpc_retry_attempts
Type:integer
Default:3

Default number of message sending attempts in case of any problems occurred: positive value N means at most N retries, 0 means no retries, None or -1 (or any other negative values) mean to retry forever. This option is used only if acknowledgments are enabled.

subscribe_on
Type:list
Default:u''

List of publisher hosts SubConsumer can subscribe on. This option has higher priority then the default publishers list taken from the matchmaker.

executor_thread_pool_size
Type:integer
Default:64

Size of executor thread pool when executor is threading or eventlet.

Deprecated Variations
Group Name
DEFAULT rpc_thread_pool_size
rpc_response_timeout
Type:integer
Default:60

Seconds to wait for a response from a call.

transport_url
Type:string
Default:<None>

The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is:

driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query

Example: rabbit://rabbitmq:password@127.0.0.1:5672//

For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html

rpc_backend
Type:string
Default:rabbit

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

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Replaced by [DEFAULT]/transport_url
control_exchange
Type:string
Default:openstack

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

debug
Type:boolean
Default:false
Mutable:This option can be changed without restarting.

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

log_config_append
Type:string
Default:<None>
Mutable:This option can be changed without restarting.

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).

Deprecated Variations
Group Name
DEFAULT log-config
DEFAULT log_config
log_date_format
Type:string
Default:%Y-%m-%d %H:%M:%S

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

log_file
Type:string
Default:<None>

(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.

Deprecated Variations
Group Name
DEFAULT logfile
log_dir
Type:string
Default:<None>

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

Deprecated Variations
Group Name
DEFAULT logdir
watch_log_file
Type:boolean
Default:false

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.

use_syslog
Type:boolean
Default:false

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.

use_journal
Type:boolean
Default:false

Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set.

syslog_log_facility
Type:string
Default:LOG_USER

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

use_json
Type:boolean
Default:false

Use JSON formatting for logging. This option is ignored if log_config_append is set.

use_stderr
Type:boolean
Default:false

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

logging_context_format_string
Type:string
Default:%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s

Format string to use for log messages with context.

logging_default_format_string
Type:string
Default:%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s

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

logging_debug_format_suffix
Type:string
Default:%(funcName)s %(pathname)s:%(lineno)d

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

logging_exception_prefix
Type:string
Default:%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s

Prefix each line of exception output with this format.

logging_user_identity_format
Type:string
Default:%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s

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

default_log_levels
Type:list
Default:amqp=WARNING,amqplib=WARNING,qpid.messaging=INFO,oslo_messaging=INFO,oslo.messaging=INFO,sqlalchemy=WARNING,stevedore=INFO,eventlet.wsgi.server=INFO,iso8601=WARNING,requests=WARNING,neutronclient=WARNING,glanceclient=WARNING,urllib3.connectionpool=WARNING,keystonemiddleware.auth_token=INFO,keystoneauth.session=INFO

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

publish_errors
Type:boolean
Default:false

Enables or disables publication of error events.

instance_format
Type:string
Default:"[instance: %(uuid)s] "

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

instance_uuid_format
Type:string
Default:"[instance: %(uuid)s] "

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

rate_limit_interval
Type:integer
Default:0

Interval, number of seconds, of log rate limiting.

rate_limit_burst
Type:integer
Default:0

Maximum number of logged messages per rate_limit_interval.

rate_limit_except_level
Type:string
Default:CRITICAL

Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.

fatal_deprecations
Type:boolean
Default:false

Enables or disables fatal status of deprecations.

agent

manage_agent_boot
Type:boolean
Default:true

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
Type:integer
Default:0

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.

stream_raw_images
Type:boolean
Default:true

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.

post_deploy_get_power_state_retries
Type:integer
Default:6

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
Type:integer
Default:5

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

agent_api_version
Type:string
Default:v1

API version to use for communicating with the ramdisk agent.

deploy_logs_collect
Type:string
Default:on_failure
Valid Values:always, on_failure, never

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

Possible values

always
always collect the logs
on_failure
only collect logs if there is a failure
never
never collect logs
deploy_logs_storage_backend
Type:string
Default:local
Valid Values:local, swift

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

Possible values

local
store the logs locally
swift
store the logs in Object Storage service
deploy_logs_local_path
Type:string
Default:/var/log/ironic/deploy

The path to the directory where the logs should be stored, used when the deploy_logs_storage_backend is configured to “local”.

deploy_logs_swift_container
Type:string
Default:ironic_deploy_logs_container

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
Type:integer
Default:30

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”.

ansible

ansible_extra_args
Type:string
Default:<None>

Extra arguments to pass on every invocation of Ansible.

verbosity
Type:integer
Default:<None>
Minimum Value:0
Maximum Value:4

Set ansible verbosity level requested when invoking “ansible-playbook” command. 4 includes detailed SSH session logging. Default is 4 when global debug is enabled and 0 otherwise.

ansible_playbook_script
Type:string
Default:ansible-playbook

Path to “ansible-playbook” script. Default will search the $PATH configured for user running ironic-conductor process. Provide the full path when ansible-playbook is not in $PATH or installed in not default location.

playbooks_path
Type:string
Default:$pybasedir/drivers/modules/ansible/playbooks

Path to directory with playbooks, roles and local inventory.

config_file_path
Type:string
Default:$pybasedir/drivers/modules/ansible/playbooks/ansible.cfg

Path to ansible configuration file. If set to empty, system default will be used.

post_deploy_get_power_state_retries
Type:integer
Default:6
Minimum Value:0

Number of times to retry getting power state to check if bare metal node has been powered off after a soft power off. Value of 0 means do not retry on failure.

post_deploy_get_power_state_retry_interval
Type:integer
Default:5
Minimum Value:0

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

extra_memory
Type:integer
Default:10

Extra amount of memory in MiB expected to be consumed by Ansible-related processes on the node. Affects decision whether image will fit into RAM.

image_store_insecure
Type:boolean
Default:false

Skip verifying SSL connections to the image store when downloading the image. Setting it to “True” is only recommended for testing environments that use self-signed certificates.

image_store_cafile
Type:string
Default:<None>

Specific CA bundle to use for validating SSL connections to the image store. If not specified, CA available in the ramdisk will be used. Is not used by default playbooks included with the driver. Suitable for environments that use self-signed certificates.

image_store_certfile
Type:string
Default:<None>

Client cert to use for SSL connections to image store. Is not used by default playbooks included with the driver.

image_store_keyfile
Type:string
Default:<None>

Client key to use for SSL connections to image store. Is not used by default playbooks included with the driver.

default_username
Type:string
Default:ansible

Name of the user to use for Ansible when connecting to the ramdisk over SSH. It may be overridden by per-node ‘ansible_username’ option in node’s ‘driver_info’ field.

default_key_file
Type:string
Default:<None>

Absolute path to the private SSH key file to use by Ansible by default when connecting to the ramdisk over SSH. Default is to use default SSH keys configured for the user running the ironic-conductor service. Private keys with password must be pre-loaded into ‘ssh-agent’. It may be overridden by per-node ‘ansible_key_file’ option in node’s ‘driver_info’ field.

default_deploy_playbook
Type:string
Default:deploy.yaml

Path (relative to $playbooks_path or absolute) to the default playbook used for deployment. It may be overridden by per-node ‘ansible_deploy_playbook’ option in node’s ‘driver_info’ field.

default_shutdown_playbook
Type:string
Default:shutdown.yaml

Path (relative to $playbooks_path or absolute) to the default playbook used for graceful in-band shutdown of the node. It may be overridden by per-node ‘ansible_shutdown_playbook’ option in node’s ‘driver_info’ field.

default_clean_playbook
Type:string
Default:clean.yaml

Path (relative to $playbooks_path or absolute) to the default playbook used for node cleaning. It may be overridden by per-node ‘ansible_clean_playbook’ option in node’s ‘driver_info’ field.

default_clean_steps_config
Type:string
Default:clean_steps.yaml

Path (relative to $playbooks_path or absolute) to the default auxiliary cleaning steps file used during the node cleaning. It may be overridden by per-node ‘ansible_clean_steps_config’ option in node’s ‘driver_info’ field.

api

host_ip
Type:string
Default:0.0.0.0

The IP address on which ironic-api listens.

port
Type:port number
Default:6385
Minimum Value:0
Maximum Value:65535

The TCP port on which ironic-api listens.

max_limit
Type:integer
Default:1000

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

public_endpoint
Type:string
Default:<None>

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.

api_workers
Type:integer
Default:<None>

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
Type:boolean
Default:false

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.

restrict_lookup
Type:boolean
Default:true

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

ramdisk_heartbeat_timeout
Type:integer
Default:300

Maximum interval (in seconds) for agent heartbeats.

Deprecated Variations
Group Name
agent heartbeat_timeout

audit

enabled
Type:boolean
Default:false

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

audit_map_file
Type:string
Default:/etc/ironic/api_audit_map.conf

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

ignore_req_list
Type:string
Default:u''

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.

cimc

max_retry
Type:integer
Default:6

Number of times a power operation needs to be retried

action_interval
Type:integer
Default:10

Amount of time in seconds to wait in between power operations

cinder

action_retries
Type:integer
Default:3

Number of retries in the case of a failed action (currently only used when detaching volumes).

action_retry_interval
Type:integer
Default:5

Retry interval in seconds in the case of a failed action (only specific actions are retried).

auth_url
Type:unknown type
Default:<None>

Authentication URL

auth_type
Type:unknown type
Default:<None>

Authentication type to load

Deprecated Variations
Group Name
cinder auth_plugin
cafile
Type:string
Default:<None>

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile
Type:string
Default:<None>

PEM encoded client certificate cert file

collect_timing
Type:boolean
Default:false

Collect per-API call timing information.

default_domain_id
Type:unknown type
Default:<None>

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

default_domain_name
Type:unknown type
Default:<None>

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

domain_id
Type:unknown type
Default:<None>

Domain ID to scope to

domain_name
Type:unknown type
Default:<None>

Domain name to scope to

endpoint_override
Type:string
Default:<None>

Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the version, min-version, and/or max-version options.

insecure
Type:boolean
Default:false

Verify HTTPS connections.

keyfile
Type:string
Default:<None>

PEM encoded client certificate key file

max_version
Type:string
Default:<None>

The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version.

min_version
Type:string
Default:<None>

The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is “latest”.

password
Type:unknown type
Default:<None>

User’s password

project_domain_id
Type:unknown type
Default:<None>

Domain ID containing project

project_domain_name
Type:unknown type
Default:<None>

Domain name containing project

project_id
Type:unknown type
Default:<None>

Project ID to scope to

Deprecated Variations
Group Name
cinder tenant-id
cinder tenant_id
project_name
Type:unknown type
Default:<None>

Project name to scope to

Deprecated Variations
Group Name
cinder tenant-name
cinder tenant_name
region_name
Type:string
Default:<None>

The default region_name for endpoint URL discovery.

retries
Type:integer
Default:3

Client retries in the case of a failed request connection.

service_name
Type:string
Default:<None>

The default service_name for endpoint URL discovery.

service_type
Type:string
Default:volumev3

The default service_type for endpoint URL discovery.

split_loggers
Type:boolean
Default:false

Log requests to multiple loggers.

system_scope
Type:unknown type
Default:<None>

Scope for system operations

tenant_id
Type:unknown type
Default:<None>

Tenant ID

tenant_name
Type:unknown type
Default:<None>

Tenant Name

timeout
Type:integer
Default:<None>

Timeout value for http requests

trust_id
Type:unknown type
Default:<None>

Trust ID

url
Type:URI
Default:<None>

URL for connecting to cinder. If set, the value must start with either http:// or https://.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Use [cinder]/endpoint_override option to set a specific cinder API URL to connect to.
user_domain_id
Type:unknown type
Default:<None>

User’s domain id

user_domain_name
Type:unknown type
Default:<None>

User’s domain name

user_id
Type:unknown type
Default:<None>

User id

username
Type:unknown type
Default:<None>

Username

Deprecated Variations
Group Name
cinder user-name
cinder user_name
valid_interfaces
Type:list
Default:internal,public

List of interfaces, in order of preference, for endpoint URL.

version
Type:string
Default:<None>

Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version

cisco_ucs

max_retry
Type:integer
Default:6

Number of times a power operation needs to be retried

action_interval
Type:integer
Default:5

Amount of time in seconds to wait in between power operations

conductor

workers_pool_size
Type:integer
Default:100
Minimum Value:3

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.

heartbeat_interval
Type:integer
Default:10

Seconds between conductor heart beats.

api_url
Type:URI
Default:<None>

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://.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Use [service_catalog]endpoint_override option instead if required to use a specific ironic api address, for example in noauth mode.
heartbeat_timeout
Type:integer
Default:60

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

sync_power_state_interval
Type:integer
Default:60

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

check_provision_state_interval
Type:integer
Default:60

Interval between checks of provision timeouts, in seconds.

check_rescue_state_interval
Type:integer
Default:60
Minimum Value:1

Interval (seconds) between checks of rescue timeouts.

deploy_callback_timeout
Type:integer
Default:1800

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

force_power_state_during_sync
Type:boolean
Default:true

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).

power_state_sync_max_retries
Type:integer
Default:3

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

periodic_max_workers
Type:integer
Default:8

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

node_locked_retry_attempts
Type:integer
Default:3

Number of attempts to grab a node lock.

node_locked_retry_interval
Type:integer
Default:1

Seconds to sleep between node lock attempts.

send_sensor_data
Type:boolean
Default:false

Enable sending sensor data message via the notification bus

send_sensor_data_interval
Type:integer
Default:600

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

send_sensor_data_workers
Type:integer
Default:4
Minimum Value:1

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

send_sensor_data_wait_timeout
Type:integer
Default:300

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_types
Type:list
Default:ALL

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.

sync_local_state_interval
Type:integer
Default:180

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.

configdrive_swift_container
Type:string
Default:ironic_configdrive_container

Name of the Swift container to store config drive data. Used when configdrive_use_object_store is True.

inspect_wait_timeout
Type:integer
Default:1800

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

Deprecated Variations
Group Name
conductor inspect_timeout
automated_clean
Type:boolean
Default:true

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.

clean_callback_timeout
Type:integer
Default:1800

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.

rescue_callback_timeout
Type:integer
Default:1800
Minimum Value:0

Timeout (seconds) to wait for a callback from the rescue ramdisk. If the timeout is reached the node will be put in the “rescue failed” provision state. Set to 0 to disable timeout.

soft_power_off_timeout
Type:integer
Default:600
Minimum Value:1

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

power_state_change_timeout
Type:integer
Default:30
Minimum Value:2

Number of seconds to wait for power operations to complete, i.e., so that a baremetal node is in the desired power state. If timed out, the power operation is considered a failure.

power_failure_recovery_interval
Type:integer
Default:300
Minimum Value:0

Interval (in seconds) between checking the power state for nodes previously put into maintenance mode due to power synchronization failure. A node is automatically moved out of maintenance mode once its power state is retrieved successfully. Set to 0 to disable this check.

conductor_group
Type:string
Default:u''

Name of the conductor group to join. Can be up to 255 characters and is case insensitive. This conductor will only manage nodes with a matching “conductor_group” field set on the node.

console

terminal
Type:string
Default:shellinaboxd

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

terminal_cert_dir
Type:string
Default:<None>

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

terminal_pid_dir
Type:string
Default:<None>

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

terminal_timeout
Type:integer
Default:600
Minimum Value:0

Timeout (in seconds) for the terminal session to be closed on inactivity. Set to 0 to disable timeout. Used only by Socat console.

subprocess_checking_interval
Type:integer
Default:1

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

subprocess_timeout
Type:integer
Default:10

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

socat_address
Type:ip address
Default:$my_ip

IP address of Socat service running on the host of ironic conductor. Used only by Socat console.

cors

allowed_origin
Type:list
Default:<None>

Indicate whether this resource may be shared with the domain received in the requests “origin” header. Format: “<protocol>://<host>[:<port>]”, no trailing slash. Example: https://horizon.example.com

allow_credentials
Type:boolean
Default:true

Indicate that the actual request can include user credentials

expose_headers
Type:list
Default:u''

Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.

max_age
Type:integer
Default:3600

Maximum cache age of CORS preflight requests.

allow_methods
Type:list
Default:OPTIONS,GET,HEAD,POST,PUT,DELETE,TRACE,PATCH

Indicate which methods can be used during the actual request.

allow_headers
Type:list
Default:u''

Indicate which header field names may be used during the actual request.

database

sqlite_synchronous
Type:boolean
Default:true

If True, SQLite uses synchronous mode.

Deprecated Variations
Group Name
DEFAULT sqlite_synchronous
backend
Type:string
Default:sqlalchemy

The back end to use for the database.

Deprecated Variations
Group Name
DEFAULT db_backend
connection
Type:string
Default:<None>

The SQLAlchemy connection string to use to connect to the database.

Deprecated Variations
Group Name
DEFAULT sql_connection
DATABASE sql_connection
sql connection
slave_connection
Type:string
Default:<None>

The SQLAlchemy connection string to use to connect to the slave database.

mysql_sql_mode
Type:string
Default:TRADITIONAL

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=

mysql_enable_ndb
Type:boolean
Default:false

If True, transparently enables support for handling MySQL Cluster (NDB).

connection_recycle_time
Type:integer
Default:3600

Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool.

Deprecated Variations
Group Name
DATABASE idle_timeout
database idle_timeout
DEFAULT sql_idle_timeout
DATABASE sql_idle_timeout
sql idle_timeout
min_pool_size
Type:integer
Default:1

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

Deprecated Variations
Group Name
DEFAULT sql_min_pool_size
DATABASE sql_min_pool_size

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:The option to set the minimum pool size is not supported by sqlalchemy.
max_pool_size
Type:integer
Default:5

Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit.

Deprecated Variations
Group Name
DEFAULT sql_max_pool_size
DATABASE sql_max_pool_size
max_retries
Type:integer
Default:10

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

Deprecated Variations
Group Name
DEFAULT sql_max_retries
DATABASE sql_max_retries
retry_interval
Type:integer
Default:10

Interval between retries of opening a SQL connection.

Deprecated Variations
Group Name
DEFAULT sql_retry_interval
DATABASE reconnect_interval
max_overflow
Type:integer
Default:50

If set, use this value for max_overflow with SQLAlchemy.

Deprecated Variations
Group Name
DEFAULT sql_max_overflow
DATABASE sqlalchemy_max_overflow
connection_debug
Type:integer
Default:0
Minimum Value:0
Maximum Value:100

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

Deprecated Variations
Group Name
DEFAULT sql_connection_debug
connection_trace
Type:boolean
Default:false

Add Python stack traces to SQL as comment strings.

Deprecated Variations
Group Name
DEFAULT sql_connection_trace
pool_timeout
Type:integer
Default:<None>

If set, use this value for pool_timeout with SQLAlchemy.

Deprecated Variations
Group Name
DATABASE sqlalchemy_pool_timeout
use_db_reconnect
Type:boolean
Default:false

Enable the experimental use of database reconnect on connection lost.

db_retry_interval
Type:integer
Default:1

Seconds between retries of a database transaction.

db_inc_retry_interval
Type:boolean
Default:true

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

db_max_retry_interval
Type:integer
Default:10

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

db_max_retries
Type:integer
Default:20

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

connection_parameters
Type:string
Default:u''

Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1&param2=value2&…

mysql_engine
Type:string
Default:InnoDB

MySQL engine to use.

deploy

http_url
Type:string
Default:<None>

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

http_root
Type:string
Default:/httpboot

ironic-conductor node’s HTTP root path.

enable_ata_secure_erase
Type:boolean
Default:true

Whether to support the use of ATA Secure Erase during the cleaning process. Defaults to True.

erase_devices_priority
Type:integer
Default:<None>

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.

erase_devices_metadata_priority
Type:integer
Default:<None>

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.

shred_random_overwrite_iterations
Type:integer
Default:1
Minimum Value:0

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.

shred_final_overwrite_with_zeros
Type:boolean
Default:true

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.

continue_if_disk_secure_erase_fails
Type:boolean
Default:false

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.

power_off_after_deploy_failure
Type:boolean
Default:true

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

default_boot_option
Type:string
Default:<None>
Valid Values:netboot, local

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.

Possible values

netboot
boot from a network
local
local boot
default_boot_mode
Type:string
Default:bios
Valid Values:uefi, bios

Default boot mode to use when no boot mode is requested in node’s driver_info, capabilities or in the instance_info configuration. Currently the default boot mode is “bios”. This option only has effect when management interface supports boot mode management

Possible values

uefi
UEFI boot mode
bios
Legacy BIOS boot mode
configdrive_use_object_store
Type:boolean
Default:false

Whether to upload the config drive to object store. Set this option to True to store config drive in swift or radosgw.

Deprecated Variations
Group Name
conductor configdrive_use_swift
object_store_endpoint_type
Type:string
Default:swift
Valid Values:swift, radosgw

Type of object store endpoint type to be used as a backend

Possible values

swift
use Object Storage service
radosgw
use RADOS object store
Deprecated Variations
Group Name
glance temp_url_endpoint_type

dhcp

dhcp_provider
Type:string
Default:neutron

DHCP provider to use. “neutron” uses Neutron, and “none” uses a no-op provider.

disk_partitioner

check_device_interval
Type:integer
Default:1

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
Type:integer
Default:20

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

efi_system_partition_size
Type:integer
Default:200

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

bios_boot_partition_size
Type:integer
Default:1

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

dd_block_size
Type:string
Default:1M

Block size to use when writing to the nodes disk.

iscsi_verify_attempts
Type:integer
Default:3

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

partprobe_attempts
Type:integer
Default:10

Maximum number of attempts to try to read the partition.

drac

query_raid_config_job_status_interval
Type:integer
Default:120

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
Type:list
Default:u''

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

auth_url
Type:unknown type
Default:<None>

Authentication URL

auth_strategy
Type:string
Default:keystone
Valid Values:keystone, noauth

Authentication strategy to use when connecting to glance.

Possible values

keystone
use the Identity service for authentication
noauth
no authentication

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:To configure glance in noauth mode, set [glance]/auth_type=none and [glance]/endpoint_override=<GLANCE_API_ADDRESS> instead.
auth_type
Type:unknown type
Default:<None>

Authentication type to load

Deprecated Variations
Group Name
glance auth_plugin
cafile
Type:string
Default:<None>

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile
Type:string
Default:<None>

PEM encoded client certificate cert file

collect_timing
Type:boolean
Default:false

Collect per-API call timing information.

default_domain_id
Type:unknown type
Default:<None>

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

default_domain_name
Type:unknown type
Default:<None>

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

domain_id
Type:unknown type
Default:<None>

Domain ID to scope to

domain_name
Type:unknown type
Default:<None>

Domain name to scope to

endpoint_override
Type:string
Default:<None>

Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the version, min-version, and/or max-version options.

glance_api_insecure
Type:boolean
Default:false

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

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Use [glance]/insecure option instead.
glance_api_servers
Type:list
Default:<None>

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

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Use [glance]/endpoint_override option to set the full load-balanced glance API URL instead.
glance_api_version
Type:integer
Default:2
Minimum Value:1
Maximum Value:2

Glance API version (1 or 2) to use.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Ironic will only support using Glance API version 2 in the Queens release.
glance_cafile
Type:string
Default:<None>

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.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Use [glance]/cafile option instead.
glance_num_retries
Type:integer
Default:0

Number of retries when downloading an image from glance.

insecure
Type:boolean
Default:false

Verify HTTPS connections.

keyfile
Type:string
Default:<None>

PEM encoded client certificate key file

max_version
Type:string
Default:<None>

The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version.

min_version
Type:string
Default:<None>

The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is “latest”.

password
Type:unknown type
Default:<None>

User’s password

project_domain_id
Type:unknown type
Default:<None>

Domain ID containing project

project_domain_name
Type:unknown type
Default:<None>

Domain name containing project

project_id
Type:unknown type
Default:<None>

Project ID to scope to

Deprecated Variations
Group Name
glance tenant-id
glance tenant_id
project_name
Type:unknown type
Default:<None>

Project name to scope to

Deprecated Variations
Group Name
glance tenant-name
glance tenant_name
region_name
Type:string
Default:<None>

The default region_name for endpoint URL discovery.

service_name
Type:string
Default:<None>

The default service_name for endpoint URL discovery.

service_type
Type:string
Default:image

The default service_type for endpoint URL discovery.

split_loggers
Type:boolean
Default:false

Log requests to multiple loggers.

swift_account
Type:string
Default:<None>

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. For example: “AUTH_a422b2-91f3-2f46-74b7-d7c9e8958f5d30”. If not set, the default value is calculated based on the ID of the project used to access Swift (as set in the [swift] section). Swift temporary URL format: “endpoint_url/api_version/[account/]container/object_id”

swift_api_version
Type:string
Default:v1

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
Type:string
Default:glance

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
Type:string
Default:<None>

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. Used for temporary URLs, will be fetched from the service catalog, if not provided.

swift_store_multiple_containers_seed
Type:integer
Default:0

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
Type:boolean
Default:false

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
Type:integer
Default:1200

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
Type:integer
Default:0
Minimum Value:0

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
Type:string
Default:<None>

The secret token given to Swift to allow temporary URL downloads. Required for temporary URLs. For the Swift backend, the key on the service project (as set in the [swift] section) is used by default.

system_scope
Type:unknown type
Default:<None>

Scope for system operations

tenant_id
Type:unknown type
Default:<None>

Tenant ID

tenant_name
Type:unknown type
Default:<None>

Tenant Name

timeout
Type:integer
Default:<None>

Timeout value for http requests

trust_id
Type:unknown type
Default:<None>

Trust ID

user_domain_id
Type:unknown type
Default:<None>

User’s domain id

user_domain_name
Type:unknown type
Default:<None>

User’s domain name

user_id
Type:unknown type
Default:<None>

User id

username
Type:unknown type
Default:<None>

Username

Deprecated Variations
Group Name
glance user-name
glance user_name
valid_interfaces
Type:list
Default:internal,public

List of interfaces, in order of preference, for endpoint URL.

version
Type:string
Default:<None>

Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version

healthcheck

path
Type:string
Default:/healthcheck

The path to respond to healtcheck requests on.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

detailed
Type:boolean
Default:false

Show more detailed information as part of the response

backends
Type:list
Default:u''

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

disable_by_file_path
Type:string
Default:<None>

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

disable_by_file_paths
Type:list
Default:u''

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.

enabled
Type:boolean
Default:false

Enable the health check endpoint at /healthcheck. Note that this is unauthenticated. More information is available at https://docs.openstack.org/oslo.middleware/latest/reference/healthcheck_plugins.html.

ilo

client_timeout
Type:integer
Default:60

Timeout (in seconds) for iLO operations

client_port
Type:port number
Default:443
Minimum Value:0
Maximum Value:65535

Port to be used for iLO operations

swift_ilo_container
Type:string
Default:ironic_ilo_container

The Swift iLO container to store data.

swift_object_expiry_timeout
Type:integer
Default:900

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

use_web_server_for_images
Type:boolean
Default:false

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.

clean_priority_reset_ilo
Type:integer
Default:0

Priority for reset_ilo clean step.

clean_priority_reset_bios_to_default
Type:integer
Default:10

Priority for reset_bios_to_default clean step.

clean_priority_reset_secure_boot_keys_to_default
Type:integer
Default:20

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

clean_priority_clear_secure_boot_keys
Type:integer
Default:0

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_reset_ilo_credential
Type:integer
Default:30

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.

power_retry
Type:integer
Default:6

Number of times a power operation needs to be retried

power_wait
Type:integer
Default:2

Amount of time in seconds to wait in between power operations

ca_file
Type:string
Default:<None>

CA certificate file to validate iLO.

default_boot_mode
Type:string
Default:auto
Valid Values:auto, bios, uefi

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.

Possible values

auto
based on boot mode settings on the system
bios
BIOS boot mode
uefi
UEFI boot mode

inspector

auth_url
Type:unknown type
Default:<None>

Authentication URL

auth_type
Type:unknown type
Default:<None>

Authentication type to load

Deprecated Variations
Group Name
inspector auth_plugin
cafile
Type:string
Default:<None>

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile
Type:string
Default:<None>

PEM encoded client certificate cert file

collect_timing
Type:boolean
Default:false

Collect per-API call timing information.

default_domain_id
Type:unknown type
Default:<None>

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

default_domain_name
Type:unknown type
Default:<None>

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

domain_id
Type:unknown type
Default:<None>

Domain ID to scope to

domain_name
Type:unknown type
Default:<None>

Domain name to scope to

enabled
Type:boolean
Default:false

This option has no affect since the classic drivers removal.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

endpoint_override
Type:string
Default:<None>

Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the version, min-version, and/or max-version options.

insecure
Type:boolean
Default:false

Verify HTTPS connections.

keyfile
Type:string
Default:<None>

PEM encoded client certificate key file

max_version
Type:string
Default:<None>

The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version.

min_version
Type:string
Default:<None>

The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is “latest”.

password
Type:unknown type
Default:<None>

User’s password

project_domain_id
Type:unknown type
Default:<None>

Domain ID containing project

project_domain_name
Type:unknown type
Default:<None>

Domain name containing project

project_id
Type:unknown type
Default:<None>

Project ID to scope to

Deprecated Variations
Group Name
inspector tenant-id
inspector tenant_id
project_name
Type:unknown type
Default:<None>

Project name to scope to

Deprecated Variations
Group Name
inspector tenant-name
inspector tenant_name
region_name
Type:string
Default:<None>

The default region_name for endpoint URL discovery.

service_name
Type:string
Default:<None>

The default service_name for endpoint URL discovery.

service_type
Type:string
Default:baremetal-introspection

The default service_type for endpoint URL discovery.

service_url
Type:string
Default:<None>

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

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Use [inspector]/endpoint_override option instead to set a specific ironic-inspector API URL to connect to.
split_loggers
Type:boolean
Default:false

Log requests to multiple loggers.

status_check_period
Type:integer
Default:60

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

system_scope
Type:unknown type
Default:<None>

Scope for system operations

tenant_id
Type:unknown type
Default:<None>

Tenant ID

tenant_name
Type:unknown type
Default:<None>

Tenant Name

timeout
Type:integer
Default:<None>

Timeout value for http requests

trust_id
Type:unknown type
Default:<None>

Trust ID

user_domain_id
Type:unknown type
Default:<None>

User’s domain id

user_domain_name
Type:unknown type
Default:<None>

User’s domain name

user_id
Type:unknown type
Default:<None>

User id

username
Type:unknown type
Default:<None>

Username

Deprecated Variations
Group Name
inspector user-name
inspector user_name
valid_interfaces
Type:list
Default:internal,public

List of interfaces, in order of preference, for endpoint URL.

version
Type:string
Default:<None>

Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version

ipmi

command_retry_timeout
Type:integer
Default:60

Maximum time in seconds to retry retryable IPMI operations. (An operation is retryable, for example, if the requested operation fails because the BMC is busy.) Setting this too high can cause the sync power state periodic task to hang when there are slow or unresponsive BMCs.

retry_timeout
Type:integer
Default:<None>

Maximum time in seconds to retry IPMI operations. Setting this too high can cause the sync power state periodic task to hang when there are slow or unresponsive BMCs.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Use option [ipmi]/command_retry_timeout to specify the timeout value for IPMI command retries, and use option [conductor]/power_state_change_timeout to specify the timeout value for waiting for a power operation to complete so that a baremetal node reaches the desired power state.
min_command_interval
Type:integer
Default:5

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.

irmc

remote_image_share_root
Type:string
Default:/remote_image_share_root

Ironic conductor node’s “NFS” or “CIFS” root path

remote_image_server
Type:string
Default:<None>

IP of remote image server

remote_image_share_type
Type:string
Default:CIFS
Valid Values:CIFS, NFS

Share type of virtual media

Possible values

CIFS
CIFS (Common Internet File System) protocol
NFS
NFS (Network File System) protocol
remote_image_share_name
Type:string
Default:share

share name of remote_image_server

remote_image_user_name
Type:string
Default:<None>

User name of remote_image_server

remote_image_user_password
Type:string
Default:<None>

Password of remote_image_user_name

remote_image_user_domain
Type:string
Default:u''

Domain name of remote_image_user_name

port
Type:port number
Default:443
Minimum Value:0
Maximum Value:65535
Valid Values:443, 80

Port to be used for iRMC operations

Possible values

443
port 443
80
port 80
auth_method
Type:string
Default:basic
Valid Values:basic, digest

Authentication method to be used for iRMC operations

Possible values

basic
Basic authentication
digest
Digest authentication
client_timeout
Type:integer
Default:60

Timeout (in seconds) for iRMC operations

sensor_method
Type:string
Default:ipmitool
Valid Values:ipmitool, scci

Sensor data retrieval method.

Possible values

ipmitool
IPMItool
scci
Fujitsu SCCI (ServerView Common Command Interface)
snmp_version
Type:string
Default:v2c
Valid Values:v1, v2c, v3

SNMP protocol version

Possible values

v1
SNMPv1
v2c
SNMPv2c
v3
SNMPv3
snmp_port
Type:port number
Default:161
Minimum Value:0
Maximum Value:65535

SNMP port

snmp_community
Type:string
Default:public

SNMP community. Required for versions “v1” and “v2c”

snmp_security
Type:string
Default:<None>

SNMP security name. Required for version “v3”

snmp_polling_interval
Type:integer
Default:10

SNMP polling interval in seconds

clean_priority_restore_irmc_bios_config
Type:integer
Default:0

Priority for restore_irmc_bios_config clean step.

gpu_ids
Type:list
Default:u''

List of vendor IDs and device IDs for GPU device to inspect. List items are in format vendorID/deviceID and separated by commas. GPU inspection will use this value to count the number of GPU device in a node. If this option is not defined, then leave out pci_gpu_devices in capabilities property. Sample gpu_ids value: 0x1000/0x0079,0x2100/0x0080

fpga_ids
Type:list
Default:u''

List of vendor IDs and device IDs for CPU FPGA to inspect. List items are in format vendorID/deviceID and separated by commas. CPU inspection will use this value to find existence of CPU FPGA in a node. If this option is not defined, then leave out CUSTOM_CPU_FPGA in node traits. Sample fpga_ids value: 0x1000/0x0079,0x2100/0x0080

query_raid_config_fgi_status_interval
Type:integer
Default:300
Minimum Value:1

Interval (in seconds) between periodic RAID status checks to determine whether the asynchronous RAID configuration was successfully finished or not. Foreground Initialization (FGI) will start 5 minutes after creating virtual drives.

ironic_lib

root_helper
Type:string
Default:sudo ironic-rootwrap /etc/ironic/rootwrap.conf

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

iscsi

portal_port
Type:port number
Default:3260
Minimum Value:0
Maximum Value:65535

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

keystone_authtoken

www_authenticate_uri
Type:string
Default:<None>

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.

Deprecated Variations
Group Name
keystone_authtoken auth_uri
auth_uri
Type:string
Default:<None>

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. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release.

Warning

This option is deprecated for removal since Queens. Its value may be silently ignored in the future.

Reason:The auth_uri option is deprecated in favor of www_authenticate_uri and will be removed in the S release.
auth_version
Type:string
Default:<None>

API version of the admin Identity API endpoint.

delay_auth_decision
Type:boolean
Default:false

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

http_connect_timeout
Type:integer
Default:<None>

Request timeout value for communicating with Identity API server.

http_request_max_retries
Type:integer
Default:3

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

cache
Type:string
Default:<None>

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.

certfile
Type:string
Default:<None>

Required if identity server requires client certificate

keyfile
Type:string
Default:<None>

Required if identity server requires client certificate

cafile
Type:string
Default:<None>

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

insecure
Type:boolean
Default:false

Verify HTTPS connections.

region_name
Type:string
Default:<None>

The region in which the identity server can be found.

signing_dir
Type:string
Default:<None>

Directory used to cache files related to PKI tokens. This option has been deprecated in the Ocata release and will be removed in the P release.

Warning

This option is deprecated for removal since Ocata. Its value may be silently ignored in the future.

Reason:PKI token format is no longer supported.
memcached_servers
Type:list
Default:<None>

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

Deprecated Variations
Group Name
keystone_authtoken memcache_servers
token_cache_time
Type:integer
Default:300

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.

revocation_cache_time
Type:integer
Default:10

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. This option has been deprecated in the Ocata release and will be removed in the P release.

Warning

This option is deprecated for removal since Ocata. Its value may be silently ignored in the future.

Reason:PKI token format is no longer supported.
memcache_security_strategy
Type:string
Default:None
Valid Values:None, MAC, ENCRYPT

(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_secret_key
Type:string
Default:<None>

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

memcache_pool_dead_retry
Type:integer
Default:300

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

memcache_pool_maxsize
Type:integer
Default:10

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

memcache_pool_socket_timeout
Type:integer
Default:3

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

memcache_pool_unused_timeout
Type:integer
Default:60

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

memcache_pool_conn_get_timeout
Type:integer
Default:10

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

memcache_use_advanced_pool
Type:boolean
Default:false

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

include_service_catalog
Type:boolean
Default:true

(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.

enforce_token_bind
Type:string
Default:permissive

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.

check_revocations_for_cached
Type:boolean
Default:false

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

Warning

This option is deprecated for removal since Ocata. Its value may be silently ignored in the future.

Reason:PKI token format is no longer supported.
hash_algorithms
Type:list
Default:md5

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.

Warning

This option is deprecated for removal since Ocata. Its value may be silently ignored in the future.

Reason:PKI token format is no longer supported.
service_token_roles
Type:list
Default:service

A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check.

service_token_roles_required
Type:boolean
Default:false

For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible.

auth_type
Type:unknown type
Default:<None>

Authentication type to load

Deprecated Variations
Group Name
keystone_authtoken auth_plugin
auth_section
Type:unknown type
Default:<None>

Config Section from which to load plugin specific options

matchmaker_redis

host
Type:string
Default:127.0.0.1

Host to locate redis.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Replaced by [DEFAULT]/transport_url
port
Type:port number
Default:6379
Minimum Value:0
Maximum Value:65535

Use this port to connect to redis host.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Replaced by [DEFAULT]/transport_url
password
Type:string
Default:u''

Password for Redis server (optional).

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Replaced by [DEFAULT]/transport_url
sentinel_hosts
Type:list
Default:u''

List of Redis Sentinel hosts (fault tolerance mode), e.g., [host:port, host1:port … ]

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Replaced by [DEFAULT]/transport_url
sentinel_group_name
Type:string
Default:oslo-messaging-zeromq

Redis replica set name.

wait_timeout
Type:integer
Default:2000

Time in ms to wait between connection attempts.

check_timeout
Type:integer
Default:20000

Time in ms to wait before the transaction is killed.

socket_timeout
Type:integer
Default:10000

Timeout in ms on blocking socket operations.

metrics

agent_backend
Type:string
Default:noop

Backend for the agent ramdisk to use for metrics. Default possible backends are “noop” and “statsd”.

agent_prepend_host
Type:boolean
Default:false

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_uuid
Type:boolean
Default:false

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.

agent_prepend_host_reverse
Type:boolean
Default:true

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_global_prefix
Type:string
Default:<None>

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.

backend
Type:string
Default:noop
Valid Values:noop, statsd

Backend to use for the metrics system.

prepend_host
Type:boolean
Default:false

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

prepend_host_reverse
Type:boolean
Default:true

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

global_prefix
Type:string
Default:<None>

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.

metrics_statsd

agent_statsd_host
Type:string
Default:localhost

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
Type:port number
Default:8125
Minimum Value:0
Maximum Value:65535

Port for the agent ramdisk to use with the statsd backend.

statsd_host
Type:string
Default:localhost

Host for use with the statsd backend.

statsd_port
Type:port number
Default:8125
Minimum Value:0
Maximum Value:65535

Port to use with the statsd backend.

neutron

auth_url
Type:unknown type
Default:<None>

Authentication URL

auth_strategy
Type:string
Default:keystone
Valid Values:keystone, noauth

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.

Possible values

keystone
use the Identity service for authentication
noauth
no authentication

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:To configure neutron for noauth mode, set [neutron]/auth_type = none and [neutron]/endpoint_override=<NEUTRON_API_URL> instead
auth_type
Type:unknown type
Default:<None>

Authentication type to load

Deprecated Variations
Group Name
neutron auth_plugin
cafile
Type:string
Default:<None>

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile
Type:string
Default:<None>

PEM encoded client certificate cert file

cleaning_network
Type:string
Default:<None>

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.

Deprecated Variations
Group Name
neutron cleaning_network_uuid
cleaning_network_security_groups
Type:list
Default:u''

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.

collect_timing
Type:boolean
Default:false

Collect per-API call timing information.

default_domain_id
Type:unknown type
Default:<None>

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

default_domain_name
Type:unknown type
Default:<None>

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

domain_id
Type:unknown type
Default:<None>

Domain ID to scope to

domain_name
Type:unknown type
Default:<None>

Domain name to scope to

endpoint_override
Type:string
Default:<None>

Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the version, min-version, and/or max-version options.

insecure
Type:boolean
Default:false

Verify HTTPS connections.

keyfile
Type:string
Default:<None>

PEM encoded client certificate key file

max_version
Type:string
Default:<None>

The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version.

min_version
Type:string
Default:<None>

The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is “latest”.

password
Type:unknown type
Default:<None>

User’s password

port_setup_delay
Type:integer
Default:0
Minimum Value:0

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

project_domain_id
Type:unknown type
Default:<None>

Domain ID containing project

project_domain_name
Type:unknown type
Default:<None>

Domain name containing project

project_id
Type:unknown type
Default:<None>

Project ID to scope to

Deprecated Variations
Group Name
neutron tenant-id
neutron tenant_id
project_name
Type:unknown type
Default:<None>

Project name to scope to

Deprecated Variations
Group Name
neutron tenant-name
neutron tenant_name
provisioning_network
Type:string
Default:<None>

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.

Deprecated Variations
Group Name
neutron provisioning_network_uuid
provisioning_network_security_groups
Type:list
Default:u''

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.

region_name
Type:string
Default:<None>

The default region_name for endpoint URL discovery.

rescuing_network
Type:string
Default:<None>

Neutron network UUID or name for booting the ramdisk for rescue mode. This is not the network that the rescue ramdisk will use post-boot – the tenant network is used for that. Required for “neutron” network interface, if rescue mode will be used. It is not used for the “flat” or “noop” network interfaces. If a name is provided, it must be unique among all networks or rescue will fail.

rescuing_network_security_groups
Type:list
Default:u''

List of Neutron Security Group UUIDs to be applied during the node rescue process. Optional for the “neutron” network interface and not used for the “flat” or “noop” network interfaces. If not specified, the default security group is used.

retries
Type:integer
Default:3

Client retries in the case of a failed request.

service_name
Type:string
Default:<None>

The default service_name for endpoint URL discovery.

service_type
Type:string
Default:network

The default service_type for endpoint URL discovery.

split_loggers
Type:boolean
Default:false

Log requests to multiple loggers.

system_scope
Type:unknown type
Default:<None>

Scope for system operations

tenant_id
Type:unknown type
Default:<None>

Tenant ID

tenant_name
Type:unknown type
Default:<None>

Tenant Name

timeout
Type:integer
Default:<None>

Timeout value for http requests

trust_id
Type:unknown type
Default:<None>

Trust ID

url
Type:string
Default:<None>

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’.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Use [neutron]/endpoint_override option instead. It has no default value and must be set explicitly if required to connect to specific neutron URL, for example in stand alone mode when [neutron]/auth_type is ‘none’.
url_timeout
Type:integer
Default:30

Timeout value for connecting to neutron in seconds.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Set the desired value explicitly using the [neutron]/timeout option instead.
user_domain_id
Type:unknown type
Default:<None>

User’s domain id

user_domain_name
Type:unknown type
Default:<None>

User’s domain name

user_id
Type:unknown type
Default:<None>

User id

username
Type:unknown type
Default:<None>

Username

Deprecated Variations
Group Name
neutron user-name
neutron user_name
valid_interfaces
Type:list
Default:internal,public

List of interfaces, in order of preference, for endpoint URL.

version
Type:string
Default:<None>

Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version

oneview

manager_url
Type:string
Default:<None>

URL where OneView is available.

username
Type:string
Default:<None>

OneView username to be used.

password
Type:string
Default:<None>

OneView password to be used.

allow_insecure_connections
Type:boolean
Default:false

Option to allow insecure connection with OneView.

tls_cacert_file
Type:string
Default:<None>

Path to CA certificate.

enable_periodic_tasks
Type:boolean
Default:true

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.

periodic_check_interval
Type:integer
Default:300

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

oslo_concurrency

disable_process_locking
Type:boolean
Default:false

Enables or disables inter-process locks.

Deprecated Variations
Group Name
DEFAULT disable_process_locking
lock_path
Type:string
Default:<None>

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.

Deprecated Variations
Group Name
DEFAULT lock_path

oslo_messaging_amqp

container_name
Type:string
Default:<None>

Name for the AMQP container. must be globally unique. Defaults to a generated UUID

Deprecated Variations
Group Name
amqp1 container_name
idle_timeout
Type:integer
Default:0

Timeout for inactive connections (in seconds)

Deprecated Variations
Group Name
amqp1 idle_timeout
trace
Type:boolean
Default:false

Debug: dump AMQP frames to stdout

Deprecated Variations
Group Name
amqp1 trace
ssl
Type:boolean
Default:false

Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate.

ssl_ca_file
Type:string
Default:u''

CA certificate PEM file used to verify the server’s certificate

Deprecated Variations
Group Name
amqp1 ssl_ca_file
ssl_cert_file
Type:string
Default:u''

Self-identifying certificate PEM file for client authentication

Deprecated Variations
Group Name
amqp1 ssl_cert_file
ssl_key_file
Type:string
Default:u''

Private key PEM file used to sign ssl_cert_file certificate (optional)

Deprecated Variations
Group Name
amqp1 ssl_key_file
ssl_key_password
Type:string
Default:<None>

Password for decrypting ssl_key_file (if encrypted)

Deprecated Variations
Group Name
amqp1 ssl_key_password
ssl_verify_vhost
Type:boolean
Default:false

By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name.

allow_insecure_clients
Type:boolean
Default:false

Accept clients using either SSL or plain TCP

Deprecated Variations
Group Name
amqp1 allow_insecure_clients

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Not applicable - not a SSL server
sasl_mechanisms
Type:string
Default:u''

Space separated list of acceptable SASL mechanisms

Deprecated Variations
Group Name
amqp1 sasl_mechanisms
sasl_config_dir
Type:string
Default:u''

Path to directory that contains the SASL configuration

Deprecated Variations
Group Name
amqp1 sasl_config_dir
sasl_config_name
Type:string
Default:u''

Name of configuration file (without .conf suffix)

Deprecated Variations
Group Name
amqp1 sasl_config_name
sasl_default_realm
Type:string
Default:u''

SASL realm to use if no realm present in username

username
Type:string
Default:u''

User name for message broker authentication

Deprecated Variations
Group Name
amqp1 username

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Should use configuration option transport_url to provide the username.
password
Type:string
Default:u''

Password for message broker authentication

Deprecated Variations
Group Name
amqp1 password

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Should use configuration option transport_url to provide the password.
connection_retry_interval
Type:integer
Default:1
Minimum Value:1

Seconds to pause before attempting to re-connect.

connection_retry_backoff
Type:integer
Default:2
Minimum Value:0

Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt.

connection_retry_interval_max
Type:integer
Default:30
Minimum Value:1

Maximum limit for connection_retry_interval + connection_retry_backoff

Type:integer
Default:10
Minimum Value:1

Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error.

default_reply_retry
Type:integer
Default:0
Minimum Value:-1

The maximum number of attempts to re-send a reply message which failed due to a recoverable error.

default_reply_timeout
Type:integer
Default:30
Minimum Value:5

The deadline for an rpc reply message delivery.

default_send_timeout
Type:integer
Default:30
Minimum Value:5

The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry.

default_notify_timeout
Type:integer
Default:30
Minimum Value:5

The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry.

Type:integer
Default:600
Minimum Value:1

The duration to schedule a purge of idle sender links. Detach link after expiry.

addressing_mode
Type:string
Default:dynamic

Indicates the addressing mode used by the driver. Permitted values: ‘legacy’ - use legacy non-routable addressing ‘routable’ - use routable addresses ‘dynamic’ - use legacy addresses if the message bus does not support routing otherwise use routable addressing

pseudo_vhost
Type:boolean
Default:true

Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private ‘subnet’ per virtual host. Set to False if the message bus supports virtual hosting using the ‘hostname’ field in the AMQP 1.0 Open performative as the name of the virtual host.

server_request_prefix
Type:string
Default:exclusive

address prefix used when sending to a specific server

Deprecated Variations
Group Name
amqp1 server_request_prefix
broadcast_prefix
Type:string
Default:broadcast

address prefix used when broadcasting to all servers

Deprecated Variations
Group Name
amqp1 broadcast_prefix
group_request_prefix
Type:string
Default:unicast

address prefix when sending to any server in group

Deprecated Variations
Group Name
amqp1 group_request_prefix
rpc_address_prefix
Type:string
Default:openstack.org/om/rpc

Address prefix for all generated RPC addresses

notify_address_prefix
Type:string
Default:openstack.org/om/notify

Address prefix for all generated Notification addresses

multicast_address
Type:string
Default:multicast

Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages.

unicast_address
Type:string
Default:unicast

Appended to the address prefix when sending to a particular RPC/Notification server. Used by the message bus to identify messages sent to a single destination.

anycast_address
Type:string
Default:anycast

Appended to the address prefix when sending to a group of consumers. Used by the message bus to identify messages that should be delivered in a round-robin fashion across consumers.

default_notification_exchange
Type:string
Default:<None>

Exchange name used in notification addresses. Exchange name resolution precedence: Target.exchange if set else default_notification_exchange if set else control_exchange if set else ‘notify’

default_rpc_exchange
Type:string
Default:<None>

Exchange name used in RPC addresses. Exchange name resolution precedence: Target.exchange if set else default_rpc_exchange if set else control_exchange if set else ‘rpc’

Type:integer
Default:200
Minimum Value:1

Window size for incoming RPC Reply messages.

rpc_server_credit
Type:integer
Default:100
Minimum Value:1

Window size for incoming RPC Request messages

notify_server_credit
Type:integer
Default:100
Minimum Value:1

Window size for incoming Notification messages

pre_settled
Type:multi-valued
Default:rpc-cast
Default:rpc-reply

Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: ‘rpc-call’ - send RPC Calls pre-settled ‘rpc-reply’- send RPC Replies pre-settled ‘rpc-cast’ - Send RPC Casts pre-settled ‘notify’ - Send Notifications pre-settled

oslo_messaging_kafka

kafka_default_host
Type:string
Default:localhost

Default Kafka broker Host

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Replaced by [DEFAULT]/transport_url
kafka_default_port
Type:port number
Default:9092
Minimum Value:0
Maximum Value:65535

Default Kafka broker Port

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Replaced by [DEFAULT]/transport_url
kafka_max_fetch_bytes
Type:integer
Default:1048576

Max fetch bytes of Kafka consumer

kafka_consumer_timeout
Type:floating point
Default:1.0

Default timeout(s) for Kafka consumers

pool_size
Type:integer
Default:10

Pool Size for Kafka Consumers

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Driver no longer uses connection pool.
conn_pool_min_size
Type:integer
Default:2

The pool size limit for connections expiration policy

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Driver no longer uses connection pool.
conn_pool_ttl
Type:integer
Default:1200

The time-to-live in sec of idle connections in the pool

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Driver no longer uses connection pool.
consumer_group
Type:string
Default:oslo_messaging_consumer

Group id for Kafka consumer. Consumers in one group will coordinate message consumption

producer_batch_timeout
Type:floating point
Default:0.0

Upper bound on the delay for KafkaProducer batching in seconds

producer_batch_size
Type:integer
Default:16384

Size of batch for the producer async send

enable_auto_commit
Type:boolean
Default:false

Enable asynchronous consumer commits

max_poll_records
Type:integer
Default:500

The maximum number of records returned in a poll call

security_protocol
Type:string
Default:PLAINTEXT
Valid Values:PLAINTEXT, SASL_PLAINTEXT, SSL, SASL_SSL

Protocol used to communicate with brokers

sasl_mechanism
Type:string
Default:PLAIN

Mechanism when security protocol is SASL

ssl_cafile
Type:string
Default:u''

CA certificate PEM file used to verify the server certificate

oslo_messaging_notifications

driver
Type:multi-valued
Default:u''

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

Deprecated Variations
Group Name
DEFAULT notification_driver
transport_url
Type:string
Default:<None>

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

Deprecated Variations
Group Name
DEFAULT notification_transport_url
topics
Type:list
Default:notifications

AMQP topic used for OpenStack notifications.

Deprecated Variations
Group Name
rpc_notifier2 topics
DEFAULT notification_topics
retry
Type:integer
Default:-1

The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite

oslo_messaging_rabbit

amqp_durable_queues
Type:boolean
Default:false

Use durable queues in AMQP.

Deprecated Variations
Group Name
DEFAULT amqp_durable_queues
DEFAULT rabbit_durable_queues
amqp_auto_delete
Type:boolean
Default:false

Auto-delete queues in AMQP.

Deprecated Variations
Group Name
DEFAULT amqp_auto_delete
ssl
Type:boolean
Default:false

Connect over SSL.

Deprecated Variations
Group Name
oslo_messaging_rabbit rabbit_use_ssl
ssl_version
Type:string
Default:u''

SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.

Deprecated Variations
Group Name
oslo_messaging_rabbit kombu_ssl_version
ssl_key_file
Type:string
Default:u''

SSL key file (valid only if SSL enabled).

Deprecated Variations
Group Name
oslo_messaging_rabbit kombu_ssl_keyfile
ssl_cert_file
Type:string
Default:u''

SSL cert file (valid only if SSL enabled).

Deprecated Variations
Group Name
oslo_messaging_rabbit kombu_ssl_certfile
ssl_ca_file
Type:string
Default:u''

SSL certification authority file (valid only if SSL enabled).

Deprecated Variations
Group Name
oslo_messaging_rabbit kombu_ssl_ca_certs
kombu_reconnect_delay
Type:floating point
Default:1.0

How long to wait before reconnecting in response to an AMQP consumer cancel notification.

Deprecated Variations
Group Name
DEFAULT kombu_reconnect_delay
kombu_compression
Type:string
Default:<None>

EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions.

kombu_missing_consumer_retry_timeout
Type:integer
Default:60

How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout.

Deprecated Variations
Group Name
oslo_messaging_rabbit kombu_reconnect_timeout
kombu_failover_strategy
Type:string
Default:round-robin
Valid Values:round-robin, shuffle

Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config.

rabbit_host
Type:string
Default:localhost

The RabbitMQ broker address where a single node is used.

Deprecated Variations
Group Name
DEFAULT rabbit_host

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Replaced by [DEFAULT]/transport_url
rabbit_port
Type:port number
Default:5672
Minimum Value:0
Maximum Value:65535

The RabbitMQ broker port where a single node is used.

Deprecated Variations
Group Name
DEFAULT rabbit_port

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Replaced by [DEFAULT]/transport_url
rabbit_hosts
Type:list
Default:$rabbit_host:$rabbit_port

RabbitMQ HA cluster host:port pairs.

Deprecated Variations
Group Name
DEFAULT rabbit_hosts

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Replaced by [DEFAULT]/transport_url
rabbit_userid
Type:string
Default:guest

The RabbitMQ userid.

Deprecated Variations
Group Name
DEFAULT rabbit_userid

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Replaced by [DEFAULT]/transport_url
rabbit_password
Type:string
Default:guest

The RabbitMQ password.

Deprecated Variations
Group Name
DEFAULT rabbit_password

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Replaced by [DEFAULT]/transport_url
rabbit_login_method
Type:string
Default:AMQPLAIN
Valid Values:PLAIN, AMQPLAIN, RABBIT-CR-DEMO

The RabbitMQ login method.

Deprecated Variations
Group Name
DEFAULT rabbit_login_method
rabbit_virtual_host
Type:string
Default:/

The RabbitMQ virtual host.

Deprecated Variations
Group Name
DEFAULT rabbit_virtual_host

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:Replaced by [DEFAULT]/transport_url
rabbit_retry_interval
Type:integer
Default:1

How frequently to retry connecting with RabbitMQ.

rabbit_retry_backoff
Type:integer
Default:2

How long to backoff for between retries when connecting to RabbitMQ.

Deprecated Variations
Group Name
DEFAULT rabbit_retry_backoff
rabbit_interval_max
Type:integer
Default:30

Maximum interval of RabbitMQ connection retries. Default is 30 seconds.

rabbit_max_retries
Type:integer
Default:0

Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).

Deprecated Variations
Group Name
DEFAULT rabbit_max_retries

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

rabbit_ha_queues
Type:boolean
Default:false

Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: “rabbitmqctl set_policy HA ‘^(?!amq.).*’ ‘{“ha-mode”: “all”}’ “

Deprecated Variations
Group Name
DEFAULT rabbit_ha_queues
rabbit_transient_queues_ttl
Type:integer
Default:1800
Minimum Value:1

Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues.

rabbit_qos_prefetch_count
Type:integer
Default:0

Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.

heartbeat_timeout_threshold
Type:integer
Default:60

Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disable the heartbeat). EXPERIMENTAL

heartbeat_rate
Type:integer
Default:2

How often times during the heartbeat_timeout_threshold we check the heartbeat.

oslo_messaging_zmq

rpc_zmq_bind_address
Type:string
Default:*

ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The “host” option should point or resolve to this address.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_bind_address
rpc_zmq_matchmaker
Type:string
Default:redis
Valid Values:redis, sentinel, dummy

MatchMaker driver.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_matchmaker
rpc_zmq_contexts
Type:integer
Default:1

Number of ZeroMQ contexts, defaults to 1.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_contexts
rpc_zmq_topic_backlog
Type:integer
Default:<None>

Maximum number of ingress messages to locally buffer per topic. Default is unlimited.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_topic_backlog
rpc_zmq_ipc_dir
Type:string
Default:/var/run/openstack

Directory for holding IPC sockets.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_ipc_dir
rpc_zmq_host
Type:string
Default:localhost

Name of this node. Must be a valid hostname, FQDN, or IP address. Must match “host” option, if running Nova.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_host
zmq_linger
Type:integer
Default:-1

Number of seconds to wait before all pending messages will be sent after closing a socket. 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. Positive values specify an upper bound for the linger period.

Deprecated Variations
Group Name
DEFAULT rpc_cast_timeout
rpc_poll_timeout
Type:integer
Default:1

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

Deprecated Variations
Group Name
DEFAULT rpc_poll_timeout
zmq_target_expire
Type:integer
Default:300

Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).

Deprecated Variations
Group Name
DEFAULT zmq_target_expire
zmq_target_update
Type:integer
Default:180

Update period in seconds of a name service record about existing target.

Deprecated Variations
Group Name
DEFAULT zmq_target_update
use_pub_sub
Type:boolean
Default:false

Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.

Deprecated Variations
Group Name
DEFAULT use_pub_sub
use_router_proxy
Type:boolean
Default:false

Use ROUTER remote proxy.

Deprecated Variations
Group Name
DEFAULT use_router_proxy
use_dynamic_connections
Type:boolean
Default:false

This option makes direct connections dynamic or static. It makes sense only with use_router_proxy=False which means to use direct connections for direct message types (ignored otherwise).

zmq_failover_connections
Type:integer
Default:2

How many additional connections to a host will be made for failover reasons. This option is actual only in dynamic connections mode.

rpc_zmq_min_port
Type:port number
Default:49153
Minimum Value:0
Maximum Value:65535

Minimal port number for random ports range.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_min_port
rpc_zmq_max_port
Type:integer
Default:65536
Minimum Value:1
Maximum Value:65536

Maximal port number for random ports range.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_max_port
rpc_zmq_bind_port_retries
Type:integer
Default:100

Number of retries to find free port number before fail with ZMQBindError.

Deprecated Variations
Group Name
DEFAULT rpc_zmq_bind_port_retries
rpc_zmq_serialization
Type:string
Default:json
Valid Values:json, msgpack

Default serialization mechanism for serializing/deserializing outgoing/incoming messages

Deprecated Variations
Group Name
DEFAULT rpc_zmq_serialization
zmq_immediate
Type:boolean
Default:true

This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it.

zmq_tcp_keepalive
Type:integer
Default:-1

Enable/disable TCP keepalive (KA) mechanism. The default value of -1 (or any other negative value) means to skip any overrides and leave it to OS default; 0 and 1 (or any other positive value) mean to disable and enable the option respectively.

zmq_tcp_keepalive_idle
Type:integer
Default:-1

The duration between two keepalive transmissions in idle condition. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

zmq_tcp_keepalive_cnt
Type:integer
Default:-1

The number of retransmissions to be carried out before declaring that remote end is not available. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

zmq_tcp_keepalive_intvl
Type:integer
Default:-1

The duration between two successive keepalive retransmissions, if acknowledgement to the previous keepalive transmission is not received. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

rpc_thread_pool_size
Type:integer
Default:100

Maximum number of (green) threads to work concurrently.

rpc_message_ttl
Type:integer
Default:300

Expiration timeout in seconds of a sent/received message after which it is not tracked anymore by a client/server.

rpc_use_acks
Type:boolean
Default:false

Wait for message acknowledgements from receivers. This mechanism works only via proxy without PUB/SUB.

rpc_ack_timeout_base
Type:integer
Default:15

Number of seconds to wait for an ack from a cast/call. After each retry attempt this timeout is multiplied by some specified multiplier.

rpc_ack_timeout_multiplier
Type:integer
Default:2

Number to multiply base ack timeout by after each retry attempt.

rpc_retry_attempts
Type:integer
Default:3

Default number of message sending attempts in case of any problems occurred: positive value N means at most N retries, 0 means no retries, None or -1 (or any other negative values) mean to retry forever. This option is used only if acknowledgments are enabled.

subscribe_on
Type:list
Default:u''

List of publisher hosts SubConsumer can subscribe on. This option has higher priority then the default publishers list taken from the matchmaker.

oslo_policy

enforce_scope
Type:boolean
Default:false

This option controls whether or not to enforce scope when evaluating policies. If True, the scope of the token used in the request is compared to the scope_types of the policy being enforced. If the scopes do not match, an InvalidScope exception will be raised. If False, a message will be logged informing operators that policies are being invoked with mismatching scope.

policy_file
Type:string
Default:policy.json

The file that defines policies.

Deprecated Variations
Group Name
DEFAULT policy_file
policy_default_rule
Type:string
Default:default

Default rule. Enforced when a requested rule is not found.

Deprecated Variations
Group Name
DEFAULT policy_default_rule
policy_dirs
Type:multi-valued
Default:policy.d

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.

Deprecated Variations
Group Name
DEFAULT policy_dirs
remote_content_type
Type:string
Default:application/x-www-form-urlencoded
Valid Values:application/x-www-form-urlencoded, application/json

Content Type to send and receive data for REST based policy check

remote_ssl_verify_server_crt
Type:boolean
Default:false

server identity verification for REST based policy check

remote_ssl_ca_crt_file
Type:string
Default:<None>

Absolute path to ca cert file for REST based policy check

remote_ssl_client_crt_file
Type:string
Default:<None>

Absolute path to client cert for REST based policy check

remote_ssl_client_key_file
Type:string
Default:<None>

Absolute path client key file REST based policy check

profiler

enabled
Type:boolean
Default:false

Enable the profiling for all services on this node.

Default value is False (fully disable the profiling feature).

Possible values:

  • True: Enables the feature
  • False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty.
Deprecated Variations
Group Name
profiler profiler_enabled
trace_sqlalchemy
Type:boolean
Default:false

Enable SQL requests profiling in services.

Default value is False (SQL requests won’t be traced).

Possible values:

  • True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that.
  • False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way.
hmac_keys
Type:string
Default:SECRET_KEY

Secret key(s) to use for encrypting context data for performance profiling.

This string value should have the following format: <key1>[,<key2>,…<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project.

Both “enabled” flag and “hmac_keys” config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources.

connection_string
Type:string
Default:messaging://

Connection string for a notifier backend.

Default value is messaging:// which sets the notifier to oslo_messaging.

Examples of possible values:

  • messaging:// - use oslo_messaging driver for sending spans.
  • redis://127.0.0.1:6379 - use redis driver for sending spans.
  • mongodb://127.0.0.1:27017 - use mongodb driver for sending spans.
  • elasticsearch://127.0.0.1:9200 - use elasticsearch driver for sending spans.
  • jaeger://127.0.0.1:6831 - use jaeger tracing as driver for sending spans.
es_doc_type
Type:string
Default:notification

Document type for notification indexing in elasticsearch.

es_scroll_time
Type:string
Default:2m

This parameter is a time value parameter (for example: es_scroll_time=2m), indicating for how long the nodes that participate in the search will maintain relevant resources in order to continue and support it.

es_scroll_size
Type:integer
Default:10000

Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000).

socket_timeout
Type:floating point
Default:0.1

Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1).

sentinel_service_name
Type:string
Default:mymaster

Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example: sentinal_service_name=mymaster).

filter_error_trace
Type:boolean
Default:false

Enable filter traces that contain error/exception to a separated place.

Default value is set to False.

Possible values:

  • True: Enable filter traces that contain error/exception.
  • False: Disable the filter.

pxe

pxe_append_params
Type:string
Default:nofb nomodeset vga=normal

Additional append parameters for baremetal PXE boot.

default_ephemeral_format
Type:string
Default:ext4

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

images_path
Type:string
Default:/var/lib/ironic/images/

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

instance_master_path
Type:string
Default:/var/lib/ironic/master_images

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

image_cache_size
Type:integer
Default:20480

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

image_cache_ttl
Type:integer
Default:10080

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

pxe_config_template
Type:string
Default:$pybasedir/drivers/modules/pxe_config.template

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

uefi_pxe_config_template
Type:string
Default:$pybasedir/drivers/modules/pxe_grub_config.template

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

pxe_config_template_by_arch
Type:dict
Default:u''

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

tftp_server
Type:string
Default:$my_ip

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

tftp_root
Type:string
Default:/tftpboot

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

tftp_master_path
Type:string
Default:/tftpboot/master_images

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

dir_permission
Type:integer
Default:<None>

The permission that will be applied to the TFTP folders upon creation. This should be set to the permission such that the tftpserver has access to read the contents of the configured TFTP folder. This setting is only required when the operating system’s umask is restrictive such that ironic-conductor is creating files that cannot be read by the TFTP server. Setting to <None> will result in the operating system’s umask to be utilized for the creation of new tftp folders. It is recommended that an octal representation is specified. For example: 0o755

pxe_bootfile_name
Type:string
Default:pxelinux.0

Bootfile DHCP parameter.

uefi_pxe_bootfile_name
Type:string
Default:bootx64.efi

Bootfile DHCP parameter for UEFI boot mode.

pxe_bootfile_name_by_arch
Type:dict
Default:u''

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

ipxe_enabled
Type:boolean
Default:false

Enable iPXE boot.

ipxe_boot_script
Type:string
Default:$pybasedir/drivers/modules/boot.ipxe

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

ipxe_timeout
Type:integer
Default:0

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

ip_version
Type:string
Default:4
Valid Values:4, 6

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

Possible values

4
IPv4
6
IPv6
ipxe_use_swift
Type:boolean
Default:false

Download deploy and rescue 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.

service_catalog

auth_url
Type:unknown type
Default:<None>

Authentication URL

auth_type
Type:unknown type
Default:<None>

Authentication type to load

Deprecated Variations
Group Name
service_catalog auth_plugin
cafile
Type:string
Default:<None>

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile
Type:string
Default:<None>

PEM encoded client certificate cert file

collect_timing
Type:boolean
Default:false

Collect per-API call timing information.

default_domain_id
Type:unknown type
Default:<None>

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

default_domain_name
Type:unknown type
Default:<None>

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

domain_id
Type:unknown type
Default:<None>

Domain ID to scope to

domain_name
Type:unknown type
Default:<None>

Domain name to scope to

endpoint_override
Type:string
Default:<None>

Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the version, min-version, and/or max-version options.

insecure
Type:boolean
Default:false

Verify HTTPS connections.

keyfile
Type:string
Default:<None>

PEM encoded client certificate key file

max_version
Type:string
Default:<None>

The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version.

min_version
Type:string
Default:<None>

The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is “latest”.

password
Type:unknown type
Default:<None>

User’s password

project_domain_id
Type:unknown type
Default:<None>

Domain ID containing project

project_domain_name
Type:unknown type
Default:<None>

Domain name containing project

project_id
Type:unknown type
Default:<None>

Project ID to scope to

Deprecated Variations
Group Name
service_catalog tenant-id
service_catalog tenant_id
project_name
Type:unknown type
Default:<None>

Project name to scope to

Deprecated Variations
Group Name
service_catalog tenant-name
service_catalog tenant_name
region_name
Type:string
Default:<None>

The default region_name for endpoint URL discovery.

service_name
Type:string
Default:<None>

The default service_name for endpoint URL discovery.

service_type
Type:string
Default:baremetal

The default service_type for endpoint URL discovery.

split_loggers
Type:boolean
Default:false

Log requests to multiple loggers.

system_scope
Type:unknown type
Default:<None>

Scope for system operations

tenant_id
Type:unknown type
Default:<None>

Tenant ID

tenant_name
Type:unknown type
Default:<None>

Tenant Name

timeout
Type:integer
Default:<None>

Timeout value for http requests

trust_id
Type:unknown type
Default:<None>

Trust ID

user_domain_id
Type:unknown type
Default:<None>

User’s domain id

user_domain_name
Type:unknown type
Default:<None>

User’s domain name

user_id
Type:unknown type
Default:<None>

User id

username
Type:unknown type
Default:<None>

Username

Deprecated Variations
Group Name
service_catalog user-name
service_catalog user_name
valid_interfaces
Type:list
Default:internal,public

List of interfaces, in order of preference, for endpoint URL.

version
Type:string
Default:<None>

Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version

snmp

power_timeout
Type:integer
Default:10

Seconds to wait for power action to be completed

reboot_delay
Type:integer
Default:0
Minimum Value:0

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

udp_transport_timeout
Type:floating point
Default:1.0
Minimum Value:0.0

Response timeout in seconds used for UDP transport. Timeout should be a multiple of 0.5 seconds and is applicable to each retry.

udp_transport_retries
Type:integer
Default:5
Minimum Value:0

Maximum number of UDP request retries, 0 means no retries.

ssl

ca_file
Type:string
Default:<None>

CA certificate file to use to verify connecting clients.

Deprecated Variations
Group Name
DEFAULT ssl_ca_file
cert_file
Type:string
Default:<None>

Certificate file to use when starting the server securely.

Deprecated Variations
Group Name
DEFAULT ssl_cert_file
key_file
Type:string
Default:<None>

Private key file to use when starting the server securely.

Deprecated Variations
Group Name
DEFAULT ssl_key_file
version
Type:string
Default:<None>

SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.

ciphers
Type:string
Default:<None>

Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format.

swift

auth_url
Type:unknown type
Default:<None>

Authentication URL

auth_type
Type:unknown type
Default:<None>

Authentication type to load

Deprecated Variations
Group Name
swift auth_plugin
cafile
Type:string
Default:<None>

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile
Type:string
Default:<None>

PEM encoded client certificate cert file

collect_timing
Type:boolean
Default:false

Collect per-API call timing information.

default_domain_id
Type:unknown type
Default:<None>

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

default_domain_name
Type:unknown type
Default:<None>

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

domain_id
Type:unknown type
Default:<None>

Domain ID to scope to

domain_name
Type:unknown type
Default:<None>

Domain name to scope to

endpoint_override
Type:string
Default:<None>

Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the version, min-version, and/or max-version options.

insecure
Type:boolean
Default:false

Verify HTTPS connections.

keyfile
Type:string
Default:<None>

PEM encoded client certificate key file

max_version
Type:string
Default:<None>

The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version.

min_version
Type:string
Default:<None>

The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is “latest”.

password
Type:unknown type
Default:<None>

User’s password

project_domain_id
Type:unknown type
Default:<None>

Domain ID containing project

project_domain_name
Type:unknown type
Default:<None>

Domain name containing project

project_id
Type:unknown type
Default:<None>

Project ID to scope to

Deprecated Variations
Group Name
swift tenant-id
swift tenant_id
project_name
Type:unknown type
Default:<None>

Project name to scope to

Deprecated Variations
Group Name
swift tenant-name
swift tenant_name
region_name
Type:string
Default:<None>

The default region_name for endpoint URL discovery.

service_name
Type:string
Default:<None>

The default service_name for endpoint URL discovery.

service_type
Type:string
Default:object-store

The default service_type for endpoint URL discovery.

split_loggers
Type:boolean
Default:false

Log requests to multiple loggers.

swift_max_retries
Type:integer
Default:2

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

system_scope
Type:unknown type
Default:<None>

Scope for system operations

tenant_id
Type:unknown type
Default:<None>

Tenant ID

tenant_name
Type:unknown type
Default:<None>

Tenant Name

timeout
Type:integer
Default:<None>

Timeout value for http requests

trust_id
Type:unknown type
Default:<None>

Trust ID

user_domain_id
Type:unknown type
Default:<None>

User’s domain id

user_domain_name
Type:unknown type
Default:<None>

User’s domain name

user_id
Type:unknown type
Default:<None>

User id

username
Type:unknown type
Default:<None>

Username

Deprecated Variations
Group Name
swift user-name
swift user_name
valid_interfaces
Type:list
Default:internal,public

List of interfaces, in order of preference, for endpoint URL.

version
Type:string
Default:<None>

Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version

xclarity

manager_ip
Type:string
Default:<None>

IP address of the XClarity Controller. Configuration here is deprecated and will be removed in the Stein release. Please update the driver_info field to use “xclarity_manager_ip” instead

username
Type:string
Default:<None>

Username for the XClarity Controller. Configuration here is deprecated and will be removed in the Stein release. Please update the driver_info field to use “xclarity_username” instead

password
Type:string
Default:<None>

Password for XClarity Controller username. Configuration here is deprecated and will be removed in the Stein release. Please update the driver_info field to use “xclarity_password” instead

port
Type:port number
Default:443
Minimum Value:0
Maximum Value:65535

Port to be used for XClarity Controller connection.

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.