admin_role = admin

string value

Role used to identify an authenticated user as administrator.

allow_anonymous_access = False

boolean value

Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware.

api_paste_config = api-paste.ini

string value

File name for the paste.deploy config for api service

backdoor_port = None

string value

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 = None

string value

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. Inside the path {pid} will be replaced with the PID of the current process.

client_socket_timeout = 900

integer value

Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of 0 means wait forever.

conn_pool_min_size = 2

integer value

The pool size limit for connections expiration policy

conn_pool_ttl = 1200

integer value

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

control_exchange = openstack

string value

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

db_auto_create = False

boolean value

Create the Barbican database on service startup.

debug = False

boolean value

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

default_limit_paging = 10

integer value

Default page size for the limit paging URL parameter.

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

list value

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

executor_thread_pool_size = 64

integer value

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

fatal_deprecations = False

boolean value

Enables or disables fatal status of deprecations.

host_href = http://localhost:9311

string value

Host name, for use in HATEOAS-style references Note: Typically this would be the load balanced endpoint that clients would use to communicate back with this service. If a deployment wants to derive host from wsgi request instead then make this blank. Blank is needed to override default config value which is http://localhost:9311

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

string value

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

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

string value

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

log-config-append = None

string value

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, log-date-format).

log-date-format = %Y-%m-%d %H:%M:%S

string value

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

log-dir = None

string value

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

log-file = None

string value

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

log_rotate_interval = 1

integer value

The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval".

log_rotate_interval_type = days

string value

Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation.

log_rotation_type = none

string value

Log rotation type.

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

string value

Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter

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

string value

Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter

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

string value

Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter

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

string value

Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter

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

string value

Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter

max_allowed_request_size_in_bytes = 25000

integer value

Maximum allowed http request size against the barbican-api.

max_allowed_secret_in_bytes = 20000

integer value

Maximum allowed secret size in bytes.

max_header_line = 16384

integer value

Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs).

max_limit_paging = 100

integer value

Maximum page size for the limit paging URL parameter.

max_logfile_count = 30

integer value

Maximum number of rotated log files.

max_logfile_size_mb = 200

integer value

Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size".

publish_errors = False

boolean value

Enables or disables publication of error events.

rate_limit_burst = 0

integer value

Maximum number of logged messages per rate_limit_interval.

rate_limit_except_level = CRITICAL

string value

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.

rate_limit_interval = 0

integer value

Interval, number of seconds, of log rate limiting.

rpc_conn_pool_size = 30

integer value

Size of RPC connection pool.

rpc_ping_enabled = False

boolean value

Add an endpoint to answer to ping calls. Endpoint is named oslo_rpc_server_ping

rpc_response_timeout = 60

integer value

Seconds to wait for a response from a call.

run_external_periodic_tasks = True

boolean value

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

sql_connection = sqlite:///barbican.sqlite

string value

SQLAlchemy connection string for the reference implementation registry server. Any valid SQLAlchemy connection string is fine. See: http://www.sqlalchemy.org/docs/05/reference/sqlalchemy/connections.html#sqlalchemy.create_engine. Note: For absolute addresses, use //// slashes after sqlite:.

sql_idle_timeout = 3600

integer value

Period in seconds after which SQLAlchemy should reestablish its connection to the database. MySQL uses a default wait_timeout of 8 hours, after which it will drop idle connections. This can result in MySQL Gone Away exceptions. If you notice this, you can lower this value to ensure that SQLAlchemy reconnects before MySQL can drop the connection.

sql_max_retries = 60

integer value

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

sql_pool_class = QueuePool

string value

Accepts a class imported from the sqlalchemy.pool module, and handles the details of building the pool for you. If commented out, SQLAlchemy will select based on the database dialect. Other options are QueuePool (for SQLAlchemy-managed connections) and NullPool (to disabled SQLAlchemy management of connections). See http://docs.sqlalchemy.org/en/latest/core/pooling.html for more details

sql_pool_logging = False

boolean value

Show SQLAlchemy pool-related debugging output in logs (sets DEBUG log level output) if specified.

sql_pool_max_overflow = 10

integer value

The maximum overflow size of the pool used by SQLAlchemy. When the number of checked-out connections reaches the size set in sql_pool_size, additional connections will be returned up to this limit. It follows then that the total number of simultaneous connections the pool will allow is sql_pool_size + sql_pool_max_overflow. Can be set to -1 to indicate no overflow limit, so no limit will be placed on the total number of concurrent connections. Comment out to allow SQLAlchemy to select the default.

sql_pool_size = 5

integer value

Size of pool used by SQLAlchemy. This is the largest number of connections that will be kept persistently in the pool. Can be set to 0 to indicate no size limit. To disable pooling, use a NullPool with sql_pool_class instead. Comment out to allow SQLAlchemy to select the default.

sql_retry_interval = 1

integer value

Interval between retries of opening a SQL connection.

syslog-log-facility = LOG_USER

string value

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

tcp_keepidle = 600

integer value

Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.

transport_url = rabbit://

string value

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

