Table 2.87. New options
| Option = default value |
(Type) Help string |
| [DEFAULT] backend_host = None |
(StrOpt) Backend override of host value. |
| [DEFAULT] backup_container = None |
(StrOpt) Custom container to use for backups. |
| [DEFAULT] backup_enable_progress_timer = True |
(BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the backend storage. The default value is True to enable the timer. |
| [DEFAULT] backup_file_size = 1999994880 |
(IntOpt) The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files. |
| [DEFAULT] backup_mount_options = None |
(StrOpt) Mount options passed to the NFS client. See NFS man page for details. |
| [DEFAULT] backup_mount_point_base = $state_path/backup_mount |
(StrOpt) Base dir containing mount point for NFS share. |
| [DEFAULT] backup_object_number_per_notification = 10 |
(IntOpt) The number of chunks or objects, for which one Ceilometer notification will be sent |
| [DEFAULT] backup_sha_block_size_bytes = 32768 |
(IntOpt) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size. |
| [DEFAULT] backup_share = None |
(StrOpt) NFS share in fqdn:path, ipv4addr:path, or "[ipv6addr]:path" format. |
| [DEFAULT] backup_swift_block_size = 32768 |
(IntOpt) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size. |
| [DEFAULT] backup_swift_enable_progress_timer = True |
(BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the Swift backend storage. The default value is True to enable the timer. |
| [DEFAULT] backup_timer_interval = 120 |
(IntOpt) Interval, in seconds, between two progress notifications reporting the backup status |
| [DEFAULT] cb_account_name = None |
(StrOpt) CloudByte storage specific account name. This maps to a project name in OpenStack. |
| [DEFAULT] cb_add_qosgroup = {'latency': '15', 'iops': '10', 'graceallowed': 'false', 'iopscontrol': 'true', 'memlimit': '0', 'throughput': '0', 'tpcontrol': 'false', 'networkspeed': '0'} |
(DictOpt) These values will be used for CloudByte storage's addQos API call. |
| [DEFAULT] cb_apikey = None |
(StrOpt) Driver will use this API key to authenticate against the CloudByte storage's management interface. |
| [DEFAULT] cb_confirm_volume_create_retries = 3 |
(IntOpt) Will confirm a successful volume creation in CloudByte storage by making this many number of attempts. |
| [DEFAULT] cb_confirm_volume_create_retry_interval = 5 |
(IntOpt) A retry value in seconds. Will be used by the driver to check if volume creation was successful in CloudByte storage. |
| [DEFAULT] cb_create_volume = {'compression': 'off', 'deduplication': 'off', 'blocklength': '512B', 'sync': 'always', 'protocoltype': 'ISCSI', 'recordsize': '16k'} |
(DictOpt) These values will be used for CloudByte storage's createVolume API call. |
| [DEFAULT] cb_tsm_name = None |
(StrOpt) This corresponds to the name of Tenant Storage Machine (TSM) in CloudByte storage. A volume will be created in this TSM. |
| [DEFAULT] chap_password = |
(StrOpt) Password for specified CHAP account name. |
| [DEFAULT] chap_username = |
(StrOpt) CHAP user name. |
| [DEFAULT] check_max_pool_luns_threshold = False |
(BoolOpt) Report free_capacity_gb as 0 when the limit to maximum number of pool LUNs is reached. By default, the value is False. |
| [DEFAULT] chiscsi_conf = /etc/chelsio-iscsi/chiscsi.conf |
(StrOpt) Chiscsi (CXT) global defaults configuration file |
| [DEFAULT] dell_sc_api_port = 3033 |
(IntOpt) Dell API port |
| [DEFAULT] dell_sc_server_folder = openstack |
(StrOpt) Name of the server folder to use on the Storage Center |
| [DEFAULT] dell_sc_ssn = 64702 |
(IntOpt) Storage Center System Serial Number |
| [DEFAULT] dell_sc_volume_folder = openstack |
(StrOpt) Name of the volume folder to use on the Storage Center |
| [DEFAULT] driver_data_namespace = None |
(StrOpt) Namespace for driver private data values to be saved in. |
| [DEFAULT] driver_use_ssl = False |
(BoolOpt) Tell driver to use SSL for connection to backend storage if the driver supports it. |
| [DEFAULT] end_time = None |
(StrOpt) If this option is specified then the end time specified is used instead of the end time of the last completed audit period. |
| [DEFAULT] enforce_multipath_for_image_xfer = False |
(BoolOpt) 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. |
| [DEFAULT] filter_function = None |
(StrOpt) 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. |
| [DEFAULT] flashsystem_connection_protocol = FC |
(StrOpt) Connection protocol should be FC. |
| [DEFAULT] flashsystem_multihostmap_enabled = True |
(BoolOpt) Allows vdisk to multi host mapping. |
| [DEFAULT] flashsystem_multipath_enabled = False |
(BoolOpt) Connect with multipath (FC only). |
| [DEFAULT] force_delete_lun_in_storagegroup = False |
(BoolOpt) Delete a LUN even if it is in Storage Groups. |
| [DEFAULT] gateway_mga = None |
(StrOpt) IP address or hostname of mg-a |
| [DEFAULT] gateway_mgb = None |
(StrOpt) IP address or hostname of mg-b |
| [DEFAULT] goodness_function = None |
(StrOpt) 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. |
| [DEFAULT] initiator_auto_deregistration = False |
(BoolOpt) Automatically deregister initiators after the related storage group is destroyed. By default, the value is False. |
| [DEFAULT] iscsi_protocol = iscsi |
(StrOpt) 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". |
| [DEFAULT] iscsi_secondary_ip_addresses = |
(ListOpt) The list of secondary IP addresses of the iSCSI daemon |
| [DEFAULT] ise_completion_retries = 30 |
(IntOpt) Number on retries to get completion status after issuing a command to ISE. |
| [DEFAULT] ise_connection_retries = 5 |
(IntOpt) Number of retries (per port) when establishing connection to ISE management port. |
| [DEFAULT] ise_raid = 1 |
(IntOpt) Raid level for ISE volumes. |
| [DEFAULT] ise_retry_interval = 1 |
(IntOpt) Interval (secs) between retries. |
| [DEFAULT] ise_storage_pool = 1 |
(IntOpt) Default storage pool for volumes. |
| [DEFAULT] log-config-append = None |
(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. |
| [DEFAULT] log-date-format = %Y-%m-%d %H:%M:%S |
(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . |
| [DEFAULT] log-dir = None |
(StrOpt) (Optional) The base directory used for relative --log-file paths. |
| [DEFAULT] log-file = None |
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. |
| [DEFAULT] 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. |
| [DEFAULT] lvm_conf_file = /etc/cinder/lvm.conf |
(StrOpt) LVM conf file to use for the LVM driver in Cinder; this setting is ignored if the specified file does not exist (You can also specify 'None' to not use a conf file even if one exists). |
| [DEFAULT] max_over_subscription_ratio = 20.0 |
(FloatOpt) 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. A ratio lower than 1.0 will be ignored and the default value will be used instead. |
| [DEFAULT] nas_mount_options = None |
(StrOpt) Options used to mount the storage backend file system where Cinder volumes are stored. |
| [DEFAULT] nas_secure_file_operations = auto |
(StrOpt) 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. |
| [DEFAULT] nas_secure_file_permissions = auto |
(StrOpt) 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. |
| [DEFAULT] nas_share_path = |
(StrOpt) 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 . |
| [DEFAULT] netapp_partner_backend_name = None |
(StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. |
| [DEFAULT] nfs_mount_attempts = 3 |
(IntOpt) The number of attempts to mount nfs shares before raising an error. At least one attempt will be made to mount an nfs share, regardless of the value specified. |
| [DEFAULT] os_privileged_user_name = None |
(StrOpt) OpenStack privileged account username. Used for requests to other services (such as Nova) that require an account with special rights. |
| [DEFAULT] os_privileged_user_password = None |
(StrOpt) Password associated with the OpenStack privileged account. |
| [DEFAULT] os_privileged_user_tenant = None |
(StrOpt) Tenant name associated with the OpenStack privileged account. |
| [DEFAULT] policy_dirs = ['policy.d'] |
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. |
| [DEFAULT] public_endpoint = None |
(StrOpt) 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. |
| [DEFAULT] quobyte_client_cfg = None |
(StrOpt) Path to a Quobyte Client configuration file. |
| [DEFAULT] quobyte_mount_point_base = $state_path/mnt |
(StrOpt) Base dir containing the mount point for the Quobyte volume. |
| [DEFAULT] quobyte_qcow2_volumes = True |
(BoolOpt) Create volumes as QCOW2 files rather than raw files. |
| [DEFAULT] quobyte_sparsed_volumes = True |
(BoolOpt) Create volumes as sparse files which take no space. If set to False, volume is created as regular file.In such case volume creation takes a lot of time. |
| [DEFAULT] quobyte_volume_url = None |
(StrOpt) URL to the Quobyte volume e.g., quobyte://<DIR host>/<volume name> |
| [DEFAULT] request_timeout = 300 |
(IntOpt) Global backend request timeout, in seconds |
| [DEFAULT] scst_target_driver = iscsi |
(StrOpt) SCST target implementation can choose from multiple SCST target drivers. |
| [DEFAULT] scst_target_iqn_name = None |
(StrOpt) Certain ISCSI targets have predefined target names, SCST target driver uses this name. |
| [DEFAULT] send_actions = False |
(BoolOpt) Send the volume and snapshot create and delete notifications generated in the specified period. |
| [DEFAULT] sf_allow_template_caching = True |
(BoolOpt) Create an internal cache of copy of images when a bootable volume is created to eliminate fetch from glance and qemu-conversion on subsequent calls. |
| [DEFAULT] sf_template_account_name = openstack-vtemplate |
(StrOpt) Account name on the SolidFire Cluster to use as owner of template/cache volumes (created if does not exist). |
| [DEFAULT] srb_base_urls = None |
(StrOpt) Comma-separated list of REST servers IP to connect to. (eg http://IP1/,http://IP2:81/path |
| [DEFAULT] start_time = None |
(StrOpt) If this option is specified then the start time specified is used instead of the start time of the last completed audit period. |
| [DEFAULT] syslog-log-facility = LOG_USER |
(StrOpt) Syslog facility to receive log lines. |
| [DEFAULT] use-syslog = False |
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424. |
| [DEFAULT] use-syslog-rfc-format = False |
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J. |
| [DEFAULT] use_chap_auth = False |
(BoolOpt) Option to enable/disable CHAP authentication for targets. |
| [DEFAULT] use_igroups = False |
(BoolOpt) Use igroups to manage targets and initiators |
| [DEFAULT] vpool_name = |
(StrOpt) Vpool to use for volumes - backend is defined by vpool not by us. |
| [DEFAULT] xtremio_cluster_name = |
(StrOpt) XMS cluster id in multi-cluster environment |
| [DEFAULT] zfssa_data_ip = None |
(StrOpt) Data path IP address |
| [DEFAULT] zfssa_https_port = 443 |
(StrOpt) HTTPS port number |
| [DEFAULT] zfssa_nfs_mount_options = |
(StrOpt) Options to be passed while mounting share over nfs |
| [DEFAULT] zfssa_nfs_pool = |
(StrOpt) Storage pool name. |
| [DEFAULT] zfssa_nfs_project = NFSProject |
(StrOpt) Project name. |
| [DEFAULT] zfssa_nfs_share = nfs_share |
(StrOpt) Share name. |
| [DEFAULT] zfssa_nfs_share_compression = off |
(StrOpt) Data compression. |
| [DEFAULT] zfssa_nfs_share_logbias = latency |
(StrOpt) Synchronous write bias-latency, throughput. |
| [oslo_concurrency] disable_process_locking = False |
(BoolOpt) Enables or disables inter-process locks. |
| [oslo_concurrency] lock_path = None |
(StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. |
| [oslo_messaging_amqp] allow_insecure_clients = False |
(BoolOpt) Accept clients using either SSL or plain TCP |
| [oslo_messaging_amqp] broadcast_prefix = broadcast |
(StrOpt) address prefix used when broadcasting to all servers |
| [oslo_messaging_amqp] container_name = None |
(StrOpt) Name for the AMQP container |
| [oslo_messaging_amqp] group_request_prefix = unicast |
(StrOpt) address prefix when sending to any server in group |
| [oslo_messaging_amqp] idle_timeout = 0 |
(IntOpt) Timeout for inactive connections (in seconds) |
| [oslo_messaging_amqp] server_request_prefix = exclusive |
(StrOpt) address prefix used when sending to a specific server |
| [oslo_messaging_amqp] ssl_ca_file = |
(StrOpt) CA certificate PEM file for verifing server certificate |
| [oslo_messaging_amqp] ssl_cert_file = |
(StrOpt) Identifying certificate PEM file to present to clients |
| [oslo_messaging_amqp] ssl_key_file = |
(StrOpt) Private key PEM file used to sign cert_file certificate |
| [oslo_messaging_amqp] ssl_key_password = None |
(StrOpt) Password for decrypting ssl_key_file (if encrypted) |
| [oslo_messaging_amqp] trace = False |
(BoolOpt) Debug: dump AMQP frames to stdout |
| [oslo_messaging_qpid] amqp_auto_delete = False |
(BoolOpt) Auto-delete queues in AMQP. |
| [oslo_messaging_qpid] amqp_durable_queues = False |
(BoolOpt) Use durable queues in AMQP. |
| [oslo_messaging_qpid] qpid_heartbeat = 60 |
(IntOpt) Seconds between connection keepalive heartbeats. |
| [oslo_messaging_qpid] qpid_hostname = localhost |
(StrOpt) Qpid broker hostname. |
| [oslo_messaging_qpid] qpid_hosts = $qpid_hostname:$qpid_port |
(ListOpt) Qpid HA cluster host:port pairs. |
| [oslo_messaging_qpid] qpid_password = |
(StrOpt) Password for Qpid connection. |
| [oslo_messaging_qpid] qpid_port = 5672 |
(IntOpt) Qpid broker port. |
| [oslo_messaging_qpid] qpid_protocol = tcp |
(StrOpt) Transport to use, either 'tcp' or 'ssl'. |
| [oslo_messaging_qpid] qpid_receiver_capacity = 1 |
(IntOpt) The number of prefetched messages held by receiver. |
| [oslo_messaging_qpid] qpid_sasl_mechanisms = |
(StrOpt) Space separated list of SASL mechanisms to use for auth. |
| [oslo_messaging_qpid] qpid_tcp_nodelay = True |
(BoolOpt) Whether to disable the Nagle algorithm. |
| [oslo_messaging_qpid] 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. |
| [oslo_messaging_qpid] qpid_username = |
(StrOpt) Username for Qpid connection. |
| [oslo_messaging_qpid] rpc_conn_pool_size = 30 |
(IntOpt) Size of RPC connection pool. |
| [oslo_messaging_rabbit] amqp_auto_delete = False |
(BoolOpt) Auto-delete queues in AMQP. |
| [oslo_messaging_rabbit] amqp_durable_queues = False |
(BoolOpt) Use durable queues in AMQP. |
| [oslo_messaging_rabbit] fake_rabbit = False |
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake |
| [oslo_messaging_rabbit] heartbeat_rate = 2 |
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. |
| [oslo_messaging_rabbit] heartbeat_timeout_threshold = 0 |
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it. Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL |
| [oslo_messaging_rabbit] kombu_reconnect_delay = 1.0 |
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. |
| [oslo_messaging_rabbit] kombu_ssl_ca_certs = |
(StrOpt) SSL certification authority file (valid only if SSL enabled). |
| [oslo_messaging_rabbit] kombu_ssl_certfile = |
(StrOpt) SSL cert file (valid only if SSL enabled). |
| [oslo_messaging_rabbit] kombu_ssl_keyfile = |
(StrOpt) SSL key file (valid only if SSL enabled). |
| [oslo_messaging_rabbit] kombu_ssl_version = |
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. |
| [oslo_messaging_rabbit] 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. |
| [oslo_messaging_rabbit] rabbit_host = localhost |
(StrOpt) The RabbitMQ broker address where a single node is used. |
| [oslo_messaging_rabbit] rabbit_hosts = $rabbit_host:$rabbit_port |
(ListOpt) RabbitMQ HA cluster host:port pairs. |
| [oslo_messaging_rabbit] rabbit_login_method = AMQPLAIN |
(StrOpt) The RabbitMQ login method. |
| [oslo_messaging_rabbit] rabbit_max_retries = 0 |
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). |
| [oslo_messaging_rabbit] rabbit_password = guest |
(StrOpt) The RabbitMQ password. |
| [oslo_messaging_rabbit] rabbit_port = 5672 |
(IntOpt) The RabbitMQ broker port where a single node is used. |
| [oslo_messaging_rabbit] rabbit_retry_backoff = 2 |
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ. |
| [oslo_messaging_rabbit] rabbit_retry_interval = 1 |
(IntOpt) How frequently to retry connecting with RabbitMQ. |
| [oslo_messaging_rabbit] rabbit_use_ssl = False |
(BoolOpt) Connect over SSL for RabbitMQ. |
| [oslo_messaging_rabbit] rabbit_userid = guest |
(StrOpt) The RabbitMQ userid. |
| [oslo_messaging_rabbit] rabbit_virtual_host = / |
(StrOpt) The RabbitMQ virtual host. |
| [oslo_messaging_rabbit] rpc_conn_pool_size = 30 |
(IntOpt) Size of RPC connection pool. |
| [oslo_middleware] max_request_body_size = 114688 |
(IntOpt) The maximum body size for each request, in bytes. |
