Additional options

Additional options

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

Description of API configuration options
Configuration option = Default value Description
[DEFAULT]  
api_rate_limit = True (Boolean) Enables or disables rate limit of the API.
az_cache_duration = 3600 (Integer) Cache volume availability zones in memory for the provided duration in seconds
backend_host = None (String) Backend override of host value.
default_timeout = 31536000 (Integer) Default timeout for CLI operations in minutes. For example, LUN migration is a typical long running operation, which depends on the LUN size and the load of the array. An upper bound in the specific deployment can be set to avoid unnecessary long wait. By default, it is 365 days long.
enable_v1_api = False (Boolean) DEPRECATED: Deploy v1 of the Cinder API.
enable_v2_api = True (Boolean) DEPRECATED: Deploy v2 of the Cinder API.
enable_v3_api = True (Boolean) Deploy v3 of the Cinder API.
extra_capabilities = {} (String) User defined capabilities, a JSON formatted string specifying key/value pairs. The key/value pairs can be used by the CapabilitiesFilter to select between backends when requests specify volume types. For example, specifying a service level or the geographical location of a backend, then creating a volume type to allow the user to select by these different properties.
ignore_pool_full_threshold = False (Boolean) Force LUN creation even if the full threshold of pool is reached. By default, the value is False.
management_ips = (String) List of Management IP addresses (separated by commas)
message_ttl = 2592000 (Integer) message minimum life in seconds.
osapi_max_limit = 1000 (Integer) The maximum number of items that a collection resource returns in a single response
osapi_volume_base_URL = None (String) Base URL that will be presented to users in links to the OpenStack Volume API
osapi_volume_ext_list = (List) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions
osapi_volume_extension = ['cinder.api.contrib.standard_extensions'] (Multi-valued) osapi volume extension to load
osapi_volume_listen = 0.0.0.0 (String) IP address on which OpenStack Volume API listens
osapi_volume_listen_port = 8776 (Port number) Port on which OpenStack Volume API listens
osapi_volume_use_ssl = False (Boolean) Wraps the socket in a SSL context if True is set. A certificate file and key file must be specified.
osapi_volume_workers = None (Integer) Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available.
per_volume_size_limit = -1 (Integer) Max size allowed per volume, in gigabytes
public_endpoint = None (String) Public url to use for versions endpoint. The default is None, which will use the request’s host_url attribute to populate the URL base. If Cinder is operating behind a proxy, you will want to change this to represent the proxy’s URL.
query_volume_filters = name, status, metadata, availability_zone, bootable, group_id (List) Volume filter options which non-admin user could use to query volumes. Default values are: [‘name’, ‘status’, ‘metadata’, ‘availability_zone’ ,’bootable’, ‘group_id’]
transfer_api_class = cinder.transfer.api.API (String) The full class name of the volume transfer API class
volume_api_class = cinder.volume.api.API (String) The full class name of the volume API class to use
volume_name_prefix = openstack- (String) Prefix before volume name to differentiate DISCO volume created through openstack and the other ones
volume_name_template = volume-%s (String) Template string to be used to generate volume names
volume_number_multiplier = -1.0 (Floating point) Multiplier used for weighing volume number. Negative numbers mean to spread vs stack.
volume_transfer_key_length = 16 (Integer) The number of characters in the autogenerated auth key.
volume_transfer_salt_length = 8 (Integer) The number of characters in the salt.
[oslo_middleware]  
enable_proxy_headers_parsing = False (Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.
max_request_body_size = 114688 (Integer) The maximum body size for each request, in bytes.
secure_proxy_ssl_header = X-Forwarded-Proto (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.
[oslo_versionedobjects]  
fatal_exception_format_errors = False (Boolean) Make exception message format errors fatal
Description of authorization configuration options
Configuration option = Default value Description
[DEFAULT]  
auth_strategy = keystone (String) The strategy to use for auth. Supports noauth or keystone.
Description of backups configuration options
Configuration option = Default value Description
[DEFAULT]  
backup_api_class = cinder.backup.api.API (String) The full class name of the volume backup API class
backup_compression_algorithm = zlib (String) Compression algorithm (None to disable)
backup_driver = cinder.backup.drivers.swift (String) Driver to use for backups.
backup_manager = cinder.backup.manager.BackupManager (String) Full class name for the Manager for volume backup
backup_metadata_version = 2 (Integer) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version.
backup_name_template = backup-%s (String) Template string to be used to generate backup names
backup_object_number_per_notification = 10 (Integer) The number of chunks or objects, for which one Ceilometer notification will be sent
backup_service_inithost_offload = True (Boolean) Offload pending backup delete during backup service startup. If false, the backup service will remain down until all pending backups are deleted.
backup_timer_interval = 120 (Integer) Interval, in seconds, between two progress notifications reporting the backup status
backup_use_same_host = False (Boolean) Backup services use same backend.
backup_use_temp_snapshot = False (Boolean) If this is set to True, the backup_use_temp_snapshot path will be used during the backup. Otherwise, it will use backup_use_temp_volume path.
snapshot_check_timeout = 3600 (Integer) How long we check whether a snapshot is finished before we give up
snapshot_name_template = snapshot-%s (String) Template string to be used to generate snapshot names
snapshot_same_host = True (Boolean) Create volume from snapshot at the host where snapshot resides
Description of block device configuration options
Configuration option = Default value Description
[DEFAULT]  
available_devices = (List) List of all available devices
Description of common configuration options
Configuration option = Default value Description
[DEFAULT]  
allow_availability_zone_fallback = False (Boolean) If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing.
chap = disabled (String) CHAP authentication mode, effective only for iscsi (disabled|enabled)
chap_password = (String) Password for specified CHAP account name.
chap_username = (String) CHAP user name.
chiscsi_conf = /etc/chelsio-iscsi/chiscsi.conf (String) Chiscsi (CXT) global defaults configuration file
cinder_internal_tenant_project_id = None (String) ID of the project which will be used as the Cinder internal tenant.
cinder_internal_tenant_user_id = None (String) ID of the user to be used in volume operations as the Cinder internal tenant.
cluster = None (String) Name of this cluster. Used to group volume hosts that share the same backend configurations to work in HA Active-Active mode. Active-Active is not yet supported.
compute_api_class = cinder.compute.nova.API (String) The full class name of the compute API class to use
connection_type = iscsi (String) Connection type to the IBM Storage Array
consistencygroup_api_class = cinder.consistencygroup.api.API (String) The full class name of the consistencygroup API class
default_availability_zone = None (String) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes.
default_group_type = None (String) Default group type to use
default_volume_type = None (String) Default volume type to use
driver_client_cert = None (String) The path to the client certificate for verification, if the driver supports it.
driver_client_cert_key = None (String) The path to the client certificate key for verification, if the driver supports it.
driver_data_namespace = None (String) Namespace for driver private data values to be saved in.
driver_ssl_cert_path = None (String) Can be used to specify a non default path to a CA_BUNDLE file or directory with certificates of trusted CAs, which will be used to validate the backend
driver_ssl_cert_verify = False (Boolean) If set to True the http client will validate the SSL certificate of the backend endpoint.
enable_force_upload = False (Boolean) Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it.
enable_new_services = True (Boolean) Services to be added to the available pool on create
enable_unsupported_driver = False (Boolean) Set this to True when you want to allow an unsupported driver to start. Drivers that haven’t maintained a working CI system and testing are marked as unsupported until CI is working again. This also marks a driver as deprecated and may be removed in the next release.
end_time = None (String) If this option is specified then the end time specified is used instead of the end time of the last completed audit period.
enforce_multipath_for_image_xfer = False (Boolean) If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path.
executor_thread_pool_size = 64 (Integer) Size of executor thread pool.
fatal_exception_format_errors = False (Boolean) Make exception message format errors fatal.
group_api_class = cinder.group.api.API (String) The full class name of the group API class
host = localhost (String) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address.
iet_conf = /etc/iet/ietd.conf (String) IET configuration file
iscsi_secondary_ip_addresses = (List) The list of secondary IP addresses of the iSCSI daemon
max_over_subscription_ratio = 20.0 (Floating point) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. The ratio has to be a minimum of 1.0.
monkey_patch = False (Boolean) Enable monkey patching
monkey_patch_modules = (List) List of modules/decorators to monkey patch
my_ip = 10.0.0.1 (String) IP address of this host
no_snapshot_gb_quota = False (Boolean) Whether snapshots count against gigabyte quota
num_shell_tries = 3 (Integer) Number of times to attempt to run flakey shell commands
os_privileged_user_auth_url = None (URI) Auth URL associated with the OpenStack privileged account.
os_privileged_user_name = None (String) OpenStack privileged account username. Used for requests to other services (such as Nova) that require an account with special rights.
os_privileged_user_password = None (String) Password associated with the OpenStack privileged account.
os_privileged_user_tenant = None (String) Tenant name associated with the OpenStack privileged account.
periodic_fuzzy_delay = 60 (Integer) Range, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)
periodic_interval = 60 (Integer) Interval, in seconds, between running periodic tasks
replication_device = None (Unknown) Multi opt of dictionaries to represent a replication target device. This option may be specified multiple times in a single config section to specify multiple replication target devices. Each entry takes the standard dict config form: replication_device = target_device_id:<required>,key1:value1,key2:value2…
report_discard_supported = False (Boolean) Report to clients of Cinder that the backend supports discard (aka. trim/unmap). This will not actually change the behavior of the backend or the client directly, it will only notify that it can be used.
report_interval = 10 (Integer) Interval, in seconds, between nodes reporting state to datastore
reserved_percentage = 0 (Integer) The percentage of backend capacity is reserved
rootwrap_config = /etc/cinder/rootwrap.conf (String) Path to the rootwrap configuration file to use for running commands as root
send_actions = False (Boolean) Send the volume and snapshot create and delete notifications generated in the specified period.
service_down_time = 60 (Integer) Maximum time since last check-in for a service to be considered up
ssh_hosts_key_file = $state_path/ssh_known_hosts (String) File containing SSH host keys for the systems with which Cinder needs to communicate. OPTIONAL: Default=$state_path/ssh_known_hosts
start_time = None (String) If this option is specified then the start time specified is used instead of the start time of the last completed audit period.
state_path = /var/lib/cinder (String) Top-level directory for maintaining cinder’s state
storage_availability_zone = nova (String) Availability zone of this node
storage_protocol = iscsi (String) Protocol for transferring data between host and storage back-end.
strict_ssh_host_key_policy = False (Boolean) Option to enable strict host key checking. When set to “True” Cinder will only connect to systems with a host key present in the configured “ssh_hosts_key_file”. When set to “False” the host key will be saved upon first connection and used for subsequent connections. Default=False
suppress_requests_ssl_warnings = False (Boolean) Suppress requests library SSL certificate warnings.
tcp_keepalive = True (Boolean) Sets the value of TCP_KEEPALIVE (True/False) for each server socket.
tcp_keepalive_count = None (Integer) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X.
tcp_keepalive_interval = None (Integer) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X.
until_refresh = 0 (Integer) Count of reservations until usage is refreshed
use_chap_auth = False (Boolean) Option to enable/disable CHAP authentication for targets.
use_forwarded_for = False (Boolean) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.
[healthcheck]  
backends = (List) Additional backends that can perform health checks and report that information back as part of a request.
detailed = False (Boolean) Show more detailed information as part of the response
disable_by_file_path = None (String) Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin.
disable_by_file_paths = (List) Check the presence of a file based on a port to determine if an application is running on a port. Expects a “port:path” list of strings. Used by DisableByFilesPortsHealthcheck plugin.
path = /healthcheck (String) DEPRECATED: The path to respond to healtcheck requests on.
[key_manager]  
backend = castellan.key_manager.barbican_key_manager.BarbicanKeyManager (String) The full class name of the key manager API class
fixed_key = None (String) Fixed key returned by key manager, specified in hex
Description of Compute configuration options
Configuration option = Default value Description
[DEFAULT]  
nova_api_insecure = False (Boolean) Allow to perform insecure SSL requests to nova
nova_ca_certificates_file = None (String) Location of ca certificates file to use for nova client requests.
nova_catalog_admin_info = compute:Compute Service:adminURL (String) Same as nova_catalog_info, but for admin endpoint.
nova_catalog_info = compute:Compute Service:publicURL (String) Match this value when searching for nova in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type>
nova_endpoint_admin_template = None (String) Same as nova_endpoint_template, but for admin endpoint.
nova_endpoint_template = None (String) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s
os_region_name = None (String) Region name of this node
Description of Coordination configuration options
Configuration option = Default value Description
[coordination]  
backend_url = file://$state_path (String) The backend URL to use for distributed coordination.
heartbeat = 1.0 (Floating point) Number of seconds between heartbeats for distributed coordination.
initial_reconnect_backoff = 0.1 (Floating point) Initial number of seconds to wait after failed reconnection.
max_reconnect_backoff = 60.0 (Floating point) Maximum number of seconds between sequential reconnection retries.
Description of logging configuration options
Configuration option = Default value Description
[DEFAULT]  
trace_flags = None (List) List of options that control which trace info is written to the DEBUG log level to assist developers. Valid values are method and api.
Description of DRBD configuration options
Configuration option = Default value Description
[DEFAULT]  
drbdmanage_devs_on_controller = True (Boolean) If set, the c-vol node will receive a useable /dev/drbdX device, even if the actual data is stored on other nodes only. This is useful for debugging, maintenance, and to be able to do the iSCSI export from the c-vol node.
drbdmanage_disk_options = {"c-min-rate": "4M"} (String) Disk options to set on new resources. See http://www.drbd.org/en/doc/users-guide-90/re-drbdconf for all the details.
drbdmanage_net_options = {"connect-int": "4", "allow-two-primaries": "yes", "ko-count": "30", "max-buffers": "20000", "ping-timeout": "100"} (String) Net options to set on new resources. See http://www.drbd.org/en/doc/users-guide-90/re-drbdconf for all the details.
drbdmanage_redundancy = 1 (Integer) Number of nodes that should replicate the data.
drbdmanage_resize_plugin = drbdmanage.plugins.plugins.wait_for.WaitForVolumeSize (String) Volume resize completion wait plugin.
drbdmanage_resize_policy = {"timeout": "60"} (String) Volume resize completion wait policy.
drbdmanage_resource_options = {"auto-promote-timeout": "300"} (String) Resource options to set on new resources. See http://www.drbd.org/en/doc/users-guide-90/re-drbdconf for all the details.
drbdmanage_resource_plugin = drbdmanage.plugins.plugins.wait_for.WaitForResource (String) Resource deployment completion wait plugin.
drbdmanage_resource_policy = {"ratio": "0.51", "timeout": "60"} (String) Resource deployment completion wait policy.
drbdmanage_snapshot_plugin = drbdmanage.plugins.plugins.wait_for.WaitForSnapshot (String) Snapshot completion wait plugin.
drbdmanage_snapshot_policy = {"count": "1", "timeout": "60"} (String) Snapshot completion wait policy.
Description of EMC configuration options
Configuration option = Default value Description
[DEFAULT]  
check_max_pool_luns_threshold = False (Boolean) Report free_capacity_gb as 0 when the limit to maximum number of pool LUNs is reached. By default, the value is False.
cinder_emc_config_file = /etc/cinder/cinder_emc_config.xml (String) Use this file for cinder emc plugin config data
destroy_empty_storage_group = False (Boolean) To destroy storage group when the last LUN is removed from it. By default, the value is False.
force_delete_lun_in_storagegroup = False (Boolean) Delete a LUN even if it is in Storage Groups. By default, the value is False.
initiator_auto_deregistration = False (Boolean) Automatically deregister initiators after the related storage group is destroyed. By default, the value is False.
initiator_auto_registration = False (Boolean) Automatically register initiators. By default, the value is False.
io_port_list = None (List) Comma separated iSCSI or FC ports to be used in Nova or Cinder.
iscsi_initiators = None (String) Mapping between hostname and its iSCSI initiator IP addresses.
max_luns_per_storage_group = 255 (Integer) Default max number of LUNs in a storage group. By default, the value is 255.
multi_pool_support = False (String) Use this value to specify multi-pool support for VMAX3
naviseccli_path = None (String) Naviseccli Path.
storage_vnx_authentication_type = global (String) VNX authentication scope type. By default, the value is global.
storage_vnx_pool_names = None (List) Comma-separated list of storage pool names to be used.
storage_vnx_security_file_dir = None (String) Directory path that contains the VNX security file. Make sure the security file is generated first.
Description of Eternus volume driver configuration options
Configuration option = Default value Description
[DEFAULT]  
cinder_eternus_config_file = /etc/cinder/cinder_fujitsu_eternus_dx.xml (String) config file for cinder eternus_dx volume driver
Description of IBM FlashSystem volume driver configuration options
Configuration option = Default value Description
[DEFAULT]  
flashsystem_connection_protocol = FC (String) Connection protocol should be FC. (Default is FC.)
flashsystem_iscsi_portid = 0 (Integer) Default iSCSI Port ID of FlashSystem. (Default port is 0.)
flashsystem_multihostmap_enabled = True (Boolean) Allows vdisk to multi host mapping. (Default is True)
flashsystem_multipath_enabled = False (Boolean) DEPRECATED: This option no longer has any affect. It is deprecated and will be removed in the next release.
Description of HGST volume driver configuration options
Configuration option = Default value Description
[DEFAULT]  
hgst_net = Net 1 (IPv4) (String) Space network name to use for data transfer
hgst_redundancy = 0 (String) Should spaces be redundantly stored (1/0)
hgst_space_group = disk (String) Group to own created spaces
hgst_space_mode = 0600 (String) UNIX mode for created spaces
hgst_space_user = root (String) User to own created spaces
hgst_storage_servers = os:gbd0 (String) Comma separated list of Space storage servers:devices. ex: os1_stor:gbd0,os2_stor:gbd0
Description of HPE LeftHand/StoreVirtual driver configuration options
Configuration option = Default value Description
[DEFAULT]  
hpelefthand_api_url = None (URI) HPE LeftHand WSAPI Server Url like https://<LeftHand ip>:8081/lhos
hpelefthand_clustername = None (String) HPE LeftHand cluster name
hpelefthand_debug = False (Boolean) Enable HTTP debugging to LeftHand
hpelefthand_iscsi_chap_enabled = False (Boolean) Configure CHAP authentication for iSCSI connections (Default: Disabled)
hpelefthand_password = None (String) HPE LeftHand Super user password
hpelefthand_ssh_port = 16022 (Port number) Port number of SSH service.
hpelefthand_username = None (String) HPE LeftHand Super user username
Description of HPE XP volume driver configuration options
Configuration option = Default value Description
[DEFAULT]  
hpexp_async_copy_check_interval = 10 (Integer) Interval to check copy asynchronously
hpexp_compute_target_ports = None (List) Target port names of compute node for host group or iSCSI target
hpexp_copy_check_interval = 3 (Integer) Interval to check copy
hpexp_copy_speed = 3 (Integer) Copy speed of storage system
hpexp_default_copy_method = FULL (String) Default copy method of storage system. There are two valid values: “FULL” specifies that a full copy; “THIN” specifies that a thin copy. Default value is “FULL”
hpexp_group_request = False (Boolean) Request for creating host group or iSCSI target
hpexp_horcm_add_conf = True (Boolean) Add to HORCM configuration
hpexp_horcm_name_only_discovery = False (Boolean) Only discover a specific name of host group or iSCSI target
hpexp_horcm_numbers = 200, 201 (List) Instance numbers for HORCM
hpexp_horcm_resource_name = meta_resource (String) Resource group name of storage system for HORCM
hpexp_horcm_user = None (String) Username of storage system for HORCM
hpexp_ldev_range = None (String) Logical device range of storage system
hpexp_pool = None (String) Pool of storage system
hpexp_storage_cli = None (String) Type of storage command line interface
hpexp_storage_id = None (String) ID of storage system
hpexp_target_ports = None (List) Target port names for host group or iSCSI target
hpexp_thin_pool = None (String) Thin pool of storage system
hpexp_zoning_request = False (Boolean) Request for FC Zone creating host group
Description of Huawei storage driver configuration options
Configuration option = Default value Description
[DEFAULT]  
cinder_huawei_conf_file = /etc/cinder/cinder_huawei_conf.xml (String) The configuration file for the Cinder Huawei driver.
hypermetro_devices = None (String) The remote device hypermetro will use.
metro_domain_name = None (String) The remote metro device domain name.
metro_san_address = None (String) The remote metro device request url.
metro_san_password = None (String) The remote metro device san password.
metro_san_user = None (String) The remote metro device san user.
metro_storage_pools = None (String) The remote metro device pool names.
Description of HyperV volume driver configuration options
Configuration option = Default value Description
[hyperv]  
force_volumeutils_v1 = False (Boolean) DEPRECATED: Force V1 volume utility class
Description of images configuration options
Configuration option = Default value Description
[DEFAULT]  
allowed_direct_url_schemes = (List) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file, cinder].
glance_api_insecure = False (Boolean) Allow to perform insecure SSL (https) requests to glance (https will be used but cert validation will not be performed).
glance_api_servers = None (List) A list of the URLs of glance API servers available to cinder ([http[s]://][hostname|ip]:port). If protocol is not specified it defaults to http.
glance_api_ssl_compression = False (Boolean) Enables or disables negotiation of SSL layer compression. In some cases disabling compression can improve data throughput, such as when high network bandwidth is available and you use compressed image formats like qcow2.
glance_ca_certificates_file = None (String) Location of ca certificates file to use for glance client requests.
glance_catalog_info = image:glance:publicURL (String) Info to match when looking for glance in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if glance_api_servers are not provided.
glance_core_properties = checksum, container_format, disk_format, image_name, image_id, min_disk, min_ram, name, size (List) Default core properties of image
glance_num_retries = 0 (Integer) Number retries when downloading an image from glance
glance_request_timeout = None (Integer) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used.
image_conversion_dir = $state_path/conversion (String) Directory used for temporary storage during image conversion
image_upload_use_cinder_backend = False (Boolean) If set to True, upload-to-image in raw format will create a cloned volume and register its location to the image service, instead of uploading the volume content. The cinder backend and locations support must be enabled in the image service.
image_upload_use_internal_tenant = False (Boolean) If set to True, the image volume created by upload-to-image will be placed in the internal tenant. Otherwise, the image volume is created in the current context’s tenant.
image_volume_cache_enabled = False (Boolean) Enable the image volume cache for this backend.
image_volume_cache_max_count = 0 (Integer) Max number of entries allowed in the image volume cache. 0 => unlimited.
image_volume_cache_max_size_gb = 0 (Integer) Max size of the image volume cache for this backend in GB. 0 => unlimited.
use_multipath_for_image_xfer = False (Boolean) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers?
Description of NAS configuration options
Configuration option = Default value Description
[DEFAULT]  
nas_host = (String) IP address or Hostname of NAS system.
nas_login = admin (String) User name to connect to NAS system.
nas_mount_options = None (String) Options used to mount the storage backend file system where Cinder volumes are stored.
nas_password = (String) Password to connect to NAS system.
nas_private_key = (String) Filename of private key to use for SSH authentication.
nas_secure_file_operations = auto (String) Allow network-attached storage systems to operate in a secure environment where root level access is not permitted. If set to False, access is as the root user and insecure. If set to True, access is not as root. If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.
nas_secure_file_permissions = auto (String) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.
nas_share_path = (String) Path to the share to use for storing Cinder volumes. For example: “/srv/export1” for an NFS server export available at 10.0.5.10:/srv/export1 .
nas_ssh_port = 22 (Port number) SSH port to use to connect to NAS system.
nas_volume_prov_type = thin (String) Provisioning type that will be used when creating volumes.
Description of profiler configuration options
Configuration option = Default value Description
[profiler]  
connection_string = messaging://

(String) Connection string for a notifier backend. Default value is messaging:// which sets the notifier to oslo_messaging.

Examples of possible values:

  • messaging://: use oslo_messaging driver for sending notifications.
  • mongodb://127.0.0.1:27017 : use mongodb driver for sending notifications.
  • elasticsearch://127.0.0.1:9200 : use elasticsearch driver for sending notifications.
enabled = False

(Boolean) Enables 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.
es_doc_type = notification (String) Document type for notification indexing in elasticsearch.
es_scroll_size = 10000 (Integer) Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000).
es_scroll_time = 2m (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.
hmac_keys = SECRET_KEY

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

sentinel_service_name = mymaster (String) Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example: sentinal_service_name=mymaster).
socket_timeout = 0.1 (Floating point) Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1).
trace_sqlalchemy = False

(Boolean) Enables 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.
Description of Pure Storage driver configuration options
Configuration option = Default value Description
[DEFAULT]  
pure_api_token = None (String) REST API authorization token.
pure_automatic_max_oversubscription_ratio = True (Boolean) Automatically determine an oversubscription ratio based on the current total data reduction values. If used this calculated value will override the max_over_subscription_ratio config option.
pure_eradicate_on_delete = False (Boolean) When enabled, all Pure volumes, snapshots, and protection groups will be eradicated at the time of deletion in Cinder. Data will NOT be recoverable after a delete with this set to True! When disabled, volumes and snapshots will go into pending eradication state and can be recovered.
pure_replica_interval_default = 900 (Integer) Snapshot replication interval in seconds.
pure_replica_retention_long_term_default = 7 (Integer) Retain snapshots per day on target for this time (in days.)
pure_replica_retention_long_term_per_day_default = 3 (Integer) Retain how many snapshots for each day.
pure_replica_retention_short_term_default = 14400 (Integer) Retain all snapshots on target for this time (in seconds.)
Description of quota configuration options
Configuration option = Default value Description
[DEFAULT]  
max_age = 0 (Integer) Number of seconds between subsequent usage refreshes
quota_backup_gigabytes = 1000 (Integer) Total amount of storage, in gigabytes, allowed for backups per project
quota_backups = 10 (Integer) Number of volume backups allowed per project
quota_consistencygroups = 10 (Integer) Number of consistencygroups allowed per project
quota_driver = cinder.quota.DbQuotaDriver (String) Default driver to use for quota checks
quota_gigabytes = 1000 (Integer) Total amount of storage, in gigabytes, allowed for volumes and snapshots per project
quota_groups = 10 (Integer) Number of groups allowed per project
quota_snapshots = 10 (Integer) Number of volume snapshots allowed per project
quota_volumes = 10 (Integer) Number of volumes allowed per project
reservation_expire = 86400 (Integer) Number of seconds until a reservation expires
use_default_quota_class = True (Boolean) Enables or disables use of default quota class with default quota.
Description of Redis configuration options
Configuration option = Default value Description
[matchmaker_redis]  
check_timeout = 20000 (Integer) Time in ms to wait before the transaction is killed.
host = 127.0.0.1 (String) DEPRECATED: Host to locate redis. Replaced by [DEFAULT]/transport_url
password = (String) DEPRECATED: Password for Redis server (optional). Replaced by [DEFAULT]/transport_url
port = 6379 (Port number) DEPRECATED: Use this port to connect to redis host. Replaced by [DEFAULT]/transport_url
sentinel_group_name = oslo-messaging-zeromq (String) Redis replica set name.
sentinel_hosts = (List) DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode), e.g., [host:port, host1:port … ] Replaced by [DEFAULT]/transport_url
socket_timeout = 10000 (Integer) Timeout in ms on blocking socket operations.
wait_timeout = 2000 (Integer) Time in ms to wait between connection attempts.
Description of SAN configuration options
Configuration option = Default value Description
[DEFAULT]  
san_clustername = (String) Cluster name to use for creating volumes
san_ip = (String) IP address of SAN controller
san_is_local = False (Boolean) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device
san_login = admin (String) Username for SAN controller
san_password = (String) Password for SAN controller
san_private_key = (String) Filename of private key to use for SSH authentication
san_ssh_port = 22 (Port number) SSH port to use with SAN
san_thin_provision = True (Boolean) Use thin provisioning for SAN volumes?
ssh_conn_timeout = 30 (Integer) SSH connection timeout in seconds
ssh_max_pool_conn = 5 (Integer) Maximum ssh connections in the pool
ssh_min_pool_conn = 1 (Integer) Minimum ssh connections in the pool
Description of scheduler configuration options
Configuration option = Default value Description
[DEFAULT]  
filter_function = None (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.
goodness_function = None (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.
scheduler_default_filters = AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter (List) Which filter class names to use for filtering hosts when not specified in the request.
scheduler_default_weighers = CapacityWeigher (List) Which weigher class names to use for weighing hosts.
scheduler_driver = cinder.scheduler.filter_scheduler.FilterScheduler (String) Default scheduler driver to use
scheduler_host_manager = cinder.scheduler.host_manager.HostManager (String) The scheduler host manager class to use
scheduler_json_config_location = (String) Absolute path to scheduler configuration JSON file.
scheduler_manager = cinder.scheduler.manager.SchedulerManager (String) Full class name for the Manager for scheduler
scheduler_max_attempts = 3 (Integer) Maximum number of attempts to schedule a volume
scheduler_weight_handler = cinder.scheduler.weights.OrderedHostWeightHandler (String) Which handler to use for selecting the host/pool after weighing
Description of SCST volume driver configuration options
Configuration option = Default value Description
[DEFAULT]  
scst_target_driver = iscsi (String) SCST target implementation can choose from multiple SCST target drivers.
scst_target_iqn_name = None (String) Certain ISCSI targets have predefined target names, SCST target driver uses this name.
Description of storage configuration options
Configuration option = Default value Description
[DEFAULT]  
allocated_capacity_weight_multiplier = -1.0 (Floating point) Multiplier used for weighing allocated capacity. Positive numbers mean to stack vs spread.
capacity_weight_multiplier = 1.0 (Floating point) Multiplier used for weighing free capacity. Negative numbers mean to stack vs spread.
enabled_backends = None (List) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options
iscsi_helper = tgtadm (String) iSCSI 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 or fake for testing.
iscsi_iotype = fileio (String) 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 (String) The IP address that the iSCSI daemon is listening on
iscsi_port = 3260 (Port number) The port that the iSCSI daemon is listening on
iscsi_protocol = iscsi (String) Determines the iSCSI protocol for new iSCSI volumes, created with tgtadm or lioadm 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”.
iscsi_target_flags = (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.
iscsi_target_prefix = iqn.2010-10.org.openstack: (String) Prefix for iSCSI volumes
iscsi_write_cache = on (String) Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if iscsi_helper is set to tgtadm.
iser_helper = tgtadm (String) The name of the iSER target user-land tool to use
iser_ip_address = $my_ip (String) The IP address that the iSER daemon is listening on
iser_port = 3260 (Port number) The port that the iSER daemon is listening on
iser_target_prefix = iqn.2010-10.org.openstack: (String) Prefix for iSER volumes
migration_create_volume_timeout_secs = 300 (Integer) Timeout for creating the volume to migrate to when performing volume migration (seconds)
num_iser_scan_tries = 3 (Integer) The maximum number of times to rescan iSER targetto find volume
num_volume_device_scan_tries = 3 (Integer) The maximum number of times to rescan targets to find volume
volume_backend_name = None (String) The backend name for a given driver implementation
volume_clear = zero (String) Method used to wipe old volumes
volume_clear_ionice = None (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.
volume_clear_size = 0 (Integer) Size in MiB to wipe at start of old volumes. 1024 MiBat max. 0 => all
volume_copy_blkio_cgroup_name = cinder-volume-copy (String) The blkio cgroup name to be used to limit bandwidth of volume copy
volume_copy_bps_limit = 0 (Integer) The upper limit of bandwidth of volume copy. 0 => unlimited
volume_dd_blocksize = 1M (String) The default block size used when copying/clearing volumes
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver (String) Driver to use for volume creation
volume_manager = cinder.volume.manager.VolumeManager (String) Full class name for the Manager for volume
volume_service_inithost_offload = False (Boolean) Offload pending volume delete during volume service startup
volume_usage_audit_period = month (String) Time period for which to generate volume usages. The options are hour, day, month, or year.
volumes_dir = $state_path/volumes (String) Volume configuration file storage directory
Description of zones configuration options
Configuration option = Default value Description
[DEFAULT]  
cloned_volume_same_az = True (Boolean) Ensure that the new volumes are the same AZ as snapshot or source volume
Creative Commons Attribution 3.0 License

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