use-journal = False

boolean value

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.

use-json = False

boolean value

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

use-syslog = False

boolean value

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_eventlog = False

boolean value

Log output to Windows Event Log.

use_stderr = False

boolean value

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

watch-log-file = False

boolean value

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.

wsgi_default_pool_size = 100

integer value

Size of the pool of greenthreads used by wsgi

wsgi_keep_alive = True

boolean value

If False, closes the client socket connection explicitly.

wsgi_log_format = %(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f

string value

A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.

wsgi_server_debug = False

boolean value

True if the server should send exception tracebacks to the clients on 500 errors. If False, the server will respond with empty bodies.

acs5000_copy_interval = 5

integer value

When volume copy task is going on,refresh volume status interval

acs5000_volpool_name = ['pool01']

list value

Comma separated list of storage system storage pools for volumes.

allocated_capacity_weight_multiplier = -1.0

floating point value

Multiplier used for weighing allocated capacity. Positive numbers mean to stack vs spread.

allow_availability_zone_fallback = False

boolean value

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

allow_compression_on_image_upload = False

boolean value

The strategy to use for image compression on upload. Default is disallow compression.

allowed_direct_url_schemes = []

list value

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

api_paste_config = api-paste.ini

string value

File name for the paste.deploy config for api service

api_rate_limit = True

boolean value

Enables or disables rate limit of the API.

as13000_ipsan_pools = ['Pool0']

list value

The Storage Pools Cinder should use, a comma separated list.

as13000_meta_pool = None

string value

The pool which is used as a meta pool when creating a volume, and it should be a replication pool at present. If not set, the driver will choose a replication pool from the value of as13000_ipsan_pools.

as13000_token_available_time = 3300

integer value

The effective time of token validity in seconds.

auth_strategy = keystone

string value

The strategy to use for auth. Supports noauth or keystone.

az_cache_duration = 3600

integer value

Cache volume availability zones in memory for the provided duration in seconds

backdoor_port = None

string value

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 = None

string value

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. Inside the path {pid} will be replaced with the PID of the current process.

backend_availability_zone = None

string value

Availability zone for this volume backend. If not set, the storage_availability_zone option value is used as the default for all backends.

backend_stats_polling_interval = 60

integer value

Time in seconds between requests for usage statistics from the backend. Be aware that generating usage statistics is expensive for some backends, so setting this value too low may adversely affect performance.

backup_api_class = cinder.backup.api.API

string value

The full class name of the volume backup API class

backup_ceph_chunk_size = 134217728

integer value

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

backup_ceph_conf = /etc/ceph/ceph.conf

string value

Ceph configuration file to use.

backup_ceph_image_journals = False

boolean value

If True, apply JOURNALING and EXCLUSIVE_LOCK feature bits to the backup RBD objects to allow mirroring

backup_ceph_pool = backups

string value

The Ceph pool where volume backups are stored.

backup_ceph_stripe_count = 0

integer value

RBD stripe count to use when creating a backup image.

backup_ceph_stripe_unit = 0

integer value

RBD stripe unit to use when creating a backup image.

backup_ceph_user = cinder

string value

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

backup_compression_algorithm = zlib

string value

Compression algorithm ("none" to disable)

backup_container = None

string value

Custom directory to use for backups.

backup_driver = cinder.backup.drivers.swift.SwiftBackupDriver

string value

Driver to use for backups.

backup_driver_init_check_interval = 60

integer value

Time in seconds between checks to see if the backup driver has been successfully initialized, any time the driver is restarted.

backup_driver_stats_polling_interval = 60

integer value

Time in seconds between checks of the backup driver status. If does not report as working, it is restarted.

backup_enable_progress_timer = True

boolean value

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

backup_file_size = 1999994880

integer value

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

backup_manager = cinder.backup.manager.BackupManager

string value

Full class name for the Manager for volume backup

backup_max_operations = 15

integer value

Maximum number of concurrent memory heavy operations: backup and restore. Value of 0 means unlimited

backup_metadata_version = 2

integer value

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

backup_mount_attempts = 3

integer value

The number of attempts to mount NFS shares before raising an error.

backup_mount_options = None

string value

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

backup_mount_point_base = $state_path/backup_mount

string value

Base dir containing mount point for NFS share.

backup_name_template = backup-%s

string value

Template string to be used to generate backup names

backup_native_threads_pool_size = 60

integer value

Size of the native threads pool for the backups. Most backup drivers rely heavily on this, it can be decreased for specific drivers that don’t.

backup_object_number_per_notification = 10

integer value

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

backup_posix_path = $state_path/backup

string value

Path specifying where to store backups.

backup_s3_block_size = 32768

integer value

The size in bytes that changes are tracked for incremental backups. backup_s3_object_size has to be multiple of backup_s3_block_size.

backup_s3_ca_cert_file = None

string value

path/to/cert/bundle.pem - A filename of the CA cert bundle to use.

backup_s3_enable_progress_timer = True

boolean value

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

backup_s3_endpoint_url = None

string value

The url where the S3 server is listening.

`backup_s3_http_proxy = `

string value

Address or host for the http proxy server.

`backup_s3_https_proxy = `

string value

Address or host for the https proxy server.

backup_s3_max_pool_connections = 10

integer value

The maximum number of connections to keep in a connection pool.

backup_s3_md5_validation = True

boolean value

Enable or Disable md5 validation in the s3 backend.

backup_s3_object_size = 52428800

integer value

The size in bytes of S3 backup objects

backup_s3_retry_max_attempts = 4

integer value

An integer representing the maximum number of retry attempts that will be made on a single request.

backup_s3_retry_mode = legacy

string value

A string representing the type of retry mode. e.g: legacy, standard, adaptive

backup_s3_sse_customer_algorithm = None

string value

The SSECustomerAlgorithm. backup_s3_sse_customer_key must be set at the same time to enable SSE.

backup_s3_sse_customer_key = None

string value

The SSECustomerKey. backup_s3_sse_customer_algorithm must be set at the same time to enable SSE.

backup_s3_store_access_key = None

string value

The S3 query token access key.

backup_s3_store_bucket = volumebackups

string value

The S3 bucket to be used to store the Cinder backup data.

backup_s3_store_secret_key = None

string value

The S3 query token secret key.

backup_s3_timeout = 60

floating point value

The time in seconds till a timeout exception is thrown.

backup_s3_verify_ssl = True

boolean value

Enable or Disable ssl verify.

backup_service_inithost_offload = True

boolean value

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

backup_sha_block_size_bytes = 32768

integer value

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

backup_share = None

string value

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

backup_swift_auth = per_user

string value

Swift authentication mechanism (per_user or single_user).

backup_swift_auth_insecure = False

boolean value

Bypass verification of server certificate when making SSL connection to Swift.

backup_swift_auth_url = None

uri value

The URL of the Keystone endpoint

backup_swift_auth_version = 1

string value

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

backup_swift_block_size = 32768

integer value

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

backup_swift_ca_cert_file = None

string value

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

backup_swift_container = volumebackups

string value

The default Swift container to use

backup_swift_enable_progress_timer = True

boolean value

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

backup_swift_key = None

string value

Swift key for authentication

backup_swift_object_size = 52428800

integer value

The size in bytes of Swift backup objects

backup_swift_project = None

string value

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

backup_swift_project_domain = None

string value

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

backup_swift_retry_attempts = 3

integer value

The number of retries to make for Swift operations

backup_swift_retry_backoff = 2

integer value

The backoff time in seconds between Swift retries

backup_swift_tenant = None

string value

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

backup_swift_url = None

uri value

The URL of the Swift endpoint

backup_swift_user = None

string value

Swift user name

backup_swift_user_domain = None

string value

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

backup_timer_interval = 120

integer value

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

backup_use_same_host = False

boolean value

Backup services use same backend.

backup_use_temp_snapshot = False

boolean value

If this is set to True, a temporary snapshot will be created for performing non-disruptive backups. Otherwise a temporary volume will be cloned in order to perform a backup.

backup_workers = 1

integer value

Number of backup processes to launch. Improves performance with concurrent backups.

capacity_weight_multiplier = 1.0

floating point value

Multiplier used for weighing free capacity. Negative numbers mean to stack vs spread.

`chap_password = `

string value

Password for specified CHAP account name.

chap_password_len = 12

integer value

Length of the random string for CHAP password.

`chap_username = `

string value

CHAP user name.

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

string value

Chiscsi (CXT) global defaults configuration file

cinder_internal_tenant_project_id = None

string value

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

cinder_internal_tenant_user_id = None

string value

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

client_socket_timeout = 900

integer value

Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of 0 means wait forever.

clone_volume_timeout = 680

integer value

Create clone volume timeout Deprecated since: 14.0.0

*Reason:*FusionStorage cinder driver refactored the code with Restful method and the old CLI mode has been abandon. So those configuration items are no longer used.

cloned_volume_same_az = True

boolean value

Ensure that the new volumes are the same AZ as snapshot or source volume

cluster = None

string value

Name of this cluster. Used to group volume hosts that share the same backend configurations to work in HA Active-Active mode.

compression_format = gzip

string value

Image compression format on image upload

compute_api_class = cinder.compute.nova.API

string value

The full class name of the compute API class to use

config-dir = ['~/.project/project.conf.d/', '~/project.conf.d/', '/etc/project/project.conf.d/', '/etc/project.conf.d/']

list value

Path to a config directory to pull *.conf files from. This file set is sorted, so as to provide a predictable parse order if individual options are over-ridden. The set is parsed after the file(s) specified via previous --config-file, arguments hence over-ridden options in the directory take precedence. This option must be set from the command-line.

config-file = ['~/.project/project.conf', '~/project.conf', '/etc/project/project.conf', '/etc/project.conf']

unknown value

Path to a config file to use. Multiple config files can be specified, with values in later files taking precedence. Defaults to %(default)s. This option must be set from the command-line.

config_source = []

list value

Lists configuration groups that provide more details for accessing configuration settings from locations other than local files.

conn_pool_min_size = 2

integer value

The pool size limit for connections expiration policy

conn_pool_ttl = 1200

integer value

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

consistencygroup_api_class = cinder.consistencygroup.api.API

string value

The full class name of the consistencygroup API class

control_exchange = openstack

string value

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

datera_503_interval = 5

integer value

Interval between 503 retries

datera_503_timeout = 120

integer value

Timeout for HTTP 503 retry messages

datera_api_port = 7717

string value

Datera API port.

datera_api_version = 2.2

string value

Datera API version.

datera_debug = False

boolean value

True to set function arg and return logging

datera_debug_replica_count_override = False

boolean value

ONLY FOR DEBUG/TESTING PURPOSES True to set replica_count to 1

datera_disable_extended_metadata = False

boolean value

Set to True to disable sending additional metadata to the Datera backend

datera_disable_profiler = False

boolean value

Set to True to disable profiling in the Datera driver

datera_disable_template_override = False

boolean value

Set to True to disable automatic template override of the size attribute when creating from a template

datera_enable_image_cache = False

boolean value

Set to True to enable Datera backend image caching

datera_image_cache_volume_type_id = None

string value

Cinder volume type id to use for cached volumes

datera_ldap_server = None

string value

LDAP authentication server

datera_tenant_id = None

string value

If set to Map -→ OpenStack project ID will be mapped implicitly to Datera tenant ID If set to None -→ Datera tenant ID will not be used during volume provisioning If set to anything else -→ Datera tenant ID will be the provided value

datera_volume_type_defaults = {}

dict value

Settings here will be used as volume-type defaults if the volume-type setting is not provided. This can be used, for example, to set a very low total_iops_max value if none is specified in the volume-type to prevent accidental overusage. Options are specified via the following format, WITHOUT ANY DF: PREFIX: datera_volume_type_defaults=iops_per_gb:100,bandwidth_per_gb:200…​etc.

db_driver = cinder.db

string value

Driver to use for database access

debug = False

boolean value

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

default_availability_zone = None

string value

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

default_group_type = None

string value

Default group type to use

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

list value

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

default_sandstone_target_ips = []

list value

SandStone default target ip.

default_volume_type = __DEFAULT__

string value

Default volume type to use

driver_client_cert = None

string value

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

driver_client_cert_key = None

string value

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

driver_data_namespace = None

string value

Namespace for driver private data values to be saved in.

driver_ssl_cert_path = None

string value

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

driver_ssl_cert_verify = False

boolean value

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

driver_use_ssl = False

boolean value

Tell driver to use SSL for connection to backend storage if the driver supports it.

dsware_isthin = False

boolean value

The flag of thin storage allocation. Deprecated since: 14.0.0

*Reason:*FusionStorage cinder driver refactored the code with Restful method and the old CLI mode has been abandon. So those configuration items are no longer used.

`dsware_manager = `

string value

Fusionstorage manager ip addr for cinder-volume. Deprecated since: 14.0.0

*Reason:*FusionStorage cinder driver refactored the code with Restful method and the old CLI mode has been abandon. So those configuration items are no longer used.

`dsware_rest_url = `

string value

The address of FusionStorage array. For example, "dsware_rest_url=xxx"

`dsware_storage_pools = `

string value

The list of pools on the FusionStorage array, the semicolon(;) was used to split the storage pools, "dsware_storage_pools = xxx1; xxx2; xxx3"

enable_force_upload = False

boolean value

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

enable_new_services = True

boolean value

Services to be added to the available pool on create

enable_unsupported_driver = False

boolean value

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

enable_v2_api = True

boolean value

DEPRECATED: Deploy v2 of the Cinder API.

enable_v3_api = True

boolean value

Deploy v3 of the Cinder API.

enabled_backends = None

list value

A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options

enforce_multipath_for_image_xfer = False

boolean value

If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path. This parameter needs to be configured for each backend section or in [backend_defaults] section as a common configuration for all backends.

executor_thread_pool_size = 64

integer value

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

fatal_deprecations = False

boolean value

Enables or disables fatal status of deprecations.

filter_function = None

string value

String representation for an equation that will be used to filter hosts. Only used when the driver filter is set to be used by the Cinder scheduler.

`fusionstorageagent = `

string value

Fusionstorage agent ip addr range Deprecated since: 14.0.0

*Reason:*FusionStorage cinder driver refactored the code with Restful method and the old CLI mode has been abandon. So those configuration items are no longer used.

glance_api_insecure = False

boolean value

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

glance_api_servers = None

list value

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

glance_api_ssl_compression = False

boolean value

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

glance_ca_certificates_file = None

string value

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

glance_catalog_info = image:glance:publicURL

string value

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

glance_certfile = None

string value

Location of certificate file to use for glance client requests.

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

list value

Default core properties of image

glance_keyfile = None

string value

Location of certificate key file to use for glance client requests.

glance_num_retries = 3

integer value

Number retries when downloading an image from glance

glance_request_timeout = None

integer value

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

glusterfs_backup_mount_point = $state_path/backup_mount

string value

Base dir containing mount point for gluster share.

glusterfs_backup_share = None

string value

GlusterFS share in <hostname|ipv4addr|ipv6addr>:<gluster_vol_name> format. Eg: 1.2.3.4:backup_vol

goodness_function = None

string value

String representation for an equation that will be used to determine the goodness of a host. Only used when using the goodness weigher is set to be used by the Cinder scheduler.

graceful_shutdown_timeout = 60

integer value

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

group_api_class = cinder.group.api.API

string value

The full class name of the group API class

host = <based on operating system>

string value

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

iet_conf = /etc/iet/ietd.conf

string value

DEPRECATED: IET configuration file

image_compress_on_upload = True

boolean value

When possible, compress images uploaded to the image service

image_conversion_address_space_limit = 1

integer value

Address space limit in gigabytes to convert the image

image_conversion_cpu_limit = 60

integer value

CPU time limit in seconds to convert the image

image_conversion_dir = $state_path/conversion

string value

Directory used for temporary storage during image conversion

image_upload_use_cinder_backend = False

boolean value

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

image_upload_use_internal_tenant = False

boolean value

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

image_volume_cache_enabled = False

boolean value

Enable the image volume cache for this backend.

image_volume_cache_max_count = 0

integer value

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

image_volume_cache_max_size_gb = 0

integer value

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

infortrend_cli_cache = False

boolean value

The Infortrend CLI cache. While set True, the RAID status report will use cache stored in the CLI. Never enable this unless the RAID is managed only by Openstack and only by one infortrend cinder-volume backend. Otherwise, CLI might report out-dated status to cinder and thus there might be some race condition among all backend/CLIs.

infortrend_cli_max_retries = 5

integer value

The maximum retry times if a command fails.

infortrend_cli_path = /opt/bin/Infortrend/raidcmd_ESDS10.jar

string value

The Infortrend CLI absolute path.

infortrend_cli_timeout = 60

integer value

The timeout for CLI in seconds.

infortrend_iqn_prefix = iqn.2002-10.com.infortrend

string value

Infortrend iqn prefix for iSCSI.

`infortrend_pools_name = `

list value

The Infortrend logical volumes name list. It is separated with comma.

`infortrend_slots_a_channels_id = `

list value

Infortrend raid channel ID list on Slot A for OpenStack usage. It is separated with comma.

`infortrend_slots_b_channels_id = `

list value

Infortrend raid channel ID list on Slot B for OpenStack usage. It is separated with comma.

init_host_max_objects_retrieval = 0

integer value

Max number of volumes and snapshots to be retrieved per batch during volume manager host initialization. Query results will be obtained in batches from the database and not in one shot to avoid extreme memory usage. Set 0 to turn off this functionality.

initiator_assign_sandstone_target_ip = {}

dict value

Support initiator assign target with assign ip.

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

string value

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

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

string value

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

instorage_mcs_allow_tenant_qos = False

boolean value

Allow tenants to specify QOS on create

instorage_mcs_iscsi_chap_enabled = True

boolean value

Configure CHAP authentication for iSCSI connections (Default: Enabled)

instorage_mcs_localcopy_rate = 50

integer value

Specifies the InStorage LocalCopy copy rate to be used when creating a full volume copy. The default rate is 50, and the valid rates are 1-100.

instorage_mcs_localcopy_timeout = 120

integer value

Maximum number of seconds to wait for LocalCopy to be prepared.

instorage_mcs_vol_autoexpand = True

boolean value

Storage system autoexpand parameter for volumes (True/False)

instorage_mcs_vol_compression = False

boolean value

Storage system compression option for volumes

instorage_mcs_vol_grainsize = 256

integer value

Storage system grain size parameter for volumes (32/64/128/256)

instorage_mcs_vol_intier = True

boolean value

Enable InTier for volumes

instorage_mcs_vol_iogrp = 0

string value

The I/O group in which to allocate volumes. It can be a comma-separated list in which case the driver will select an io_group based on least number of volumes associated with the io_group.

instorage_mcs_vol_rsize = 2

integer value

Storage system space-efficiency parameter for volumes (percentage)

instorage_mcs_vol_warning = 0

integer value

Storage system threshold for volume capacity warnings (percentage)

instorage_mcs_volpool_name = ['volpool']

list value

Comma separated list of storage system storage pools for volumes.

instorage_san_secondary_ip = None

string value

Specifies secondary management IP or hostname to be used if san_ip is invalid or becomes inaccessible.

iscsi_iotype = fileio

string value

Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device

iscsi_secondary_ip_addresses = []

list value

The list of secondary IP addresses of the iSCSI daemon

`iscsi_target_flags = `

string value

Sets the target-specific flags for the iSCSI target. Only used for tgtadm to specify backing device flags using bsoflags option. The specified string is passed as is to the underlying tool.

iscsi_write_cache = on

string value

Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if target_helper is set to tgtadm.

iser_helper = tgtadm

string value

The name of the iSER target user-land tool to use

iser_ip_address = $my_ip

string value

The IP address that the iSER daemon is listening on

iser_port = 3260

port value

The port that the iSER daemon is listening on

iser_target_prefix = iqn.2010-10.org.openstack:

string value

Prefix for iSER volumes

java_path = /usr/bin/java

string value

The Java absolute path.

jovian_block_size = 64K

string value

Block size can be: 32K, 64K, 128K, 256K, 512K, 1M

jovian_ignore_tpath = []

list value

List of multipath ip addresses to ignore.

jovian_pool = Pool-0

string value

JovianDSS pool that holds all cinder volumes

jovian_recovery_delay = 60

integer value

Time before HA cluster failure.

keystone_catalog_info = identity:Identity Service:publicURL

string value

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

kioxia_block_size = 4096

integer value

Volume block size in bytes - 512 or 4096 (Default).

kioxia_cafile = None

string value

Cert for provisioner REST API SSL

kioxia_desired_bw_per_gb = 0

integer value

Desired bandwidth in B/s per GB.

kioxia_desired_iops_per_gb = 0

integer value

Desired IOPS/GB.

kioxia_max_bw_per_gb = 0

integer value

Upper limit for bandwidth in B/s per GB.

kioxia_max_iops_per_gb = 0

integer value

Upper limit for IOPS/GB.

kioxia_max_replica_down_time = 0

integer value

Replicated volume max downtime for replica in minutes.

kioxia_num_replicas = 1

integer value

Number of volume replicas.

kioxia_provisioning_type = THICK

string value

Thin or thick volume, Default thick.

kioxia_same_rack_allowed = False

boolean value

Can more than one replica be allocated to same rack.

kioxia_snap_reserved_space_percentage = 0

integer value

Percentage of the parent volume to be used for log.

kioxia_snap_vol_reserved_space_percentage = 0

integer value

Writable snapshot percentage of parent volume used for log.

kioxia_snap_vol_span_allowed = True

boolean value

Allow span in snapshot volume - Default True.

kioxia_span_allowed = True

boolean value

Allow span - Default True.

kioxia_token = None

string value

KumoScale Provisioner auth token.

kioxia_url = None

string value

KumoScale provisioner REST API URL

kioxia_vol_reserved_space_percentage = 0

integer value

Thin volume reserved capacity allocation percentage.

kioxia_writable = False

boolean value

Volumes from snapshot writeable or not.

log-config-append = None

string value

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, log-date-format).

