(StrOpt) 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.
+
+
= False
+
(BoolOpt) Force LUN creation even if the full threshold of pool is reached.
+
+
+
=
+
(StrOpt) List of Management IP addresses (separated by commas)
+
= 16384
(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
@@ -85,10 +93,18 @@
= None
(IntOpt) Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available.
+
+
= -1
+
(IntOpt) Max size allowed per volume, in gigabytes
+
= None
(StrOpt) Public url to use for versions endpoint. The default is None, which will use the request's host_url attribute to populate the URL base. If Cinder is operating behind a proxy, you will want to change this to represent the proxy's URL.
+
+
= name, status, metadata, availability_zone
+
(ListOpt) Volume filter options which non-admin user could use to query volumes. Default values are: ['name', 'status', 'metadata', 'availability_zone']
+
= cinder.transfer.api.API
(StrOpt) The full class name of the volume transfer API class
@@ -113,6 +129,39 @@
= 8
(IntOpt) The number of characters in the salt.
+
+
[oslo_middleware]
+
+
+
= 114688
+
(IntOpt) The maximum body size for each request, in bytes.
+
+
+
= X-Forwarded-Proto
+
(StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.
+
+
+
[oslo_policy]
+
+
+
= default
+
(StrOpt) Default rule. Enforced when a requested rule is not found.
+
+
+
= ['policy.d']
+
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
+
+
+
= policy.json
+
(StrOpt) The JSON file that defines policies.
+
+
+
[oslo_versionedobjects]
+
+
+
= False
+
(BoolOpt) Make exception message format errors fatal
(StrOpt) Driver will use this API key to authenticate against the CloudByte storage's management interface.
+
+
= None
+
(StrOpt) 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.
+
= 3
(IntOpt) Will confirm a successful volume creation in CloudByte storage by making this many number of attempts.
(StrOpt) Namespace for driver private data values to be saved in.
+
+
= False
+
(BoolOpt) If set to True the http client will validate the SSL certificate of the backend endpoint.
+
+
+
= False
+
(BoolOpt) Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it.
+
= True
(BoolOpt) Services to be added to the available pool on create
@@ -109,6 +117,10 @@
= 3
(IntOpt) Number of times to attempt to run flakey shell commands
+
+
= None
+
(StrOpt) Auth URL associated with the OpenStack privileged account.
+
= None
(StrOpt) OpenStack privileged account username. Used for requests to other services (such as Nova) that require an account with special rights.
@@ -129,18 +141,6 @@
= 60
(IntOpt) Interval, in seconds, between running periodic tasks
-
-
= default
-
(StrOpt) Default rule. Enforced when a requested rule is not found.
-
-
-
= ['policy.d']
-
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
-
-
-
= policy.json
-
(StrOpt) The JSON file that defines policies.
-
= cinder.replication.api.API
(StrOpt) The full class name of the volume replication API class
@@ -161,10 +161,6 @@
= /etc/cinder/rootwrap.conf
(StrOpt) Path to the rootwrap configuration file to use for running commands as root
-
-
= True
-
(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?
-
= False
(BoolOpt) Send the volume and snapshot create and delete notifications generated in the specified period.
(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.
+
= None
+
(ListOpt) List of options that control which trace info is written to the DEBUG log level to assist developers. Valid values are method and api.
Description of EMC SIO volume driver configuration options
+
+
+
+
+
Configuration option = Default value
+
Description
+
+
+
+
+
[DEFAULT]
+
+
+
= False
+
(BoolOpt) Whether to allow force delete.
+
+
+
= None
+
(StrOpt) Protection domain id.
+
+
+
= None
+
(StrOpt) Protection domain name.
+
+
+
= 443
+
(StrOpt) REST server port.
+
+
+
= True
+
(BoolOpt) Whether to round volume capacity.
+
+
+
= None
+
(StrOpt) Server certificate path.
+
+
+
= None
+
(StrOpt) Storage pool id.
+
+
+
= None
+
(StrOpt) Storage pool name.
+
+
+
= None
+
(StrOpt) Storage pools.
+
+
+
= False
+
(BoolOpt) Whether to unmap volume before deletion.
+
+
+
= False
+
(BoolOpt) Whether to verify server certificate.
+
+
+
+
diff --git a/doc/common/tables/cinder-flashsystem.xml b/doc/common/tables/cinder-flashsystem.xml
index f6e60613dd..c249bde299 100644
--- a/doc/common/tables/cinder-flashsystem.xml
+++ b/doc/common/tables/cinder-flashsystem.xml
@@ -4,7 +4,7 @@
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
-
Description of IBM FlashSystem volume river configuration options
+
Description of IBM FlashSystem volume driver configuration options
@@ -19,15 +19,19 @@
= FC
-
(StrOpt) Connection protocol should be FC.
+
(StrOpt) Connection protocol should be FC. (Default is FC.)
+
+
+
= 0
+
(IntOpt) Default iSCSI Port ID of FlashSystem. (Default port is 0.)
= True
-
(BoolOpt) Allows vdisk to multi host mapping.
+
(BoolOpt) Allows vdisk to multi host mapping. (Default is True)
= False
-
(BoolOpt) Connect with multipath (FC only).
+
(BoolOpt) Connect with multipath (FC only).(Default is false.)
Description of HP XP volume driver configuration options
+
+
+
+
+
Configuration option = Default value
+
Description
+
+
+
+
+
[DEFAULT]
+
+
+
= 10
+
(IntOpt) Interval to check copy asynchronously
+
+
+
= None
+
(ListOpt) Target port names of compute node for host group or iSCSI target
+
+
+
= 3
+
(IntOpt) Interval to check copy
+
+
+
= 3
+
(IntOpt) Copy speed of storage system
+
+
+
= FULL
+
(StrOpt) Default copy method of storage system. There are two valid values: "FULL" specifies that a full copy; "THIN" specifies that a thin copy. Default value is "FULL"
+
+
+
= False
+
(BoolOpt) Request for creating host group or iSCSI target
+
+
+
= True
+
(BoolOpt) Add to HORCM configuration
+
+
+
= False
+
(BoolOpt) Only discover a specific name of host group or iSCSI target
+
+
+
= 200, 201
+
(ListOpt) Instance numbers for HORCM
+
+
+
= meta_resource
+
(StrOpt) Resource group name of storage system for HORCM
+
+
+
= None
+
(StrOpt) Username of storage system for HORCM
+
+
+
= None
+
(StrOpt) Logical device range of storage system
+
+
+
= None
+
(StrOpt) Pool of storage system
+
+
+
= None
+
(StrOpt) Type of storage command line interface
+
+
+
= None
+
(StrOpt) ID of storage system
+
+
+
= None
+
(ListOpt) Target port names for host group or iSCSI target
Description of Infortrend volume driver configuration options
+
+
+
+
+
Configuration option = Default value
+
Description
+
+
+
+
+
[DEFAULT]
+
+
+
= 5
+
(IntOpt) Maximum retry time for cli. Default is 5.
+
+
+
= /opt/bin/Infortrend/raidcmd_ESDS10.jar
+
(StrOpt) The Infortrend CLI absolute path. By default, it is at /opt/bin/Infortrend/raidcmd_ESDS10.jar
+
+
+
= 30
+
(IntOpt) Default timeout for CLI copy operations in minutes. Support: migrate volume, create cloned volume and create volume from snapshot. By Default, it is 30 minutes.
+
+
+
=
+
(StrOpt) Infortrend raid pool name list. It is separated with comma.
+
+
+
= full
+
(StrOpt) Let the volume use specific provisioning. By default, it is the full provisioning. The supported options are full or thin.
+
+
+
= 0,1,2,3,4,5,6,7
+
(StrOpt) Infortrend raid channel ID list on Slot A for OpenStack usage. It is separated with comma. By default, it is the channel 0~7.
+
+
+
= 0,1,2,3,4,5,6,7
+
(StrOpt) Infortrend raid channel ID list on Slot B for OpenStack usage. It is separated with comma. By default, it is the channel 0~7.
+
+
+
= 0
+
(StrOpt) Let the volume use specific tiering level. By default, it is the level 0. The supported levels are 0,2,3,4.
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
-
-
= None
-
(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.
-
-
-
= %Y-%m-%d %H:%M:%S
-
(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
-
-
-
= None
-
(StrOpt) (Optional) The base directory used for relative --log-file paths.
-
-
-
= None
-
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
-
-
-
= None
-
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
(StrOpt) Prefix each line of exception output with this format.
@@ -105,29 +85,17 @@
= LOG_USER
(StrOpt) Syslog facility to receive log lines.
-
-
= LOG_USER
-
(StrOpt) Syslog facility to receive log lines.
-
-
-
= False
-
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
-
-
-
= False
-
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
-
= True
(BoolOpt) Log output to standard error.
= False
-
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
+
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424.
-
= False
-
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
+
= True
+
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in K, and will be removed in M, along with this option.
(StrOpt) Administrative user account name used to access the storage system or proxy server.
+
+
= None
+
(StrOpt) 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.
+
= None
(StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC.
(StrOpt) 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.
+
+
= None
+
(StrOpt) 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.
+
+
+
= None
+
(StrOpt) 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.
+
= None
(StrOpt) Administrative user account name used to access the storage system or proxy server.
+
+
= None
+
(StrOpt) 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.
+
= None
(StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC.
(StrOpt) 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.
-
= linux_dm_mp
-
(StrOpt) This option is used to define how the controllers in the E-Series storage array will work with the particular operating system on the hosts that are connected to it.
+
= True
+
(BoolOpt) 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.
+
+
+
= None
+
(StrOpt) 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.
(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.
Description of Quobyte USP volume driver configuration options
-
-
-
-
-
Configuration option = Default value
-
Description
-
-
-
-
-
[DEFAULT]
-
-
-
= None
-
(StrOpt) Path to a Quobyte Client configuration file.
-
-
-
= $state_path/mnt
-
(StrOpt) Base dir containing the mount point for the Quobyte volume.
-
-
-
= True
-
(BoolOpt) Create volumes as QCOW2 files rather than raw files.
-
-
-
= True
-
(BoolOpt) Create volumes as sparse files which take no space. If set to False, volume is created as regular file.In such case volume creation takes a lot of time.
-
-
-
= None
-
(StrOpt) URL to the Quobyte volume e.g., quobyte://<DIR host>/<volume name>
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
-
= 0
-
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it. Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
+
= 60
+
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL
= 1.0
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
+
+
= 60
+
(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout.
+
=
(StrOpt) SSL certification authority file (valid only if SSL enabled).
@@ -106,8 +110,8 @@
(StrOpt) The RabbitMQ virtual host.
-
= 30
-
(IntOpt) Size of RPC connection pool.
+
= False
+
(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.
(StrOpt) 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 hostsname (previous default behavior). The default is NO prefix.
+
(StrOpt) 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.
(StrOpt) Determines the iSCSI protocol for new iSCSI volumes, created with tgtadm or lioadm target helpers. In order to enable RDMA, this parameter should be set with the value "iser". The supported iSCSI protocol values are "iscsi" and "iser".
+
+
=
+
(StrOpt) 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.
Description of StorPool volume driver configuration options
+
+
+
+
+
Configuration option = Default value
+
Description
+
+
+
+
+
[DEFAULT]
+
+
+
= 3
+
(IntOpt) The default StorPool chain replication value. Used when creating a volume with no specified type if storpool_template is not set. Also used for calculating the apparent free space reported in the stats.
+
+
+
= None
+
(StrOpt) The StorPool template for volumes with no type.
(BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova)
-
= False
-
(BoolOpt) Indicate whether svc driver is compatible for NPIV setup. If it is compatible, it will allow no wwpns being returned on get_conn_fc_wwpns during initialize_connection
+
= True
+
(BoolOpt) Indicate whether svc driver is compatible for NPIV setup. If it is compatible, it will allow no wwpns being returned on get_conn_fc_wwpns during initialize_connection. It should always be set to True. It will be deprecated and removed in M release.
= None
diff --git a/doc/common/tables/cinder-tintri.xml b/doc/common/tables/cinder-tintri.xml
index 76b9613ea7..21d6e3f91f 100644
--- a/doc/common/tables/cinder-tintri.xml
+++ b/doc/common/tables/cinder-tintri.xml
@@ -4,7 +4,7 @@
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
-
Description of Tintri driver configuration options
+
Description of Tintri volume driver configuration options
@@ -18,20 +18,20 @@
[DEFAULT]
-
= None
-
(StrOpt) Tintri VMstore management IP address
+
= v310
+
(StrOpt) API version for the storage system
-
= None
-
(StrOpt) Tintri VMstore username
+
= None
+
(StrOpt) The hostname (or IP address) for the storage system
(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues.
+
+
= None
+
(StrOpt) CA bundle file to use in verifying the vCenter server certificate.
+
= None
(StrOpt) IP address for connecting to VMware ESX/VC server.
@@ -41,6 +45,10 @@
= 7200
(IntOpt) Timeout in seconds for VMDK volume transfer between Cinder and Glance.
+
+
= False
+
(BoolOpt) If true, the vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "vmware_ca_file" is set.
+
= 100
(IntOpt) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value.
Description of VidZapper Storage volume driver configuration options
+
+
+
+
+
Configuration option = Default value
+
Description
+
+
+
+
+
[DEFAULT]
+
+
+
= None
+
(ListOpt) Mount options passed to the vzstorage client. See section of the pstorage-mount man page for details.
+
+
+
= $state_path/mnt
+
(StrOpt) Base dir containing mount points for vzstorage shares.
+
+
+
= /etc/cinder/vzstorage_shares
+
(StrOpt) File with the list of available vzstorage shares.
+
+
+
= True
+
(BoolOpt) 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.
+
+
+
= 0.95
+
(FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination.