Red Hat Training

A Red Hat training course is available for Red Hat OpenStack Platform

Chapter 3. Block Storage

The OpenStack Block Storage service provides persistent storage for Compute instances, working with many different storage drivers that you can configure.

3.1. Block Storage Configuration Options

Note

The common configurations for shared services and libraries, such as database connections and RPC messaging, are described at Common configurations.

3.1.1. Description of Configuration Options

The following tables provide a comprehensive list of the Block Storage configuration options.

Table 3.1. Description of API configuration options

Configuration option = Default valueDescription

[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

Table 3.2. Description of authorization configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

auth_strategy = keystone

(String) The strategy to use for auth. Supports noauth or keystone.

Table 3.3. Description of Ceph backup driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

backup_ceph_chunk_size = 134217728

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

backup_ceph_conf = /etc/ceph/ceph.conf

(String) Ceph configuration file to use.

backup_ceph_pool = backups

(String) The Ceph pool where volume backups are stored.

backup_ceph_stripe_count = 0

(Integer) RBD stripe count to use when creating a backup image.

backup_ceph_stripe_unit = 0

(Integer) RBD stripe unit to use when creating a backup image.

backup_ceph_user = cinder

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

restore_discard_excess_bytes = True

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

Table 3.4. Description of GCS backup driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

backup_gcs_block_size = 32768

(Integer) The size in bytes that changes are tracked for incremental backups. backup_gcs_object_size has to be multiple of backup_gcs_block_size.

backup_gcs_bucket = None

(String) The GCS bucket to use.

backup_gcs_bucket_location = US

(String) Location of GCS bucket.

backup_gcs_credential_file = None

(String) Absolute path of GCS service account credential file.

backup_gcs_enable_progress_timer = True

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

backup_gcs_num_retries = 3

(Integer) Number of times to retry.

backup_gcs_object_size = 52428800

(Integer) The size in bytes of GCS backup objects.

backup_gcs_project_id = None

(String) Owner project id for GCS bucket.

backup_gcs_proxy_url = None

(URI) URL for http proxy access.

backup_gcs_reader_chunk_size = 2097152

(Integer) GCS object will be downloaded in chunks of bytes.

backup_gcs_retry_error_codes = 429

(List) List of GCS error codes.

backup_gcs_storage_class = NEARLINE

(String) Storage class of GCS bucket.

backup_gcs_user_agent = gcscinder

(String) Http user-agent string for gcs api.

backup_gcs_writer_chunk_size = 2097152

(Integer) GCS object will be uploaded in chunks of bytes. Pass in a value of -1 if the file is to be uploaded as a single chunk.

Table 3.5. Description of NFS backup driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

backup_container = None

(String) Custom directory to use for backups.

backup_enable_progress_timer = True

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

backup_file_size = 1999994880

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

backup_mount_options = None

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

backup_mount_point_base = $state_path/backup_mount

(String) Base dir containing mount point for NFS share.

backup_sha_block_size_bytes = 32768

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

backup_share = None

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

Table 3.6. Description of POSIX backup driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

backup_container = None

(String) Custom directory to use for backups.

backup_enable_progress_timer = True

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

backup_file_size = 1999994880

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

backup_posix_path = $state_path/backup

(String) Path specifying where to store backups.

backup_sha_block_size_bytes = 32768

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

Table 3.7. Description of backups configuration options

Configuration option = Default valueDescription

[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

Table 3.8. Description of Swift backup driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

backup_swift_auth = per_user

(String) Swift authentication mechanism

backup_swift_auth_version = 1

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

backup_swift_block_size = 32768

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

backup_swift_ca_cert_file = None

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

backup_swift_container = volumebackups

(String) The default Swift container to use

backup_swift_enable_progress_timer = True

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

backup_swift_key = None

(String) Swift key for authentication

backup_swift_object_size = 52428800

(Integer) The size in bytes of Swift backup objects

backup_swift_project = None

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

backup_swift_project_domain = None

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

backup_swift_retry_attempts = 3

(Integer) The number of retries to make for Swift operations

backup_swift_retry_backoff = 2

(Integer) The backoff time in seconds between Swift retries

backup_swift_tenant = None

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

backup_swift_url = None

(URI) The URL of the Swift endpoint

backup_swift_user = None

(String) Swift user name

backup_swift_user_domain = None

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

keystone_catalog_info = identity:Identity Service:publicURL

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

swift_catalog_info = object-store:swift:publicURL

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

Table 3.9. Description of IBM Tivoli Storage Manager backup driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

backup_tsm_compression = True

(Boolean) Enable or Disable compression for backups

backup_tsm_password = password

(String) TSM password for the running username

backup_tsm_volume_prefix = backup

(String) Volume prefix for the backup id when backing up to TSM

Table 3.10. Description of block device configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

available_devices =

(List) List of all available devices

Table 3.11. Description of CloudByte volume driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

cb_account_name = None

(String) CloudByte storage specific account name. This maps to a project name in OpenStack.

cb_add_qosgroup = {'latency': '15', 'iops': '10', 'graceallowed': 'false', 'iopscontrol': 'true', 'memlimit': '0', 'throughput': '0', 'tpcontrol': 'false', 'networkspeed': '0'}

(Dict) These values will be used for CloudByte storage’s addQos API call.

cb_apikey = None

(String) Driver will use this API key to authenticate against the CloudByte storage’s management interface.

cb_auth_group = None

(String) This corresponds to the discovery authentication group in CloudByte storage. Chap users are added to this group. Driver uses the first user found for this group. Default value is None.

cb_confirm_volume_create_retries = 3

(Integer) Will confirm a successful volume creation in CloudByte storage by making this many number of attempts.

cb_confirm_volume_create_retry_interval = 5

(Integer) A retry value in seconds. Will be used by the driver to check if volume creation was successful in CloudByte storage.

cb_confirm_volume_delete_retries = 3

(Integer) Will confirm a successful volume deletion in CloudByte storage by making this many number of attempts.

cb_confirm_volume_delete_retry_interval = 5

(Integer) A retry value in seconds. Will be used by the driver to check if volume deletion was successful in CloudByte storage.

cb_create_volume = {'compression': 'off', 'deduplication': 'off', 'blocklength': '512B', 'sync': 'always', 'protocoltype': 'ISCSI', 'recordsize': '16k'}

(Dict) These values will be used for CloudByte storage’s createVolume API call.

cb_tsm_name = None

(String) This corresponds to the name of Tenant Storage Machine (TSM) in CloudByte storage. A volume will be created in this TSM.

cb_update_file_system = compression, sync, noofcopies, readonly

(List) These values will be used for CloudByte storage’s updateFileSystem API call.

cb_update_qos_group = iops, latency, graceallowed

(List) These values will be used for CloudByte storage’s updateQosGroup API call.

Table 3.12. Description of Coho volume driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

coho_rpc_port = 2049

(Integer) RPC port to connect to Coho Data MicroArray

Table 3.13. Description of common configuration options

Configuration option = Default valueDescription

[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]

 

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

Table 3.14. Description of Compute configuration options

Configuration option = Default valueDescription

[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

Table 3.15. Description of Coordination configuration options

Configuration option = Default valueDescription

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

Table 3.16. Description of logging configuration options

Configuration option = Default valueDescription

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

Table 3.17. Description of Dell Storage Center volume driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

dell_sc_api_port = 3033

(Port number) Dell API port

dell_sc_server_folder = openstack

(String) Name of the server folder to use on the Storage Center

dell_sc_ssn = 64702

(Integer) Storage Center System Serial Number

dell_sc_verify_cert = False

(Boolean) Enable HTTPS SC certificate verification

dell_sc_volume_folder = openstack

(String) Name of the volume folder to use on the Storage Center

dell_server_os = Red Hat Linux 6.x

(String) Server OS type to use when creating a new server on the Storage Center.

excluded_domain_ip = None

(Unknown) Domain IP to be excluded from iSCSI returns.

secondary_san_ip =

(String) IP address of secondary DSM controller

secondary_san_login = Admin

(String) Secondary DSM user name

secondary_san_password =

(String) Secondary DSM user password name

secondary_sc_api_port = 3033

(Port number) Secondary Dell API port

Table 3.18. Description of EMC configuration options

Configuration option = Default valueDescription

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

Table 3.19. Description of EMC SIO volume driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

sio_max_over_subscription_ratio = 10.0

(Floating point) max_over_subscription_ratio setting for the ScaleIO driver. This replaces the general max_over_subscription_ratio which has no effect in this driver.Maximum value allowed for ScaleIO is 10.0.

sio_protection_domain_id = None

(String) Protection Domain ID.

sio_protection_domain_name = None

(String) Protection Domain name.

sio_rest_server_port = 443

(String) REST server port.

sio_round_volume_capacity = True

(Boolean) Round up volume capacity.

sio_server_certificate_path = None

(String) Server certificate path.

sio_storage_pool_id = None

(String) Storage Pool ID.

sio_storage_pool_name = None

(String) Storage Pool name.

sio_storage_pools = None

(String) Storage Pools.

sio_unmap_volume_before_deletion = False

(Boolean) Unmap volume before deletion.

sio_verify_server_certificate = False

(Boolean) Verify server certificate.

Table 3.20. Description of EMC XtremIO volume driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

xtremio_array_busy_retry_count = 5

(Integer) Number of retries in case array is busy

xtremio_array_busy_retry_interval = 5

(Integer) Interval between retries in case array is busy

xtremio_cluster_name =

(String) XMS cluster id in multi-cluster environment

xtremio_volumes_per_glance_cache = 100

(Integer) Number of volumes created from each cached glance image

Table 3.21. Description of Dell EqualLogic volume driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

eqlx_cli_max_retries = 5

(Integer) Maximum retry count for reconnection. Default is 5.

eqlx_group_name = group-0

(String) Group name to use for creating volumes. Defaults to "group-0".

eqlx_pool = default

(String) Pool in which volumes will be created. Defaults to "default".

Table 3.22. Description of Eternus volume driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

cinder_eternus_config_file = /etc/cinder/cinder_fujitsu_eternus_dx.xml

(String) config file for cinder eternus_dx volume driver

Table 3.23. Description of IBM FlashSystem volume driver configuration options

Configuration option = Default valueDescription

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

Table 3.24. Description of Hitachi storage volume driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

hitachi_add_chap_user = False

(Boolean) Add CHAP user

hitachi_async_copy_check_interval = 10

(Integer) Interval to check copy asynchronously

hitachi_auth_method = None

(String) iSCSI authentication method

hitachi_auth_password = HBSD-CHAP-password

(String) iSCSI authentication password

hitachi_auth_user = HBSD-CHAP-user

(String) iSCSI authentication username

hitachi_copy_check_interval = 3

(Integer) Interval to check copy

hitachi_copy_speed = 3

(Integer) Copy speed of storage system

hitachi_default_copy_method = FULL

(String) Default copy method of storage system

hitachi_group_range = None

(String) Range of group number

hitachi_group_request = False

(Boolean) Request for creating HostGroup or iSCSI Target

hitachi_horcm_add_conf = True

(Boolean) Add to HORCM configuration

hitachi_horcm_numbers = 200,201

(String) Instance numbers for HORCM

hitachi_horcm_password = None

(String) Password of storage system for HORCM

hitachi_horcm_resource_lock_timeout = 600

(Integer) Timeout until a resource lock is released, in seconds. The value must be between 0 and 7200.

hitachi_horcm_user = None

(String) Username of storage system for HORCM

hitachi_ldev_range = None

(String) Range of logical device of storage system

hitachi_pool_id = None

(Integer) Pool ID of storage system

hitachi_serial_number = None

(String) Serial number of storage system

hitachi_target_ports = None

(String) Control port names for HostGroup or iSCSI Target

hitachi_thin_pool_id = None

(Integer) Thin pool ID of storage system

hitachi_unit_name = None

(String) Name of an array unit

hitachi_zoning_request = False

(Boolean) Request for FC Zone creating HostGroup

Table 3.25. Description of Hitachi HNAS iSCSI and NFS driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

hds_hnas_iscsi_config_file = /opt/hds/hnas/cinder_iscsi_conf.xml

(String) DEPRECATED: Legacy configuration file for HNAS iSCSI Cinder plugin. This is not needed if you fill all configuration on cinder.conf

hds_hnas_nfs_config_file = /opt/hds/hnas/cinder_nfs_conf.xml

(String) DEPRECATED: Legacy configuration file for HNAS NFS Cinder plugin. This is not needed if you fill all configuration on cinder.conf

hnas_chap_enabled = True

(Boolean) Whether the chap authentication is enabled in the iSCSI target or not.

hnas_cluster_admin_ip0 = None

(String) The IP of the HNAS cluster admin. Required only for HNAS multi-cluster setups.

hnas_mgmt_ip0 = None

(IP) Management IP address of HNAS. This can be any IP in the admin address on HNAS or the SMU IP.

hnas_password = None

(String) HNAS password.

hnas_ssc_cmd = ssc

(String) Command to communicate to HNAS.

hnas_ssh_port = 22

(Port number) Port to be used for SSH authentication.

hnas_ssh_private_key = None

(String) Path to the SSH private key used to authenticate in HNAS SMU.

hnas_svc0_hdp = None

(String) Service 0 HDP

hnas_svc0_iscsi_ip = None

(IP) Service 0 iSCSI IP

hnas_svc0_pool_name = None

(String) Service 0 pool name

hnas_svc1_hdp = None

(String) Service 1 HDP

hnas_svc1_iscsi_ip = None

(IP) Service 1 iSCSI IP

hnas_svc1_pool_name = None

(String) Service 1 pool name

hnas_svc2_hdp = None

(String) Service 2 HDP

hnas_svc2_iscsi_ip = None

(IP) Service 2 iSCSI IP

hnas_svc2_pool_name = None

(String) Service 2 pool name

hnas_svc3_hdp = None

(String) Service 3 HDP

hnas_svc3_iscsi_ip = None

(IP) Service 3 iSCSI IP

hnas_svc3_pool_name = None

(String) Service 3 pool name:

hnas_username = None

(String) HNAS username.

Table 3.26. Description of HORCM interface module for Hitachi VSP driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

vsp_async_copy_check_interval = 10

(Integer) Interval in seconds at which volume pair synchronization status is checked when volume pairs are deleted.

vsp_auth_password = None

(String) Password corresponding to vsp_auth_user.

vsp_auth_user = None

(String) Name of the user used for CHAP authentication performed in communication between hosts and iSCSI targets on the storage ports.

vsp_compute_target_ports = None

(List) IDs of the storage ports used to attach volumes to compute nodes. To specify multiple ports, connect them by commas (e.g. CL1-A,CL2-A).

vsp_copy_check_interval = 3

(Integer) Interval in seconds at which volume pair synchronization status is checked when volume pairs are created.

vsp_copy_speed = 3

(Integer) Speed at which data is copied by Shadow Image. 1 or 2 indicates low speed, 3 indicates middle speed, and a value between 4 and 15 indicates high speed.

vsp_default_copy_method = FULL

(String) Method of volume copy. FULL indicates full data copy by Shadow Image and THIN indicates differential data copy by Thin Image.

vsp_group_request = False

(Boolean) If True, the driver will create host groups or iSCSI targets on storage ports as needed.

vsp_horcm_add_conf = True

(Boolean) If True, the driver will create or update the Command Control Interface configuration file as needed.

vsp_horcm_numbers = 200, 201

(List) Command Control Interface instance numbers in the format of 'xxx,yyy'. The second one is for Shadow Image operation and the first one is for other purposes.

vsp_horcm_pair_target_ports = None

(List) IDs of the storage ports used to copy volumes by Shadow Image or Thin Image. To specify multiple ports, connect them by commas (e.g. CL1-A,CL2-A).

vsp_horcm_password = None

(String) Password corresponding to vsp_horcm_user.

vsp_horcm_user = None

(String) Name of the user on the storage system.

vsp_ldev_range = None

(String) Range of the LDEV numbers in the format of 'xxxx-yyyy' that can be used by the driver. Values can be in decimal format (e.g. 1000) or in colon-separated hexadecimal format (e.g. 00:03:E8).

vsp_pool = None

(String) Pool number or pool name of the DP pool.

vsp_storage_id = None

(String) Product number of the storage system.

vsp_target_ports = None

(List) IDs of the storage ports used to attach volumes to the controller node. To specify multiple ports, connect them by commas (e.g. CL1-A,CL2-A).

vsp_thin_pool = None

(String) Pool number or pool name of the Thin Image pool.

vsp_use_chap_auth = False

(Boolean) If True, CHAP authentication will be applied to communication between hosts and any of the iSCSI targets on the storage ports.

vsp_zoning_request = False

(Boolean) If True, the driver will configure FC zoning between the server and the storage system provided that FC zoning manager is enabled.

Table 3.27. Description of HPE 3PAR Fibre Channel and iSCSI drivers configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

hpe3par_api_url =

(String) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1

hpe3par_cpg = OpenStack

(List) List of the CPG(s) to use for volume creation

hpe3par_cpg_snap =

(String) The CPG to use for Snapshots for volumes. If empty the userCPG will be used.

hpe3par_debug = False

(Boolean) Enable HTTP debugging to 3PAR

hpe3par_iscsi_chap_enabled = False

(Boolean) Enable CHAP authentication for iSCSI connections.

hpe3par_iscsi_ips =

(List) List of target iSCSI addresses to use.

hpe3par_password =

(String) 3PAR password for the user specified in hpe3par_username

hpe3par_snapshot_expiration =

(String) The time in hours when a snapshot expires and is deleted. This must be larger than expiration

hpe3par_snapshot_retention =

(String) The time in hours to retain a snapshot. You can’t delete it before this expires.

hpe3par_username =

(String) 3PAR username with the 'edit' role

Table 3.28. Description of HPE LeftHand/StoreVirtual driver configuration options

Configuration option = Default valueDescription

[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

Table 3.29. Description of Huawei storage driver configuration options

Configuration option = Default valueDescription

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

Table 3.30. Description of IBM Storage driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

ds8k_devadd_unitadd_mapping =

(String) Mapping between IODevice address and unit address.

ds8k_host_type = auto

(String) Set to zLinux if your OpenStack version is prior to Liberty and you’re connecting to zLinux systems. Otherwise set to auto. Valid values for this parameter are: 'auto', 'AMDLinuxRHEL', 'AMDLinuxSuse', 'AppleOSX', 'Fujitsu', 'Hp', 'HpTru64', 'HpVms', 'LinuxDT', 'LinuxRF', 'LinuxRHEL', 'LinuxSuse', 'Novell', 'SGI', 'SVC', 'SanFsAIX', 'SanFsLinux', 'Sun', 'VMWare', 'Win2000', 'Win2003', 'Win2008', 'Win2012', 'iLinux', 'nSeries', 'pLinux', 'pSeries', 'pSeriesPowerswap', 'zLinux', 'iSeries'.

ds8k_ssid_prefix = FF

(String) Set the first two digits of SSID

proxy = cinder.volume.drivers.ibm.ibm_storage.proxy.IBMStorageProxy

(String) Proxy driver that connects to the IBM Storage Array

san_clustername =

(String) Cluster name to use for creating volumes

san_ip =

(String) IP address of SAN controller

san_login = admin

(String) Username for SAN controller

san_password =

(String) Password for SAN controller

Table 3.31. Description of images configuration options

Configuration option = Default valueDescription

[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_api_version = 2

(Integer) Version of the glance API to use

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, and glance_api_version must be set to 2.

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?

Table 3.32. Description of INFINIDAT InfiniBox volume driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

infinidat_pool_name = None

(String) Name of the pool from which volumes are allocated

Table 3.33. Description of Kaminario volume driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

auto_calc_max_oversubscription_ratio = False

(Boolean) K2 driver will calculate max_oversubscription_ratio on setting this option as True.

Table 3.34. Description of LVM configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

lvm_conf_file = /etc/cinder/lvm.conf

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

lvm_max_over_subscription_ratio = 1.0

(Floating point) max_over_subscription_ratio setting for the LVM driver. If set, this takes precedence over the general max_over_subscription_ratio option. If None, the general option is used.

lvm_mirrors = 0

(Integer) If >0, create LVs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space

lvm_suppress_fd_warnings = False

(Boolean) Suppress leaked file descriptor warnings in LVM commands.

lvm_type = default

(String) Type of LVM volumes to deploy; (default, thin, or auto). Auto defaults to thin if thin is supported.

volume_group = cinder-volumes

(String) Name for the VG that will contain exported volumes

Table 3.35. Description of NAS configuration options

Configuration option = Default valueDescription

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

Table 3.36. Description of NEC Storage M series driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

nec_actual_free_capacity = False

(Boolean) Return actual free capacity.

nec_backend_max_ld_count = 1024

(Integer) Maximum number of managing sessions.

nec_backup_ldname_format = LX:%s

(String) M-Series Storage LD name format for snapshots.

nec_backup_pools =

(List) M-Series Storage backup pool number to be used.

nec_diskarray_name =

(String) Diskarray name of M-Series Storage.

nec_iscsi_portals_per_cont = 1

(Integer) Number of iSCSI portals.

nec_ismcli_fip = None

(IP) FIP address of M-Series Storage iSMCLI.

nec_ismcli_password =

(String) Password for M-Series Storage iSMCLI.

nec_ismcli_privkey =

(String) Filename of RSA private key for M-Series Storage iSMCLI.

nec_ismcli_user =

(String) User name for M-Series Storage iSMCLI.

nec_ismview_alloptimize = False

(Boolean) Use legacy iSMCLI command with optimization.

nec_ismview_dir = /tmp/nec/cinder

(String) Output path of iSMview file.

nec_ldname_format = LX:%s

(String) M-Series Storage LD name format for volumes.

nec_ldset =

(String) M-Series Storage LD Set name for Compute Node.

nec_ldset_for_controller_node =

(String) M-Series Storage LD Set name for Controller Node.

nec_pools =

(List) M-Series Storage pool numbers list to be used.

nec_queryconfig_view = False

(Boolean) Use legacy iSMCLI command.

nec_ssh_pool_port_number = 22

(Integer) Port number of ssh pool.

nec_unpairthread_timeout = 3600

(Integer) Timeout value of Unpairthread.

Table 3.37. Description of NetApp 7-Mode iSCSI driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

netapp_login = None

(String) Administrative user account name used to access the storage system or proxy server.

netapp_partner_backend_name = None

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

netapp_password = None

(String) Password for the administrative user account specified in the netapp_login option.

netapp_pool_name_search_pattern = (.+)

(String) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC.

netapp_replication_aggregate_map = None

(Unknown) Multi opt of dictionaries to represent the aggregate mapping between source and destination back ends when using whole back end replication. For every source aggregate associated with a cinder pool (NetApp FlexVol), you would need to specify the destination aggregate on the replication target device. A replication target device is configured with the configuration option replication_device. Specify this option as many times as you have replication devices. Each entry takes the standard dict config form: netapp_replication_aggregate_map = backend_id:<name_of_replication_device_section>,src_aggr_name1:dest_aggr_name1,src_aggr_name2:dest_aggr_name2,…​

netapp_server_hostname = None

(String) The hostname (or IP address) for the storage system or proxy server.

netapp_server_port = None

(Integer) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.

netapp_size_multiplier = 1.2

(Floating point) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. Note: this option is deprecated and will be removed in favor of "reserved_percentage" in the Mitaka release.

netapp_snapmirror_quiesce_timeout = 3600

(Integer) The maximum time in seconds to wait for existing SnapMirror transfers to complete before aborting during a failover.

netapp_storage_family = ontap_cluster

(String) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.

netapp_storage_protocol = None

(String) The storage protocol to be used on the data path with the storage system.

netapp_transport_type = http

(String) The transport protocol used when communicating with the storage system or proxy server.

netapp_vfiler = None

(String) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode. Only use this option when utilizing the MultiStore feature on the NetApp storage system.

Table 3.38. Description of NetApp 7-Mode NFS driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

expiry_thres_minutes = 720

(Integer) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share.

netapp_login = None

(String) Administrative user account name used to access the storage system or proxy server.

netapp_partner_backend_name = None

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

netapp_password = None

(String) Password for the administrative user account specified in the netapp_login option.

netapp_pool_name_search_pattern = (.+)

(String) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC.

netapp_replication_aggregate_map = None

(Unknown) Multi opt of dictionaries to represent the aggregate mapping between source and destination back ends when using whole back end replication. For every source aggregate associated with a cinder pool (NetApp FlexVol), you would need to specify the destination aggregate on the replication target device. A replication target device is configured with the configuration option replication_device. Specify this option as many times as you have replication devices. Each entry takes the standard dict config form: netapp_replication_aggregate_map = backend_id:<name_of_replication_device_section>,src_aggr_name1:dest_aggr_name1,src_aggr_name2:dest_aggr_name2,…​

netapp_server_hostname = None

(String) The hostname (or IP address) for the storage system or proxy server.

netapp_server_port = None

(Integer) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.

netapp_snapmirror_quiesce_timeout = 3600

(Integer) The maximum time in seconds to wait for existing SnapMirror transfers to complete before aborting during a failover.

netapp_storage_family = ontap_cluster

(String) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.

netapp_storage_protocol = None

(String) The storage protocol to be used on the data path with the storage system.

netapp_transport_type = http

(String) The transport protocol used when communicating with the storage system or proxy server.

netapp_vfiler = None

(String) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode. Only use this option when utilizing the MultiStore feature on the NetApp storage system.

thres_avl_size_perc_start = 20

(Integer) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned.

thres_avl_size_perc_stop = 60

(Integer) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option.

Table 3.39. Description of NetApp cDOT iSCSI driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

netapp_login = None

(String) Administrative user account name used to access the storage system or proxy server.

netapp_lun_ostype = None

(String) This option defines the type of operating system that will access a LUN exported from Data ONTAP; it is assigned to the LUN at the time it is created.

netapp_lun_space_reservation = enabled

(String) This option determines if storage space is reserved for LUN allocation. If enabled, LUNs are thick provisioned. If space reservation is disabled, storage space is allocated on demand.

netapp_partner_backend_name = None

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

netapp_password = None

(String) Password for the administrative user account specified in the netapp_login option.

netapp_pool_name_search_pattern = (.+)

(String) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC.

netapp_replication_aggregate_map = None

(Unknown) Multi opt of dictionaries to represent the aggregate mapping between source and destination back ends when using whole back end replication. For every source aggregate associated with a cinder pool (NetApp FlexVol), you would need to specify the destination aggregate on the replication target device. A replication target device is configured with the configuration option replication_device. Specify this option as many times as you have replication devices. Each entry takes the standard dict config form: netapp_replication_aggregate_map = backend_id:<name_of_replication_device_section>,src_aggr_name1:dest_aggr_name1,src_aggr_name2:dest_aggr_name2,…​

netapp_server_hostname = None

(String) The hostname (or IP address) for the storage system or proxy server.

netapp_server_port = None

(Integer) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.

netapp_size_multiplier = 1.2

(Floating point) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. Note: this option is deprecated and will be removed in favor of "reserved_percentage" in the Mitaka release.

netapp_snapmirror_quiesce_timeout = 3600

(Integer) The maximum time in seconds to wait for existing SnapMirror transfers to complete before aborting during a failover.

netapp_storage_family = ontap_cluster

(String) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.

netapp_storage_protocol = None

(String) The storage protocol to be used on the data path with the storage system.

netapp_transport_type = http

(String) The transport protocol used when communicating with the storage system or proxy server.

netapp_vserver = None

(String) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur.

Table 3.40. Description of NetApp cDOT NFS driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

expiry_thres_minutes = 720

(Integer) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share.

netapp_copyoffload_tool_path = None

(String) This option specifies the path of the NetApp copy offload tool binary. Ensure that the binary has execute permissions set which allow the effective user of the cinder-volume process to execute the file.

netapp_host_type = None

(String) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts.

netapp_host_type = None

(String) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts.

netapp_login = None

(String) Administrative user account name used to access the storage system or proxy server.

netapp_lun_ostype = None

(String) This option defines the type of operating system that will access a LUN exported from Data ONTAP; it is assigned to the LUN at the time it is created.

netapp_partner_backend_name = None

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

netapp_password = None

(String) Password for the administrative user account specified in the netapp_login option.

netapp_pool_name_search_pattern = (.+)

(String) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC.

netapp_replication_aggregate_map = None

(Unknown) Multi opt of dictionaries to represent the aggregate mapping between source and destination back ends when using whole back end replication. For every source aggregate associated with a cinder pool (NetApp FlexVol), you would need to specify the destination aggregate on the replication target device. A replication target device is configured with the configuration option replication_device. Specify this option as many times as you have replication devices. Each entry takes the standard dict config form: netapp_replication_aggregate_map = backend_id:<name_of_replication_device_section>,src_aggr_name1:dest_aggr_name1,src_aggr_name2:dest_aggr_name2,…​

netapp_server_hostname = None

(String) The hostname (or IP address) for the storage system or proxy server.

netapp_server_port = None

(Integer) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.

netapp_snapmirror_quiesce_timeout = 3600

(Integer) The maximum time in seconds to wait for existing SnapMirror transfers to complete before aborting during a failover.

netapp_storage_family = ontap_cluster

(String) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.

netapp_storage_protocol = None

(String) The storage protocol to be used on the data path with the storage system.

netapp_transport_type = http

(String) The transport protocol used when communicating with the storage system or proxy server.

netapp_vserver = None

(String) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur.

thres_avl_size_perc_start = 20

(Integer) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned.

thres_avl_size_perc_stop = 60

(Integer) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option.

Table 3.41. Description of NetApp E-Series driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

netapp_controller_ips = None

(String) This option is only utilized when the storage family is configured to eseries. This option is used to restrict provisioning to the specified controllers. Specify the value of this option to be a comma separated list of controller hostnames or IP addresses to be used for provisioning.

netapp_enable_multiattach = False

(Boolean) This option specifies whether the driver should allow operations that require multiple attachments to a volume. An example would be live migration of servers that have volumes attached. When enabled, this backend is limited to 256 total volumes in order to guarantee volumes can be accessed by more than one host.

netapp_host_type = None

(String) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts.

netapp_login = None

(String) Administrative user account name used to access the storage system or proxy server.

netapp_partner_backend_name = None

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

netapp_password = None

(String) Password for the administrative user account specified in the netapp_login option.

netapp_pool_name_search_pattern = (.+)

(String) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC.

netapp_replication_aggregate_map = None

(Unknown) Multi opt of dictionaries to represent the aggregate mapping between source and destination back ends when using whole back end replication. For every source aggregate associated with a cinder pool (NetApp FlexVol), you would need to specify the destination aggregate on the replication target device. A replication target device is configured with the configuration option replication_device. Specify this option as many times as you have replication devices. Each entry takes the standard dict config form: netapp_replication_aggregate_map = backend_id:<name_of_replication_device_section>,src_aggr_name1:dest_aggr_name1,src_aggr_name2:dest_aggr_name2,…​

netapp_sa_password = None

(String) Password for the NetApp E-Series storage array.

netapp_server_hostname = None

(String) The hostname (or IP address) for the storage system or proxy server.

netapp_server_port = None

(Integer) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.

netapp_snapmirror_quiesce_timeout = 3600

(Integer) The maximum time in seconds to wait for existing SnapMirror transfers to complete before aborting during a failover.

netapp_storage_family = ontap_cluster

(String) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.

netapp_transport_type = http

(String) The transport protocol used when communicating with the storage system or proxy server.

netapp_webservice_path = /devmgr/v2

(String) This option is used to specify the path to the E-Series proxy application on a proxy server. The value is combined with the value of the netapp_transport_type, netapp_server_hostname, and netapp_server_port options to create the URL used by the driver to connect to the proxy application.

Table 3.42. Description of os-brick configuration options

Configuration option = Default valueDescription

[privsep_osbrick]

 

capabilities = []

(Unknown) List of Linux capabilities retained by the privsep daemon.

group = None

(String) Group that the privsep daemon should run as.

helper_command = None

(String) Command to invoke to start the privsep daemon if not using the "fork" method. If not specified, a default is generated using "sudo privsep-helper" and arguments designed to recreate the current configuration. This command must accept suitable --privsep_context and --privsep_sock_path arguments.

user = None

(String) User that the privsep daemon should run as.

Table 3.43. Description of profiler configuration options

Configuration option = Default valueDescription

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

Table 3.44. Description of Pure Storage driver configuration options

Configuration option = Default valueDescription

[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.)

Table 3.45. Description of Quobyte USP volume driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

quobyte_client_cfg = None

(String) Path to a Quobyte Client configuration file.

quobyte_mount_point_base = $state_path/mnt

(String) Base dir containing the mount point for the Quobyte volume.

quobyte_qcow2_volumes = True

(Boolean) Create volumes as QCOW2 files rather than raw files.

quobyte_sparsed_volumes = True

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

quobyte_volume_url = None

(URI) URL to the Quobyte volume e.g., quobyte://<DIR host>/<volume name>

Table 3.46. Description of quota configuration options

Configuration option = Default valueDescription

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

Table 3.47. Description of Redis configuration options

Configuration option = Default valueDescription

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

Table 3.48. Description of SAN configuration options

Configuration option = Default valueDescription

[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

Table 3.49. Description of Scality SOFS volume driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

scality_sofs_config = None

(String) Path or URL to Scality SOFS configuration file

scality_sofs_mount_point = $state_path/scality

(String) Base dir where Scality SOFS shall be mounted

scality_sofs_volume_dir = cinder/volumes

(String) Path from Scality SOFS root to volume dir

Table 3.50. Description of scheduler configuration options

Configuration option = Default valueDescription

[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

Table 3.51. Description of SCST volume driver configuration options

Configuration option = Default valueDescription

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

Table 3.52. Description of Sheepdog driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

sheepdog_store_address = 127.0.0.1

(String) IP address of sheep daemon.

sheepdog_store_port = 7000

(Port number) Port of sheep daemon.

Table 3.53. Description of Samba volume driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

smbfs_allocation_info_file_path = $state_path/allocation_data

(String) The path of the automatically generated file containing information about volume disk space allocation.

smbfs_default_volume_format = qcow2

(String) Default format that will be used when creating volumes if no volume format is specified.

smbfs_mount_options = noperm,file_mode=0775,dir_mode=0775

(String) Mount options passed to the smbfs client. See mount.cifs man page for details.

smbfs_mount_point_base = $state_path/mnt

(String) Base dir containing mount points for smbfs shares.

smbfs_oversub_ratio = 1.0

(Floating point) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid.

smbfs_shares_config = /etc/cinder/smbfs_shares

(String) File with the list of available smbfs shares.

smbfs_sparsed_volumes = True

(Boolean) Create volumes as sparsed files which take no space rather than regular files when using raw format, in which case volume creation takes lot of time.

smbfs_used_ratio = 0.95

(Floating point) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination.

Table 3.54. Description of SolidFire driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

sf_account_prefix = None

(String) Create SolidFire accounts with this prefix. Any string can be used here, but the string "hostname" is special and will create a prefix using the cinder node hostname (previous default behavior). The default is NO prefix.

sf_allow_template_caching = True

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

sf_allow_tenant_qos = False

(Boolean) Allow tenants to specify QOS on create

sf_api_port = 443

(Port number) SolidFire API port. Useful if the device api is behind a proxy on a different port.

sf_emulate_512 = True

(Boolean) Set 512 byte emulation on volume creation;

sf_enable_vag = False

(Boolean) Utilize volume access groups on a per-tenant basis.

sf_enable_volume_mapping = True

(Boolean) Create an internal mapping of volume IDs and account. Optimizes lookups and performance at the expense of memory, very large deployments may want to consider setting to False.

sf_svip = None

(String) Overrides default cluster SVIP with the one specified. This is required or deployments that have implemented the use of VLANs for iSCSI networks in their cloud.

sf_template_account_name = openstack-vtemplate

(String) Account name on the SolidFire Cluster to use as owner of template/cache volumes (created if does not exist).

sf_volume_prefix = UUID-

(String) Create SolidFire volumes with this prefix. Volume names are of the form <sf_volume_prefix><cinder-volume-id>. The default is to use a prefix of 'UUID-'.

Table 3.55. Description of Ceph storage configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

rados_connect_timeout = -1

(Integer) Timeout value (in seconds) used when connecting to ceph cluster. If value < 0, no timeout is set and default librados value is used.

rados_connection_interval = 5

(Integer) Interval value (in seconds) between connection retries to ceph cluster.

rados_connection_retries = 3

(Integer) Number of retries if connection to ceph cluster failed.

rbd_ceph_conf =

(String) Path to the ceph configuration file

rbd_cluster_name = ceph

(String) The name of ceph cluster

rbd_flatten_volume_from_snapshot = False

(Boolean) Flatten volumes created from snapshots to remove dependency from volume to snapshot

rbd_max_clone_depth = 5

(Integer) Maximum number of nested volume clones that are taken before a flatten occurs. Set to 0 to disable cloning.

rbd_pool = rbd

(String) The RADOS pool where rbd volumes are stored

rbd_secret_uuid = None

(String) The libvirt uuid of the secret for the rbd_user volumes

rbd_store_chunk_size = 4

(Integer) Volumes will be chunked into objects of this size (in megabytes).

rbd_user = None

(String) The RADOS client name for accessing rbd volumes - only set when using cephx authentication

replication_connect_timeout = 5

(Integer) Timeout value (in seconds) used when connecting to ceph cluster to do a demotion/promotion of volumes. If value < 0, no timeout is set and default librados value is used.

Table 3.56. Description of GPFS storage configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

gpfs_images_dir = None

(String) Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS.

gpfs_images_share_mode = None

(String) Specifies the type of image copy to be used. Set this when the Image service repository also uses GPFS so that image files can be transferred efficiently from the Image service to the Block Storage service. There are two valid values: "copy" specifies that a full copy of the image is made; "copy_on_write" specifies that copy-on-write optimization strategy is used and unmodified blocks of the image file are shared efficiently.

gpfs_max_clone_depth = 0

(Integer) Specifies an upper limit on the number of indirections required to reach a specific block due to snapshots or clones. A lengthy chain of copy-on-write snapshots or clones can have a negative impact on performance, but improves space utilization. 0 indicates unlimited clone depth.

gpfs_mount_point_base = None

(String) Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored.

gpfs_sparse_volumes = True

(Boolean) Specifies that volumes are created as sparse files which initially consume no space. If set to False, the volume is created as a fully allocated file, in which case, creation may take a significantly longer time.

gpfs_storage_pool = system

(String) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used.

nas_host =

(String) IP address or Hostname of NAS system.

nas_login = admin

(String) User name to connect to NAS system.

nas_password =

(String) Password to connect to NAS system.

nas_private_key =

(String) Filename of private key to use for SSH authentication.

nas_ssh_port = 22

(Port number) SSH port to use to connect to NAS system.

Table 3.57. Description of NFS storage configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

nfs_mount_attempts = 3

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

nfs_mount_options = None

(String) Mount options passed to the NFS client. See section of the NFS man page for details.

nfs_mount_point_base = $state_path/mnt

(String) Base dir containing mount points for NFS shares.

nfs_qcow2_volumes = False

(Boolean) Create volumes as QCOW2 files rather than raw files.

nfs_shares_config = /etc/cinder/nfs_shares

(String) File with the list of available NFS shares.

nfs_snapshot_support = False

(Boolean) Enable support for snapshots on the NFS driver. Platforms using libvirt <1.2.7 will encounter issues with this feature.

nfs_sparsed_volumes = True

(Boolean) Create volumes as sparsed 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.

Table 3.58. Description of storage configuration options

Configuration option = Default valueDescription

[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

Table 3.59. Description of IBM Storwise driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

san_ip =

(String) IP address of SAN controller

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

storwize_san_secondary_ip = None

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

storwize_svc_allow_tenant_qos = False

(Boolean) Allow tenants to specify QOS on create

storwize_svc_flashcopy_rate = 50

(Integer) Specifies the Storwize FlashCopy copy rate to be used when creating a full volume copy. The default is rate is 50, and the valid rates are 1-100.

storwize_svc_flashcopy_timeout = 120

(Integer) Maximum number of seconds to wait for FlashCopy to be prepared.

storwize_svc_iscsi_chap_enabled = True

(Boolean) Configure CHAP authentication for iSCSI connections (Default: Enabled)

storwize_svc_multihostmap_enabled = True

(Boolean) DEPRECATED: This option no longer has any affect. It is deprecated and will be removed in the next release.

storwize_svc_multipath_enabled = False

(Boolean) Connect with multipath (FC only; iSCSI multipath is controlled by Nova)

storwize_svc_stretched_cluster_partner = None

(String) If operating in stretched cluster mode, specify the name of the pool in which mirrored copies are stored.Example: "pool2"

storwize_svc_vol_autoexpand = True

(Boolean) Storage system autoexpand parameter for volumes (True/False)

storwize_svc_vol_compression = False

(Boolean) Storage system compression option for volumes

storwize_svc_vol_easytier = True

(Boolean) Enable Easy Tier for volumes

storwize_svc_vol_grainsize = 256

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

storwize_svc_vol_iogrp = 0

(Integer) The I/O group in which to allocate volumes

storwize_svc_vol_nofmtdisk = False

(Boolean) Specifies that the volume not be formatted during creation.

storwize_svc_vol_rsize = 2

(Integer) Storage system space-efficiency parameter for volumes (percentage)

storwize_svc_vol_warning = 0

(Integer) Storage system threshold for volume capacity warnings (percentage)

storwize_svc_volpool_name = volpool

(List) Comma separated list of storage system storage pools for volumes.

Table 3.60. Description of swift configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

backup_swift_auth_insecure = False

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

backup_swift_auth_url = None

(URI) The URL of the Keystone endpoint

Table 3.61. Description of Tintri volume driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

tintri_api_version = v310

(String) API version for the storage system

tintri_image_cache_expiry_days = 30

(Integer) Delete unused image snapshots older than mentioned days

tintri_image_shares_config = None

(String) Path to image nfs shares file

tintri_server_hostname = None

(String) The hostname (or IP address) for the storage system

tintri_server_password = None

(String) Password for the storage system

tintri_server_username = None

(String) User name for the storage system

Table 3.62. Description of Violin volume driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

violin_dedup_capable_pools =

(List) Storage pools capable of dedup and other luns.(Comma separated list)

violin_dedup_only_pools =

(List) Storage pools to be used to setup dedup luns only.(Comma separated list)

violin_iscsi_target_ips =

(List) Target iSCSI addresses to use.(Comma separated list)

violin_pool_allocation_method = random

(String) Method of choosing a storage pool for a lun.

violin_request_timeout = 300

(Integer) Global backend request timeout, in seconds.

Table 3.63. Description of Windows configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

windows_iscsi_lun_path = C:\iSCSIVirtualDisks

(String) Path to store VHD backed volumes

Table 3.64. Description of ZFS Storage Appliance NFS driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

zfssa_cache_directory = os-cinder-cache

(String) Name of directory inside zfssa_nfs_share where cache volumes are stored.

zfssa_cache_project = os-cinder-cache

(String) Name of ZFSSA project where cache volumes are stored.

zfssa_data_ip = None

(String) Data path IP address

zfssa_enable_local_cache = True

(Boolean) Flag to enable local caching: True, False.

zfssa_https_port = 443

(String) HTTPS port number

zfssa_manage_policy = loose

(String) Driver policy for volume manage.

zfssa_nfs_mount_options =

(String) Options to be passed while mounting share over nfs

zfssa_nfs_pool =

(String) Storage pool name.

zfssa_nfs_project = NFSProject

(String) Project name.

zfssa_nfs_share = nfs_share

(String) Share name.

zfssa_nfs_share_compression = off

(String) Data compression.

zfssa_nfs_share_logbias = latency

(String) Synchronous write bias-latency, throughput.

zfssa_rest_timeout = None

(Integer) REST connection timeout. (seconds)

Table 3.65. Description of zones configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

cloned_volume_same_az = True

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

Table 3.66. Description of brocade zoning fabrics configuration options

Configuration option = Default valueDescription

[BRCD_FABRIC_EXAMPLE]

 

fc_fabric_address =

(String) Management IP of fabric.

fc_fabric_password =

(String) Password for user.

fc_fabric_port = 22

(Port number) Connecting port

fc_fabric_ssh_cert_path =

(String) Local SSH certificate Path.

fc_fabric_user =

(String) Fabric user ID.

fc_southbound_protocol = HTTP

(String) South bound connector for the fabric.

fc_virtual_fabric_id = None

(String) Virtual Fabric ID.

principal_switch_wwn = None

(String) DEPRECATED: Principal switch WWN of the fabric. This option is not used anymore.

zone_activate = True

(Boolean) Overridden zoning activation state.

zone_name_prefix = openstack

(String) Overridden zone name prefix.

zoning_policy = initiator-target

(String) Overridden zoning policy.

Table 3.67. Description of cisco zoning fabrics configuration options

Configuration option = Default valueDescription

[CISCO_FABRIC_EXAMPLE]

 

cisco_fc_fabric_address =

(String) Management IP of fabric

cisco_fc_fabric_password =

(String) Password for user

cisco_fc_fabric_port = 22

(Port number) Connecting port

cisco_fc_fabric_user =

(String) Fabric user ID

cisco_zone_activate = True

(Boolean) overridden zoning activation state

cisco_zone_name_prefix = None

(String) overridden zone name prefix

cisco_zoning_policy = initiator-target

(String) overridden zoning policy

cisco_zoning_vsan = None

(String) VSAN of the Fabric

Table 3.68. Description of brocade zoning manager configuration options

Configuration option = Default valueDescription

[fc-zone-manager]

 

brcd_sb_connector = HTTP

(String) South bound connector for zoning operation

Table 3.69. Description of cisco zoning manager configuration options

Configuration option = Default valueDescription

[fc-zone-manager]

 

cisco_sb_connector = cinder.zonemanager.drivers.cisco.cisco_fc_zone_client_cli.CiscoFCZoneClientCLI

(String) Southbound connector for zoning operation

Table 3.70. Description of zoning configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

zoning_mode = None

(String) FC Zoning mode configured

[fc-zone-manager]

 

enable_unsupported_driver = False

(Boolean) Set this to True when you want to allow an unsupported zone manager 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.

fc_fabric_names = None

(String) Comma separated list of Fibre Channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric

fc_san_lookup_service = cinder.zonemanager.drivers.brocade.brcd_fc_san_lookup_service.BrcdFCSanLookupService

(String) FC SAN Lookup Service

zone_driver = cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver.BrcdFCZoneDriver

(String) FC Zone Driver responsible for zone management

zoning_policy = initiator-target

(String) Zoning policy configured by user; valid values include "initiator-target" or "initiator"

3.1.2. New, updated, and deprecated options in Ocata for Block Storage

Table 3.71. New options

Option = default value(Type) Help string

[DEFAULT] auto_calc_max_oversubscription_ratio = False

(BoolOpt) K2 driver will calculate max_oversubscription_ratio on setting this option as True.

[DEFAULT] ds8k_devadd_unitadd_mapping =

(StrOpt) Mapping between IODevice address and unit address.

[DEFAULT] ds8k_host_type = auto

(StrOpt) Set to zLinux if your OpenStack version is prior to Liberty and you’re connecting to zLinux systems. Otherwise set to auto. Valid values for this parameter are: 'auto', 'AMDLinuxRHEL', 'AMDLinuxSuse', 'AppleOSX', 'Fujitsu', 'Hp', 'HpTru64', 'HpVms', 'LinuxDT', 'LinuxRF', 'LinuxRHEL', 'LinuxSuse', 'Novell', 'SGI', 'SVC', 'SanFsAIX', 'SanFsLinux', 'Sun', 'VMWare', 'Win2000', 'Win2003', 'Win2008', 'Win2012', 'iLinux', 'nSeries', 'pLinux', 'pSeries', 'pSeriesPowerswap', 'zLinux', 'iSeries'.

[DEFAULT] ds8k_ssid_prefix = FF

(StrOpt) Set the first two digits of SSID

[DEFAULT] fss_san_secondary_ip =

(StrOpt) Specifies FSS secondary management IP to be used if san_ip is invalid or becomes inaccessible.

[DEFAULT] hnas_svc0_pool_name = None

(StrOpt) Service 0 pool name

[DEFAULT] hnas_svc1_pool_name = None

(StrOpt) Service 1 pool name

[DEFAULT] hnas_svc2_pool_name = None

(StrOpt) Service 2 pool name

[DEFAULT] hnas_svc3_pool_name = None

(StrOpt) Service 3 pool name:

[DEFAULT] infinidat_pool_name = None

(StrOpt) Name of the pool from which volumes are allocated

[DEFAULT] multi_pool_support = False

(StrOpt) Use this value to specify multi-pool support for VMAX3

[DEFAULT] nec_actual_free_capacity = False

(BoolOpt) Return actual free capacity.

[DEFAULT] nec_backend_max_ld_count = 1024

(IntOpt) Maximum number of managing sessions.

[DEFAULT] nec_backup_ldname_format = LX:%s

(StrOpt) M-Series Storage LD name format for snapshots.

[DEFAULT] nec_backup_pools =

(ListOpt) M-Series Storage backup pool number to be used.

[DEFAULT] nec_diskarray_name =

(StrOpt) Diskarray name of M-Series Storage.

[DEFAULT] nec_iscsi_portals_per_cont = 1

(IntOpt) Number of iSCSI portals.

[DEFAULT] nec_ismcli_fip = None

(IPOpt) FIP address of M-Series Storage iSMCLI.

[DEFAULT] nec_ismcli_password =

(StrOpt) Password for M-Series Storage iSMCLI.

[DEFAULT] nec_ismcli_privkey =

(StrOpt) Filename of RSA private key for M-Series Storage iSMCLI.

[DEFAULT] nec_ismcli_user =

(StrOpt) User name for M-Series Storage iSMCLI.

[DEFAULT] nec_ismview_alloptimize = False

(BoolOpt) Use legacy iSMCLI command with optimization.

[DEFAULT] nec_ismview_dir = /tmp/nec/cinder

(StrOpt) Output path of iSMview file.

[DEFAULT] nec_ldname_format = LX:%s

(StrOpt) M-Series Storage LD name format for volumes.

[DEFAULT] nec_ldset =

(StrOpt) M-Series Storage LD Set name for Compute Node.

[DEFAULT] nec_ldset_for_controller_node =

(StrOpt) M-Series Storage LD Set name for Controller Node.

[DEFAULT] nec_pools =

(ListOpt) M-Series Storage pool numbers list to be used.

[DEFAULT] nec_queryconfig_view = False

(BoolOpt) Use legacy iSMCLI command.

[DEFAULT] nec_ssh_pool_port_number = 22

(IntOpt) Port number of ssh pool.

[DEFAULT] nec_unpairthread_timeout = 3600

(IntOpt) Timeout value of Unpairthread.

[DEFAULT] nfs_qcow2_volumes = False

(BoolOpt) Create volumes as QCOW2 files rather than raw files.

[DEFAULT] nfs_snapshot_support = False

(BoolOpt) Enable support for snapshots on the NFS driver. Platforms using libvirt <1.2.7 will encounter issues with this feature.

[DEFAULT] nova_api_insecure = False

(BoolOpt) Allow to perform insecure SSL requests to nova

[DEFAULT] nova_ca_certificates_file = None

(StrOpt) Location of ca certificates file to use for nova client requests.

[DEFAULT] nova_catalog_admin_info = compute:Compute Service:adminURL

(StrOpt) Same as nova_catalog_info, but for admin endpoint.

[DEFAULT] nova_catalog_info = compute:Compute Service:publicURL

(StrOpt) Match this value when searching for nova in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type>

[DEFAULT] nova_endpoint_admin_template = None

(StrOpt) Same as nova_endpoint_template, but for admin endpoint.

[DEFAULT] nova_endpoint_template = None

(StrOpt) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s

[DEFAULT] os_region_name = None

(StrOpt) Region name of this node

[DEFAULT] replication_connect_timeout = 5

(IntOpt) Timeout value (in seconds) used when connecting to ceph cluster to do a demotion/promotion of volumes. If value < 0, no timeout is set and default librados value is used.

[DEFAULT] rest_ip = None

(IPOpt) The IP address of the REST server

[DEFAULT] unity_io_ports = None

(ListOpt) A comma-separated list of iSCSI or FC ports to be used. Each port can be Unix-style glob expressions.

[DEFAULT] unity_storage_pool_names = None

(ListOpt) A comma-separated list of storage pool names to be used.

[DEFAULT] vmware_connection_pool_size = 10

(IntOpt) Maximum number of connections in http connection pool.

[DEFAULT] vsp_async_copy_check_interval = 10

(IntOpt) Interval in seconds at which volume pair synchronization status is checked when volume pairs are deleted.

[DEFAULT] vsp_auth_password = None

(StrOpt) Password corresponding to vsp_auth_user.

[DEFAULT] vsp_auth_user = None

(StrOpt) Name of the user used for CHAP authentication performed in communication between hosts and iSCSI targets on the storage ports.

[DEFAULT] vsp_compute_target_ports = None

(ListOpt) IDs of the storage ports used to attach volumes to compute nodes. To specify multiple ports, connect them by commas (e.g. CL1-A,CL2-A).

[DEFAULT] vsp_copy_check_interval = 3

(IntOpt) Interval in seconds at which volume pair synchronization status is checked when volume pairs are created.

[DEFAULT] vsp_copy_speed = 3

(IntOpt) Speed at which data is copied by Shadow Image. 1 or 2 indicates low speed, 3 indicates middle speed, and a value between 4 and 15 indicates high speed.

[DEFAULT] vsp_default_copy_method = FULL

(StrOpt) Method of volume copy. FULL indicates full data copy by Shadow Image and THIN indicates differential data copy by Thin Image.

[DEFAULT] vsp_group_request = False

(BoolOpt) If True, the driver will create host groups or iSCSI targets on storage ports as needed.

[DEFAULT] vsp_horcm_add_conf = True

(BoolOpt) If True, the driver will create or update the Command Control Interface configuration file as needed.

[DEFAULT] vsp_horcm_numbers = 200, 201

(ListOpt) Command Control Interface instance numbers in the format of 'xxx,yyy'. The second one is for Shadow Image operation and the first one is for other purposes.

[DEFAULT] vsp_horcm_pair_target_ports = None

(ListOpt) IDs of the storage ports used to copy volumes by Shadow Image or Thin Image. To specify multiple ports, connect them by commas (e.g. CL1-A,CL2-A).

[DEFAULT] vsp_horcm_password = None

(StrOpt) Password corresponding to vsp_horcm_user.

[DEFAULT] vsp_horcm_user = None

(StrOpt) Name of the user on the storage system.

[DEFAULT] vsp_ldev_range = None

(StrOpt) Range of the LDEV numbers in the format of 'xxxx-yyyy' that can be used by the driver. Values can be in decimal format (e.g. 1000) or in colon-separated hexadecimal format (e.g. 00:03:E8).

[DEFAULT] vsp_pool = None

(StrOpt) Pool number or pool name of the DP pool.

[DEFAULT] vsp_storage_id = None

(StrOpt) Product number of the storage system.

[DEFAULT] vsp_target_ports = None

(ListOpt) IDs of the storage ports used to attach volumes to the controller node. To specify multiple ports, connect them by commas (e.g. CL1-A,CL2-A).

[DEFAULT] vsp_thin_pool = None

(StrOpt) Pool number or pool name of the Thin Image pool.

[DEFAULT] vsp_use_chap_auth = False

(BoolOpt) If True, CHAP authentication will be applied to communication between hosts and any of the iSCSI targets on the storage ports.

[DEFAULT] vsp_zoning_request = False

(BoolOpt) If True, the driver will configure FC zoning between the server and the storage system provided that FC zoning manager is enabled.

Table 3.72. New default values

OptionPrevious default valueNew default value

[DEFAULT] enable_v1_api

True

False

[DEFAULT] proxy

storage.proxy.IBMStorageProxy

cinder.volume.drivers.ibm.ibm_storage.proxy.IBMStorageProxy

Table 3.73. Deprecated options

Deprecated optionNew Option

[DEFAULT] enable_v1_api

None

[DEFAULT] enable_v2_api

None

[DEFAULT] hnas_svc0_volume_type

[DEFAULT] hnas_svc0_pool_name

[DEFAULT] hnas_svc1_volume_type

[DEFAULT] hnas_svc1_pool_name

[DEFAULT] hnas_svc2_volume_type

[DEFAULT] hnas_svc2_pool_name

[DEFAULT] hnas_svc3_volume_type

[DEFAULT] hnas_svc3_pool_name

[DEFAULT] host

[DEFAULT] backend_host

[DEFAULT] osapi_max_request_body_size

[oslo_middleware] max_request_body_size

[DEFAULT] rpc_thread_pool_size

[DEFAULT] executor_thread_pool_size

[DEFAULT] use_syslog

None