log-date-format = %Y-%m-%d %H:%M:%S

string value

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

log-dir = None

string value

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

log-file = None

string value

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

log_options = True

boolean value

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

log_rotate_interval = 1

integer value

The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval".

log_rotate_interval_type = days

string value

Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation.

log_rotation_type = none

string value

Log rotation type.

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

string value

Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter

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

string value

Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter

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

string value

Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter

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

string value

Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter

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

string value

Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter

manager_ips = {}

dict value

This option is to support the FSA to mount across the different nodes. The parameters takes the standard dict config form, manager_ips = host1:ip1, host2:ip2…​

max_age = 0

integer value

Number of seconds between subsequent usage refreshes

max_header_line = 16384

integer value

Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs).

max_logfile_count = 30

integer value

Maximum number of rotated log files.

max_logfile_size_mb = 200

integer value

Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size".

max_over_subscription_ratio = 20.0

string value

Representation of the over subscription ratio when thin provisioning is enabled. Default ratio is 20.0, meaning provisioned capacity can be 20 times of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. If ratio is auto, Cinder will automatically calculate the ratio based on the provisioned capacity and the used space. If not set to auto, the ratio has to be a minimum of 1.0.

message_reap_interval = 86400

integer value

interval between periodic task runs to clean expired messages in seconds.

