Atom feed of this document
Icehouse -  Icehouse -  Icehouse -  Icehouse -  Icehouse -  Icehouse -  Icehouse -  Icehouse - 

 Additional options

These options can also be set in the cinder.conf file.

Table 1.37. Description of configuration options for auth_token
Configuration option = Default value Description
memcached_servers = None (ListOpt) Memcached servers or None for in process cache.
admin_password = None (StrOpt) Keystone account password
admin_tenant_name = admin (StrOpt) Keystone service account tenant name to validate user tokens
admin_token = None (StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process.
admin_user = None (StrOpt) Keystone account username
auth_admin_prefix = (StrOpt) Prefix to prepend at the beginning of the path
auth_host = (StrOpt) Host providing the admin Identity API endpoint
auth_port = 35357 (IntOpt) Port of the admin Identity API endpoint
auth_protocol = https (StrOpt) Protocol of the admin Identity API endpoint(http or https)
auth_uri = None (StrOpt) Complete public Identity API endpoint
auth_version = None (StrOpt) API version of the admin Identity API endpoint
cache = None (StrOpt) Env key for the swift cache
cafile = None (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
certfile = None (StrOpt) Required if Keystone server requires client certificate
delay_auth_decision = False (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components
enforce_token_bind = permissive (StrOpt) 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.
http_connect_timeout = None (BoolOpt) Request timeout value for communicating with Identity API server.
http_request_max_retries = 3 (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.
include_service_catalog = True (BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
insecure = False (BoolOpt) Verify HTTPS connections.
keyfile = None (StrOpt) Required if Keystone server requires client certificate
memcache_secret_key = None (StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.
memcache_security_strategy = None (StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. 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.
memcached_servers = None (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
revocation_cache_time = 300 (IntOpt) 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.
signing_dir = None (StrOpt) Directory used to cache files related to PKI tokens
token_cache_time = 300 (IntOpt) 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.

Table 1.38. Description of configuration options for connection
Configuration option = Default value Description
connection = sqlite:///$state_path/$sqlite_db (StrOpt) The SQLAlchemy connection string used to connect to the database
connection_debug = 0 (IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything
connection_trace = False (BoolOpt) Add python stack traces to SQL as comment strings

Table 1.39. Description of configuration options for huawei
Configuration option = Default value Description
cinder_huawei_conf_file = /etc/cinder/cinder_huawei_conf.xml (StrOpt) config data for cinder huawei plugin

Table 1.40. Description of configuration options for nas
Configuration option = Default value Description
nas_ip = (StrOpt) IP address or Hostname of NAS system.
nas_login = admin (StrOpt) User name to connect to NAS system.
nas_password = (StrOpt) Password to connect to NAS system.
nas_private_key = (StrOpt) Filename of private key to use for SSH authentication.
nas_ssh_port = 22 (IntOpt) SSH port to use to connect to NAS system.

Table 1.41. Description of configuration options for hpmsa
Configuration option = Default value Description
msa_vdisk = OpenStack (StrOpt) The VDisk to use for volume creation.

Table 1.42. Description of configuration options for database
Configuration option = Default value Description
db_backend = sqlalchemy (StrOpt) The backend to use for db
db_driver = cinder.db (StrOpt) driver to use for database access

Table 1.43. Description of configuration options for keymgr
Configuration option = Default value Description
api_class = cinder.keymgr.conf_key_mgr.ConfKeyManager (StrOpt) The full class name of the key manager API class
fixed_key = None (StrOpt) Fixed key returned by key manager, specified in hex

Table 1.44. Description of configuration options for storage
Configuration option = Default value Description
allocated_capacity_weight_multiplier = -1.0 (FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.
capacity_weight_multiplier = 1.0 (FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.
enabled_backends = None (ListOpt) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options
iscsi_helper = tgtadm (StrOpt) iscsi target user-land tool to use
iscsi_iotype = fileio (StrOpt) 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_ip_address = $my_ip (StrOpt) The IP address that the iSCSI daemon is listening on
iscsi_num_targets = 100 (IntOpt) The maximum number of iscsi target ids per host
iscsi_port = 3260 (IntOpt) The port that the iSCSI daemon is listening on
iscsi_target_prefix = (StrOpt) prefix for iscsi volumes
iser_helper = tgtadm (StrOpt) iser target user-land tool to use
iser_ip_address = $my_ip (StrOpt) The IP address that the iSER daemon is listening on
iser_num_targets = 100 (IntOpt) The maximum number of iser target ids per host
iser_port = 3260 (IntOpt) The port that the iSER daemon is listening on
iser_target_prefix = (StrOpt) prefix for iser volumes
max_gigabytes = 10000 (IntOpt) This configure option has been deprecated along with the SimpleScheduler. New scheduler is able to gather capacity information for each host, thus setting the maximum number of volume gigabytes for host is no longer needed. It's safe to remove this configure from cinder.conf.
migration_create_volume_timeout_secs = 300 (IntOpt) Timeout for creating the volume to migrate to when performing volume migration (seconds)
num_iser_scan_tries = 3 (IntOpt) The maximum number of times to rescan iSER targetto find volume
num_volume_device_scan_tries = 3 (IntOpt) The maximum number of times to rescan targets to find volume
volume_backend_name = None (StrOpt) The backend name for a given driver implementation
volume_clear = zero (StrOpt) Method used to wipe old voumes (valid options are: none, zero, shred)
volume_clear_ionice = None (StrOpt) 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 (IntOpt) Size in MiB to wipe at start of old volumes. 0 => all
volume_dd_blocksize = 1M (StrOpt) The default block size used when copying/clearing volumes
volume_driver = cinder.volume.drivers.lvm.LVMISCSIDriver (StrOpt) Driver to use for volume creation
volume_manager = cinder.volume.manager.VolumeManager (StrOpt) full class name for the Manager for volume
volume_service_inithost_offload = False (BoolOpt) Offload pending volume delete during volume service startup
volume_usage_audit_period = month (StrOpt) time period to generate volume usages for. Time period must be hour, day, month or year
volumes_dir = $state_path/volumes (StrOpt) Volume configuration file storage directory
backend = sqlalchemy (StrOpt) The backend to use for db
max_overflow = None (IntOpt) If set, use this value for max_overflow with sqlalchemy
max_pool_size = 5 (IntOpt) Maximum number of SQL connections to keep open in a pool
max_retries = 10 (IntOpt) maximum db connection retries during startup. (setting -1 implies an infinite retry count)
min_pool_size = 1 (IntOpt) Minimum number of SQL connections to keep open in a pool

Table 1.45. Description of configuration options for rpc
Configuration option = Default value Description
allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions (ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.
amqp_auto_delete = False (BoolOpt) Auto-delete queues in amqp.
amqp_durable_queues = False (BoolOpt) Use durable queues in amqp.
control_exchange = openstack (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
default_timeout = 20 (IntOpt) Default Time Out For CLI operations in minutes
fake_rabbit = False (BoolOpt) If passed, use a fake RabbitMQ provider.
kombu_reconnect_delay = 1.0 (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
kombu_ssl_ca_certs = (StrOpt) SSL certification authority file (valid only if SSL enabled).
kombu_ssl_certfile = (StrOpt) SSL cert file (valid only if SSL enabled).
kombu_ssl_keyfile = (StrOpt) SSL key file (valid only if SSL enabled).
kombu_ssl_version = (StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.
matchmaker_heartbeat_freq = 300 (IntOpt) Heartbeat frequency.
matchmaker_heartbeat_ttl = 600 (IntOpt) Heartbeat time-to-live.
notification_driver = [] (MultiStrOpt) Driver or drivers to handle sending notifications.
notification_topics = notifications (ListOpt) AMQP topic used for OpenStack notifications.
password = None (StrOpt) Password for Redis server (optional).
port = 6379 (IntOpt) Use this port to connect to redis host.
publish_errors = False (BoolOpt) Publish error events
qpid_heartbeat = 60 (IntOpt) Seconds between connection keepalive heartbeats.
qpid_hostname = localhost (StrOpt) Qpid broker hostname.
qpid_hosts = $qpid_hostname:$qpid_port (ListOpt) Qpid HA cluster host:port pairs.
qpid_password = (StrOpt) Password for Qpid connection.
qpid_port = 5672 (IntOpt) Qpid broker port.
qpid_protocol = tcp (StrOpt) Transport to use, either 'tcp' or 'ssl'.
qpid_sasl_mechanisms = (StrOpt) Space separated list of SASL mechanisms to use for auth.
qpid_tcp_nodelay = True (BoolOpt) Whether to disable the Nagle algorithm.
qpid_topology_version = 1 (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
qpid_username = (StrOpt) Username for Qpid connection.
rabbit_ha_queues = False (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.
rabbit_host = localhost (StrOpt) The RabbitMQ broker address where a single node is used.
rabbit_hosts = $rabbit_host:$rabbit_port (ListOpt) RabbitMQ HA cluster host:port pairs.
rabbit_login_method = AMQPLAIN (StrOpt) the RabbitMQ login method
rabbit_max_retries = 0 (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
rabbit_password = guest (StrOpt) The RabbitMQ password.
rabbit_port = 5672 (IntOpt) The RabbitMQ broker port where a single node is used.
rabbit_retry_backoff = 2 (IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
rabbit_retry_interval = 1 (IntOpt) How frequently to retry connecting with RabbitMQ.
rabbit_use_ssl = False (BoolOpt) Connect over SSL for RabbitMQ.
rabbit_userid = guest (StrOpt) The RabbitMQ userid.
rabbit_virtual_host = / (StrOpt) The RabbitMQ virtual host.
rpc_backend = rabbit (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.
rpc_cast_timeout = 30 (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.
rpc_conn_pool_size = 30 (IntOpt) Size of RPC connection pool.
rpc_response_timeout = 60 (IntOpt) Seconds to wait for a response from a call.
rpc_thread_pool_size = 64 (IntOpt) Size of RPC greenthread pool.
rpc_zmq_bind_address = * (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.
rpc_zmq_contexts = 1 (IntOpt) Number of ZeroMQ contexts, defaults to 1.
rpc_zmq_host = oslo (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.
rpc_zmq_ipc_dir = /var/run/openstack (StrOpt) Directory for holding IPC sockets.
rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost (StrOpt) MatchMaker driver.
rpc_zmq_port = 9501 (IntOpt) ZeroMQ receiver listening port.
rpc_zmq_topic_backlog = None (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
transport_url = None (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.
volume_topic = cinder-volume (StrOpt) the topic volume nodes listen on
ringfile = /etc/oslo/matchmaker_ring.json (StrOpt) Matchmaker ring file (JSON).

Table 1.46. Description of configuration options for san-solaris
Configuration option = Default value Description
san_zfs_volume_base = rpool/ (StrOpt) The ZFS path under which to create zvols for volumes.

Table 1.47. Description of configuration options for rootwrap
Configuration option = Default value Description
filters_path = /etc/cinder/rootwrap.d,/usr/share/cinder/rootwrap List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !
exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !
use_syslog = False Enable logging to syslog Default value is False
syslog_log_facility = syslog Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog'
syslog_log_level = ERROR Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts

Table 1.48. Description of configuration options for ssl
Configuration option = Default value Description
ca_file = None (StrOpt) CA certificate file to use to verify connecting clients
cert_file = None (StrOpt) Certificate file to use when starting the server securely
key_file = None (StrOpt) Private key file to use when starting the server securely

Table 1.49. Description of configuration options for images
Configuration option = Default value Description
allowed_direct_url_schemes = (ListOpt) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file].
glance_api_insecure = False (BoolOpt) Allow to perform insecure SSL (https) requests to glance
glance_api_servers = $glance_host:$glance_port (ListOpt) A list of the glance api servers available to cinder ([hostname|ip]:port)
glance_api_ssl_compression = False (BoolOpt) Whether to attempt to negotiate SSL layer compression when using SSL (https) requests. Set to False to disable SSL layer compression. In some cases disabling this may improve data throughput, eg when high network bandwidth is available and you are using already compressed image formats such as qcow2 .
glance_api_version = 1 (IntOpt) Version of the glance api to use
glance_host = $my_ip (StrOpt) default glance hostname or ip
glance_num_retries = 0 (IntOpt) Number retries when downloading an image from glance
glance_port = 9292 (IntOpt) default glance port
glance_request_timeout = None (IntOpt) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used.
image_conversion_dir = $state_path/conversion (StrOpt) Directory used for temporary storage during image conversion
instance_format = "[instance: %(uuid)s] " (StrOpt) If an instance is passed with the log message, format it like this
instance_uuid_format = "[instance: %(uuid)s] " (StrOpt) If an instance UUID is passed with the log message, format it like this
use_multipath_for_image_xfer = False (BoolOpt) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers?

Table 1.50. Description of configuration options for emc
Configuration option = Default value Description
cinder_emc_config_file = /etc/cinder/cinder_emc_config.xml (StrOpt) use this file for cinder emc plugin config data
max_luns_per_storage_group = 256 (IntOpt) Default max number of LUNs in a storage group
naviseccli_path = (StrOpt) Naviseccli Path
storage_vnx_pool_name = None (StrOpt) ISCSI pool name

Table 1.51. Description of configuration options for backups
Configuration option = Default value Description
backup_api_class = cinder.backup.api.API (StrOpt) The full class name of the volume backup API class
backup_compression_algorithm = zlib (StrOpt) Compression algorithm (None to disable)
backup_driver = cinder.backup.drivers.swift (StrOpt) Driver to use for backups.
backup_manager = cinder.backup.manager.BackupManager (StrOpt) full class name for the Manager for volume backup
backup_metadata_version = 1 (IntOpt) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version.
backup_name_template = backup-%s (StrOpt) Template string to be used to generate backup names
backup_topic = cinder-backup (StrOpt) the topic volume backup nodes listen on
snapshot_name_template = snapshot-%s (StrOpt) Template string to be used to generate snapshot names
snapshot_same_host = True (BoolOpt) Create volume from snapshot at the host where snapshot resides

Table 1.52. Description of configuration options for hp3par
Configuration option = Default value Description
hp3par_api_url = (StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1
hp3par_cpg = OpenStack (StrOpt) The CPG to use for volume creation
hp3par_cpg_snap = (StrOpt) The CPG to use for Snapshots for volumes. If empty hp3par_cpg will be used
hp3par_debug = False (BoolOpt) Enable HTTP debugging to 3PAR
hp3par_iscsi_ips = (ListOpt) List of target iSCSI addresses to use.
hp3par_password = (StrOpt) 3PAR Super user password
hp3par_snapshot_expiration = (StrOpt) The time in hours when a snapshot expires and is deleted. This must be larger than expiration
hp3par_snapshot_retention = (StrOpt) The time in hours to retain a snapshot. You can't delete it before this expires.
hp3par_username = (StrOpt) 3PAR Super user username

Table 1.53. Description of configuration options for api
Configuration option = Default value Description
api_paste_config = api-paste.ini (StrOpt) File name for the paste.deploy config for cinder-api
api_rate_limit = True (BoolOpt) whether to rate limit the api
backdoor_port = None (StrOpt) 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.
enable_v1_api = True (BoolOpt) Deploy v1 of the Cinder API.
enable_v2_api = True (BoolOpt) Deploy v2 of the Cinder API.
extra_capabilities = {} (StrOpt) User defined capabilities, a JSON formatted string specifying key/value pairs.
max_header_line = 16384 (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
osapi_max_limit = 1000 (IntOpt) the maximum number of items returned in a single response from a collection resource
osapi_max_request_body_size = 114688 (IntOpt) Max size for body of a request
osapi_volume_base_URL = None (StrOpt) Base URL that will be presented to users in links to the OpenStack Volume API
osapi_volume_ext_list = (ListOpt) 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'] (MultiStrOpt) osapi volume extension to load
osapi_volume_listen = (StrOpt) IP address for OpenStack Volume API to listen
osapi_volume_listen_port = 8776 (IntOpt) port for os volume api to listen
osapi_volume_workers = None (IntOpt) Number of workers for OpenStack Volume API service
transfer_api_class = cinder.transfer.api.API (StrOpt) The full class name of the volume transfer API class
volume_api_class = cinder.volume.api.API (StrOpt) The full class name of the volume API class to use
volume_name_template = volume-%s (StrOpt) Template string to be used to generate volume names
volume_transfer_key_length = 16 (IntOpt) The number of characters in the autogenerated auth key.
volume_transfer_salt_length = 8 (IntOpt) The number of characters in the salt.

Table 1.54. Description of configuration options for hplefthand
Configuration option = Default value Description
hplefthand_api_url = None (StrOpt) HP LeftHand WSAPI Server Url like https://<LeftHand ip>:8081/lhos
hplefthand_clustername = None (StrOpt) HP LeftHand cluster name
hplefthand_debug = False (BoolOpt) Enable HTTP debugging to LeftHand
hplefthand_iscsi_chap_enabled = False (BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled)
hplefthand_password = None (StrOpt) HP LeftHand Super user password
hplefthand_username = None (StrOpt) HP LeftHand Super user username

Table 1.55. Description of configuration options for scality
Configuration option = Default value Description
scality_sofs_config = None (StrOpt) Path or URL to Scality SOFS configuration file
scality_sofs_mount_point = $state_path/scality (StrOpt) Base dir where Scality SOFS shall be mounted
scality_sofs_volume_dir = cinder/volumes (StrOpt) Path from Scality SOFS root to volume dir

Table 1.56. Description of configuration options for block-device
Configuration option = Default value Description
available_devices = (ListOpt) List of all available devices

Table 1.57. Description of configuration options for compute
Configuration option = Default value Description
nova_api_insecure = False (BoolOpt) Allow to perform insecure SSL requests to nova
nova_ca_certificates_file = None (StrOpt) Location of ca certificates file to use for nova client requests.
nova_catalog_admin_info = compute:nova:adminURL (StrOpt) Same as nova_catalog_info, but for admin endpoint.
nova_catalog_info = compute:nova:publicURL (StrOpt) Info to match when looking for nova in the service catalog. Format is : separated values of the form: <service_type>:<service_name>:<endpoint_type>
nova_endpoint_admin_template = None (StrOpt) Same as nova_endpoint_template, but for admin endpoint.
nova_endpoint_template = None (StrOpt) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s
os_region_name = None (StrOpt) region name of this node

Table 1.58. Description of configuration options for san
Configuration option = Default value Description
san_clustername = (StrOpt) Cluster name to use for creating volumes
san_ip = (StrOpt) IP address of SAN controller
san_is_local = False (BoolOpt) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device
san_login = admin (StrOpt) Username for SAN controller
san_password = (StrOpt) Password for SAN controller
san_private_key = (StrOpt) Filename of private key to use for SSH authentication
san_ssh_port = 22 (IntOpt) SSH port to use with SAN
san_thin_provision = True (BoolOpt) Use thin provisioning for SAN volumes?
ssh_conn_timeout = 30 (IntOpt) SSH connection timeout in seconds
ssh_max_pool_conn = 5 (IntOpt) Maximum ssh connections in the pool
ssh_min_pool_conn = 1 (IntOpt) Minimum ssh connections in the pool

Table 1.59. Description of configuration options for zones
Configuration option = Default value Description
cloned_volume_same_az = True (BoolOpt) Ensure that the new volumes are the same AZ as snapshot or source volume

Table 1.60. Description of configuration options for auth
Configuration option = Default value Description
auth_strategy = noauth (StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated.

Table 1.61. Description of configuration options for scheduler
Configuration option = Default value Description
scheduler_default_filters = AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter (ListOpt) Which filter class names to use for filtering hosts when not specified in the request.
scheduler_default_weighers = CapacityWeigher (ListOpt) Which weigher class names to use for weighing hosts.
scheduler_driver = cinder.scheduler.filter_scheduler.FilterScheduler (StrOpt) Default scheduler driver to use
scheduler_host_manager = cinder.scheduler.host_manager.HostManager (StrOpt) The scheduler host manager class to use
scheduler_json_config_location = (StrOpt) Absolute path to scheduler configuration JSON file.
scheduler_manager = cinder.scheduler.manager.SchedulerManager (StrOpt) full class name for the Manager for scheduler
scheduler_max_attempts = 3 (IntOpt) Maximum number of attempts to schedule an volume
scheduler_topic = cinder-scheduler (StrOpt) the topic scheduler nodes listen on

Table 1.62. Description of configuration options for quota
Configuration option = Default value Description
max_age = 0 (IntOpt) number of seconds between subsequent usage refreshes
quota_driver = cinder.quota.DbQuotaDriver (StrOpt) default driver to use for quota checks
quota_gigabytes = 1000 (IntOpt) number of volume gigabytes (snapshots are also included) allowed per project
quota_snapshots = 10 (IntOpt) number of volume snapshots allowed per project
quota_volumes = 10 (IntOpt) number of volumes allowed per project
reservation_expire = 86400 (IntOpt) number of seconds until a reservation expires
use_default_quota_class = True (BoolOpt) whether to use default quota class for default quota

Table 1.63. Description of configuration options for common
Configuration option = Default value Description
compute_api_class = cinder.compute.nova.API (StrOpt) The full class name of the compute API class to use
debug = False (BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).
default_availability_zone = None (StrOpt) default availability zone to use when creating a new volume. If this is not set then we use the value from the storage_availability_zone option as the default availability_zone for new volumes.
default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN (ListOpt) List of logger=LEVEL pairs
default_volume_type = None (StrOpt) default volume type to use
disable_process_locking = False (BoolOpt) Whether to disable inter-process locks
enable_new_services = True (BoolOpt) Services to be added to the available pool on create
fatal_deprecations = False (BoolOpt) Make deprecations fatal
fatal_exception_format_errors = False (BoolOpt) make exception message format errors fatal
host = oslo (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.
iet_conf = /etc/iet/ietd.conf (StrOpt) IET configuration file
lio_initiator_iqns = (StrOpt) Comma-separated list of initiator IQNs allowed to connect to the iSCSI target. (From Nova compute nodes.)
lock_path = None (StrOpt) Directory to use for lock files. Default to a temp directory
log_config_append = None (StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.
log_date_format = %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s
log_dir = None (StrOpt) (Optional) The base directory used for relative --log-file paths
log_file = None (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
log_format = None (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s (StrOpt) Format string to use for log messages with context
logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d (StrOpt) Data to append to log format when level is DEBUG
logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s (StrOpt) Format string to use for log messages without context
logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s (StrOpt) Prefix each line of exception output with this format
monkey_patch = False (BoolOpt) Enable monkey patching
monkey_patch_modules = (ListOpt) List of modules/decorators to monkey patch
my_ip = (StrOpt) ip address of this host
no_snapshot_gb_quota = False (BoolOpt) Whether snapshots count against GigaByte quota
num_shell_tries = 3 (IntOpt) number of times to attempt to run flakey shell commands
periodic_fuzzy_delay = 60 (IntOpt) range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)
periodic_interval = 60 (IntOpt) seconds between running periodic tasks
policy_default_rule = default (StrOpt) Rule checked when requested rule is not found
policy_file = policy.json (StrOpt) JSON file representing policy
report_interval = 10 (IntOpt) seconds between nodes reporting state to datastore
reserved_percentage = 0 (IntOpt) The percentage of backend capacity is reserved
rootwrap_config = /etc/cinder/rootwrap.conf (StrOpt) Path to the rootwrap configuration file to use for running commands as root
run_external_periodic_tasks = True (BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?
service_down_time = 60 (IntOpt) maximum time since last check-in for up service
sqlite_db = cinder.sqlite (StrOpt) the filename to use with sqlite
sqlite_synchronous = True (BoolOpt) If true, use synchronous mode for sqlite
ssl_ca_file = None (StrOpt) CA certificate file to use to verify connecting clients
ssl_cert_file = None (StrOpt) Certificate file to use when starting the server securely
ssl_key_file = None (StrOpt) Private key file to use when starting the server securely
state_path = /var/lib/cinder (StrOpt) Top-level directory for maintaining cinder's state
storage_availability_zone = nova (StrOpt) availability zone of this node
syslog_log_facility = LOG_USER (StrOpt) Syslog facility to receive log lines
tcp_keepidle = 600 (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.
until_refresh = 0 (IntOpt) count of reservations until usage is refreshed
use_forwarded_for = False (BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.
use_stderr = True (BoolOpt) Log output to standard error
use_syslog = False (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424
use_syslog_rfc_format = False (BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J.
verbose = False (BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).
idle_timeout = 3600 (IntOpt) timeout before idle sql connections are reaped
retry_interval = 10 (IntOpt) interval between retries of opening a sql connection
use_tpool = False (BoolOpt) Enable the experimental use of thread pooling for all DB API calls

Questions? Discuss on
Found an error? Report a bug against this page

loading table of contents...