Additional options¶
These options can also be set in the cinder.conf file.
Configuration option = Default value |
Description |
|---|---|
|
(Boolean) Enables or disables rate limit of the API. |
|
(String) The full class name of the compute API class to use |
|
(String) The full class name of the group API class |
|
(List of String) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions |
|
(String) osapi volume extension to load |
|
(Boolean) Sets the value of TCP_KEEPALIVE (True/False) for each server socket. |
|
(Integer) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X. |
|
(Integer) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X. |
|
(String) The full class name of the volume API class to use |
Configuration option = Default value |
Description |
|---|---|
|
(Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not. |
|
(Integer) The maximum body size for each request, in bytes. |
|
(String) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy. DEPRECATED |
Configuration option = Default value |
Description |
|---|---|
|
(String(choices=[‘noauth’, ‘noauth_include_project_id’, ‘keystone’])) The strategy to use for auth. Supports noauth, noauth_include_project_id or keystone. |
Configuration option = Default value |
Description |
|---|---|
|
(Integer(min=20)) Size of the native threads pool for the backend. Increase for backends that heavily rely on this, like the RBD driver. |
|
(Integer(min=3)) 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. |
|
(String) User defined capabilities, a JSON formatted string specifying key/value pairs. The key/value pairs can be used by the CapabilitiesFilter to select between backends when requests specify volume types. For example, specifying a service level or the geographical location of a backend, then creating a volume type to allow the user to select by these different properties. |
|
(Integer) 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. |
|
(Integer) Timeout for creating the volume to migrate to when performing volume migration (seconds) |
|
(Integer) Maximum times to reintialize the driver if volume initialization fails. The interval of retry is exponentially backoff, and will be 1s, 2s, 4s etc. |
|
(Boolean) Suppress requests library SSL certificate warnings. |
|
(String) Driver to use for volume creation |
|
(Boolean) Offload pending volume delete during volume service startup |
|
(String) FC Zoning mode configured, only ‘fabric’ is supported now. |
Configuration option = Default value |
Description |
|---|---|
|
(Float) Multiplier used for weighing allocated capacity. Positive numbers mean to stack vs spread. |
|
(Float) Multiplier used for weighing free capacity. Negative numbers mean to stack vs spread. |
|
(List of String) Which filter class names to use for filtering hosts when not specified in the request. |
|
(List of String) Which weigher class names to use for weighing hosts. |
|
(String) Default scheduler driver to use |
|
(Integer(min=1)) Maximum time in seconds to wait for the driver to report as ready |
|
(String) The scheduler host manager class to use |
|
(Integer) Maximum number of attempts to schedule a volume |
|
(String) Which handler to use for selecting the host/pool after weighing |
|
(Float) Multiplier used for weighing volume number. Negative numbers mean to spread vs stack. |
Configuration option = Default value |
Description |
|---|---|
|
(String) The full class name of the volume backup API class |
|
(String(choices=[‘none’, ‘off’, ‘no’, ‘zlib’, ‘gzip’, ‘bz2’, ‘bzip2’, ‘zstd’])) Compression algorithm for backups (‘none’ to disable) |
|
(String) Driver to use for backups. |
|
(Integer(min=5)) Time in seconds between checks to see if the backup driver has been successfully initialized, any time the driver is restarted. |
|
(Integer(min=10)) Time in seconds between checks of the backup driver status. If does not report as working, it is restarted. |
|
(String) Full class name for the Manager for volume backup |
|
(Integer) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version. |
|
(String) Template string to be used to generate backup names |
|
(Integer(min=20)) 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. |
|
(Integer) The number of chunks or objects, for which one Ceilometer notification will be sent |
|
(Boolean) Offload pending backup delete during backup service startup. If false, the backup service will remain down until all pending backups are deleted. |
|
(Integer) Interval, in seconds, between two progress notifications reporting the backup status |
|
(Boolean) Backup services use same backend. |
Configuration option = Default value |
Description |
|---|---|
|
(<class ‘str’>) Config Section from which to load plugin specific options |
|
(<class ‘str’>) Authentication type to load |
|
(String) PEM encoded Certificate Authority to use when verifying HTTPs connections. |
|
(String) PEM encoded client certificate cert file |
|
(Boolean) Collect per-API call timing information. |
|
(Boolean) Verify HTTPS connections. |
|
(String(choices=[‘public’, ‘admin’, ‘internal’])) Type of the nova endpoint to use. This endpoint will be looked up in the keystone catalog and should be one of public, internal or admin. |
|
(String) PEM encoded client certificate key file |
|
(String) Name of nova region to use. Useful if keystone manages more than one region. |
|
(Boolean) Log requests to multiple loggers. |
|
(Integer) Timeout value for http requests |
|
(String) The authentication URL for the nova connection when using the current users token |
Configuration option = Default value |
Description |
|---|---|
|
(List of String) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file, cinder]. |
|
(Boolean) If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path. This parameter needs to be configured for each backend section or in [backend_defaults] section as a common configuration for all backends. |
|
(Boolean) Allow to perform insecure SSL (https) requests to glance (https will be used but cert validation will not be performed). |
|
(List of String) 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. |
|
(Boolean) Enables or disables negotiation of SSL layer compression. In some cases disabling compression can improve data throughput, such as when high network bandwidth is available and you use compressed image formats like qcow2. |
|
(String) Location of ca certificates file to use for glance client requests. |
|
(String) Info to match when looking for glance in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if glance_api_servers are not provided. |
|
(String) Location of certificate file to use for glance client requests. |
|
(List of String) Default core properties of image |
|
(String) Location of certificate key file to use for glance client requests. |
|
(Integer(min=0)) Number retries when downloading an image from glance |
|
(Integer) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used. |
|
(Boolean) When possible, compress images uploaded to the image service |
|
(Integer) Address space limit in gigabytes to convert the image |
|
(Integer) CPU time limit in seconds to convert the image |
|
(String) Directory used for temporary storage during image conversion |
|
(Boolean) Disallow image conversion when creating a volume from an image and when uploading a volume as an image. Image conversion consumes a large amount of system resources and can cause performance problems on the cinder-volume node. When set True, this option disables image conversion. |
|
(Boolean) If set to True, upload-to-image in raw format will create a cloned volume and register its location to the image service, instead of uploading the volume content. The cinder backend and locations support must be enabled in the image service. |
|
(Boolean) If set to True, the image volume created by upload-to-image will be placed in the internal tenant. Otherwise, the image volume is created in the current context’s tenant. |
|
(Boolean) Enable the image volume cache for this backend. |
|
(Integer) Max number of entries allowed in the image volume cache. 0 => unlimited. |
|
(Integer) Max size of the image volume cache for this backend in GB. 0 => unlimited. |
|
(List of String) List of reserved image namespaces that should be filtered out when uploading a volume as an image back to Glance. When a volume is created from an image, Cinder stores the image properties as volume image metadata, and if the volume is later uploaded as an image, Cinder will add these properties when it creates the image in Glance. This can cause problems for image metadata that are in namespaces that glance reserves for itself, or when properties (such as an image signature) cannot apply to the new image, or when an operator has configured glance property protections to make some image properties read-only. Cinder will always filter out image metadata in the namespaces os_glance and img_signature; this configuration option allows operators to specify additional namespaces to be excluded. |
|
(Boolean) 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. |
|
(String(choices=[‘disabled’, ‘enabled’]))
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.
1. |
|
(List of String) 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. |
Configuration option = Default value |
Description |
|---|---|
|
(String) IP address or Hostname of NAS system. |
|
(String) User name to connect to NAS system. |
|
(String) Options used to mount the storage backend file system where Cinder volumes are stored. |
|
(String) Password to connect to NAS system. |
|
(String) Filename of private key to use for SSH authentication. |
|
(String) Allow network-attached storage systems to operate in a secure environment where root level access is not permitted. If set to False, access is as the root user and insecure. If set to True, access is not as root. If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto. |
|
(String) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto. |
|
(String) Path to the share to use for storing Cinder volumes. For example: “/srv/export1” for an NFS server export available at 10.0.5.10:/srv/export1 . |
|
(Port(min=0, max=65535)) SSH port to use to connect to NAS system. |
|
(String(choices=[‘thin’, ‘thick’])) Provisioning type that will be used when creating volumes. |
Configuration option = Default value |
Description |
|---|---|
|
(String) Availability zone for this volume backend. If not set, the storage_availability_zone option value is used as the default for all backends. |
|
(String) Password for specified CHAP account name. |
|
(String) CHAP user name. |
|
(String) Chiscsi (CXT) global defaults configuration file |
|
(String) The path to the client certificate for verification, if the driver supports it. |
|
(String) The path to the client certificate key for verification, if the driver supports it. |
|
(String) Namespace for driver private data values to be saved in. |
|
(String) Can be used to specify a non default path to a CA_BUNDLE file or directory with certificates of trusted CAs, which will be used to validate the backend |
|
(Boolean) If set to True the http client will validate the SSL certificate of the backend endpoint. |
|
(Boolean) Tell driver to use SSL for connection to backend storage if the driver supports it. |
|
(Boolean) Set this to True when you want to allow an unsupported driver to start. Drivers that haven’t maintained a working CI system and testing are marked as unsupported until CI is working again. This also marks a driver as deprecated and may be removed in the next release. |
|
(String) 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. |
|
(String) 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. |
|
(String(choices=[‘blockio’, ‘fileio’, ‘auto’])) 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 |
|
(String) 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. |
|
(String(choices=[‘on’, ‘off’])) 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. |
|
(String(regex=’^(auto|\d*\.\d+|\d+)$’)) 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. |
|
(Integer) Number of times to attempt to run flakey shell commands |
|
(Integer) The maximum number of times to rescan targets to find volume |
|
(Dict of String) 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… |
|
(Boolean) Report to clients of Cinder that the backend supports discard (aka. trim/unmap). This will not actually change the behavior of the backend or the client directly, it will only notify that it can be used. |
|
(Integer(min=0, max=100)) The percentage of backend capacity is reserved |
|
(String(choices=[‘iSCSI’, ‘FC’])) Protocol for transferring data between host and storage back-end. |
|
(String(choices=[‘tgtadm’, ‘lioadm’, ‘scstadmin’, ‘iscsictl’, ‘ietadm’, ‘nvmet’, ‘spdk-nvmeof’, ‘fake’])) 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. |
|
(String) The IP address that the iSCSI/NVMEoF daemon is listening on |
|
(Port(min=0, max=65535)) The port that the iSCSI/NVMEoF daemon is listening on |
|
(String) Prefix for iSCSI/NVMEoF volumes |
|
(String(choices=[‘iscsi’, ‘iser’, ‘nvmet_rdma’, ‘nvmet_tcp’])) 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” or “nvmet_tcp”. |
|
(List of String) The list of secondary IP addresses of the iSCSI/NVMEoF daemon |
|
(List of String) List of options that control which trace info is written to the DEBUG log level to assist developers. Valid values are method and api. |
|
(Boolean) Option to enable/disable CHAP authentication for targets. |
|
(String) The backend name for a given driver implementation |
|
(String(choices=[‘none’, ‘zero’])) Method used to wipe old volumes |
|
(String) 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. |
|
(Integer(max=1024)) Size in MiB to wipe at start of old volumes. 1024 MiB at max. 0 => all |
|
(String) The blkio cgroup name to be used to limit bandwidth of volume copy |
|
(Integer) The upper limit of bandwidth of volume copy. 0 => unlimited |
|
(String) The default block size used when copying/clearing volumes |
|
(String) Volume configuration file storage directory |
|
(String) DEPRECATED: IET configuration file DEPRECATED |
Configuration option = Default value |
Description |
|---|---|
|
(Boolean) If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing. |
|
(String) The full class name of the consistencygroup API class |
|
(String) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes. |
|
(String) Default group type to use |
|
(String) Default volume type to use |
|
(List of String) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options |
|
(String) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address. |
|
(Boolean) Enable monkey patching |
|
(List of String) List of modules/decorators to monkey patch |
|
(HostAddress) IP address of this host |
|
(Boolean) Whether snapshots sizes count against global and per volume type gigabyte quotas. By default snapshots’ sizes are counted. |
|
(String) Path to the rootwrap configuration file to use for running commands as root |
|
(String) Full class name for the Manager for scheduler |
|
(Integer) Maximum time since last check-in for a service to be considered up |
|
(Boolean) Log requests to multiple loggers. |
|
(String) Availability zone of this node. Can be overridden per volume backend with the option “backend_availability_zone”. |
|
(String) The full class name of the volume transfer API class |
|
(String) Full class name for the Manager for volume |
|
(String) Time period for which to generate volume usages. The options are hour, day, month, or year. |
Configuration option = Default value |
Description |
|---|---|
|
(String)
Connection string for a notifier backend.
Default value is |
|
(Boolean) Enable the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values: * True: Enables the feature * False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty. |
|
(String) Document type for notification indexing in elasticsearch. |
|
(Integer) Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000). |
|
(String) This parameter is a time value parameter (for example: es_scroll_time=2m), indicating for how long the nodes that participate in the search will maintain relevant resources in order to continue and support it. |
|
(Boolean) Enable filter traces that contain error/exception to a separated place. Default value is set to False. Possible values: * True: Enable filter traces that contain error/exception. * False: Disable the filter. |
|
(String) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: <key1>[,<key2>,…<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project. Both “enabled” flag and “hmac_keys” config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources. |
|
(String)
Redissentinel uses a service name to identify a master redis service.
This parameter defines the name (for example:
|
|
(Float) Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1). |
|
(Boolean) Enable SQL requests profiling in services. Default value is False (SQL requests won’t be traced). Possible values: * True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that. * False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way. |
Configuration option = Default value |
Description |
|---|---|
|
(Integer) Number of seconds between subsequent usage refreshes |
|
(Integer) Max size allowed per volume, in gigabytes |
|
(Integer) Total amount of storage, in gigabytes, allowed for backups per project |
|
(Integer) Number of volume backups allowed per project |
|
(Integer) Number of consistencygroups allowed per project |
|
(String) Default driver to use for quota checks |
|
(Integer) Total amount of storage, in gigabytes, allowed for volumes and snapshots per project |
|
(Integer) Number of groups allowed per project |
|
(Integer) Number of volume snapshots allowed per project |
|
(Integer) Number of volumes allowed per project |
|
(Integer) Interval between periodic task runs to clean expired reservations in seconds. |
|
(Integer) Number of seconds until a reservation expires |
|
(Integer) Count of reservations until usage is refreshed |
|
(Boolean) Enables or disables use of default quota class with default quota. |
Configuration option = Default value |
Description |
|---|---|
|
(Port(min=0, max=65535)) Port to use to access the SAN API |
|
(String) Cluster name to use for creating volumes |
|
(String) IP address of SAN controller |
|
(Boolean) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device |
|
(String) Username for SAN controller |
|
(String) Password for SAN controller |
|
(String) Filename of private key to use for SSH authentication |
|
(Port(min=0, max=65535)) SSH port to use with SAN |
|
(Boolean) Use thin provisioning for SAN volumes? |
|
(Integer) SSH connection timeout in seconds |
|
(Integer) Maximum ssh connections in the pool |
|
(Integer) Minimum ssh connections in the pool |
Configuration option = Default value |
Description |
|---|---|
|
(String) The name of the iSER target user-land tool to use |
|
(String) The IP address that the iSER daemon is listening on |
|
(Port(min=0, max=65535)) The port that the iSER daemon is listening on |
|
(String) Prefix for iSER volumes |
|
(Integer) The maximum number of times to rescan iSER target to find volume |
Configuration option = Default value |
Description |
|---|---|
|
(Integer) Namespace id for the subsystem for the LVM volume when not sharing targets. The minimum id value when sharing.Maximum supported value in Linux is 8192 |
|
(Port(min=0, max=65535)) The id of the NVMe target port definition when not sharing targets. The starting port id value when sharing, incremented for each secondary ip address. |
Configuration option = Default value |
Description |
|---|---|
|
(String) SCST target implementation can choose from multiple SCST target drivers. |
|
(String) Certain ISCSI targets have predefined target names, SCST target driver uses this name. |
Configuration option = Default value |
Description |
|---|---|
|
(Boolean) Ensure that the new volumes are the same AZ as snapshot or source volume |