message_ttl = 2592000

integer value

message minimum life in seconds.

migration_create_volume_timeout_secs = 300

integer value

Timeout for creating the volume to migrate to when performing volume migration (seconds)

monkey_patch = False

boolean value

Enable monkey patching

monkey_patch_modules = []

list value

List of modules/decorators to monkey patch

my_ip = <based on operating system>

host address value

IP address of this host

no_snapshot_gb_quota = False

boolean value

Whether snapshots count against gigabyte quota

num_iser_scan_tries = 3

integer value

The maximum number of times to rescan iSER target to find volume

num_shell_tries = 3

integer value

Number of times to attempt to run flakey shell commands

num_volume_device_scan_tries = 3

integer value

The maximum number of times to rescan targets to find volume

nvmet_ns_id = 10

integer value

The namespace id associated with the subsystem that will be created with the path for the LVM volume.

nvmet_port_id = 1

port value

The port that the NVMe target is listening on.

osapi_max_limit = 1000

integer value

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

osapi_volume_ext_list = []

list value

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

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

multi valued

osapi volume extension to load

osapi_volume_listen = 0.0.0.0

string value

IP address on which OpenStack Volume API listens

osapi_volume_listen_port = 8776

port value

Port on which OpenStack Volume API listens

osapi_volume_use_ssl = False

boolean value

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

osapi_volume_workers = None

integer value

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

per_volume_size_limit = -1

integer value

Max size allowed per volume, in gigabytes

periodic_fuzzy_delay = 60

integer value

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

periodic_interval = 60

integer value

Interval, in seconds, between running periodic tasks

pool_id_filter = []

list value

Pool id permit to use Deprecated since: 14.0.0

*Reason:*FusionStorage cinder driver refactored the code with Restful method and the old CLI mode has been abandon. So those configuration items are no longer used.

pool_type = default

string value

Pool type, like sata-2copy Deprecated since: 14.0.0

*Reason:*FusionStorage cinder driver refactored the code with Restful method and the old CLI mode has been abandon. So those configuration items are no longer used.

public_endpoint = None

string value

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

publish_errors = False

boolean value

Enables or disables publication of error events.

quota_backup_gigabytes = 1000

integer value

Total amount of storage, in gigabytes, allowed for backups per project

quota_backups = 10

integer value

Number of volume backups allowed per project

quota_consistencygroups = 10

integer value

Number of consistencygroups allowed per project

quota_driver = cinder.quota.DbQuotaDriver

string value

Default driver to use for quota checks

quota_gigabytes = 1000

integer value

Total amount of storage, in gigabytes, allowed for volumes and snapshots per project

quota_groups = 10

integer value

Number of groups allowed per project

quota_snapshots = 10

integer value

Number of volume snapshots allowed per project

quota_volumes = 10

integer value

Number of volumes allowed per project

rate_limit_burst = 0

integer value

Maximum number of logged messages per rate_limit_interval.

rate_limit_except_level = CRITICAL

string value

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.

rate_limit_interval = 0

integer value

Interval, number of seconds, of log rate limiting.

reinit_driver_count = 3

integer value

Maximum times to reintialize the driver if volume initialization fails. The interval of retry is exponentially backoff, and will be 1s, 2s, 4s etc.

replication_device = None

dict value

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

report_discard_supported = False

boolean value

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

report_interval = 10

integer value

Interval, in seconds, between nodes reporting state to datastore

reservation_clean_interval = $reservation_expire

integer value

Interval between periodic task runs to clean expired reservations in seconds.

reservation_expire = 86400

integer value

Number of seconds until a reservation expires

reserved_percentage = 0

integer value

The percentage of backend capacity is reserved

resource_query_filters_file = /etc/cinder/resource_filters.json

string value

Json file indicating user visible filter parameters for list queries.

restore_discard_excess_bytes = True

boolean value

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

rootwrap_config = /etc/cinder/rootwrap.conf

string value

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

rpc_conn_pool_size = 30

integer value

Size of RPC connection pool.

rpc_ping_enabled = False

boolean value

Add an endpoint to answer to ping calls. Endpoint is named oslo_rpc_server_ping

rpc_response_timeout = 60

integer value

Seconds to wait for a response from a call.

run_external_periodic_tasks = True

boolean value

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

`san_hosts = `

list value

IP address of Open-E JovianDSS SA

`sandstone_pool = `

string value

SandStone storage pool resource name.

scheduler_default_filters = ['AvailabilityZoneFilter', 'CapacityFilter', 'CapabilitiesFilter']

list value

Which filter class names to use for filtering hosts when not specified in the request.

scheduler_default_weighers = ['CapacityWeigher']

list value

Which weigher class names to use for weighing hosts.

scheduler_driver = cinder.scheduler.filter_scheduler.FilterScheduler

string value

Default scheduler driver to use

scheduler_driver_init_wait_time = 60

integer value

Maximum time in seconds to wait for the driver to report as ready

scheduler_host_manager = cinder.scheduler.host_manager.HostManager

string value

The scheduler host manager class to use

`scheduler_json_config_location = `

string value

Absolute path to scheduler configuration JSON file.

scheduler_manager = cinder.scheduler.manager.SchedulerManager

string value

Full class name for the Manager for scheduler

scheduler_max_attempts = 3

integer value

Maximum number of attempts to schedule a volume

scheduler_weight_handler = cinder.scheduler.weights.OrderedHostWeightHandler

string value

Which handler to use for selecting the host/pool after weighing

scst_target_driver = iscsi

string value

SCST target implementation can choose from multiple SCST target drivers.

scst_target_iqn_name = None

string value

Certain ISCSI targets have predefined target names, SCST target driver uses this name.

service_down_time = 60

integer value

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

snapshot_name_template = snapshot-%s

string value

Template string to be used to generate snapshot names

snapshot_same_host = True

boolean value

Create volume from snapshot at the host where snapshot resides

split_loggers = False

boolean value

Log requests to multiple loggers.

ssh_hosts_key_file = $state_path/ssh_known_hosts

string value

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

state_path = /var/lib/cinder

string value

Top-level directory for maintaining cinder’s state

storage_availability_zone = nova

string value

Availability zone of this node. Can be overridden per volume backend with the option "backend_availability_zone".

storage_protocol = iscsi

string value

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

strict_ssh_host_key_policy = False

boolean value

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

swift_catalog_info = object-store:swift:publicURL

string value

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

syslog-log-facility = LOG_USER

string value

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

target_helper = tgtadm

string value

Target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, scstadmin for SCST target support, ietadm for iSCSI Enterprise Target, iscsictl for Chelsio iSCSI Target, nvmet for NVMEoF support, spdk-nvmeof for SPDK NVMe-oF, or fake for testing. Note: The IET driver is deprecated and will be removed in the V release.

target_ip_address = $my_ip

string value

The IP address that the iSCSI daemon is listening on

target_port = 3260

port value

The port that the iSCSI daemon is listening on

target_prefix = iqn.2010-10.org.openstack:

string value

Prefix for iSCSI volumes

target_protocol = iscsi

string value

Determines the target protocol for new volumes, created with tgtadm, lioadm and nvmet target helpers. In order to enable RDMA, this parameter should be set with the value "iser". The supported iSCSI protocol values are "iscsi" and "iser", in case of nvmet target set to "nvmet_rdma".

tcp_keepalive = True

boolean value

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

tcp_keepalive_count = None

integer value

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

tcp_keepalive_interval = None

integer value

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

tcp_keepidle = 600

integer value

Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.

trace_flags = None

list value

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

transfer_api_class = cinder.transfer.api.API

string value

The full class name of the volume transfer API class

transport_url = rabbit://

string value

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

until_refresh = 0

integer value

Count of reservations until usage is refreshed

use-journal = False

boolean value

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.

use-json = False

boolean value

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

use-syslog = False

boolean value

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_chap_auth = False

boolean value

Option to enable/disable CHAP authentication for targets.

use_default_quota_class = True

boolean value

Enables or disables use of default quota class with default quota.

use_eventlog = False

boolean value

Log output to Windows Event Log.

use_forwarded_for = False

boolean value

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

use_multipath_for_image_xfer = False

boolean value

Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers? This parameter needs to be configured for each backend section or in [backend_defaults] section as a common configuration for all backends.

use_stderr = False

boolean value

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

verify_glance_signatures = enabled

string value

Enable image signature verification.

Cinder uses the image signature metadata from Glance and verifies the signature of a signed image while downloading that image. There are two options here.

If the image signature cannot be verified or if the image signature metadata is incomplete when required, then Cinder will not create the volume and update it into an error state. This provides end users with stronger assurances of the integrity of the image data they are using to create volumes.

vmdk_allowed_types = ['streamOptimized', 'monolithicSparse']

list value

A list of strings describing the VMDK createType subformats that are allowed. We recommend that you only include single-file-with-sparse-header variants to avoid potential host file exposure when processing named extents when an image is converted to raw format as it is written to a volume. If this list is empty, no VMDK images are allowed.

volume_api_class = cinder.volume.api.API

string value

The full class name of the volume API class to use

volume_backend_name = None

string value

The backend name for a given driver implementation

volume_clear = zero

string value

Method used to wipe old volumes

volume_clear_ionice = None

string value

The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority.

volume_clear_size = 0

integer value

Size in MiB to wipe at start of old volumes. 1024 MiB at max. 0 ⇒ all

volume_copy_blkio_cgroup_name = cinder-volume-copy

string value

The blkio cgroup name to be used to limit bandwidth of volume copy

volume_copy_bps_limit = 0

integer value

The upper limit of bandwidth of volume copy. 0 ⇒ unlimited

volume_dd_blocksize = 1M

string value

The default block size used when copying/clearing volumes

volume_manager = cinder.volume.manager.VolumeManager

string value

Full class name for the Manager for volume

volume_name_template = volume-%s

string value

Template string to be used to generate volume names

volume_number_multiplier = -1.0

floating point value

Multiplier used for weighing volume number. Negative numbers mean to spread vs stack.

volume_service_inithost_offload = False

boolean value

Offload pending volume delete during volume service startup

volume_transfer_key_length = 16

integer value

The number of characters in the autogenerated auth key.

volume_transfer_salt_length = 8

integer value

The number of characters in the salt.

volume_usage_audit_period = month

string value

Time period for which to generate volume usages. The options are hour, day, month, or year.

volumes_dir = $state_path/volumes

string value

Volume configuration file storage directory

vrts_lun_sparse = True

boolean value

Create sparse Lun.

vrts_target_config = /etc/cinder/vrts_target.xml

string value

VA config file.

watch-log-file = False

boolean value

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.

wsgi_default_pool_size = 100

integer value

Size of the pool of greenthreads used by wsgi

wsgi_keep_alive = True

boolean value

If False, closes the client socket connection explicitly.

wsgi_log_format = %(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f

string value

A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.

wsgi_server_debug = False

boolean value

True if the server should send exception tracebacks to the clients on 500 errors. If False, the server will respond with empty bodies.

zoning_mode = None

string value

FC Zoning mode configured, only fabric is supported now.