| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| = |
- (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop | -
| = |
- (ListOpt) AMQP topic used for OpenStack notifications. | -
| = |
- (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. | -
| Configuration option = Default value | -Description | -
|---|---|
| [api] | -|
| = |
- (StrOpt) The listen IP for the aodh API server. | -
| = |
- (StrOpt) Configuration file for WSGI definition of API. | -
| = |
- (BoolOpt) Toggle Pecan Debug Middleware. | -
| = |
- (IntOpt) The port for the aodh API server. | -
| = |
- (IntOpt) Number of workers for aodh API server. | -
| [oslo_middleware] | -|
| = |
- (IntOpt) The maximum body size for each request, in bytes. | -
| = |
- (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. | -
| Configuration option = Default value | -Description | -
|---|---|
| [service_credentials] | -|
| = |
- (BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established. | -
| = |
- (StrOpt) Auth URL to use for OpenStack service access. | -
| = |
- (StrOpt) Certificate chain for SSL validation. | -
| = |
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services. | -
| = |
- (StrOpt) Password to use for OpenStack service access. | -
| = |
- (StrOpt) The domain id of the user project | -
| = |
- (StrOpt) The user project name | -
| = |
- (StrOpt) Region name to use for OpenStack service endpoints. | -
| = |
- (StrOpt) Tenant ID to use for OpenStack service access. | -
| = |
- (StrOpt) Tenant name to use for OpenStack service access. | -
| = |
- (StrOpt) The domain id of the user | -
| = |
- (StrOpt) User name to use for OpenStack service access. | -
| Configuration option = Default value | -Description | -
|---|---|
| [keystone_authtoken] | -|
| = |
- (StrOpt) Service user password. | -
| = |
- (StrOpt) Service tenant name. | -
| = |
- (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | -
| = |
- (StrOpt) Service username. | -
| = |
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Name of the plugin to load | -
| = |
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | -
| = |
- (StrOpt) Config Section from which to load plugin specific options | -
| = |
- (StrOpt) Complete public Identity API endpoint. | -
| = |
- (StrOpt) API version of the admin Identity API endpoint. | -
| = |
- (StrOpt) Env key for the swift cache. | -
| = |
- (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. | -
| = |
- (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. | -
| = |
- (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| = |
- (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | -
| = |
- (IntOpt) Request timeout value for communicating with Identity API server. | -
| = |
- (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| = |
- (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | -
| = |
- (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. | -
| = |
- (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. | -
| = |
- (IntOpt) (Optional) Maximum total number of open connections to every memcached server. | -
| = |
- (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. | -
| = |
- (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. | -
| = |
- (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. | -
| = |
- (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. | -
| = |
- (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. | -
| = |
- (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| = |
- (StrOpt) The region in which the identity server can be found. | -
| = |
- (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| = |
- (StrOpt) Directory used to cache files related to PKI tokens. | -
| = |
- (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Maximum count of actions for each state of an alarm, non-positive number means no limit. | -
| = |
- (IntOpt) Period of evaluation cycle, should be >= than configured pipeline interval for collection of underlying meters. | -
| = |
- (IntOpt) TTL of event alarm caches, in seconds. Set to 0 to disable caching. | -
| = |
- (StrOpt) The topic that aodh uses for event alarm evaluation. | -
| = |
- (IntOpt) Size of executor thread pool. | -
| = |
- (StrOpt) URL to Gnocchi. | -
| = |
- (StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address. | -
| = |
- (IntOpt) Timeout seconds for HTTP requests. Set it to None to disable timeout. | -
| = |
- (ListOpt) Memcached servers or None for in process cache. | -
| = |
- (IntOpt) Number of workers for notification service. A single notification agent is enabled by default. | -
| = |
- (StrOpt) The topic that aodh uses for alarm notifier messages. | -
| = |
- (IntOpt) Maximum number of alarms defined for a project. | -
| = |
- (BoolOpt) Record alarm change events. | -
| = |
- (StrOpt) SSL Client certificate for REST notifier. | -
| = |
- (StrOpt) SSL Client private key for REST notifier. | -
| = |
- (IntOpt) Number of retries for REST notifier | -
| = |
- (BoolOpt) Whether to verify the SSL Server certificate when calling alarm action. | -
| = |
- (IntOpt) Maximum number of alarms defined for a user. | -
| Configuration option = Default value | -Description | -
|---|---|
| [coordination] | -|
| = |
- (StrOpt) The backend URL to use for distributed coordination. If left empty, per-deployment central agent and per-host compute agent won't do workload partitioning and will only function correctly if a single instance of that service is running. | -
| = |
- (FloatOpt) Number of seconds between checks to see if group membership has changed | -
| = |
- (FloatOpt) Number of seconds between heartbeats for distributed coordination. | -
| Configuration option = Default value | -Description | -
|---|---|
| [cors] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| [database] | -|
| = |
- (StrOpt) The connection string used to connect to the alarm database - rather use ${database.connection} | -
| = |
- (IntOpt) Number of seconds that alarm histories are kept in the database for (<= 0 means forever). | -
| = |
- (StrOpt) The back end to use for the database. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the database. | -
| = |
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. | -
| = |
- (BoolOpt) Add Python stack traces to SQL as comment strings. | -
| = |
- (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. | -
| = |
- (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. | -
| = |
- (IntOpt) Seconds between retries of a database transaction. | -
| = |
- (IntOpt) Timeout before idle SQL connections are reaped. | -
| = |
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy. | -
| = |
- (IntOpt) Maximum number of SQL connections to keep open in a pool. | -
| = |
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) Minimum number of SQL connections to keep open in a pool. | -
| = |
- (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | -
| = |
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. | -
| = |
- (IntOpt) Interval between retries of opening a SQL connection. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. | -
| = |
- (StrOpt) The file name to use with SQLite. | -
| = |
- (BoolOpt) If True, SQLite uses synchronous mode. | -
| = |
- (BoolOpt) Enable the experimental use of database reconnect on connection lost. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). | -
| = |
- (ListOpt) List of logger=LEVEL pairs. | -
| = |
- (BoolOpt) Enables or disables fatal status of deprecations. | -
| = |
- (StrOpt) The format for an instance that is passed with the log message. | -
| = |
- (StrOpt) The format for an instance UUID that is passed with the log message. | -
| = |
- (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. | -
| = |
- (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . | -
| = |
- (StrOpt) (Optional) The base directory used for relative --log-file paths. | -
| = |
- (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | -
| = |
- (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) Format string to use for log messages with context. | -
| = |
- (StrOpt) Data to append to log format when level is DEBUG. | -
| = |
- (StrOpt) Format string to use for log messages without context. | -
| = |
- (StrOpt) Prefix each line of exception output with this format. | -
| = |
- (BoolOpt) Enables or disables publication of error events. | -
| = |
- (StrOpt) Syslog facility to receive log lines. | -
| = |
- (BoolOpt) Log output to standard error. | -
| = |
- (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. | -
| = |
- (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 Kilo, and will be removed in Mitaka, along with this option. | -
| = |
- (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_policy] | -|
| = |
- (StrOpt) Default rule. Enforced when a requested rule is not found. | -
| = |
- (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. | -
| = |
- (StrOpt) The JSON file that defines policies. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_qpid] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (IntOpt) Seconds between connection keepalive heartbeats. | -
| = |
- (StrOpt) Qpid broker hostname. | -
| = |
- (ListOpt) Qpid HA cluster host:port pairs. | -
| = |
- (StrOpt) Password for Qpid connection. | -
| = |
- (IntOpt) Qpid broker port. | -
| = |
- (StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| = |
- (IntOpt) The number of prefetched messages held by receiver. | -
| = |
- (StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| = |
- (BoolOpt) Whether to disable the Nagle algorithm. | -
| = |
- (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. | -
| = |
- (StrOpt) Username for Qpid connection. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_rabbit] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake | -
| = |
- (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. | -
| = |
- (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL | -
| = |
- (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| = |
- (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). | -
| = |
- (StrOpt) SSL cert file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL key file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. | -
| = |
- (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| = |
- (StrOpt) The RabbitMQ broker address where a single node is used. | -
| = |
- (ListOpt) RabbitMQ HA cluster host:port pairs. | -
| = |
- (StrOpt) The RabbitMQ login method. | -
| = |
- (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| = |
- (StrOpt) The RabbitMQ password. | -
| = |
- (IntOpt) The RabbitMQ broker port where a single node is used. | -
| = |
- (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| = |
- (IntOpt) How frequently to retry connecting with RabbitMQ. | -
| = |
- (BoolOpt) Connect over SSL for RabbitMQ. | -
| = |
- (StrOpt) The RabbitMQ userid. | -
| = |
- (StrOpt) The RabbitMQ virtual host. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [matchmaker_redis] | -|
| = |
- (StrOpt) Host to locate redis. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| [matchmaker_ring] | -|
| = |
- (StrOpt) Matchmaker ring file (JSON). | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Heartbeat frequency. | -
| = |
- (IntOpt) Heartbeat time-to-live. | -
| = |
- (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| = |
- (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| = |
- (IntOpt) Size of RPC connection pool. | -
| = |
- (IntOpt) Seconds to wait for a response from a call. | -
| [oslo_messaging_amqp] | -|
| = |
- (BoolOpt) Accept clients using either SSL or plain TCP | -
| = |
- (StrOpt) address prefix used when broadcasting to all servers | -
| = |
- (StrOpt) Name for the AMQP container | -
| = |
- (StrOpt) address prefix when sending to any server in group | -
| = |
- (IntOpt) Timeout for inactive connections (in seconds) | -
| = |
- (StrOpt) address prefix used when sending to a specific server | -
| = |
- (StrOpt) CA certificate PEM file to verify server certificate | -
| = |
- (StrOpt) Identifying certificate PEM file to present to clients | -
| = |
- (StrOpt) Private key PEM file used to sign cert_file certificate | -
| = |
- (StrOpt) Password for decrypting ssl_key_file (if encrypted) | -
| = |
- (BoolOpt) Debug: dump AMQP frames to stdout | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| = |
- (IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| = |
- (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. | -
| = |
- (StrOpt) Directory for holding IPC sockets. | -
| = |
- (StrOpt) MatchMaker driver. | -
| = |
- (IntOpt) ZeroMQ receiver listening port. | -
| = |
- (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| = |
- (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop | -
| = |
- (ListOpt) AMQP topic used for OpenStack notifications. | -
| = |
- (StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. | -
| = |
- (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Configuration file for WSGI definition of API. | -
| = |
- (StrOpt) Configuration file for event pipeline definition. | -
| = |
- (StrOpt) Configuration file for pipeline definition. | -
| = |
- (IntOpt) Polling interval for pipeline file configuration in seconds. | -
| = |
- (BoolOpt) Refresh Event Pipeline configuration on-the-fly. | -
| = |
- (BoolOpt) Refresh Pipeline configuration on-the-fly. | -
| = |
- (ListOpt) List of metadata keys reserved for metering use. And these keys are additional to the ones included in the namespace. | -
| = |
- (IntOpt) Limit on length of reserved metadata values. | -
| = |
- (ListOpt) List of metadata prefixes reserved for metering use. | -
| [api] | -|
| = |
- (BoolOpt) Set True to redirect alarms URLs to aodh. Default autodetection by querying keystone. | -
| = |
- (StrOpt) The endpoint of Aodh to redirect alarms URLs to Aodh API. Default autodetection by querying keystone. | -
| = |
- (IntOpt) Default maximum number of items returned by API request. | -
| = |
- (BoolOpt) Set True to disable resource/meter/sample URLs. Default autodetection by querying keystone. | -
| = |
- (StrOpt) The listen IP for the ceilometer API server. | -
| = |
- (BoolOpt) Toggle Pecan Debug Middleware. | -
| = |
- (PortOpt) The port for the ceilometer API server. | -
| = |
- (IntOpt) Number of workers for api, default value is 1. | -
| [oslo_middleware] | -|
| = |
- (IntOpt) The maximum body size for each request, in bytes. | -
| = |
- (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. | -
| Configuration option = Default value | -Description | -
|---|---|
| [service_credentials] | -|
| = |
- (Opt) Config Section from which to load plugin specific options | -
| = |
- (Opt) Authentication type to load | -
| = |
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections. | -
| = |
- (StrOpt) PEM encoded client certificate cert file | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services. | -
| = |
- (StrOpt) PEM encoded client certificate key file | -
| = |
- (StrOpt) Region name to use for OpenStack service endpoints. | -
| = |
- (IntOpt) Timeout value for http requests | -
| Configuration option = Default value | -Description | -
|---|---|
| [keystone_authtoken] | -|
| = |
- (StrOpt) Service user password. | -
| = |
- (StrOpt) Service tenant name. | -
| = |
- (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | -
| = |
- (StrOpt) Service username. | -
| = |
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | -
| = |
- (Opt) Config Section from which to load plugin specific options | -
| = |
- (Opt) Authentication type to load | -
| = |
- (StrOpt) Complete public Identity API endpoint. | -
| = |
- (StrOpt) API version of the admin Identity API endpoint. | -
| = |
- (StrOpt) Env key for the swift cache. | -
| = |
- (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. | -
| = |
- (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. | -
| = |
- (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| = |
- (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | -
| = |
- (IntOpt) Request timeout value for communicating with Identity API server. | -
| = |
- (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| = |
- (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | -
| = |
- (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. | -
| = |
- (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. | -
| = |
- (IntOpt) (Optional) Maximum total number of open connections to every memcached server. | -
| = |
- (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. | -
| = |
- (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. | -
| = |
- (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. | -
| = |
- (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. | -
| = |
- (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. | -
| = |
- (StrOpt) The region in which the identity server can be found. | -
| = |
- (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| = |
- (StrOpt) Directory used to cache files related to PKI tokens. | -
| = |
- (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | -Description | -
|---|---|
| [collector] | -|
| = |
- (BoolOpt) Requeue the event on the collector event queue when the collector fails to dispatch it. | -
| = |
- (BoolOpt) Requeue the sample on the collector sample queue when the collector fails to dispatch it. This is only valid if the sample come from the notifier publisher. | -
| = |
- (StrOpt) Address to which the UDP socket is bound. Set to an empty string to disable. | -
| = |
- (PortOpt) Port to which the UDP socket is bound. | -
| = |
- (IntOpt) Number of workers for collector service. default value is 1. | -
| [dispatcher_file] | -|
| = |
- (IntOpt) The max number of the files to keep. | -
| = |
- (StrOpt) Name and the location of the file to record meters. | -
| = |
- (IntOpt) The max size of the file. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) To reduce polling agent load, samples are sent to the notification agent in a batch. To gain higher throughput at the cost of load set this to False. | -
| = |
- (IntOpt) Size of executor thread pool. | -
| = |
- (StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address. | -
| = |
- (IntOpt) Timeout seconds for HTTP requests. Set it to None to disable timeout. | -
| = |
- (ListOpt) Memcached servers or None for in process cache. | -
| = |
- (MultiChoicesOpt) Polling namespace(s) to be used while resource polling | -
| = |
- (MultiChoicesOpt) List of pollsters (or wildcard templates) to be used while polling | -
| = |
- (StrOpt) Path to the rootwrap configuration file touse for running commands as root | -
| = |
- (IntOpt) To reduce large requests at same time to Nova or other components from different compute agents, shuffle start time of polling task. | -
| = |
- (BoolOpt) Indicates if expirer expires only samples. If set true, expired samples will be deleted, but residual resource and meter definition data will remain. | -
| [compute] | -|
| = |
- (BoolOpt) Enable work-load partitioning, allowing multiple compute agents to be run simultaneously. | -
| [coordination] | -|
| = |
- (StrOpt) The backend URL to use for distributed coordination. If left empty, per-deployment central agent and per-host compute agent won't do workload partitioning and will only function correctly if a single instance of that service is running. | -
| = |
- (FloatOpt) Number of seconds between checks to see if group membership has changed | -
| = |
- (FloatOpt) Number of seconds between heartbeats for distributed coordination. | -
| [keystone_authtoken] | -|
| = |
- (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| [meter] | -|
| = |
- (StrOpt) Configuration file for defining meter notifications. | -
| [polling] | -|
| = |
- (StrOpt) Work-load partitioning group prefix. Use only if you want to run multiple polling agents with different config files. For each sub-group of the agent pool with the same partitioning_group_prefix a disjoint subset of pollsters should be loaded. | -
| Configuration option = Default value | -Description | -
|---|---|
| [cors] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) DEPRECATED - Database connection string. | -
| [database] | -|
| = |
- (StrOpt) The back end to use for the database. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the database. | -
| = |
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. | -
| = |
- (BoolOpt) Add Python stack traces to SQL as comment strings. | -
| = |
- (IntOpt) The max length of resources id in DB2 nosql, the value should be larger than len(hostname) * 2 as compute node's resource id is <hostname>_<nodename>. | -
| = |
- (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. | -
| = |
- (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. | -
| = |
- (IntOpt) Seconds between retries of a database transaction. | -
| = |
- (StrOpt) The connection string used to connect to the event database. (if unset, connection is used) | -
| = |
- (IntOpt) Number of seconds that events are kept in the database for (<= 0 means forever). | -
| = |
- (IntOpt) Timeout before idle SQL connections are reaped. | -
| = |
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy. | -
| = |
- (IntOpt) Maximum number of SQL connections to keep open in a pool. | -
| = |
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. | -
| = |
- (StrOpt) The connection string used to connect to the metering database. (if unset, connection is used) | -
| = |
- (IntOpt) Number of seconds that samples are kept in the database for (<= 0 means forever). | -
| = |
- (IntOpt) Minimum number of SQL connections to keep open in a pool. | -
| = |
- (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | -
| = |
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. | -
| = |
- (IntOpt) Interval between retries of opening a SQL connection. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. | -
| = |
- (StrOpt) The file name to use with SQLite. | -
| = |
- (BoolOpt) If True, SQLite uses synchronous mode. | -
| = |
- (BoolOpt) Enable the experimental use of database reconnect on connection lost. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Allow novaclient's debug log output. (Use default_log_levels instead) | -
| Configuration option = Default value | -Description | -
|---|---|
| [dispatcher_gnocchi] | -|
| = |
- (StrOpt) The archive policy to use when the dispatcher create a new metric. | -
| = |
- (StrOpt) Gnocchi project used to filter out samples generated by Gnocchi service activity | -
| = |
- (BoolOpt) Filter out samples generated by Gnocchi service activity | -
| = |
- (StrOpt) The Yaml file that defines mapping between samples and gnocchi resources/metrics | -
| = |
- (StrOpt) URL to Gnocchi. default: autodetection | -
| Configuration option = Default value | -Description | -
|---|---|
| [dispatcher_http] | -|
| = |
- (StrOpt) The target for event data where the http request will be sent to. If this is not set, it will default to same as Sample target. | -
| = |
- (StrOpt) The target where the http request will be sent. If this is not set, no data will be posted. For example: target = http://hostname:1234/path | -
| = |
- (IntOpt) The max time in seconds to wait for a request to timeout. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (MultiStrOpt) Dispatchers to process event data. | -
| = |
- (MultiStrOpt) Dispatchers to process metering data. | -
| Configuration option = Default value | -Description | -
|---|---|
| [event] | -|
| = |
- (StrOpt) Configuration file for event definitions. | -
| = |
- (BoolOpt) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits) | -
| = |
- (MultiStrOpt) Store the raw notification for select priority levels (info and/or error). By default, raw details are not captured. | -
| [notification] | -|
| = |
- (BoolOpt) Acknowledge message when event persistence fails. | -
| = |
- (BoolOpt) Save event details. | -
| = |
- (IntOpt) Number of workers for notification service, default value is 1. | -
| = |
- (BoolOpt) Enable workload partitioning, allowing multiple notification agents to be run simultaneously. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Exchange name for ceilometer notifications. | -
| = |
- (StrOpt) Exchange name for Cinder notifications. | -
| = |
- (StrOpt) Exchange name for DNS notifications. | -
| = |
- (StrOpt) Exchange name for Glance notifications. | -
| = |
- (StrOpt) Exchange name for Heat notifications | -
| = |
- (MultiStrOpt) Exchanges name to listen for notifications. | -
| = |
- (StrOpt) Exchange name for Ironic notifications. | -
| = |
- (StrOpt) Exchange name for Keystone notifications. | -
| = |
- (StrOpt) Exchange name for Magnum notifications. | -
| = |
- (StrOpt) Exchange name for Neutron notifications. | -
| = |
- (StrOpt) Exchange name for Nova notifications. | -
| = |
- (StrOpt) Exchange name for Data Processing notifications. | -
| = |
- (StrOpt) Source for samples emitted on this instance. | -
| = |
- (StrOpt) Exchange name for Swift notifications. | -
| = |
- (StrOpt) Exchange name for DBaaS notifications. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Number of items to request in each paginated Glance API request (parameter used by glancecelient). If this is less than or equal to 0, page size is not specified (default value in glanceclient is used). | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Inspector to use for inspecting the hypervisor layer. Known inspectors are libvirt, hyperv, vmware, xenapi and powervm. | -
| = |
- (StrOpt) Libvirt domain type. | -
| = |
- (StrOpt) Override the default libvirt URI (which is dependent on libvirt_type). | -
| Configuration option = Default value | -Description | -
|---|---|
| [ipmi] | -|
| = |
- (IntOpt) Number of retries upon Intel Node Manager initialization failure | -
| = |
- (IntOpt) Tolerance of IPMI/NM polling failures before disable this pollster. Negative indicates retrying forever. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). | -
| = |
- (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Enables or disables fatal status of deprecations. | -
| = |
- (StrOpt) The format for an instance that is passed with the log message. | -
| = |
- (StrOpt) The format for an instance UUID that is passed with the log message. | -
| = |
- (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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). | -
| = |
- (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. | -
| = |
- (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. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) Format string to use for log messages with context. | -
| = |
- (StrOpt) Data to append to log format when level is DEBUG. | -
| = |
- (StrOpt) Format string to use for log messages without context. | -
| = |
- (StrOpt) Prefix each line of exception output with this format. | -
| = |
- (StrOpt) Format string for user_identity field of the logging_context_format_string | -
| = |
- (BoolOpt) Enables or disables publication of error events. | -
| = |
- (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. | -
| = |
- (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 Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. | -
| = |
- (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Exchange name for Magnetodb notifications. | -
| Configuration option = Default value | -Description | -
|---|---|
| [notification] | -|
| = |
- (BoolOpt) WARNING: Ceilometer historically offered the ability to store events as meters. This usage is NOT advised as it can flood the metering database and cause performance degradation. | -
| = |
- (IntOpt) Number of queues to parallelize workload across. This value should be larger than the number of active notification agents for optimal results. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_policy] | -|
| = |
- (StrOpt) Default rule. Enforced when a requested rule is not found. | -
| = |
- (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. | -
| = |
- (StrOpt) The JSON file that defines policies. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_qpid] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (IntOpt) Seconds between connection keepalive heartbeats. | -
| = |
- (StrOpt) Qpid broker hostname. | -
| = |
- (ListOpt) Qpid HA cluster host:port pairs. | -
| = |
- (StrOpt) Password for Qpid connection. | -
| = |
- (IntOpt) Qpid broker port. | -
| = |
- (StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| = |
- (IntOpt) The number of prefetched messages held by receiver. | -
| = |
- (StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| = |
- (BoolOpt) Whether to disable the Nagle algorithm. | -
| = |
- (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. | -
| = |
- (StrOpt) Username for Qpid connection. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_rabbit] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake | -
| = |
- (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. | -
| = |
- (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL | -
| = |
- (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| = |
- (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). | -
| = |
- (StrOpt) SSL cert file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL key file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. | -
| = |
- (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| = |
- (StrOpt) The RabbitMQ broker address where a single node is used. | -
| = |
- (ListOpt) RabbitMQ HA cluster host:port pairs. | -
| = |
- (StrOpt) The RabbitMQ login method. | -
| = |
- (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| = |
- (StrOpt) The RabbitMQ password. | -
| = |
- (IntOpt) The RabbitMQ broker port where a single node is used. | -
| = |
- (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| = |
- (IntOpt) How frequently to retry connecting with RabbitMQ. | -
| = |
- (BoolOpt) Connect over SSL for RabbitMQ. | -
| = |
- (StrOpt) The RabbitMQ userid. | -
| = |
- (StrOpt) The RabbitMQ virtual host. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| [matchmaker_redis] | -|
| = |
- (StrOpt) Host to locate redis. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| Configuration option = Default value | -Description | -
|---|---|
| [rgw_admin_credentials] | -|
| = |
- (StrOpt) Access key for Radosgw Admin. | -
| = |
- (StrOpt) Secret key for Radosgw Admin. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| = |
- (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| = |
- (IntOpt) Size of RPC connection pool. | -
| = |
- (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| = |
- (IntOpt) Seconds to wait for a response from a call. | -
| [notification] | -|
| = |
- (MultiStrOpt) Messaging URLs to listen for notifications. Example: transport://user:pass@host1:port[,hostN:portN]/virtual_host (DEFAULT/transport_url is used if empty) | -
| [oslo_concurrency] | -|
| = |
- (BoolOpt) Enables or disables inter-process locks. | -
| = |
- (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. | -
| [oslo_messaging_amqp] | -|
| = |
- (BoolOpt) Accept clients using either SSL or plain TCP | -
| = |
- (StrOpt) address prefix used when broadcasting to all servers | -
| = |
- (StrOpt) Name for the AMQP container | -
| = |
- (StrOpt) address prefix when sending to any server in group | -
| = |
- (IntOpt) Timeout for inactive connections (in seconds) | -
| = |
- (StrOpt) Password for message broker authentication | -
| = |
- (StrOpt) Path to directory that contains the SASL configuration | -
| = |
- (StrOpt) Name of configuration file (without .conf suffix) | -
| = |
- (StrOpt) Space separated list of acceptable SASL mechanisms | -
| = |
- (StrOpt) address prefix used when sending to a specific server | -
| = |
- (StrOpt) CA certificate PEM file to verify server certificate | -
| = |
- (StrOpt) Identifying certificate PEM file to present to clients | -
| = |
- (StrOpt) Private key PEM file used to sign cert_file certificate | -
| = |
- (StrOpt) Password for decrypting ssl_key_file (if encrypted) | -
| = |
- (BoolOpt) Debug: dump AMQP frames to stdout | -
| = |
- (StrOpt) User name for message broker authentication | -
| [publisher] | -|
| = |
- (StrOpt) Secret value for signing messages. Set value empty if signing is not required to avoid computational overhead. | -
| [publisher_notifier] | -|
| = |
- (StrOpt) The topic that ceilometer uses for event notifications. | -
| = |
- (StrOpt) The topic that ceilometer uses for metering notifications. | -
| = |
- (StrOpt) The driver that ceilometer uses for metering notifications. | -
| Configuration option = Default value | -Description | -
|---|---|
| [service_types] | -|
| = |
- (StrOpt) Glance service type. | -
| = |
- (StrOpt) Kwapi service type. | -
| = |
- (StrOpt) Neutron service type. | -
| = |
- (StrOpt) Nova service type. | -
| = |
- (StrOpt) Radosgw service type. | -
| = |
- (StrOpt) Swift service type. | -
| Configuration option = Default value | -Description | -
|---|---|
| [storage] | -|
| = |
- (IntOpt) Maximum number of connection retries during startup. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) Interval (in seconds) between retries of connection. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf. | -
| Configuration option = Default value | -Description | -
|---|---|
| [hardware] | -|
| = |
- (StrOpt) Configuration file for defining hardware snmp meters. | -
| = |
- (StrOpt) SNMPd user name of all nodes running in the cloud. | -
| = |
- (StrOpt) SNMPd password of all the nodes running in the cloud. | -
| = |
- (StrOpt) URL scheme to use for hardware nodes. | -
| Configuration option = Default value | -Description | -
|---|---|
| [vmware] | -|
| = |
- (IntOpt) Number of times a VMware vSphere API may be retried. | -
| = |
- (StrOpt) CA bundle file to use in verifying the vCenter server certificate. | -
| = |
- (StrOpt) IP address of the VMware vSphere host. | -
| = |
- (StrOpt) Password of VMware vSphere. | -
| = |
- (PortOpt) Port of the VMware vSphere host. | -
| = |
- (StrOpt) Username of VMware vSphere. | -
| = |
- (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 "ca_file" is set. | -
| = |
- (FloatOpt) Sleep time in seconds for polling an ongoing async task. | -
| = |
- (StrOpt) Optional vim service WSDL location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds. | -
| Configuration option = Default value | -Description | -
|---|---|
| [xenapi] | -|
| = |
- (StrOpt) Password for connection to XenServer/Xen Cloud Platform. | -
| = |
- (StrOpt) URL for connection to XenServer/Xen Cloud Platform. | -
| = |
- (StrOpt) Username for connection to XenServer/Xen Cloud Platform. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Exchange name for Messaging service notifications. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| = |
- (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| = |
- (IntOpt) Number of retries to find free port number before fail with ZMQBindError. | -
| = |
- (StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| = |
- (IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| = |
- (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. | -
| = |
- (StrOpt) Directory for holding IPC sockets. | -
| = |
- (StrOpt) MatchMaker driver. | -
| = |
- (IntOpt) Maximal port number for random ports range. | -
| = |
- (IntOpt) Minimal port number for random ports range. | -
| = |
- (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| = |
- (BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| = |
- (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop | -
| = |
- (ListOpt) AMQP topic used for OpenStack notifications. | -
| = |
- (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) File name for the paste.deploy config for cinder-api | -
| = |
- (BoolOpt) Enables or disables rate limit of the API. | -
| = |
- (IntOpt) Cache volume availability zones in memory for the provided duration in seconds | -
| = |
- (StrOpt) Backend override of host value. | -
| = |
- (IntOpt) 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. | -
| = |
- (BoolOpt) DEPRECATED: Deploy v1 of the Cinder API. | -
| = |
- (BoolOpt) Deploy v2 of the Cinder API. | -
| = |
- (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. | -
| = |
- (BoolOpt) Force LUN creation even if the full threshold of pool is reached. | -
| = |
- (StrOpt) List of Management IP addresses (separated by commas) | -
| = |
- (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). | -
| = |
- (IntOpt) The maximum number of items that a collection resource returns in a single response | -
| = |
- (IntOpt) Max size for body of a request | -
| = |
- (StrOpt) Base URL that will be presented to users in links to the OpenStack Volume API | -
| = |
- (ListOpt) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions | -
| = |
- (MultiStrOpt) osapi volume extension to load | -
| = |
- (StrOpt) IP address on which OpenStack Volume API listens | -
| = |
- (IntOpt) Port on which OpenStack Volume API listens | -
| = |
- (IntOpt) Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Max size allowed per volume, in gigabytes | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| = |
- (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. | -
| = |
- (ListOpt) Volume filter options which non-admin user could use to query volumes. Default values are: ['name', 'status', 'metadata', 'availability_zone'] | -
| = |
- (StrOpt) The full class name of the volume transfer API class | -
| = |
- (StrOpt) The full class name of the volume API class to use | -
| = |
- (StrOpt) Template string to be used to generate volume names | -
| = |
- (FloatOpt) Multiplier used for weighing volume number. Negative numbers mean to spread vs stack. | -
| = |
- (IntOpt) The number of characters in the autogenerated auth key. | -
| = |
- (IntOpt) The number of characters in the salt. | -
| [oslo_middleware] | -|
| = |
- (IntOpt) The maximum body size for each request, in bytes. | -
| = |
- (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] | -|
| = |
- (StrOpt) Default rule. Enforced when a requested rule is not found. | -
| = |
- (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. | -
| = |
- (StrOpt) The JSON file that defines policies. | -
| [oslo_versionedobjects] | -|
| = |
- (BoolOpt) Make exception message format errors fatal | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated. | -
| Configuration option = Default value | -Description | -
|---|---|
| [keystone_authtoken] | -|
| = |
- (StrOpt) Service user password. | -
| = |
- (StrOpt) Service tenant name. | -
| = |
- (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | -
| = |
- (StrOpt) Service username. | -
| = |
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Name of the plugin to load | -
| = |
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | -
| = |
- (StrOpt) Config Section from which to load plugin specific options | -
| = |
- (StrOpt) Complete public Identity API endpoint. | -
| = |
- (StrOpt) API version of the admin Identity API endpoint. | -
| = |
- (StrOpt) Env key for the swift cache. | -
| = |
- (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. | -
| = |
- (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. | -
| = |
- (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| = |
- (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | -
| = |
- (IntOpt) Request timeout value for communicating with Identity API server. | -
| = |
- (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| = |
- (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | -
| = |
- (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. | -
| = |
- (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. | -
| = |
- (IntOpt) (Optional) Maximum total number of open connections to every memcached server. | -
| = |
- (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. | -
| = |
- (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. | -
| = |
- (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. | -
| = |
- (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. | -
| = |
- (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. | -
| = |
- (StrOpt) The region in which the identity server can be found. | -
| = |
- (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| = |
- (StrOpt) Directory used to cache files related to PKI tokens. | -
| = |
- (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The full class name of the volume backup API class | -
| = |
- (StrOpt) Compression algorithm (None to disable) | -
| = |
- (StrOpt) Driver to use for backups. | -
| = |
- (StrOpt) Full class name for the Manager for volume backup | -
| = |
- (IntOpt) 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. | -
| = |
- (StrOpt) Template string to be used to generate backup names | -
| = |
- (IntOpt) The number of chunks or objects, for which one Ceilometer notification will be sent | -
| = |
- (StrOpt) Path specifying where to store backups. | -
| = |
- (BoolOpt) Offload pending backup delete during backup service startup. | -
| = |
- (IntOpt) Interval, in seconds, between two progress notifications reporting the backup status | -
| = |
- (StrOpt) The topic that volume backup nodes listen on | -
| = |
- (StrOpt) Template string to be used to generate snapshot names | -
| = |
- (BoolOpt) Create volume from snapshot at the host where snapshot resides | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) The chunk size, in bytes, that a backup is broken into before transfer to the Ceph object store. | -
| = |
- (StrOpt) Ceph configuration file to use. | -
| = |
- (StrOpt) The Ceph pool where volume backups are stored. | -
| = |
- (IntOpt) RBD stripe count to use when creating a backup image. | -
| = |
- (IntOpt) RBD stripe unit to use when creating a backup image. | -
| = |
- (StrOpt) 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. | -
| = |
- (BoolOpt) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Custom directory to use for backups. | -
| = |
- (BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the backend storage. The default value is True to enable the timer. | -
| = |
- (IntOpt) The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files.backup_file_size must be a multiple of backup_sha_block_size_bytes. | -
| = |
- (StrOpt) Mount options passed to the NFS client. See NFS man page for details. | -
| = |
- (StrOpt) Base dir containing mount point for NFS share. | -
| = |
- (IntOpt) The size in bytes that changes are tracked for incremental backups. backup_file_size has to be multiple of backup_sha_block_size_bytes. | -
| = |
- (StrOpt) NFS share in hostname:path, ipv4addr:path, or "[ipv6addr]:path" format. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Swift authentication mechanism | -
| = |
- (StrOpt) Swift authentication version. Specify "1" for auth 1.0, or "2" for auth 2.0 | -
| = |
- (IntOpt) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size. | -
| = |
- (StrOpt) Location of the CA certificate file to use for swift client requests. | -
| = |
- (StrOpt) The default Swift container to use | -
| = |
- (BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the Swift backend storage. The default value is True to enable the timer. | -
| = |
- (StrOpt) Swift key for authentication | -
| = |
- (IntOpt) The size in bytes of Swift backup objects | -
| = |
- (IntOpt) The number of retries to make for Swift operations | -
| = |
- (IntOpt) The backoff time in seconds between Swift retries | -
| = |
- (StrOpt) Swift tenant/account name. Required when connecting to an auth 2.0 system | -
| = |
- (StrOpt) The URL of the Swift endpoint | -
| = |
- (StrOpt) Swift user name | -
| = |
- (StrOpt) 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 | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Enable or Disable compression for backups | -
| = |
- (StrOpt) TSM password for the running username | -
| = |
- (StrOpt) Volume prefix for the backup id when backing up to TSM | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (ListOpt) List of all available devices | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) IP address/hostname of Blockbridge API. | -
| = |
- (IntOpt) Override HTTPS port to connect to Blockbridge API server. | -
| = |
- (StrOpt) Blockbridge API password (for auth scheme 'password') | -
| = |
- (StrOpt) Blockbridge API authentication scheme (token or password) | -
| = |
- (StrOpt) Blockbridge API token (for auth scheme 'token') | -
| = |
- (StrOpt) Blockbridge API user (for auth scheme 'password') | -
| = |
- (StrOpt) Default pool name if unspecified. | -
| = |
- (DictOpt) Defines the set of exposed pools and their associated backend query strings | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) CA certificate file to use to verify connecting clients | -
| = |
- (StrOpt) Certificate file to use when starting the server securely | -
| = |
- (StrOpt) Private key file to use when starting the server securely | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) CloudByte storage specific account name. This maps to a project name in OpenStack. | -
| = |
- (DictOpt) These values will be used for CloudByte storage's addQos API call. | -
| = |
- (StrOpt) Driver will use this API key to authenticate against the CloudByte storage's management interface. | -
| = |
- (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. | -
| = |
- (IntOpt) Will confirm a successful volume creation in CloudByte storage by making this many number of attempts. | -
| = |
- (IntOpt) A retry value in seconds. Will be used by the driver to check if volume creation was successful in CloudByte storage. | -
| = |
- (IntOpt) Will confirm a successful volume deletion in CloudByte storage by making this many number of attempts. | -
| = |
- (IntOpt) A retry value in seconds. Will be used by the driver to check if volume deletion was successful in CloudByte storage. | -
| = |
- (DictOpt) These values will be used for CloudByte storage's createVolume API call. | -
| = |
- (StrOpt) This corresponds to the name of Tenant Storage Machine (TSM) in CloudByte storage. A volume will be created in this TSM. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing. | -
| = |
- (StrOpt) Password for specified CHAP account name. | -
| = |
- (StrOpt) CHAP user name. | -
| = |
- (StrOpt) Chiscsi (CXT) global defaults configuration file | -
| = |
- (StrOpt) ID of the project which will be used as the Cinder internal tenant. | -
| = |
- (StrOpt) ID of the user to be used in volume operations as the Cinder internal tenant. | -
| = |
- (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. | -
| = |
- (StrOpt) The full class name of the compute API class to use | -
| = |
- (StrOpt) The full class name of the consistencygroup API class | -
| = |
- (StrOpt) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes. | -
| = |
- (StrOpt) Default volume type to use | -
| = |
- (StrOpt) Namespace for driver private data values to be saved in. | -
| = |
- (BoolOpt) If set to True the http client will validate the SSL certificate of the backend endpoint. | -
| = |
- (BoolOpt) Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it. | -
| = |
- (BoolOpt) Services to be added to the available pool on create | -
| = |
- (StrOpt) If this option is specified then the end time specified is used instead of the end time of the last completed audit period. | -
| = |
- (BoolOpt) If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path. | -
| = |
- (IntOpt) Size of executor thread pool. | -
| = |
- (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address. | -
| = |
- (StrOpt) IET configuration file | -
| = |
- (ListOpt) The list of secondary IP addresses of the iSCSI daemon | -
| = |
- (BoolOpt) There are two types of target configurations managed (replicate to another configured backend) or unmanaged (replicate to a device not managed by Cinder). | -
| = |
- (FloatOpt) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 will be ignored and the default value will be used instead. | -
| = |
- (ListOpt) Memcached servers or None for in process cache. | -
| = |
- (BoolOpt) Enable monkey patching | -
| = |
- (ListOpt) List of modules/decorators to monkey patch | -
| = |
- (StrOpt) IP address of this host | -
| = |
- (BoolOpt) Whether snapshots count against gigabyte quota | -
| = |
- (IntOpt) Number of times to attempt to run flakey shell commands | -
| = |
- (StrOpt) Auth URL associated with the OpenStack privileged account. | -
| = |
- (StrOpt) OpenStack privileged account username. Used for requests to other services (such as Nova) that require an account with special rights. | -
| = |
- (StrOpt) Password associated with the OpenStack privileged account. | -
| = |
- (StrOpt) Tenant name associated with the OpenStack privileged account. | -
| = |
- (IntOpt) Range, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) | -
| = |
- (IntOpt) Interval, in seconds, between running periodic tasks | -
| = |
- (StrOpt) The full class name of the volume replication API class | -
| = |
- (ListOpt) List of k/v pairs representing a replication target for this backend device. For unmanaged the format is: {'key-1'='val1' 'key-2'='val2'...},{...} and for managed devices its simply a list of valid configured backend_names that the driver supports replicating to: backend-a,bakcend-b... | -
| = |
- (IntOpt) Interval, in seconds, between nodes reporting state to datastore | -
| = |
- (IntOpt) Global backend request timeout, in seconds | -
| = |
- (IntOpt) The percentage of backend capacity is reserved | -
| = |
- (StrOpt) Path to the rootwrap configuration file to use for running commands as root | -
| = |
- (BoolOpt) Send the volume and snapshot create and delete notifications generated in the specified period. | -
| = |
- (IntOpt) Maximum time since last check-in for a service to be considered up | -
| = |
- (StrOpt) File name of clean sqlite db | -
| = |
- (StrOpt) File containing SSH host keys for the systems with which Cinder needs to communicate. OPTIONAL: Default=$state_path/ssh_known_hosts | -
| = |
- (StrOpt) If this option is specified then the start time specified is used instead of the start time of the last completed audit period. | -
| = |
- (StrOpt) Top-level directory for maintaining cinder's state | -
| = |
- (StrOpt) Availability zone of this node | -
| = |
- (BoolOpt) 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 | -
| = |
- (BoolOpt) Sets the value of TCP_KEEPALIVE (True/False) for each server socket. | -
| = |
- (IntOpt) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X. | -
| = |
- (IntOpt) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X. | -
| = |
- (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. | -
| = |
- (IntOpt) Count of reservations until usage is refreshed | -
| = |
- (BoolOpt) Option to enable/disable CHAP authentication for targets. | -
| = |
- (BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. | -
| = |
- (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) If False, closes the client socket connection explicitly. Setting it to True to maintain backward compatibility. Recommended setting is set it to False. | -
| [keystone_authtoken] | -|
| = |
- (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Allow to perform insecure SSL requests to nova | -
| = |
- (StrOpt) Location of ca certificates file to use for nova client requests. | -
| = |
- (StrOpt) Same as nova_catalog_info, but for admin endpoint. | -
| = |
- (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> | -
| = |
- (StrOpt) Same as nova_endpoint_template, but for admin endpoint. | -
| = |
- (StrOpt) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s | -
| = |
- (StrOpt) Region name of this node | -
| Configuration option = Default value | -Description | -
|---|---|
| [cors] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Driver to use for database access | -
| [database] | -|
| = |
- (StrOpt) The back end to use for the database. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the database. | -
| = |
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. | -
| = |
- (BoolOpt) Add Python stack traces to SQL as comment strings. | -
| = |
- (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. | -
| = |
- (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. | -
| = |
- (IntOpt) Seconds between retries of a database transaction. | -
| = |
- (IntOpt) Timeout before idle SQL connections are reaped. | -
| = |
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy. | -
| = |
- (IntOpt) Maximum number of SQL connections to keep open in a pool. | -
| = |
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) Minimum number of SQL connections to keep open in a pool. | -
| = |
- (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | -
| = |
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. | -
| = |
- (IntOpt) Interval between retries of opening a SQL connection. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. | -
| = |
- (StrOpt) The file name to use with SQLite. | -
| = |
- (BoolOpt) If True, SQLite uses synchronous mode. | -
| = |
- (BoolOpt) Enable the experimental use of database reconnect on connection lost. | -
| = |
- (BoolOpt) Enable the experimental use of thread pooling for all DB API calls | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Datera API port. | -
| = |
- (StrOpt) DEPRECATED: This will be removed in the Liberty release. Use san_login and san_password instead. This directly sets the Datera API token. | -
| = |
- (StrOpt) Datera API version. | -
| = |
- (StrOpt) Number of replicas to create of an inode. | -
| = |
- (StrOpt) The path to the client certificate for verification, if the driver supports it. | -
| = |
- (StrOpt) The path to the client certificate key for verification, if the driver supports it. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (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. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Dell API port | -
| = |
- (StrOpt) Name of the server folder to use on the Storage Center | -
| = |
- (IntOpt) Storage Center System Serial Number | -
| = |
- (BoolOpt) Enable HTTPS SC certificate verification. | -
| = |
- (StrOpt) Name of the volume folder to use on the Storage Center | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) DotHill API interface protocol. | -
| = |
- (StrOpt) Pool or Vdisk name to use for volume creation. | -
| = |
- (StrOpt) linear (for Vdisk) or virtual (for Pool). | -
| = |
- (ListOpt) List of comma-separated target iSCSI IP addresses. | -
| = |
- (BoolOpt) Whether to verify DotHill array SSL certificate. | -
| = |
- (StrOpt) DotHill array SSL certificate path. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Number of nodes that should replicate the data. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Report free_capacity_gb as 0 when the limit to maximum number of pool LUNs is reached. By default, the value is False. | -
| = |
- (StrOpt) use this file for cinder emc plugin config data | -
| = |
- (BoolOpt) To destroy storage group when the last LUN is removed from it. By default, the value is False. | -
| = |
- (BoolOpt) Delete a LUN even if it is in Storage Groups. | -
| = |
- (BoolOpt) Automatically deregister initiators after the related storage group is destroyed. By default, the value is False. | -
| = |
- (BoolOpt) Automatically register initiators. By default, the value is False. | -
| = |
- (StrOpt) Comma separated iSCSI or FC ports to be used in Nova or Cinder. | -
| = |
- (StrOpt) Mapping between hostname and its iSCSI initiator IP addresses. | -
| = |
- (IntOpt) Default max number of LUNs in a storage group. By default, the value is 255. | -
| = |
- (StrOpt) Naviseccli Path. | -
| = |
- (StrOpt) VNX authentication scope type. | -
| = |
- (StrOpt) Comma-separated list of storage pool names to be used. | -
| = |
- (StrOpt) Directory path that contains the VNX security file. Make sure the security file is generated first. | -
| = |
- (IntOpt) Number of retries in case array is busy | -
| = |
- (IntOpt) Interval between retries in case array is busy | -
| = |
- (StrOpt) XMS cluster id in multi-cluster environment | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Whether to allow force delete. | -
| = |
- (StrOpt) Protection domain id. | -
| = |
- (StrOpt) Protection domain name. | -
| = |
- (StrOpt) REST server port. | -
| = |
- (BoolOpt) Whether to round volume capacity. | -
| = |
- (StrOpt) Server certificate path. | -
| = |
- (StrOpt) Storage pool id. | -
| = |
- (StrOpt) Storage pool name. | -
| = |
- (StrOpt) Storage pools. | -
| = |
- (BoolOpt) Whether to unmap volume before deletion. | -
| = |
- (BoolOpt) Whether to verify server certificate. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Existing CHAP account name. Note that this option is deprecated in favour of "chap_username" as specified in cinder/volume/driver.py and will be removed in next release. | -
| = |
- (StrOpt) Password for specified CHAP account name. Note that this option is deprecated in favour of "chap_password" as specified in cinder/volume/driver.py and will be removed in the next release | -
| = |
- (IntOpt) Maximum retry count for reconnection. Default is 5. | -
| = |
- (IntOpt) Timeout for the Group Manager cli command execution. Default is 30. Note that this option is deprecated in favour of "ssh_conn_timeout" as specified in cinder/volume/drivers/san/san.py and will be removed in M release. | -
| = |
- (StrOpt) Group name to use for creating volumes. Defaults to "group-0". | -
| = |
- (StrOpt) Pool in which volumes will be created. Defaults to "default". | -
| = |
- (BoolOpt) Use CHAP authentication for targets. Note that this option is deprecated in favour of "use_chap_auth" as specified in cinder/volume/driver.py and will be removed in next release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Connection protocol should be FC. (Default is FC.) | -
| = |
- (IntOpt) Default iSCSI Port ID of FlashSystem. (Default port is 0.) | -
| = |
- (BoolOpt) Allows vdisk to multi host mapping. (Default is True) | -
| = |
- (BoolOpt) Connect with multipath (FC only).(Default is false.) | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Configuration file for HDS iSCSI cinder plugin | -
| = |
- (StrOpt) Configuration file for HDS NFS cinder plugin | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Space network name to use for data transfer | -
| = |
- (StrOpt) Should spaces be redundantly stored (1/0) | -
| = |
- (StrOpt) Group to own created spaces | -
| = |
- (StrOpt) UNIX mode for created spaces | -
| = |
- (StrOpt) User to own created spaces | -
| = |
- (StrOpt) Comma separated list of Space storage servers:devices. ex: os1_stor:gbd0,os2_stor:gbd0 | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Add CHAP user | -
| = |
- (IntOpt) Interval to check copy asynchronously | -
| = |
- (StrOpt) iSCSI authentication method | -
| = |
- (StrOpt) iSCSI authentication password | -
| = |
- (StrOpt) iSCSI authentication username | -
| = |
- (IntOpt) Interval to check copy | -
| = |
- (IntOpt) Copy speed of storage system | -
| = |
- (StrOpt) Default copy method of storage system | -
| = |
- (StrOpt) Range of group number | -
| = |
- (BoolOpt) Request for creating HostGroup or iSCSI Target | -
| = |
- (BoolOpt) Add to HORCM configuration | -
| = |
- (StrOpt) Instance numbers for HORCM | -
| = |
- (StrOpt) Password of storage system for HORCM | -
| = |
- (IntOpt) Timeout until a resource lock is released, in seconds. The value must be between 0 and 7200. | -
| = |
- (StrOpt) Username of storage system for HORCM | -
| = |
- (StrOpt) Range of logical device of storage system | -
| = |
- (IntOpt) Pool ID of storage system | -
| = |
- (StrOpt) Serial number of storage system | -
| = |
- (StrOpt) Control port names for HostGroup or iSCSI Target | -
| = |
- (IntOpt) Thin pool ID of storage system | -
| = |
- (StrOpt) Name of an array unit | -
| = |
- (BoolOpt) Request for FC Zone creating HostGroup | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1 | -
| = |
- (ListOpt) List of the CPG(s) to use for volume creation | -
| = |
- (StrOpt) The CPG to use for Snapshots for volumes. If empty the userCPG will be used. | -
| = |
- (BoolOpt) Enable HTTP debugging to 3PAR | -
| = |
- (BoolOpt) Enable CHAP authentication for iSCSI connections. | -
| = |
- (ListOpt) List of target iSCSI addresses to use. | -
| = |
- (StrOpt) 3PAR password for the user specified in hpe3par_username | -
| = |
- (StrOpt) The time in hours when a snapshot expires and is deleted. This must be larger than expiration | -
| = |
- (StrOpt) The time in hours to retain a snapshot. You can't delete it before this expires. | -
| = |
- (StrOpt) 3PAR username with the 'edit' role | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) HPE LeftHand WSAPI Server Url like https://<LeftHand ip>:8081/lhos | -
| = |
- (StrOpt) HPE LeftHand cluster name | -
| = |
- (BoolOpt) Enable HTTP debugging to LeftHand | -
| = |
- (BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled) | -
| = |
- (StrOpt) HPE LeftHand Super user password | -
| = |
- (StrOpt) HPE LeftHand Super user username | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) HPMSA API interface protocol. | -
| = |
- (StrOpt) Pool or Vdisk name to use for volume creation. | -
| = |
- (StrOpt) linear (for Vdisk) or virtual (for Pool). | -
| = |
- (ListOpt) List of comma-separated target iSCSI IP addresses. | -
| = |
- (BoolOpt) Whether to verify HPMSA array SSL certificate. | -
| = |
- (StrOpt) HPMSA array SSL certificate path. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Interval to check copy asynchronously | -
| = |
- (ListOpt) Target port names of compute node for host group or iSCSI target | -
| = |
- (IntOpt) Interval to check copy | -
| = |
- (IntOpt) Copy speed of storage system | -
| = |
- (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" | -
| = |
- (BoolOpt) Request for creating host group or iSCSI target | -
| = |
- (BoolOpt) Add to HORCM configuration | -
| = |
- (BoolOpt) Only discover a specific name of host group or iSCSI target | -
| = |
- (ListOpt) Instance numbers for HORCM | -
| = |
- (StrOpt) Resource group name of storage system for HORCM | -
| = |
- (StrOpt) Username of storage system for HORCM | -
| = |
- (StrOpt) Logical device range of storage system | -
| = |
- (StrOpt) Pool of storage system | -
| = |
- (StrOpt) Type of storage command line interface | -
| = |
- (StrOpt) ID of storage system | -
| = |
- (ListOpt) Target port names for host group or iSCSI target | -
| = |
- (StrOpt) Thin pool of storage system | -
| = |
- (BoolOpt) Request for FC Zone creating host group | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The configuration file for the Cinder Huawei driver. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) IBMNAS platform type to be used as backend storage; valid values are - v7ku : for using IBM Storwize V7000 Unified, sonas : for using IBM Scale Out NAS, gpfs-nas : for using NFS based IBM GPFS deployments. | -
| = |
- (StrOpt) IP address or Hostname of NAS system. | -
| = |
- (StrOpt) User name to connect to NAS system. | -
| = |
- (StrOpt) Options used to mount the storage backend file system where Cinder volumes are stored. | -
| = |
- (StrOpt) Password to connect to NAS system. | -
| = |
- (StrOpt) Filename of private key to use for SSH authentication. | -
| = |
- (StrOpt) Allow network-attached storage systems to operate in a secure environment where root level access is not permitted. If set to False, access is as the root user and insecure. If set to True, access is not as root. If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto. | -
| = |
- (StrOpt) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto. | -
| = |
- (StrOpt) Path to the share to use for storing Cinder volumes. For example: "/srv/export1" for an NFS server export available at 10.0.5.10:/srv/export1 . | -
| = |
- (IntOpt) SSH port to use to connect to NAS system. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (ListOpt) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. | -
| = |
- (BoolOpt) Allow to perform insecure SSL (https) requests to glance | -
| = |
- (ListOpt) A list of the glance API servers available to cinder ([hostname|ip]:port) | -
| = |
- (BoolOpt) 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. | -
| = |
- (IntOpt) Version of the glance API to use | -
| = |
- (StrOpt) Location of ca certificates file to use for glance client requests. | -
| = |
- (ListOpt) Default core properties of image | -
| = |
- (StrOpt) Default glance host name or IP | -
| = |
- (IntOpt) Number retries when downloading an image from glance | -
| = |
- (IntOpt) Default glance port | -
| = |
- (IntOpt) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used. | -
| = |
- (StrOpt) Directory used for temporary storage during image conversion | -
| = |
- (BoolOpt) 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. | -
| = |
- (BoolOpt) 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. | -
| = |
- (BoolOpt) Enable the image volume cache for this backend. | -
| = |
- (IntOpt) Max number of entries allowed in the image volume cache. 0 => unlimited. | -
| = |
- (IntOpt) Max size of the image volume cache for this backend in GB. 0 => unlimited. | -
| = |
- (BoolOpt) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers? | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Maximum retry time for cli. Default is 5. | -
| = |
- (StrOpt) The Infortrend CLI absolute path. By default, it is at /opt/bin/Infortrend/raidcmd_ESDS10.jar | -
| = |
- (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. | -
| = |
- (StrOpt) Let the volume use specific provisioning. By default, it is the full provisioning. The supported options are full or thin. | -
| = |
- (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. | -
| = |
- (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. | -
| = |
- (StrOpt) Let the volume use specific tiering level. By default, it is the level 0. The supported levels are 0,2,3,4. | -
| Configuration option = Default value | -Description | -
|---|---|
| [keymgr] | -|
| = |
- (StrOpt) The full class name of the key manager API class | -
| = |
- (StrOpt) Url for encryption service. | -
| = |
- (StrOpt) Authentication url for encryption service. | -
| = |
- (StrOpt) Fixed key returned by key manager, specified in hex | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Lenovo api interface protocol. | -
| = |
- (StrOpt) Pool or Vdisk name to use for volume creation. | -
| = |
- (StrOpt) linear (for VDisk) or virtual (for Pool). | -
| = |
- (ListOpt) List of comma-separated target iSCSI IP addresses. | -
| = |
- (BoolOpt) Whether to verify Lenovo array SSL certificate. | -
| = |
- (StrOpt) Lenovo array SSL certificate path. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). | -
| = |
- (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Enables or disables fatal status of deprecations. | -
| = |
- (BoolOpt) Make exception message format errors fatal. | -
| = |
- (StrOpt) The format for an instance that is passed with the log message. | -
| = |
- (StrOpt) The format for an instance UUID that is passed with the log message. | -
| = |
- (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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). | -
| = |
- (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. | -
| = |
- (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. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) Format string to use for log messages with context. | -
| = |
- (StrOpt) Data to append to log format when level is DEBUG. | -
| = |
- (StrOpt) Format string to use for log messages without context. | -
| = |
- (StrOpt) Prefix each line of exception output with this format. | -
| = |
- (BoolOpt) Enables or disables publication of error events. | -
| = |
- (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. | -
| = |
- (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 Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) LVM conf file to use for the LVM driver in Cinder; this setting is ignored if the specified file does not exist (You can also specify 'None' to not use a conf file even if one exists). | -
| = |
- (IntOpt) If >0, create LVs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space | -
| = |
- (StrOpt) Type of LVM volumes to deploy; (default, thin, or auto). Auto defaults to thin if thin is supported. | -
| = |
- (StrOpt) Name for the VG that will contain exported volumes | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Administrative user account name used to access the storage system or proxy server. | -
| = |
- (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) Password for the administrative user account specified in the netapp_login option. | -
| = |
- (StrOpt) 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. | -
| = |
- (StrOpt) The hostname (or IP address) for the storage system or proxy server. | -
| = |
- (IntOpt) 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. | -
| = |
- (FloatOpt) 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. | -
| = |
- (StrOpt) 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. | -
| = |
- (StrOpt) The storage protocol to be used on the data path with the storage system. | -
| = |
- (StrOpt) The transport protocol used when communicating with the storage system or proxy server. | -
| = |
- (StrOpt) 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. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) 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. | -
| = |
- (StrOpt) Administrative user account name used to access the storage system or proxy server. | -
| = |
- (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) Password for the administrative user account specified in the netapp_login option. | -
| = |
- (StrOpt) 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. | -
| = |
- (StrOpt) The hostname (or IP address) for the storage system or proxy server. | -
| = |
- (IntOpt) 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. | -
| = |
- (StrOpt) 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. | -
| = |
- (StrOpt) The storage protocol to be used on the data path with the storage system. | -
| = |
- (StrOpt) The transport protocol used when communicating with the storage system or proxy server. | -
| = |
- (StrOpt) 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. | -
| = |
- (IntOpt) 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. | -
| = |
- (IntOpt) 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. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Administrative user account name used to access the storage system or proxy server. | -
| = |
- (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. | -
| = |
- (StrOpt) 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. | -
| = |
- (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) Password for the administrative user account specified in the netapp_login option. | -
| = |
- (StrOpt) 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. | -
| = |
- (StrOpt) The hostname (or IP address) for the storage system or proxy server. | -
| = |
- (IntOpt) 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. | -
| = |
- (FloatOpt) 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. | -
| = |
- (StrOpt) 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. | -
| = |
- (StrOpt) The storage protocol to be used on the data path with the storage system. | -
| = |
- (StrOpt) The transport protocol used when communicating with the storage system or proxy server. | -
| = |
- (StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) 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. | -
| = |
- (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. | -
| = |
- (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. | -
| = |
- (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. | -
| = |
- (StrOpt) Administrative user account name used to access the storage system or proxy server. | -
| = |
- (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. | -
| = |
- (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) Password for the administrative user account specified in the netapp_login option. | -
| = |
- (StrOpt) 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. | -
| = |
- (StrOpt) The hostname (or IP address) for the storage system or proxy server. | -
| = |
- (IntOpt) 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. | -
| = |
- (StrOpt) 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. | -
| = |
- (StrOpt) The storage protocol to be used on the data path with the storage system. | -
| = |
- (StrOpt) The transport protocol used when communicating with the storage system or proxy server. | -
| = |
- (StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. | -
| = |
- (IntOpt) 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. | -
| = |
- (IntOpt) 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. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (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. | -
| = |
- (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. | -
| = |
- (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. | -
| = |
- (StrOpt) Administrative user account name used to access the storage system or proxy server. | -
| = |
- (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) Password for the administrative user account specified in the netapp_login option. | -
| = |
- (StrOpt) 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. | -
| = |
- (StrOpt) Password for the NetApp E-Series storage array. | -
| = |
- (StrOpt) The hostname (or IP address) for the storage system or proxy server. | -
| = |
- (IntOpt) 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. | -
| = |
- (StrOpt) 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. | -
| = |
- (StrOpt) The transport protocol used when communicating with the storage system or proxy server. | -
| = |
- (StrOpt) 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. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Nimble Controller pool name | -
| = |
- (StrOpt) Nimble Subnet Label | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Vpool to use for volumes - backend is defined by vpool not by us. | -
| Configuration option = Default value | -Description | -
|---|---|
| [profiler] | -|
| = |
- (BoolOpt) If False fully disable profiling feature. | -
| = |
- (BoolOpt) If False doesn't trace SQL requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) DPL pool uuid in which DPL volumes are stored. | -
| = |
- (IntOpt) DPL port number. | -
| = |
- (IntOpt) The port that the iSCSI daemon is listening on | -
| = |
- (StrOpt) IP address of SAN controller | -
| = |
- (StrOpt) Username for SAN controller | -
| = |
- (StrOpt) Password for SAN controller | -
| = |
- (BoolOpt) Use thin provisioning for SAN volumes? | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) REST API authorization token. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_qpid] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (IntOpt) Seconds between connection keepalive heartbeats. | -
| = |
- (StrOpt) Qpid broker hostname. | -
| = |
- (ListOpt) Qpid HA cluster host:port pairs. | -
| = |
- (StrOpt) Password for Qpid connection. | -
| = |
- (IntOpt) Qpid broker port. | -
| = |
- (StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| = |
- (IntOpt) The number of prefetched messages held by receiver. | -
| = |
- (StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| = |
- (BoolOpt) Whether to disable the Nagle algorithm. | -
| = |
- (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. | -
| = |
- (StrOpt) Username for Qpid connection. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Path to a Quobyte Client configuration file. | -
| = |
- (StrOpt) Base dir containing the mount point for the Quobyte volume. | -
| = |
- (BoolOpt) Create volumes as QCOW2 files rather than raw files. | -
| = |
- (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. | -
| = |
- (StrOpt) URL to the Quobyte volume e.g., quobyte://<DIR host>/<volume name> | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Number of seconds between subsequent usage refreshes | -
| = |
- (IntOpt) Total amount of storage, in gigabytes, allowed for backups per project | -
| = |
- (IntOpt) Number of volume backups allowed per project | -
| = |
- (IntOpt) Number of consistencygroups allowed per project | -
| = |
- (StrOpt) Default driver to use for quota checks | -
| = |
- (IntOpt) Total amount of storage, in gigabytes, allowed for volumes and snapshots per project | -
| = |
- (IntOpt) Number of volume snapshots allowed per project | -
| = |
- (IntOpt) Number of volumes allowed per project | -
| = |
- (IntOpt) Number of seconds until a reservation expires | -
| = |
- (BoolOpt) Enables or disables use of default quota class with default quota. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_rabbit] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake | -
| = |
- (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. | -
| = |
- (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL | -
| = |
- (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| = |
- (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). | -
| = |
- (StrOpt) SSL cert file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL key file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. | -
| = |
- (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| = |
- (StrOpt) The RabbitMQ broker address where a single node is used. | -
| = |
- (ListOpt) RabbitMQ HA cluster host:port pairs. | -
| = |
- (StrOpt) The RabbitMQ login method. | -
| = |
- (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| = |
- (StrOpt) The RabbitMQ password. | -
| = |
- (IntOpt) The RabbitMQ broker port where a single node is used. | -
| = |
- (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| = |
- (IntOpt) How frequently to retry connecting with RabbitMQ. | -
| = |
- (BoolOpt) Connect over SSL for RabbitMQ. | -
| = |
- (StrOpt) The RabbitMQ userid. | -
| = |
- (StrOpt) The RabbitMQ virtual host. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [matchmaker_redis] | -|
| = |
- (StrOpt) Host to locate redis. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| = |
- (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| = |
- (IntOpt) Size of RPC connection pool. | -
| = |
- (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| = |
- (IntOpt) Seconds to wait for a response from a call. | -
| = |
- (StrOpt) The topic that volume nodes listen on | -
| [oslo_concurrency] | -|
| = |
- (BoolOpt) Enables or disables inter-process locks. | -
| = |
- (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. | -
| [oslo_messaging_amqp] | -|
| = |
- (BoolOpt) Accept clients using either SSL or plain TCP | -
| = |
- (StrOpt) address prefix used when broadcasting to all servers | -
| = |
- (StrOpt) Name for the AMQP container | -
| = |
- (StrOpt) address prefix when sending to any server in group | -
| = |
- (IntOpt) Timeout for inactive connections (in seconds) | -
| = |
- (StrOpt) Password for message broker authentication | -
| = |
- (StrOpt) Path to directory that contains the SASL configuration | -
| = |
- (StrOpt) Name of configuration file (without .conf suffix) | -
| = |
- (StrOpt) Space separated list of acceptable SASL mechanisms | -
| = |
- (StrOpt) address prefix used when sending to a specific server | -
| = |
- (StrOpt) CA certificate PEM file to verify server certificate | -
| = |
- (StrOpt) Identifying certificate PEM file to present to clients | -
| = |
- (StrOpt) Private key PEM file used to sign cert_file certificate | -
| = |
- (StrOpt) Password for decrypting ssl_key_file (if encrypted) | -
| = |
- (BoolOpt) Debug: dump AMQP frames to stdout | -
| = |
- (StrOpt) User name for message broker authentication | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Cluster name to use for creating volumes | -
| = |
- (StrOpt) IP address of SAN controller | -
| = |
- (BoolOpt) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device | -
| = |
- (StrOpt) Username for SAN controller | -
| = |
- (StrOpt) Password for SAN controller | -
| = |
- (StrOpt) Filename of private key to use for SSH authentication | -
| = |
- (StrOpt) VNX secondary SP IP Address. | -
| = |
- (IntOpt) SSH port to use with SAN | -
| = |
- (BoolOpt) Use thin provisioning for SAN volumes? | -
| = |
- (IntOpt) SSH connection timeout in seconds | -
| = |
- (IntOpt) Maximum ssh connections in the pool | -
| = |
- (IntOpt) Minimum ssh connections in the pool | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Path or URL to Scality SOFS configuration file | -
| = |
- (StrOpt) Base dir where Scality SOFS shall be mounted | -
| = |
- (StrOpt) Path from Scality SOFS root to volume dir | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) String representation for an equation that will be used to filter hosts. Only used when the driver filter is set to be used by the Cinder scheduler. | -
| = |
- (StrOpt) String representation for an equation that will be used to determine the goodness of a host. Only used when using the goodness weigher is set to be used by the Cinder scheduler. | -
| = |
- (ListOpt) Which filter class names to use for filtering hosts when not specified in the request. | -
| = |
- (ListOpt) Which weigher class names to use for weighing hosts. | -
| = |
- (StrOpt) Default scheduler driver to use | -
| = |
- (StrOpt) The scheduler host manager class to use | -
| = |
- (StrOpt) Absolute path to scheduler configuration JSON file. | -
| = |
- (StrOpt) Full class name for the Manager for scheduler | -
| = |
- (IntOpt) Maximum number of attempts to schedule an volume | -
| = |
- (StrOpt) The topic that scheduler nodes listen on | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) SCST target implementation can choose from multiple SCST target drivers. | -
| = |
- (StrOpt) Certain ISCSI targets have predefined target names, SCST target driver uses this name. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) IP address of sheep daemon. | -
| = |
- (IntOpt) Port of sheep daemon. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Default format that will be used when creating volumes if no volume format is specified. | -
| = |
- (StrOpt) Mount options passed to the smbfs client. See mount.cifs man page for details. | -
| = |
- (StrOpt) Base dir containing mount points for smbfs shares. | -
| = |
- (FloatOpt) 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. | -
| = |
- (StrOpt) File with the list of available smbfs shares. | -
| = |
- (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. | -
| = |
- (FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (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. | -
| = |
- (BoolOpt) Create an internal cache of copy of images when a bootable volume is created to eliminate fetch from glance and qemu-conversion on subsequent calls. | -
| = |
- (BoolOpt) Allow tenants to specify QOS on create | -
| = |
- (IntOpt) SolidFire API port. Useful if the device api is behind a proxy on a different port. | -
| = |
- (BoolOpt) Set 512 byte emulation on volume creation; | -
| = |
- (BoolOpt) 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. | -
| = |
- (StrOpt) 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. | -
| = |
- (StrOpt) Account name on the SolidFire Cluster to use as owner of template/cache volumes (created if does not exist). | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Comma-separated list of REST servers IP to connect to. (eg http://IP1/,http://IP2:81/path | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread. | -
| = |
- (FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread. | -
| = |
- (ListOpt) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options | -
| = |
- (StrOpt) iSCSI target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, scstadmin for SCST target support, iseradm for the ISER protocol, ietadm for iSCSI Enterprise Target, iscsictl for Chelsio iSCSI Target or fake for testing. | -
| = |
- (StrOpt) 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 | -
| = |
- (StrOpt) The IP address that the iSCSI daemon is listening on | -
| = |
- (IntOpt) The port that the iSCSI daemon is listening on | -
| = |
- (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. | -
| = |
- (StrOpt) Prefix for iSCSI volumes | -
| = |
- (StrOpt) 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 or iseradm. | -
| = |
- (StrOpt) The name of the iSER target user-land tool to use | -
| = |
- (StrOpt) The IP address that the iSER daemon is listening on | -
| = |
- (IntOpt) The port that the iSER daemon is listening on | -
| = |
- (StrOpt) Prefix for iSER volumes | -
| = |
- (IntOpt) Timeout for creating the volume to migrate to when performing volume migration (seconds) | -
| = |
- (IntOpt) The maximum number of times to rescan iSER targetto find volume | -
| = |
- (IntOpt) The maximum number of times to rescan targets to find volume | -
| = |
- (StrOpt) The backend name for a given driver implementation | -
| = |
- (StrOpt) Method used to wipe old volumes | -
| = |
- (StrOpt) 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. | -
| = |
- (IntOpt) Size in MiB to wipe at start of old volumes. 0 => all | -
| = |
- (StrOpt) The blkio cgroup name to be used to limit bandwidth of volume copy | -
| = |
- (IntOpt) The upper limit of bandwidth of volume copy. 0 => unlimited | -
| = |
- (StrOpt) The default block size used when copying/clearing volumes | -
| = |
- (StrOpt) Driver to use for volume creation | -
| = |
- (StrOpt) Full class name for the Manager for volume | -
| = |
- (BoolOpt) Offload pending volume delete during volume service startup | -
| = |
- (StrOpt) Time period for which to generate volume usages. The options are hour, day, month, or year. | -
| = |
- (StrOpt) Volume configuration file storage directory | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Timeout value (in seconds) used when connecting to ceph cluster. If value < 0, no timeout is set and default librados value is used. | -
| = |
- (IntOpt) Interval value (in seconds) between connection retries to ceph cluster. | -
| = |
- (IntOpt) Number of retries if connection to ceph cluster failed. | -
| = |
- (StrOpt) Path to the ceph configuration file | -
| = |
- (StrOpt) The name of ceph cluster | -
| = |
- (BoolOpt) Flatten volumes created from snapshots to remove dependency from volume to snapshot | -
| = |
- (IntOpt) Maximum number of nested volume clones that are taken before a flatten occurs. Set to 0 to disable cloning. | -
| = |
- (StrOpt) The RADOS pool where rbd volumes are stored | -
| = |
- (StrOpt) The libvirt uuid of the secret for the rbd_user volumes | -
| = |
- (IntOpt) Volumes will be chunked into objects of this size (in megabytes). | -
| = |
- (StrOpt) The RADOS client name for accessing rbd volumes - only set when using cephx authentication | -
| = |
- (StrOpt) Directory where temporary image files are stored when the volume driver does not write them directly to the volume. Warning: this option is now deprecated, please use image_conversion_dir instead. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Base dir containing mount point for gluster share. | -
| = |
- (StrOpt) GlusterFS share in <hostname|ipv4addr|ipv6addr>:<gluster_vol_name> format. Eg: 1.2.3.4:backup_vol | -
| = |
- (StrOpt) Base dir containing mount points for gluster shares. | -
| = |
- (StrOpt) File with the list of available gluster shares | -
| = |
- (StrOpt) Provisioning type that will be used when creating volumes. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS. | -
| = |
- (StrOpt) 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. | -
| = |
- (IntOpt) 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. | -
| = |
- (StrOpt) Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored. | -
| = |
- (BoolOpt) 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. | -
| = |
- (StrOpt) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) The number of attempts to mount nfs shares before raising an error. At least one attempt will be made to mount an nfs share, regardless of the value specified. | -
| = |
- (StrOpt) Mount options passed to the nfs client. See section of the nfs man page for details. | -
| = |
- (StrOpt) Base dir containing mount points for nfs shares. | -
| = |
- (FloatOpt) 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. Note that this option is deprecated in favor of "max_oversubscription_ratio" and will be removed in the Mitaka release. | -
| = |
- (StrOpt) File with the list of available nfs shares | -
| = |
- (BoolOpt) 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. | -
| = |
- (FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. Note that this option is deprecated in favor of "reserved_percentage" and will be removed in the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (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. | -
| = |
- (StrOpt) The StorPool template for volumes with no type. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Allow tenants to specify QOS on create | -
| = |
- (StrOpt) Connection protocol (iSCSI/FC) | -
| = |
- (IntOpt) Maximum number of seconds to wait for FlashCopy to be prepared. | -
| = |
- (BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Enabled) | -
| = |
- (BoolOpt) Allows vdisk to multi host mapping | -
| = |
- (BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova) | -
| = |
- (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. | -
| = |
- (StrOpt) If operating in stretched cluster mode, specify the name of the pool in which mirrored copies are stored.Example: "pool2" | -
| = |
- (BoolOpt) Storage system autoexpand parameter for volumes (True/False) | -
| = |
- (BoolOpt) Storage system compression option for volumes | -
| = |
- (BoolOpt) Enable Easy Tier for volumes | -
| = |
- (IntOpt) Storage system grain size parameter for volumes (32/64/128/256) | -
| = |
- (IntOpt) The I/O group in which to allocate volumes | -
| = |
- (IntOpt) Storage system space-efficiency parameter for volumes (percentage) | -
| = |
- (IntOpt) Storage system threshold for volume capacity warnings (percentage) | -
| = |
- (StrOpt) Storage system storage pool for volumes | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) API version for the storage system | -
| = |
- (StrOpt) The hostname (or IP address) for the storage system | -
| = |
- (StrOpt) Password for the storage system | -
| = |
- (StrOpt) User name for the storage system | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) IP address or hostname of mg-a | -
| = |
- (StrOpt) IP address or hostname of mg-b | -
| = |
- (BoolOpt) Use igroups to manage targets and initiators | -
| = |
- (IntOpt) Global backend request timeout, in seconds. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Number of times VMware ESX/vCenter server API must be retried upon connection related issues. | -
| = |
- (StrOpt) CA bundle file to use in verifying the vCenter server certificate. | -
| = |
- (MultiStrOpt) Name of a vCenter compute cluster where volumes should be created. | -
| = |
- (StrOpt) IP address for connecting to VMware ESX/vCenter server. | -
| = |
- (StrOpt) Password for authenticating with VMware ESX/vCenter server. | -
| = |
- (StrOpt) Username for authenticating with VMware ESX/vCenter server. | -
| = |
- (StrOpt) Optional string specifying the VMware vCenter server version. The driver attempts to retrieve the version from VMware vCenter server. Set this configuration only if you want to override the vCenter server version. | -
| = |
- (IntOpt) Timeout in seconds for VMDK volume transfer between Cinder and Glance. | -
| = |
- (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. | -
| = |
- (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. | -
| = |
- (FloatOpt) The interval (in seconds) for polling remote tasks invoked on VMware ESX/vCenter server. | -
| = |
- (StrOpt) Directory where virtual disks are stored during volume backup and restore. | -
| = |
- (StrOpt) Name of the vCenter inventory folder that will contain Cinder volumes. This folder will be created under "OpenStack/<project_folder>", where project_folder is of format "Project (<volume_project_id>)". | -
| = |
- (StrOpt) Optional VIM service WSDL Location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (ListOpt) Mount options passed to the vzstorage client. See section of the pstorage-mount man page for details. | -
| = |
- (StrOpt) Base dir containing mount points for vzstorage shares. | -
| = |
- (StrOpt) File with the list of available vzstorage shares. | -
| = |
- (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. | -
| = |
- (FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Path to store VHD backed volumes | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Tell driver to use SSL for connection to backend storage if the driver supports it. | -
| = |
- (IntOpt) Number on retries to get completion status after issuing a command to ISE. | -
| = |
- (IntOpt) Number of retries (per port) when establishing connection to ISE management port. | -
| = |
- (IntOpt) Raid level for ISE volumes. | -
| = |
- (IntOpt) Interval (secs) between retries. | -
| = |
- (IntOpt) Default storage pool for volumes. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Cluster name to use for creating volumes | -
| = |
- (StrOpt) IP address of SAN controller | -
| = |
- (StrOpt) Username for SAN controller | -
| = |
- (StrOpt) Password for SAN controller | -
| = |
- (StrOpt) CHAP authentication mode, effective only for iscsi (disabled|enabled) | -
| = |
- (StrOpt) Connection type to the IBM Storage Array | -
| = |
- (StrOpt) Proxy driver that connects to the IBM Storage Array | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| = |
- (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| = |
- (StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| = |
- (IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| = |
- (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. | -
| = |
- (StrOpt) Directory for holding IPC sockets. | -
| = |
- (StrOpt) MatchMaker driver. | -
| = |
- (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| = |
- (BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) iSCSI initiator IQNs. (comma separated) | -
| = |
- (StrOpt) iSCSI initiators configuration. | -
| = |
- (StrOpt) iSCSI initiator group. | -
| = |
- (StrOpt) Secret of the iSCSI initiator CHAP user. | -
| = |
- (StrOpt) iSCSI initiator CHAP user (name). | -
| = |
- (StrOpt) Data compression. | -
| = |
- (StrOpt) Synchronous write bias. | -
| = |
- (BoolOpt) Flag to enable sparse (thin-provisioned): True, False. | -
| = |
- (StrOpt) Block size. | -
| = |
- (StrOpt) Storage pool name. | -
| = |
- (StrOpt) Project name. | -
| = |
- (StrOpt) IP address used for replication data. (maybe the same as data ip) | -
| = |
- (IntOpt) REST connection timeout. (seconds) | -
| = |
- (StrOpt) iSCSI target group name. | -
| = |
- (StrOpt) Network interfaces of iSCSI targets. (comma separated) | -
| = |
- (StrOpt) Secret of the iSCSI target CHAP user. | -
| = |
- (StrOpt) iSCSI target portal (Data-IP:Port, w.x.y.z:3260). | -
| = |
- (StrOpt) iSCSI target CHAP user (name). | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Name of directory inside zfssa_nfs_share where cache volumes are stored. | -
| = |
- (StrOpt) Name of ZFSSA project where cache volumes are stored. | -
| = |
- (StrOpt) Data path IP address | -
| = |
- (BoolOpt) Flag to enable local caching: True, False. | -
| = |
- (StrOpt) HTTPS port number | -
| = |
- (StrOpt) Options to be passed while mounting share over nfs | -
| = |
- (StrOpt) Storage pool name. | -
| = |
- (StrOpt) Project name. | -
| = |
- (StrOpt) Share name. | -
| = |
- (StrOpt) Data compression. | -
| = |
- (StrOpt) Synchronous write bias-latency, throughput. | -
| = |
- (IntOpt) REST connection timeout. (seconds) | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) REST connection timeout. (seconds) | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Ensure that the new volumes are the same AZ as snapshot or source volume | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) FC Zoning mode configured | -
| [fc-zone-manager] | -|
| = |
- (StrOpt) 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 | -
| = |
- (StrOpt) FC SAN Lookup Service | -
| = |
- (StrOpt) FC Zone Driver responsible for zone management | -
| = |
- (StrOpt) Zoning policy configured by user; valid values include "initiator-target" or "initiator" | -
| Configuration option = Default value | -Description | -
|---|---|
| [BRCD_FABRIC_EXAMPLE] | -|
| = |
- (StrOpt) Management IP of fabric | -
| = |
- (StrOpt) Password for user | -
| = |
- (IntOpt) Connecting port | -
| = |
- (StrOpt) Fabric user ID | -
| = |
- (StrOpt) Principal switch WWN of the fabric | -
| = |
- (BoolOpt) overridden zoning activation state | -
| = |
- (StrOpt) overridden zone name prefix | -
| = |
- (StrOpt) overridden zoning policy | -
| Configuration option = Default value | -Description | -
|---|---|
| [CISCO_FABRIC_EXAMPLE] | -|
| = |
- (StrOpt) Management IP of fabric | -
| = |
- (StrOpt) Password for user | -
| = |
- (IntOpt) Connecting port | -
| = |
- (StrOpt) Fabric user ID | -
| = |
- (BoolOpt) overridden zoning activation state | -
| = |
- (StrOpt) overridden zone name prefix | -
| = |
- (StrOpt) overridden zoning policy | -
| = |
- (StrOpt) VSAN of the Fabric | -
| Configuration option = Default value | -Description | -
|---|---|
| [fc-zone-manager] | -|
| = |
- (StrOpt) Southbound connector for zoning operation | -
| Configuration option = Default value | -Description | -
|---|---|
| [fc-zone-manager] | -|
| = |
- (StrOpt) Southbound connector for zoning operation | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| = |
- (StrOpt) Default publisher_id for outgoing notifications. | -
| = |
- (ListOpt) List of disabled notifications. A notification can be given either as a notification type to disable a single event, or as a notification group prefix to disable all events within a group. Example: if this config option is set to ["image.create", "metadef_namespace"], then "image.create" notification will not be sent after image is created and none of the notifications for metadefinition namespaces will be sent. | -
| = |
- (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop | -
| = |
- (ListOpt) AMQP topic used for OpenStack notifications. | -
| = |
- (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Role used to identify an authenticated user as administrator. | -
| = |
- (BoolOpt) Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware. | -
| = |
- (ListOpt) A list of artifacts that are allowed in the format name or name-version. Empty list means that any artifact can be loaded. | -
| = |
- (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. | -
| = |
- (BoolOpt) Deploy the v1 OpenStack Images API. | -
| = |
- (BoolOpt) Deploy the v1 OpenStack Registry API. | -
| = |
- (BoolOpt) Deploy the v2 OpenStack Images API. | -
| = |
- (BoolOpt) Deploy the v2 OpenStack Registry API. | -
| = |
- (BoolOpt) Deploy the v3 OpenStack Objects API. | -
| = |
- (BoolOpt) If False, server will return the header "Connection: close", If True, server will return "Connection: Keep-Alive" in its responses. In order to close the client socket connection explicitly after the response is sent and read successfully by the client, you simply have to set this option to False when you create a wsgi server. | -
| = |
- (IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).WARNING: this value should only be increased after careful consideration and must be set to a value under 8 EB (9223372036854775808). | -
| = |
- (BoolOpt) When false, no artifacts can be loaded regardless of available_plugins. When true, artifacts can be loaded. | -
| = |
- (StrOpt) This value sets what strategy will be used to determine the image location order. Currently two strategies are packaged with Glance 'location_order' and 'store_type'. | -
| = |
- (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 | -
| = |
- (IntOpt) Limits request ID length. | -
| = |
- (BoolOpt) When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request. | -
| = |
- (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 Glance is operating behind a proxy, you will want to change this to represent the proxy's URL. | -
| = |
- (BoolOpt) Whether to pass through headers containing user and tenant information when making requests to the registry. This allows the registry to use the context middleware without keystonemiddleware's auth_token middleware, removing calls to the keystone auth service. It is recommended that when using this option, secure communication between glance api and glance registry is ensured by means other than auth_token middleware. | -
| = |
- (BoolOpt) Whether to include the backend image locations in image properties. For example, if using the file system store a URL of "file:///path/to/image" will be returned to the user in the 'direct_url' meta-data field. Revealing storage location can be a security risk, so use this setting with caution! The overrides show_image_direct_url. | -
| = |
- (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. | -
| = |
- (BoolOpt) Whether to pass through the user token when making requests to the registry. To prevent failures with token expiration during big files upload, it is recommended to set this parameter to False.If "use_user_token" is not in effect, then admin credentials can be specified. | -
| [glance_store] | -|
| = |
- (StrOpt) Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the 'stores' config option. | -
| = |
- (IntOpt) Minimum interval seconds to execute updating dynamic storage capabilities based on backend status then. It's not a periodic routine, the update logic will be executed only when interval seconds elapsed and an operation of store has triggered. The feature will be enabled only when the option value greater then zero. | -
| = |
- (ListOpt) List of stores enabled | -
| [oslo_middleware] | -|
| = |
- (IntOpt) The maximum body size for each request, in bytes. | -
| = |
- (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. | -
| [paste_deploy] | -|
| = |
- (StrOpt) Name of the paste configuration file. | -
| = |
- (StrOpt) Partial name of a pipeline in your paste configuration file with the service name removed. For example, if your paste section name is [pipeline:glance-api-keystone] use the value "keystone" | -
| [store_type_location_strategy] | -|
| = |
- (ListOpt) The store names to use to get store preference order. The name must be registered by one of the stores defined by the 'stores' config option. This option will be applied when you using 'store_type' option as image location strategy defined by the 'location_strategy' config option. | -
| Configuration option = Default value | -Description | -
|---|---|
| [keystone_authtoken] | -|
| = |
- (StrOpt) Service user password. | -
| = |
- (StrOpt) Service tenant name. | -
| = |
- (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | -
| = |
- (StrOpt) Service username. | -
| = |
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Name of the plugin to load | -
| = |
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | -
| = |
- (StrOpt) Config Section from which to load plugin specific options | -
| = |
- (StrOpt) Complete public Identity API endpoint. | -
| = |
- (StrOpt) API version of the admin Identity API endpoint. | -
| = |
- (StrOpt) Env key for the swift cache. | -
| = |
- (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. | -
| = |
- (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. | -
| = |
- (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| = |
- (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | -
| = |
- (IntOpt) Request timeout value for communicating with Identity API server. | -
| = |
- (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| = |
- (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | -
| = |
- (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. | -
| = |
- (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. | -
| = |
- (IntOpt) (Optional) Maximum total number of open connections to every memcached server. | -
| = |
- (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. | -
| = |
- (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. | -
| = |
- (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. | -
| = |
- (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. | -
| = |
- (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. | -
| = |
- (StrOpt) The region in which the identity server can be found. | -
| = |
- (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| = |
- (StrOpt) Directory used to cache files related to PKI tokens. | -
| = |
- (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) CA certificate file to use to verify connecting clients. | -
| = |
- (StrOpt) Certificate file to use when starting API server securely. | -
| = |
- (StrOpt) Private key file to use when starting API server securely. | -
| Configuration option = Default value | -Description | -
|---|---|
| [glance_store] | -|
| = |
- (BoolOpt) Allow to perform insecure SSL requests to cinder | -
| = |
- (StrOpt) Location of ca certicates file to use for cinder client requests. | -
| = |
- (StrOpt) Info to match when looking for cinder in the service catalog. Format is : separated values of the form: <service_type>:<service_name>:<endpoint_type> | -
| = |
- (StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s | -
| = |
- (IntOpt) Number of cinderclient retries on failed http calls | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Whether to allow users to specify image properties beyond what the image schema provides | -
| = |
- (IntOpt) Maximum permissible number of items that could be returned by a request | -
| = |
- (IntOpt) The backlog value that will be used when creating the TCP listener socket. | -
| = |
- (StrOpt) Address to bind the server. Useful when selecting a particular network interface. | -
| = |
- (IntOpt) The port on which the server will listen. | -
| = |
- (StrOpt) Python module path of data access API | -
| = |
- (StrOpt) Digest algorithm which will be used for digital signature. Use the command "openssl list-message-digest-algorithms" to get the available algorithmssupported by the version of OpenSSL on the platform. Examples are "sha1", "sha256", "sha512", etc. | -
| = |
- (IntOpt) Size of executor thread pool. | -
| = |
- (IntOpt) Maximum number of locations allowed on an image. Negative values evaluate to unlimited. | -
| = |
- (IntOpt) Maximum number of image members per image. Negative values evaluate to unlimited. | -
| = |
- (IntOpt) Maximum number of properties allowed on an image. Negative values evaluate to unlimited. | -
| = |
- (IntOpt) Maximum number of tags allowed on an image. Negative values evaluate to unlimited. | -
| = |
- (IntOpt) Default value for the number of items returned by a request if not specified explicitly in the request | -
| = |
- (ListOpt) Memcached servers or None for in process cache. | -
| = |
- (StrOpt) AES key for encrypting store 'location' metadata. This includes, if used, Swift or S3 credentials. Should be set to a random string of length 16, 24 or 32 bytes | -
| = |
- (StrOpt) Path to the directory where json metadata files are stored | -
| = |
- (StrOpt) The location of the property protection file.This file contains the rules for property protections and the roles/policies associated with it. If this config value is not specified, by default, property protections won't be enforced. If a value is specified and the file is not found, then the glance-api service will not start. | -
| = |
- (StrOpt) This config value indicates whether "roles" or "policies" are used in the property protection file. | -
| = |
- (BoolOpt) Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution! | -
| = |
- (StrOpt) Set a system wide quota for every user. This value is the total capacity that a user can use across all storage systems. A value of 0 means unlimited.Optional unit can be specified for the value. Accepted units are B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytes respectively. If no unit is specified then Bytes is assumed. Note that there should not be any space between value and unit and units are case sensitive. | -
| = |
- (IntOpt) The number of child process workers that will be created to service requests. The default will be equal to the number of CPUs available. | -
| [glance_store] | -|
| = |
- (StrOpt) Region name of this node | -
| [image_format] | -|
| = |
- (ListOpt) Supported values for the 'container_format' image attribute | -
| = |
- (ListOpt) Supported values for the 'disk_format' image attribute | -
| [keystone_authtoken] | -|
| = |
- (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| [task] | -|
| = |
- (StrOpt) Specifies which task executor to be used to run the task scripts. | -
| = |
- (IntOpt) Time in hours for which a task lives after, either succeeding or failing | -
| = |
- (StrOpt) Work dir for asynchronous task operations. The directory set here will be used to operate over images - normally before they are imported in the destination store. When providing work dir, make sure enough space is provided for concurrent tasks to run efficiently without running out of space. A rough estimation can be done by multiplying the number of `max_workers` - or the N of workers running - by an average image size (e.g 500MB). The image size estimation should be done based on the average size in your deployment. Note that depending on the tasks running you may need to multiply this number by some factor depending on what the task does. For example, you may want to double the available size if image conversion is enabled. All this being said, remember these are just estimations and you should do them based on the worst case scenario and be prepared to act in case they were wrong. | -
| Configuration option = Default value | -Description | -
|---|---|
| [cors] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| [database] | -|
| = |
- (StrOpt) The back end to use for the database. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the database. | -
| = |
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. | -
| = |
- (BoolOpt) Add Python stack traces to SQL as comment strings. | -
| = |
- (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. | -
| = |
- (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. | -
| = |
- (IntOpt) Seconds between retries of a database transaction. | -
| = |
- (IntOpt) Timeout before idle SQL connections are reaped. | -
| = |
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy. | -
| = |
- (IntOpt) Maximum number of SQL connections to keep open in a pool. | -
| = |
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) Minimum number of SQL connections to keep open in a pool. | -
| = |
- (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | -
| = |
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. | -
| = |
- (IntOpt) Interval between retries of opening a SQL connection. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. | -
| = |
- (StrOpt) The file name to use with SQLite. | -
| = |
- (BoolOpt) If True, SQLite uses synchronous mode. | -
| = |
- (BoolOpt) Enable the experimental use of database reconnect on connection lost. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (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. | -
| Configuration option = Default value | -Description | -
|---|---|
| [elasticsearch] | -|
| = |
- (ListOpt) List of nodes where Elasticsearch instances are running. A single node should be defined as an IP address and port number. | -
| Configuration option = Default value | -Description | -
|---|---|
| [glance_store] | -|
| = |
- (StrOpt) Directory to which the Filesystem backend store writes images. | -
| = |
- (MultiStrOpt) List of directories and its priorities to which the Filesystem backend store writes images. | -
| = |
- (IntOpt) The required permission for created image file. In this way the user other service used, e.g. Nova, who consumes the image could be the exclusive member of the group that owns the files created. Assigning it less then or equal to zero means don't change the default permission of the file. This value will be decoded as an octal digit. | -
| = |
- (StrOpt) The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON object. The object should contain the keys 'id' and 'mountpoint'. The value for both keys should be 'string'. | -
| Configuration option = Default value | -Description | -
|---|---|
| [glance_store] | -|
| = |
- (StrOpt) Database to use | -
| = |
- (StrOpt) Hostname or IP address of the instance to connect to, or a mongodb URI, or a list of hostnames / mongodb URIs. If host is an IPv6 literal it must be enclosed in '[' and ']' characters following the RFC2732 URL syntax (e.g. '[::1]' for localhost) | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Turn on/off delayed delete. | -
| = |
- (StrOpt) Base directory that the Image Cache uses. | -
| = |
- (StrOpt) The driver to use for image cache management. | -
| = |
- (IntOpt) The upper limit (the maximum size of accumulated cache in bytes) beyond which pruner, if running, starts cleaning the images cache. | -
| = |
- (StrOpt) The path to the sqlite file database that will be used for image cache management. | -
| = |
- (IntOpt) The amount of time to let an image remain in the cache without being accessed. | -
| = |
- (IntOpt) The size of thread pool to be used for scrubbing images. The default is one, which signifies serial scrubbing. Any value above one indicates the max number of images that may be scrubbed in parallel. | -
| = |
- (IntOpt) The amount of time in seconds to delay before performing a delete. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). | -
| = |
- (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Enables or disables fatal status of deprecations. | -
| = |
- (StrOpt) The format for an instance that is passed with the log message. | -
| = |
- (StrOpt) The format for an instance UUID that is passed with the log message. | -
| = |
- (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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). | -
| = |
- (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. | -
| = |
- (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. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) Format string to use for log messages with context. | -
| = |
- (StrOpt) Data to append to log format when level is DEBUG. | -
| = |
- (StrOpt) Format string to use for log messages without context. | -
| = |
- (StrOpt) Prefix each line of exception output with this format. | -
| = |
- (BoolOpt) Enables or disables publication of error events. | -
| = |
- (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. | -
| = |
- (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 Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. | -
| = |
- (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_policy] | -|
| = |
- (StrOpt) Default rule. Enforced when a requested rule is not found. | -
| = |
- (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. | -
| = |
- (StrOpt) The JSON file that defines policies. | -
| Configuration option = Default value | -Description | -
|---|---|
| [profiler] | -|
| = |
- (BoolOpt) If False fully disable profiling feature. | -
| = |
- (BoolOpt) If False doesn't trace SQL requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_qpid] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (IntOpt) Seconds between connection keepalive heartbeats. | -
| = |
- (StrOpt) Qpid broker hostname. | -
| = |
- (ListOpt) Qpid HA cluster host:port pairs. | -
| = |
- (StrOpt) Password for Qpid connection. | -
| = |
- (IntOpt) Qpid broker port. | -
| = |
- (StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| = |
- (IntOpt) The number of prefetched messages held by receiver. | -
| = |
- (StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| = |
- (BoolOpt) Whether to disable the Nagle algorithm. | -
| = |
- (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. | -
| = |
- (StrOpt) Username for Qpid connection. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_rabbit] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake | -
| = |
- (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. | -
| = |
- (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL | -
| = |
- (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| = |
- (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). | -
| = |
- (StrOpt) SSL cert file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL key file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. | -
| = |
- (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| = |
- (StrOpt) The RabbitMQ broker address where a single node is used. | -
| = |
- (ListOpt) RabbitMQ HA cluster host:port pairs. | -
| = |
- (StrOpt) The RabbitMQ login method. | -
| = |
- (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| = |
- (StrOpt) The RabbitMQ password. | -
| = |
- (IntOpt) The RabbitMQ broker port where a single node is used. | -
| = |
- (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| = |
- (IntOpt) How frequently to retry connecting with RabbitMQ. | -
| = |
- (BoolOpt) Connect over SSL for RabbitMQ. | -
| = |
- (StrOpt) The RabbitMQ userid. | -
| = |
- (StrOpt) The RabbitMQ virtual host. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [glance_store] | -|
| = |
- (IntOpt) Timeout value (in seconds) used when connecting to ceph cluster. If value <= 0, no timeout is set and default librados value is used. | -
| = |
- (StrOpt) Ceph configuration file path. If <None>, librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client.<USER> section | -
| = |
- (IntOpt) RADOS images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two. | -
| = |
- (StrOpt) RADOS pool in which images are stored. | -
| = |
- (StrOpt) RADOS user to authenticate as (only applicable if using Cephx. If <None>, a default will be chosen based on the client. section in rbd_store_ceph_conf) | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Host to locate redis. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| [matchmaker_redis] | -|
| = |
- (StrOpt) Host to locate redis. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The administrators password. If "use_user_token" is not in effect, then admin credentials can be specified. | -
| = |
- (StrOpt) The tenant name of the administrative user. If "use_user_token" is not in effect, then admin tenant name can be specified. | -
| = |
- (StrOpt) The administrators user name. If "use_user_token" is not in effect, then admin credentials can be specified. | -
| = |
- (StrOpt) The region for the authentication service. If "use_user_token" is not in effect and using keystone auth, then region name can be specified. | -
| = |
- (StrOpt) The strategy to use for authentication. If "use_user_token" is not in effect, then auth strategy can be specified. | -
| = |
- (StrOpt) The URL to the keystone service. If "use_user_token" is not in effect and using keystone auth, then URL of keystone can be specified. | -
| = |
- (StrOpt) The path to the certifying authority cert file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_CA_FILE environment variable to a filepath of the CA cert file. | -
| = |
- (StrOpt) The path to the cert file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_CERT_FILE environment variable to a filepath of the CA cert file | -
| = |
- (BoolOpt) When using SSL in connections to the registry server, do not require validation via a certifying authority. This is the registry's equivalent of specifying --insecure on the command line using glanceclient for the API. | -
| = |
- (StrOpt) The path to the key file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_KEY_FILE environment variable to a filepath of the key file | -
| = |
- (StrOpt) The protocol to use for communication with the registry server. Either http or https. | -
| = |
- (IntOpt) The period of time, in seconds, that the API server will wait for a registry request to complete. A value of 0 implies no timeout. | -
| = |
- (StrOpt) Address to find the registry server. | -
| = |
- (IntOpt) Port the registry server is listening on. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (ListOpt) Arguments for the command | -
| = |
- (IntOpt) Amount of data to transfer per HTTP write. | -
| = |
- (StrOpt) Command to be given to replicator | -
| = |
- (StrOpt) List of fields to not replicate. | -
| = |
- (StrOpt) Pass in your authentication token if you have one. This is the token used for the master. | -
| = |
- (BoolOpt) Only replicate metadata, not images. | -
| = |
- (StrOpt) Pass in your authentication token if you have one. This is the token used for the slave. | -
| = |
- (StrOpt) Pass in your authentication token if you have one. If you use this option the same token is used for both the master and the slave. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call. | -
| = |
- (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| = |
- (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| = |
- (IntOpt) Size of RPC connection pool. | -
| = |
- (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| = |
- (IntOpt) Seconds to wait for a response from a call. | -
| [oslo_concurrency] | -|
| = |
- (BoolOpt) Enables or disables inter-process locks. | -
| = |
- (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. | -
| [oslo_messaging_amqp] | -|
| = |
- (BoolOpt) Accept clients using either SSL or plain TCP | -
| = |
- (StrOpt) address prefix used when broadcasting to all servers | -
| = |
- (StrOpt) Name for the AMQP container | -
| = |
- (StrOpt) address prefix when sending to any server in group | -
| = |
- (IntOpt) Timeout for inactive connections (in seconds) | -
| = |
- (StrOpt) Password for message broker authentication | -
| = |
- (StrOpt) Path to directory that contains the SASL configuration | -
| = |
- (StrOpt) Name of configuration file (without .conf suffix) | -
| = |
- (StrOpt) Space separated list of acceptable SASL mechanisms | -
| = |
- (StrOpt) address prefix used when sending to a specific server | -
| = |
- (StrOpt) CA certificate PEM file to verify server certificate | -
| = |
- (StrOpt) Identifying certificate PEM file to present to clients | -
| = |
- (StrOpt) Private key PEM file used to sign cert_file certificate | -
| = |
- (StrOpt) Password for decrypting ssl_key_file (if encrypted) | -
| = |
- (BoolOpt) Debug: dump AMQP frames to stdout | -
| = |
- (StrOpt) User name for message broker authentication | -
| Configuration option = Default value | -Description | -
|---|---|
| [glance_store] | -|
| = |
- (StrOpt) The S3 query token access key. | -
| = |
- (StrOpt) The S3 bucket to be used to store the Glance data. | -
| = |
- (StrOpt) The S3 calling format used to determine the bucket. Either subdomain or path can be used. | -
| = |
- (BoolOpt) A boolean to determine if the S3 bucket should be created on upload if it does not exist or if an error should be returned to the user. | -
| = |
- (BoolOpt) Enable the use of a proxy. | -
| = |
- (StrOpt) The host where the S3 server is listening. | -
| = |
- (IntOpt) What multipart upload part size, in MB, should S3 use when uploading parts. The size must be greater than or equal to 5M. | -
| = |
- (IntOpt) What size, in MB, should S3 start chunking image files and do a multipart upload in S3. | -
| = |
- (StrOpt) The local directory where uploads will be staged before they are transferred into S3. | -
| = |
- (StrOpt) Address or hostname for the proxy server. | -
| = |
- (StrOpt) The password to use when connecting over a proxy. | -
| = |
- (IntOpt) The port to use when connecting over a proxy. | -
| = |
- (StrOpt) The username to connect to the proxy. | -
| = |
- (StrOpt) The S3 query token secret key. | -
| = |
- (IntOpt) The number of thread pools to perform a multipart upload in S3. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Loop time between checking for new items to schedule for delete. | -
| Configuration option = Default value | -Description | -
|---|---|
| [glance_store] | -|
| = |
- (StrOpt) IP address of sheep daemon. | -
| = |
- (IntOpt) Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two. | -
| = |
- (IntOpt) Port of sheep daemon. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The reference to the default swift account/backing store parameters to use for adding new images. | -
| = |
- (StrOpt) The address where the Swift authentication service is listening.(deprecated) | -
| = |
- (StrOpt) The config file that has the swift account(s)configs. | -
| = |
- (StrOpt) Auth key for the user authenticating against the Swift authentication service. (deprecated) | -
| = |
- (StrOpt) The user to authenticate against the Swift authentication service (deprecated) | -
| Configuration option = Default value | -Description | -
|---|---|
| [taskflow_executor] | -|
| = |
- (StrOpt) The format to which images will be automatically converted. | -
| = |
- (StrOpt) The mode in which the engine will run. Can be 'serial' or 'parallel'. | -
| = |
- (IntOpt) The number of parallel activities executed at the same time by the engine. The value can be greater than one when the engine mode is 'parallel'. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The hostname/IP of the pydev process listening for debug connections | -
| = |
- (IntOpt) The port on which a pydev process is listening for connections. | -
| Configuration option = Default value | -Description | -
|---|---|
| [glance_store] | -|
| = |
- (BoolOpt) Allow to perform insecure SSL requests to ESX/VC. | -
| = |
- (IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues. | -
| = |
- (StrOpt) DEPRECATED. Inventory path to a datacenter. If the vmware_server_host specified is an ESX/ESXi, the vmware_datacenter_path is optional. If specified, it should be "ha-datacenter". This option is deprecated in favor of vmware_datastores and will be removed in the Liberty release. | -
| = |
- (StrOpt) DEPRECATED. Datastore associated with the datacenter. This option is deprecated in favor of vmware_datastores and will be removed in the Liberty release. | -
| = |
- (MultiStrOpt) A list of datastores where the image can be stored. This option may be specified multiple times for specifying multiple datastores. Either one of vmware_datastore_name or vmware_datastores is required. The datastore name should be specified after its datacenter path, seperated by ":". An optional weight may be given after the datastore name, seperated again by ":". Thus, the required format becomes <datacenter_path>:<datastore_name>:<optional_weight>. When adding an image, the datastore with highest weight will be selected, unless there is not enough free space available in cases where the image size is already known. If no weight is given, it is assumed to be zero and the directory will be considered for selection last. If multiple datastores have the same weight, then the one with the most free space available is selected. | -
| = |
- (StrOpt) ESX/ESXi or vCenter Server target system. The server value can be an IP address or a DNS name. | -
| = |
- (StrOpt) Password for authenticating with VMware ESX/VC server. | -
| = |
- (StrOpt) Username for authenticating with VMware ESX/VC server. | -
| = |
- (StrOpt) The name of the directory where the glance images will be stored in the VMware datastore. | -
| = |
- (IntOpt) The interval used for polling remote tasks invoked on VMware ESX/VC server. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| = |
- (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| = |
- (StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| = |
- (IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| = |
- (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. | -
| = |
- (StrOpt) Directory for holding IPC sockets. | -
| = |
- (StrOpt) MatchMaker driver. | -
| = |
- (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| = |
- (BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| = |
- (StrOpt) Default notification level for outgoing notifications. | -
| = |
- (StrOpt) Default publisher_id for outgoing notifications. | -
| = |
- (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop | -
| = |
- (ListOpt) AMQP topic used for OpenStack notifications. | -
| = |
- (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Number of times to retry to bring a resource to a non-error state. Set to 0 to disable retries. | -
| = |
- (BoolOpt) Enable the preview Stack Abandon feature. | -
| = |
- (BoolOpt) Enable the preview Stack Adopt feature. | -
| = |
- (BoolOpt) Encrypt template parameters that were marked as hidden and also all the resource properties before storing them in database. | -
| = |
- (StrOpt) URL of the Heat metadata server. | -
| = |
- (StrOpt) Keystone role for heat template-defined users. | -
| = |
- (StrOpt) URL of the Heat waitcondition server. | -
| = |
- (StrOpt) URL of the Heat CloudWatch server. | -
| = |
- (ListOpt) Stacks containing these tag names will be hidden. Multiple tags should be given in a comma-delimited list (eg. hidden_stack_tags=hide_me,me_too). | -
| = |
- (IntOpt) Maximum raw byte size of JSON request body. Should be larger than max_template_size. | -
| = |
- (IntOpt) Number of heat-engine processes to fork and run. | -
| = |
- (StrOpt) The HTTP Header that will be used to determine which the original request protocol scheme was, even if it was removed by an SSL terminator proxy. | -
| = |
- (IntOpt) Timeout in seconds for stack action (ie. create or update). | -
| = |
- (StrOpt) Keystone username, a user with roles sufficient to manage users and projects in the stack_user_domain. | -
| = |
- (StrOpt) Keystone password for stack_domain_admin user. | -
| = |
- (BoolOpt) When this feature is enabled, scheduler hints identifying the heat stack context of a server or volume resource are passed to the configured schedulers in nova and cinder, for creates done using heat resource types OS::Cinder::Volume, OS::Nova::Server, and AWS::EC2::Instance. heat_root_stack_id will be set to the id of the root stack of the resource, heat_stack_id will be set to the id of the resource's parent stack, heat_stack_name will be set to the name of the resource's parent stack, heat_path_in_stack will be set to a list of tuples, (stackresourcename, stackname) with list[0] being (None, rootstackname), heat_resource_name will be set to the resource's name, and heat_resource_uuid will be set to the resource's orchestration id. | -
| = |
- (StrOpt) Keystone domain ID which contains heat template-defined users. If this option is set, stack_user_domain_name option will be ignored. | -
| = |
- (StrOpt) Keystone domain name which contains heat template-defined users. If `stack_user_domain_id` option is set, this option is ignored. | -
| = |
- (ListOpt) Subset of trustor roles to be delegated to heat. If left unset, all roles of a user will be delegated to heat when creating a stack. | -
| [auth_password] | -|
| = |
- (ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. | -
| = |
- (BoolOpt) Allow orchestration of multiple clouds. | -
| [ec2authtoken] | -|
| = |
- (ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. | -
| = |
- (StrOpt) Authentication Endpoint URI. | -
| = |
- (StrOpt) Optional CA cert file to use in SSL connections. | -
| = |
- (StrOpt) Optional PEM-formatted certificate chain file. | -
| = |
- (BoolOpt) If set, then the server's certificate will not be verified. | -
| = |
- (StrOpt) Optional PEM-formatted file that contains the private key. | -
| = |
- (BoolOpt) Allow orchestration of multiple clouds. | -
| [eventlet_opts] | -|
| = |
- (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. | -
| = |
- (BoolOpt) If False, closes the client socket connection explicitly. | -
| [heat_api] | -|
| = |
- (IntOpt) Number of backlog requests to configure the socket with. | -
| = |
- (StrOpt) Address to bind the server. Useful when selecting a particular network interface. | -
| = |
- (IntOpt) The port on which the server will listen. | -
| = |
- (StrOpt) Location of the SSL certificate file to use for SSL mode. | -
| = |
- (StrOpt) Location of the SSL key file to use for enabling SSL mode. | -
| = |
- (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). | -
| = |
- (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. | -
| = |
- (IntOpt) Number of workers for Heat service. | -
| [oslo_middleware] | -|
| = |
- (IntOpt) The maximum body size for each request, in bytes. | -
| = |
- (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] | -|
| = |
- (StrOpt) Default rule. Enforced when a requested rule is not found. | -
| = |
- (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. | -
| = |
- (StrOpt) The JSON file that defines policies. | -
| [oslo_versionedobjects] | -|
| = |
- (BoolOpt) Make exception message format errors fatal | -
| [paste_deploy] | -|
| = |
- (StrOpt) The API paste config file to use. | -
| = |
- (StrOpt) The flavor to use. | -
| Configuration option = Default value | -Description | -
|---|---|
| [keystone_authtoken] | -|
| = |
- (StrOpt) Service user password. | -
| = |
- (StrOpt) Service tenant name. | -
| = |
- (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | -
| = |
- (StrOpt) Service username. | -
| = |
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Name of the plugin to load | -
| = |
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | -
| = |
- (StrOpt) Config Section from which to load plugin specific options | -
| = |
- (StrOpt) Complete public Identity API endpoint. | -
| = |
- (StrOpt) API version of the admin Identity API endpoint. | -
| = |
- (StrOpt) Env key for the swift cache. | -
| = |
- (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. | -
| = |
- (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. | -
| = |
- (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| = |
- (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | -
| = |
- (IntOpt) Request timeout value for communicating with Identity API server. | -
| = |
- (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| = |
- (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | -
| = |
- (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. | -
| = |
- (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. | -
| = |
- (IntOpt) (Optional) Maximum total number of open connections to every memcached server. | -
| = |
- (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. | -
| = |
- (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. | -
| = |
- (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. | -
| = |
- (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. | -
| = |
- (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. | -
| = |
- (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| = |
- (StrOpt) The region in which the identity server can be found. | -
| = |
- (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| = |
- (StrOpt) Directory used to cache files related to PKI tokens. | -
| = |
- (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Instance connection to CFN/CW API validate certs if SSL is used. | -
| = |
- (StrOpt) Instance connection to CFN/CW API via https. | -
| [heat_api_cfn] | -|
| = |
- (IntOpt) Number of backlog requests to configure the socket with. | -
| = |
- (StrOpt) Address to bind the server. Useful when selecting a particular network interface. | -
| = |
- (IntOpt) The port on which the server will listen. | -
| = |
- (StrOpt) Location of the SSL certificate file to use for SSL mode. | -
| = |
- (StrOpt) Location of the SSL key file to use for enabling SSL mode. | -
| = |
- (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). | -
| = |
- (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. | -
| = |
- (IntOpt) Number of workers for Heat service. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Default region name used to get services endpoints. | -
| [clients] | -|
| = |
- (StrOpt) Optional CA cert file to use in SSL connections. | -
| = |
- (StrOpt) Optional PEM-formatted certificate chain file. | -
| = |
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| = |
- (BoolOpt) If set, then the server's certificate will not be verified. | -
| = |
- (StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Fully qualified class name to use as a client backend. | -
| Configuration option = Default value | -Description | -
|---|---|
| [clients_ceilometer] | -|
| = |
- (StrOpt) Optional CA cert file to use in SSL connections. | -
| = |
- (StrOpt) Optional PEM-formatted certificate chain file. | -
| = |
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| = |
- (BoolOpt) If set, then the server's certificate will not be verified. | -
| = |
- (StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | -Description | -
|---|---|
| [clients_cinder] | -|
| = |
- (StrOpt) Optional CA cert file to use in SSL connections. | -
| = |
- (StrOpt) Optional PEM-formatted certificate chain file. | -
| = |
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| = |
- (BoolOpt) Allow client's debug log output. | -
| = |
- (BoolOpt) If set, then the server's certificate will not be verified. | -
| = |
- (StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | -Description | -
|---|---|
| [clients_glance] | -|
| = |
- (StrOpt) Optional CA cert file to use in SSL connections. | -
| = |
- (StrOpt) Optional PEM-formatted certificate chain file. | -
| = |
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| = |
- (BoolOpt) If set, then the server's certificate will not be verified. | -
| = |
- (StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | -Description | -
|---|---|
| [clients_heat] | -|
| = |
- (StrOpt) Optional CA cert file to use in SSL connections. | -
| = |
- (StrOpt) Optional PEM-formatted certificate chain file. | -
| = |
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| = |
- (BoolOpt) If set, then the server's certificate will not be verified. | -
| = |
- (StrOpt) Optional PEM-formatted file that contains the private key. | -
| = |
- (StrOpt) Optional heat url in format like http://0.0.0.0:8004/v1/%(tenant_id)s. | -
| Configuration option = Default value | -Description | -
|---|---|
| [clients_keystone] | -|
| = |
- (StrOpt) Unversioned keystone url in format like http://0.0.0.0:5000. | -
| = |
- (StrOpt) Optional CA cert file to use in SSL connections. | -
| = |
- (StrOpt) Optional PEM-formatted certificate chain file. | -
| = |
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| = |
- (BoolOpt) If set, then the server's certificate will not be verified. | -
| = |
- (StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | -Description | -
|---|---|
| [clients_neutron] | -|
| = |
- (StrOpt) Optional CA cert file to use in SSL connections. | -
| = |
- (StrOpt) Optional PEM-formatted certificate chain file. | -
| = |
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| = |
- (BoolOpt) If set, then the server's certificate will not be verified. | -
| = |
- (StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | -Description | -
|---|---|
| [clients_nova] | -|
| = |
- (StrOpt) Optional CA cert file to use in SSL connections. | -
| = |
- (StrOpt) Optional PEM-formatted certificate chain file. | -
| = |
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| = |
- (BoolOpt) Allow client's debug log output. | -
| = |
- (BoolOpt) If set, then the server's certificate will not be verified. | -
| = |
- (StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | -Description | -
|---|---|
| [clients_sahara] | -|
| = |
- (StrOpt) Optional CA cert file to use in SSL connections. | -
| = |
- (StrOpt) Optional PEM-formatted certificate chain file. | -
| = |
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| = |
- (BoolOpt) If set, then the server's certificate will not be verified. | -
| = |
- (StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | -Description | -
|---|---|
| [clients_swift] | -|
| = |
- (StrOpt) Optional CA cert file to use in SSL connections. | -
| = |
- (StrOpt) Optional PEM-formatted certificate chain file. | -
| = |
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| = |
- (BoolOpt) If set, then the server's certificate will not be verified. | -
| = |
- (StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | -Description | -
|---|---|
| [clients_trove] | -|
| = |
- (StrOpt) Optional CA cert file to use in SSL connections. | -
| = |
- (StrOpt) Optional PEM-formatted certificate chain file. | -
| = |
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| = |
- (BoolOpt) If set, then the server's certificate will not be verified. | -
| = |
- (StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Enable the legacy OS::Heat::CWLiteAlarm resource. | -
| = |
- (StrOpt) URL of the Heat CloudWatch server. | -
| [heat_api_cloudwatch] | -|
| = |
- (IntOpt) Number of backlog requests to configure the socket with. | -
| = |
- (StrOpt) Address to bind the server. Useful when selecting a particular network interface. | -
| = |
- (IntOpt) The port on which the server will listen. | -
| = |
- (StrOpt) Location of the SSL certificate file to use for SSL mode. | -
| = |
- (StrOpt) Location of the SSL key file to use for enabling SSL mode. | -
| = |
- (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.) | -
| = |
- (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. | -
| = |
- (IntOpt) Number of workers for Heat service. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Enables engine with convergence architecture. All stacks with this option will be created using convergence engine . | -
| = |
- (StrOpt) Template default for how the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL (requires enabled heat-api-cfn). TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT (requires object-store endpoint which supports TempURL). HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials. | -
| = |
- (StrOpt) Template default for how the server should receive the metadata required for software configuration. POLL_SERVER_CFN will allow calls to the cfn API action DescribeStackResource authenticated with the provided keypair (requires enabled heat-api-cfn). POLL_SERVER_HEAT will allow calls to the Heat API resource-show using the provided keystone credentials (requires keystone v3 API, and configured stack_user_* config options). POLL_TEMP_URL will create and populate a Swift TempURL with metadata for polling (requires object-store endpoint which supports TempURL).ZAQAR_MESSAGE will create a dedicated zaqar queue and post the metadata for polling. | -
| = |
- (StrOpt) Select deferred auth method, stored password or trusts. | -
| = |
- (StrOpt) The directory to search for environment files. | -
| = |
- (IntOpt) Error wait time in seconds for stack action (ie. create or update). | -
| = |
- (IntOpt) Controls how many events will be pruned whenever a stack's events exceed max_events_per_stack. Set this lower to keep more events at the expense of more frequent purges. | -
| = |
- (IntOpt) Size of executor thread pool. | -
| = |
- (StrOpt) Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. | -
| = |
- (StrOpt) Fully qualified class name to use as a keystone backend. | -
| = |
- (ListOpt) Memcached servers or None for in process cache. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Seconds between running periodic tasks. | -
| = |
- (ListOpt) List of directories to search for plug-ins. | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| = |
- (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| [cache] | -|
| = |
- (StrOpt) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. | -
| = |
- (MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: "<argname>:<value>". | -
| = |
- (StrOpt) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. | -
| = |
- (BoolOpt) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. | -
| = |
- (BoolOpt) Global toggle for caching. | -
| = |
- (IntOpt) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. | -
| = |
- (IntOpt) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). | -
| = |
- (IntOpt) Number of seconds that an operation will wait to get a memcache client connection. | -
| = |
- (IntOpt) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). | -
| = |
- (IntOpt) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). | -
| = |
- (ListOpt) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). | -
| = |
- (IntOpt) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). | -
| = |
- (ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. | -
| [constraint_validation_cache] | -|
| = |
- (BoolOpt) Toggle to enable/disable caching when Orchestration Engine validates property constraints of stack.During property validation with constraints Orchestration Engine caches requests to other OpenStack services. Please note that the global toggle for oslo.cache(enabled=True in [cache] group) must be enabled to use this feature. | -
| = |
- (IntOpt) TTL, in seconds, for any cached item in the dogpile.cache region used for caching of validation constraints. | -
| [revision] | -|
| = |
- (StrOpt) Heat build revision. If you would prefer to manage your build revision separately, you can move this section to a different file and add it as another config option. | -
| Configuration option = Default value | -Description | -
|---|---|
| [cors] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Key used to encrypt authentication info in the database. Length of this key must be 32 characters. | -
| Configuration option = Default value | -Description | -
|---|---|
| [database] | -|
| = |
- (StrOpt) The back end to use for the database. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the database. | -
| = |
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. | -
| = |
- (BoolOpt) Add Python stack traces to SQL as comment strings. | -
| = |
- (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. | -
| = |
- (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. | -
| = |
- (IntOpt) Seconds between retries of a database transaction. | -
| = |
- (IntOpt) Timeout before idle SQL connections are reaped. | -
| = |
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy. | -
| = |
- (IntOpt) Maximum number of SQL connections to keep open in a pool. | -
| = |
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) Minimum number of SQL connections to keep open in a pool. | -
| = |
- (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | -
| = |
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. | -
| = |
- (IntOpt) Interval between retries of opening a SQL connection. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. | -
| = |
- (StrOpt) The file name to use with SQLite. | -
| = |
- (BoolOpt) If True, SQLite uses synchronous mode. | -
| = |
- (BoolOpt) Enable the experimental use of database reconnect on connection lost. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Custom template for the built-in loadbalancer nested stack. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). | -
| = |
- (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Enables or disables fatal status of deprecations. | -
| = |
- (StrOpt) The format for an instance that is passed with the log message. | -
| = |
- (StrOpt) The format for an instance UUID that is passed with the log message. | -
| = |
- (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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). | -
| = |
- (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. | -
| = |
- (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. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) Format string to use for log messages with context. | -
| = |
- (StrOpt) Data to append to log format when level is DEBUG. | -
| = |
- (StrOpt) Format string to use for log messages without context. | -
| = |
- (StrOpt) Prefix each line of exception output with this format. | -
| = |
- (BoolOpt) Enables or disables publication of error events. | -
| = |
- (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. | -
| = |
- (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 Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) URL of the Heat metadata server. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Deprecated. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_qpid] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (IntOpt) Seconds between connection keepalive heartbeats. | -
| = |
- (StrOpt) Qpid broker hostname. | -
| = |
- (ListOpt) Qpid HA cluster host:port pairs. | -
| = |
- (StrOpt) Password for Qpid connection. | -
| = |
- (IntOpt) Qpid broker port. | -
| = |
- (StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| = |
- (IntOpt) The number of prefetched messages held by receiver. | -
| = |
- (StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| = |
- (BoolOpt) Whether to disable the Nagle algorithm. | -
| = |
- (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. | -
| = |
- (StrOpt) Username for Qpid connection. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Maximum events that will be available per stack. Older events will be deleted when this is reached. Set to 0 for unlimited events per stack. | -
| = |
- (IntOpt) Maximum depth allowed when using nested stacks. | -
| = |
- (IntOpt) Maximum resources allowed per top-level stack. -1 stands for unlimited. | -
| = |
- (IntOpt) Maximum number of stacks any one tenant may have active at one time. | -
| = |
- (IntOpt) Maximum raw byte size of any template. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_rabbit] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake | -
| = |
- (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. | -
| = |
- (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL | -
| = |
- (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| = |
- (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). | -
| = |
- (StrOpt) SSL cert file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL key file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. | -
| = |
- (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| = |
- (StrOpt) The RabbitMQ broker address where a single node is used. | -
| = |
- (ListOpt) RabbitMQ HA cluster host:port pairs. | -
| = |
- (StrOpt) The RabbitMQ login method. | -
| = |
- (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| = |
- (StrOpt) The RabbitMQ password. | -
| = |
- (IntOpt) The RabbitMQ broker port where a single node is used. | -
| = |
- (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| = |
- (IntOpt) How frequently to retry connecting with RabbitMQ. | -
| = |
- (BoolOpt) Connect over SSL for RabbitMQ. | -
| = |
- (StrOpt) The RabbitMQ userid. | -
| = |
- (StrOpt) The RabbitMQ virtual host. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [matchmaker_redis] | -|
| = |
- (StrOpt) Host to locate redis. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) RPC timeout for the engine liveness check that is used for stack locking. | -
| = |
- (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| = |
- (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| = |
- (IntOpt) Size of RPC connection pool. | -
| = |
- (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| = |
- (IntOpt) Seconds to wait for a response from a call. | -
| [oslo_concurrency] | -|
| = |
- (BoolOpt) Enables or disables inter-process locks. | -
| = |
- (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. | -
| [oslo_messaging_amqp] | -|
| = |
- (BoolOpt) Accept clients using either SSL or plain TCP | -
| = |
- (StrOpt) address prefix used when broadcasting to all servers | -
| = |
- (StrOpt) Name for the AMQP container | -
| = |
- (StrOpt) address prefix when sending to any server in group | -
| = |
- (IntOpt) Timeout for inactive connections (in seconds) | -
| = |
- (StrOpt) Password for message broker authentication | -
| = |
- (StrOpt) Path to directory that contains the SASL configuration | -
| = |
- (StrOpt) Name of configuration file (without .conf suffix) | -
| = |
- (StrOpt) Space separated list of acceptable SASL mechanisms | -
| = |
- (StrOpt) address prefix used when sending to a specific server | -
| = |
- (StrOpt) CA certificate PEM file to verify server certificate | -
| = |
- (StrOpt) Identifying certificate PEM file to present to clients | -
| = |
- (StrOpt) Private key PEM file used to sign cert_file certificate | -
| = |
- (StrOpt) Password for decrypting ssl_key_file (if encrypted) | -
| = |
- (BoolOpt) Debug: dump AMQP frames to stdout | -
| = |
- (StrOpt) User name for message broker authentication | -
| Configuration option = Default value | -Description | -
|---|---|
| [profiler] | -|
| = |
- (BoolOpt) If False fully disable profiling feature. | -
| = |
- (BoolOpt) If False do not trace SQL requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| [trustee] | -|
| = |
- (StrOpt) Name of the plugin to load | -
| = |
- (StrOpt) Config Section from which to load plugin specific options | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) URL of the Heat waitcondition server. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| = |
- (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| = |
- (StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| = |
- (IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| = |
- (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. | -
| = |
- (StrOpt) Directory for holding IPC sockets. | -
| = |
- (StrOpt) MatchMaker driver. | -
| = |
- (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| = |
- (BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| Configuration option = Default value | -Description | -
|---|---|
| [agent] | -|
| = |
- (StrOpt) API version to use for communicating with the ramdisk agent. | -
| = |
- (StrOpt) DEPRECATED. Additional append parameters for baremetal PXE boot. This option is deprecated and will be removed in Mitaka release. Please use [pxe]pxe_append_params instead. | -
| = |
- (StrOpt) DEPRECATED. Template file for PXE configuration. This option is deprecated and will be removed in Mitaka release. Please use [pxe]pxe_config_template instead. | -
| = |
- (IntOpt) Maximum interval (in seconds) for agent heartbeats. | -
| = |
- (BoolOpt) Whether Ironic will manage booting of the agent ramdisk. If set to False, you will need to configure your mechanism to allow booting the agent ramdisk. | -
| = |
- (IntOpt) The memory size in MiB consumed by agent when it is booted on a bare metal node. This is used for checking if the image can be downloaded and deployed on the bare metal node after booting agent ramdisk. This may be set according to the memory consumed by the agent ramdisk image. | -
| = |
- (IntOpt) Number of times to retry getting power state to check if bare metal node has been powered off after a soft power off. | -
| = |
- (IntOpt) Amount of time (in seconds) to wait between polling power state after trigger soft poweroff. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| = |
- (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop | -
| = |
- (ListOpt) AMQP topic used for OpenStack notifications. | -
| = |
- (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. | -
| Configuration option = Default value | -Description | -
|---|---|
| [amt] | -|
| = |
- (IntOpt) Amount of time (in seconds) to wait, before retrying an AMT operation | -
| = |
- (IntOpt) Maximum number of times to attempt an AMT operation, before failing | -
| = |
- (StrOpt) Protocol used for AMT endpoint, support http/https | -
| Configuration option = Default value | -Description | -
|---|---|
| [api] | -|
| = |
- (StrOpt) The IP address on which ironic-api listens. | -
| = |
- (IntOpt) The maximum number of items returned in a single response from a collection resource. | -
| = |
- (IntOpt) The TCP port on which ironic-api listens. | -
| = |
- (StrOpt) Public URL to use when building the links to the API resources (for example, "https://ironic.rocks:6384"). If None the links will be built using the request's host URL. If the API is operating behind a proxy, you will want to change this to represent the proxy's URL. Defaults to None. | -
| [cors] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| [oslo_middleware] | -|
| = |
- (IntOpt) The maximum body size for each request, in bytes. | -
| = |
- (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_versionedobjects] | -|
| = |
- (BoolOpt) Make exception message format errors fatal | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Authentication strategy used by ironic-api: one of "keystone" or "noauth". "noauth" should not be used in a production environment because all authentication will be disabled. | -
| Configuration option = Default value | -Description | -
|---|---|
| [keystone_authtoken] | -|
| = |
- (StrOpt) Service user password. | -
| = |
- (StrOpt) Service tenant name. | -
| = |
- (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | -
| = |
- (StrOpt) Service username. | -
| = |
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Name of the plugin to load | -
| = |
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | -
| = |
- (StrOpt) Config Section from which to load plugin specific options | -
| = |
- (StrOpt) Complete public Identity API endpoint. | -
| = |
- (StrOpt) API version of the admin Identity API endpoint. | -
| = |
- (StrOpt) Env key for the swift cache. | -
| = |
- (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. | -
| = |
- (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. | -
| = |
- (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| = |
- (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | -
| = |
- (IntOpt) Request timeout value for communicating with Identity API server. | -
| = |
- (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| = |
- (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | -
| = |
- (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. | -
| = |
- (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. | -
| = |
- (IntOpt) (Optional) Maximum total number of open connections to every memcached server. | -
| = |
- (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. | -
| = |
- (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. | -
| = |
- (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. | -
| = |
- (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. | -
| = |
- (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. | -
| = |
- (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| = |
- (StrOpt) The region in which the identity server can be found. | -
| = |
- (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| = |
- (StrOpt) Directory used to cache files related to PKI tokens. | -
| = |
- (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | -Description | -
|---|---|
| [cimc] | -|
| = |
- (IntOpt) Amount of time in seconds to wait in between power operations | -
| = |
- (IntOpt) Number of times a power operation needs to be retried | -
| [cisco_ucs] | -|
| = |
- (IntOpt) Amount of time in seconds to wait in between power operations | -
| = |
- (IntOpt) Number of times a power operation needs to be retried | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Directory where ironic binaries are installed. | -
| = |
- (ListOpt) Specify the list of drivers to load during service initialization. Missing drivers, or drivers which fail to initialize, will prevent the conductor service from starting. The option default is a recommended set of production-oriented drivers. A complete list of drivers present on your system may be found by enumerating the "ironic.drivers" entrypoint. An example may be found in the developer documentation online. | -
| = |
- (IntOpt) Size of executor thread pool. | -
| = |
- (BoolOpt) Enables or disables fatal status of deprecations. | -
| = |
- (BoolOpt) If True, convert backing images to "raw" disk image format. | -
| = |
- (StrOpt) Template file for grub configuration file. | -
| = |
- (IntOpt) [Experimental Feature] Number of hosts to map onto each hash partition. Setting this to more than one will cause additional conductor services to prepare deployment environments and potentially allow the Ironic cluster to recover more quickly if a conductor instance is terminated. | -
| = |
- (IntOpt) Exponent to determine number of hash partitions to use when distributing load across conductors. Larger values will result in more even distribution of load and less load when rebalancing the ring, but more memory usage. Number of partitions per conductor is (2^hash_partition_exponent). This determines the granularity of rebalancing: given 10 hosts, and an exponent of the 2, there are 40 partitions in the ring.A few thousand partitions should make rebalancing smooth in most cases. The default is suitable for up to a few hundred conductors. Too many partitions has a CPU impact. | -
| = |
- (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address. | -
| = |
- (StrOpt) Path to isolinux binary file. | -
| = |
- (StrOpt) Template file for isolinux configuration file. | -
| = |
- (ListOpt) Memcached servers or None for in process cache. | -
| = |
- (StrOpt) IP address of this host. If unset, will determine the IP programmatically. If unable to do so, will use "127.0.0.1". | -
| = |
- (BoolOpt) Run image downloads and raw format conversions in parallel. | -
| = |
- (IntOpt) Seconds between running periodic tasks. | -
| = |
- (StrOpt) Directory where the ironic python module is installed. | -
| = |
- (StrOpt) Path to the rootwrap configuration file to use for running commands as root. | -
| = |
- (StrOpt) Top-level directory for maintaining ironic's state. | -
| = |
- (StrOpt) Temporary working directory, default is Python temp dir. | -
| Configuration option = Default value | -Description | -
|---|---|
| [conductor] | -|
| = |
- (StrOpt) URL of Ironic API service. If not set ironic can get the current value from the keystone service catalog. | -
| = |
- (IntOpt) Interval between checks of provision timeouts, in seconds. | -
| = |
- (IntOpt) Timeout (seconds) to wait for a callback from the ramdisk doing the cleaning. If the timeout is reached the node will be put in the "clean failed" provision state. Set to 0 to disable timeout. | -
| = |
- (BoolOpt) Cleaning is a configurable set of steps, such as erasing disk drives, that are performed on the node to ensure it is in a baseline state and ready to be deployed to. This is done after instance deletion, and during the transition from a "managed" to "available" state. When enabled, the particular steps performed to clean a node depend on which driver that node is managed by; see the individual driver's documentation for details. NOTE: The introduction of the cleaning operation causes instance deletion to take significantly longer. In an environment where all tenants are trusted (eg, because there is only one tenant), this option could be safely disabled. | -
| = |
- (StrOpt) Name of the Swift container to store config drive data. Used when configdrive_use_swift is True. | -
| = |
- (BoolOpt) Whether to upload the config drive to Swift. | -
| = |
- (IntOpt) Timeout (seconds) to wait for a callback from a deploy ramdisk. Set to 0 to disable timeout. | -
| = |
- (BoolOpt) During sync_power_state, should the hardware power state be set to the state recorded in the database (True) or should the database be updated based on the hardware state (False). | -
| = |
- (IntOpt) Seconds between conductor heart beats. | -
| = |
- (IntOpt) Maximum time (in seconds) since the last check-in of a conductor. A conductor is considered inactive when this time has been exceeded. | -
| = |
- (IntOpt) Timeout (seconds) for waiting for node inspection. 0 - unlimited. | -
| = |
- (IntOpt) Number of attempts to grab a node lock. | -
| = |
- (IntOpt) Seconds to sleep between node lock attempts. | -
| = |
- (IntOpt) Maximum number of worker threads that can be started simultaneously by a periodic task. Should be less than RPC thread pool size. | -
| = |
- (IntOpt) During sync_power_state failures, limit the number of times Ironic should try syncing the hardware node power state with the node power state in DB | -
| = |
- (BoolOpt) Enable sending sensor data message via the notification bus | -
| = |
- (IntOpt) Seconds between conductor sending sensor data message to ceilometer via the notification bus. | -
| = |
- (ListOpt) List of comma separated meter types which need to be sent to Ceilometer. The default value, "ALL", is a special value meaning send all the sensor data. | -
| = |
- (IntOpt) When conductors join or leave the cluster, existing conductors may need to update any persistent local state as nodes are moved around the cluster. This option controls how often, in seconds, each conductor will check for nodes that it should "take over". Set it to a negative value to disable the check entirely. | -
| = |
- (IntOpt) Interval between syncing the node power state to the database, in seconds. | -
| = |
- (IntOpt) The size of the workers greenthread pool. | -
| Configuration option = Default value | -Description | -
|---|---|
| [console] | -|
| = |
- (IntOpt) Time interval (in seconds) for checking the status of console subprocess. | -
| = |
- (IntOpt) Time (in seconds) to wait for the console subprocess to start. | -
| = |
- (StrOpt) Path to serial console terminal program | -
| = |
- (StrOpt) Directory containing the terminal SSL cert(PEM) for serial console access | -
| = |
- (StrOpt) Directory for holding terminal pid files. If not specified, the temporary directory will be used. | -
| Configuration option = Default value | -Description | -
|---|---|
| [database] | -|
| = |
- (StrOpt) The back end to use for the database. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the database. | -
| = |
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. | -
| = |
- (BoolOpt) Add Python stack traces to SQL as comment strings. | -
| = |
- (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. | -
| = |
- (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. | -
| = |
- (IntOpt) Seconds between retries of a database transaction. | -
| = |
- (IntOpt) Timeout before idle SQL connections are reaped. | -
| = |
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy. | -
| = |
- (IntOpt) Maximum number of SQL connections to keep open in a pool. | -
| = |
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) Minimum number of SQL connections to keep open in a pool. | -
| = |
- (StrOpt) MySQL engine to use. | -
| = |
- (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | -
| = |
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. | -
| = |
- (IntOpt) Interval between retries of opening a SQL connection. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. | -
| = |
- (StrOpt) The file name to use with SQLite. | -
| = |
- (BoolOpt) If True, SQLite uses synchronous mode. | -
| = |
- (BoolOpt) Enable the experimental use of database reconnect on connection lost. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Enable pecan debug mode. WARNING: this is insecure and should not be used in a production environment. | -
| Configuration option = Default value | -Description | -
|---|---|
| [deploy] | -|
| = |
- (StrOpt) Block size to use when writing to the nodes disk. | -
| = |
- (IntOpt) Size of EFI system partition in MiB when configuring UEFI systems for local boot. | -
| = |
- (IntOpt) Number of iterations to be run for erasing devices. | -
| = |
- (IntOpt) Priority to run in-band erase devices via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 10 for the GenericHardwareManager). If set to 0, will not run during cleaning. | -
| = |
- (StrOpt) ironic-conductor node's HTTP root path. | -
| = |
- (StrOpt) ironic-conductor node's HTTP server URL. Example: http://192.1.2.3:8080 | -
| = |
- (IntOpt) Maximum attempts to verify an iSCSI connection is active, sleeping 1 second between attempts. | -
| Configuration option = Default value | -Description | -
|---|---|
| [dhcp] | -|
| = |
- (StrOpt) DHCP provider to use. "neutron" uses Neutron, and "none" uses a no-op provider. | -
| Configuration option = Default value | -Description | -
|---|---|
| [disk_partitioner] | -|
| = |
- (IntOpt) After Ironic has completed creating the partition table, it continues to check for activity on the attached iSCSI device status at this interval prior to copying the image to the node, in seconds | -
| = |
- (IntOpt) The maximum number of times to check that the device is not accessed by another process. If the device is still busy after that, the disk partitioning will be treated as having failed. | -
| Configuration option = Default value | -Description | -
|---|---|
| [drac] | -|
| = |
- (IntOpt) In case there is a communication failure, the DRAC client is going to resend the request as many times as defined in this setting. | -
| = |
- (IntOpt) In case there is a communication failure, the DRAC client is going to wait for as many seconds as defined in this setting before resending the request. | -
| Configuration option = Default value | -Description | -
|---|---|
| [glance] | -|
| = |
- (ListOpt) A list of URL schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. | -
| = |
- (StrOpt) Authentication strategy to use when connecting to glance. Only "keystone" and "noauth" are currently supported by ironic. | -
| = |
- (BoolOpt) Allow to perform insecure SSL (https) requests to glance. | -
| = |
- (ListOpt) A list of the glance api servers available to ironic. Prefix with https:// for SSL-based glance API servers. Format is [hostname|IP]:port. | -
| = |
- (StrOpt) Default glance hostname or IP address. | -
| = |
- (IntOpt) Number of retries when downloading an image from glance. | -
| = |
- (IntOpt) Default glance port. | -
| = |
- (StrOpt) Default protocol to use when connecting to glance. Set to https for SSL. | -
| = |
- (StrOpt) The account that Glance uses to communicate with Swift. The format is "AUTH_uuid". "uuid" is the UUID for the account configured in the glance-api.conf. Required for temporary URLs. For example: "AUTH_a422b2-91f3-2f46-74b7-d7c9e8958f5d30". Swift temporary URL format: "endpoint_url/api_version/account/container/object_id" | -
| = |
- (StrOpt) The Swift API version to create a temporary URL for. Defaults to "v1". Swift temporary URL format: "endpoint_url/api_version/account/container/object_id" | -
| = |
- (StrOpt) The Swift container Glance is configured to store its images in. Defaults to "glance", which is the default in glance-api.conf. Swift temporary URL format: "endpoint_url/api_version/account/container/object_id" | -
| = |
- (StrOpt) The "endpoint" (scheme, hostname, optional port) for the Swift URL of the form "endpoint_url/api_version/account/container/object_id". Do not include trailing "/". For example, use "https://swift.example.com". Required for temporary URLs. | -
| = |
- (IntOpt) This should match a config by the same name in the Glance configuration file. When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a single-tenant store will use multiple containers to store images, and this value will determine how many containers are created. | -
| = |
- (IntOpt) The length of time in seconds that the temporary URL will be valid for. Defaults to 20 minutes. If some deploys get a 401 response code when trying to download from the temporary URL, try raising this duration. | -
| = |
- (StrOpt) The secret token given to Swift to allow temporary URL downloads. Required for temporary URLs. | -
| Configuration option = Default value | -Description | -
|---|---|
| [iboot] | -|
| = |
- (IntOpt) Maximum retries for iBoot operations | -
| = |
- (IntOpt) Time between retry attempts for iBoot operations | -
| Configuration option = Default value | -Description | -
|---|---|
| [ilo] | -|
| = |
- (IntOpt) Priority for clear_secure_boot_keys clean step. This step is not enabled by default. It can be enabled to to clear all secure boot keys enrolled with iLO. | -
| = |
- (IntOpt) Priority for erase devices clean step. If unset, it defaults to 10. If set to 0, the step will be disabled and will not run during cleaning. | -
| = |
- (IntOpt) Priority for reset_bios_to_default clean step. | -
| = |
- (IntOpt) Priority for reset_ilo clean step. | -
| = |
- (IntOpt) Priority for reset_ilo_credential clean step. This step requires "ilo_change_password" parameter to be updated in nodes's driver_info with the new password. | -
| = |
- (IntOpt) Priority for reset_secure_boot_keys clean step. This step will reset the secure boot keys to manufacturing defaults. | -
| = |
- (IntOpt) Port to be used for iLO operations | -
| = |
- (IntOpt) Timeout (in seconds) for iLO operations | -
| = |
- (IntOpt) Number of times a power operation needs to be retried | -
| = |
- (IntOpt) Amount of time in seconds to wait in between power operations | -
| = |
- (StrOpt) The Swift iLO container to store data. | -
| = |
- (IntOpt) Amount of time in seconds for Swift objects to auto-expire. | -
| = |
- (BoolOpt) Set this to True to use http web server to host floppy images and generated boot ISO. This requires http_root and http_url to be configured in the [deploy] section of the config file. If this is set to False, then Ironic will use Swift to host the floppy images and generated boot_iso. | -
| Configuration option = Default value | -Description | -
|---|---|
| [inspector] | -|
| = |
- (BoolOpt) whether to enable inspection using ironic-inspector | -
| = |
- (StrOpt) ironic-inspector HTTP endpoint. If this is not set, the ironic-inspector client default (http://127.0.0.1:5050) will be used. | -
| = |
- (IntOpt) period (in seconds) to check status of nodes on inspection | -
| Configuration option = Default value | -Description | -
|---|---|
| [ipmi] | -|
| = |
- (IntOpt) Minimum time, in seconds, between IPMI operations sent to a server. There is a risk with some hardware that setting this too low may cause the BMC to crash. Recommended setting is 5 seconds. | -
| = |
- (IntOpt) Maximum time in seconds to retry IPMI operations. There is a tradeoff when setting this value. Setting this too low may cause older BMCs to crash and require a hard reset. However, setting too high can cause the sync power state periodic task to hang when there are slow or unresponsive BMCs. | -
| Configuration option = Default value | -Description | -
|---|---|
| [irmc] | -|
| = |
- (StrOpt) Authentication method to be used for iRMC operations, either "basic" or "digest" | -
| = |
- (IntOpt) Timeout (in seconds) for iRMC operations | -
| = |
- (IntOpt) Port to be used for iRMC operations, either 80 or 443 | -
| = |
- (StrOpt) IP of remote image server | -
| = |
- (StrOpt) share name of remote_image_server | -
| = |
- (StrOpt) Ironic conductor node's "NFS" or "CIFS" root path | -
| = |
- (StrOpt) Share type of virtual media, either "NFS" or "CIFS" | -
| = |
- (StrOpt) Domain name of remote_image_user_name | -
| = |
- (StrOpt) User name of remote_image_server | -
| = |
- (StrOpt) Password of remote_image_user_name | -
| = |
- (StrOpt) Sensor data retrieval method, either "ipmitool" or "scci" | -
| Configuration option = Default value | -Description | -
|---|---|
| [keystone] | -|
| = |
- (StrOpt) The region used for getting endpoints of OpenStackservices. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). | -
| = |
- (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Used if there is a formatting error when generating an exception message (a programming error). If True, raise an exception; if False, use the unformatted message. | -
| = |
- (StrOpt) The format for an instance that is passed with the log message. | -
| = |
- (StrOpt) The format for an instance UUID that is passed with the log message. | -
| = |
- (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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). | -
| = |
- (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. | -
| = |
- (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. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) Format string to use for log messages with context. | -
| = |
- (StrOpt) Data to append to log format when level is DEBUG. | -
| = |
- (StrOpt) Format string to use for log messages without context. | -
| = |
- (StrOpt) Prefix each line of exception output with this format. | -
| = |
- (BoolOpt) Enables or disables publication of error events. | -
| = |
- (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. | -
| = |
- (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 Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. | -
| = |
- (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| Configuration option = Default value | -Description | -
|---|---|
| [neutron] | -|
| = |
- (StrOpt) Default authentication strategy to use when connecting to neutron. Can be either "keystone" or "noauth". Running neutron in noauth mode (related to but not affected by this setting) is insecure and should only be used for testing. | -
| = |
- (StrOpt) UUID of the network to create Neutron ports on when booting to a ramdisk for cleaning/zapping using Neutron DHCP | -
| = |
- (IntOpt) Client retries in the case of a failed request. | -
| = |
- (StrOpt) URL for connecting to neutron. | -
| = |
- (IntOpt) Timeout value for connecting to neutron in seconds. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_policy] | -|
| = |
- (StrOpt) Default rule. Enforced when a requested rule is not found. | -
| = |
- (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. | -
| = |
- (StrOpt) The JSON file that defines policies. | -
| Configuration option = Default value | -Description | -
|---|---|
| [pxe] | -|
| = |
- (StrOpt) Default file system format for ephemeral partition, if one is created. | -
| = |
- (StrOpt) The disk devices to scan while doing the deploy. | -
| = |
- (IntOpt) Maximum size (in MiB) of cache for master images, including those in use. | -
| = |
- (IntOpt) Maximum TTL (in minutes) for old master images in cache. | -
| = |
- (StrOpt) On the ironic-conductor node, directory where images are stored on disk. | -
| = |
- (StrOpt) On the ironic-conductor node, directory where master instance images are stored on disk. | -
| = |
- (StrOpt) On ironic-conductor node, the path to the main iPXE script file. | -
| = |
- (BoolOpt) Enable iPXE boot. | -
| = |
- (StrOpt) Additional append parameters for baremetal PXE boot. | -
| = |
- (StrOpt) Bootfile DHCP parameter. | -
| = |
- (StrOpt) On ironic-conductor node, template file for PXE configuration. | -
| = |
- (StrOpt) On ironic-conductor node, directory where master TFTP images are stored on disk. | -
| = |
- (StrOpt) ironic-conductor node's TFTP root path. | -
| = |
- (StrOpt) IP address of ironic-conductor node's TFTP server. | -
| = |
- (StrOpt) Bootfile DHCP parameter for UEFI boot mode. | -
| = |
- (StrOpt) On ironic-conductor node, template file for PXE configuration for UEFI boot loader. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_qpid] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (IntOpt) Seconds between connection keepalive heartbeats. | -
| = |
- (StrOpt) Qpid broker hostname. | -
| = |
- (ListOpt) Qpid HA cluster host:port pairs. | -
| = |
- (StrOpt) Password for Qpid connection. | -
| = |
- (IntOpt) Qpid broker port. | -
| = |
- (StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| = |
- (IntOpt) The number of prefetched messages held by receiver. | -
| = |
- (StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| = |
- (BoolOpt) Whether to disable the Nagle algorithm. | -
| = |
- (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. | -
| = |
- (StrOpt) Username for Qpid connection. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_rabbit] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake | -
| = |
- (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. | -
| = |
- (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL | -
| = |
- (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| = |
- (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). | -
| = |
- (StrOpt) SSL cert file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL key file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. | -
| = |
- (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| = |
- (StrOpt) The RabbitMQ broker address where a single node is used. | -
| = |
- (ListOpt) RabbitMQ HA cluster host:port pairs. | -
| = |
- (StrOpt) The RabbitMQ login method. | -
| = |
- (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| = |
- (StrOpt) The RabbitMQ password. | -
| = |
- (IntOpt) The RabbitMQ broker port where a single node is used. | -
| = |
- (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| = |
- (IntOpt) How frequently to retry connecting with RabbitMQ. | -
| = |
- (BoolOpt) Connect over SSL for RabbitMQ. | -
| = |
- (StrOpt) The RabbitMQ userid. | -
| = |
- (StrOpt) The RabbitMQ virtual host. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| [matchmaker_redis] | -|
| = |
- (StrOpt) Host to locate redis. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| = |
- (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| = |
- (IntOpt) Size of RPC connection pool. | -
| = |
- (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| = |
- (IntOpt) Seconds to wait for a response from a call. | -
| [oslo_concurrency] | -|
| = |
- (BoolOpt) Enables or disables inter-process locks. | -
| = |
- (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. | -
| [oslo_messaging_amqp] | -|
| = |
- (BoolOpt) Accept clients using either SSL or plain TCP | -
| = |
- (StrOpt) address prefix used when broadcasting to all servers | -
| = |
- (StrOpt) Name for the AMQP container | -
| = |
- (StrOpt) address prefix when sending to any server in group | -
| = |
- (IntOpt) Timeout for inactive connections (in seconds) | -
| = |
- (StrOpt) Password for message broker authentication | -
| = |
- (StrOpt) Path to directory that contains the SASL configuration | -
| = |
- (StrOpt) Name of configuration file (without .conf suffix) | -
| = |
- (StrOpt) Space separated list of acceptable SASL mechanisms | -
| = |
- (StrOpt) address prefix used when sending to a specific server | -
| = |
- (StrOpt) CA certificate PEM file to verify server certificate | -
| = |
- (StrOpt) Identifying certificate PEM file to present to clients | -
| = |
- (StrOpt) Private key PEM file used to sign cert_file certificate | -
| = |
- (StrOpt) Password for decrypting ssl_key_file (if encrypted) | -
| = |
- (BoolOpt) Debug: dump AMQP frames to stdout | -
| = |
- (StrOpt) User name for message broker authentication | -
| Configuration option = Default value | -Description | -
|---|---|
| [seamicro] | -|
| = |
- (IntOpt) Seconds to wait for power action to be completed | -
| = |
- (IntOpt) Maximum retries for SeaMicro operations | -
| Configuration option = Default value | -Description | -
|---|---|
| [snmp] | -|
| = |
- (IntOpt) Seconds to wait for power action to be completed | -
| Configuration option = Default value | -Description | -
|---|---|
| [ssh] | -|
| = |
- (StrOpt) libvirt URI | -
| Configuration option = Default value | -Description | -
|---|---|
| [swift] | -|
| = |
- (IntOpt) Maximum number of times to retry a Swift request, before failing. | -
| Configuration option = Default value | -Description | -
|---|---|
| [virtualbox] | -|
| = |
- (IntOpt) Port on which VirtualBox web service is listening. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| = |
- (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| = |
- (StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| = |
- (IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| = |
- (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. | -
| = |
- (StrOpt) Directory for holding IPC sockets. | -
| = |
- (StrOpt) MatchMaker driver. | -
| = |
- (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| = |
- (BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| = |
- (StrOpt) Default publisher_id for outgoing notifications | -
| = |
- (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop | -
| = |
- (StrOpt) Define the notification format for Identity Service events. A "basic" notification has information about the resource being operated on. A "cadf" notification has the same information, as well as information about the initiator of the event. | -
| = |
- (ListOpt) AMQP topic used for OpenStack notifications. | -
| = |
- (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The base admin endpoint URL for Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:35357/v3/users will default to http://server:35357. You should only need to set this value if the base URL contains a path (e.g. /prefix/v3) or the endpoint should be found on a different server. | -
| = |
- (StrOpt) A "shared secret" that can be used to bootstrap Keystone. This "token" does not represent a user, and carries no explicit authorization. To disable in production (highly recommended), remove AdminTokenAuthMiddleware from your paste application pipelines (for example, in keystone-paste.ini). | -
| = |
- (BoolOpt) Set this to false if you want to enable the ability for user, group and project entities to be moved between domains by updating their domain_id. Allowing such movement is not recommended if the scope of a domain admin is being restricted by use of an appropriate policy file (see policy.v3cloudsample as an example). | -
| = |
- (IntOpt) The maximum number of entities that will be returned in a collection, with no limit set by default. This global limit may be then overridden for a specific driver, by specifying a list_limit in the appropriate section (e.g. [assignment]). | -
| = |
- (IntOpt) Limit the sizes of user & project ID/names. | -
| = |
- (IntOpt) Maximum depth of the project hierarchy. WARNING: setting it to a large value may adversely impact performance. | -
| = |
- (IntOpt) Similar to max_param_size, but provides an exception for token values. | -
| = |
- (StrOpt) Similar to the member_role_name option, this represents the default role ID used to associate users with their default projects in the v2 API. This will be used as the explicit role where one is not specified by the v2 API. | -
| = |
- (StrOpt) This is the role name used in combination with the member_role_id option; see that option for more detail. | -
| = |
- (StrOpt) The base public endpoint URL for Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:5000/v3/users will default to http://server:5000. You should only need to set this value if the base URL contains a path (e.g. /prefix/v3) or the endpoint should be found on a different server. | -
| = |
- (StrOpt) The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is "HTTP_X_FORWARDED_PROTO". | -
| = |
- (BoolOpt) If set to true, strict password length checking is performed for password manipulation. If a password exceeds the maximum length, the operation will fail with an HTTP 403 Forbidden error. If set to false, passwords are automatically truncated to the maximum length. | -
| [endpoint_filter] | -|
| = |
- (StrOpt) Entrypoint for the endpoint filter backend driver in the keystone.endpoint_filter namespace. | -
| = |
- (BoolOpt) Toggle to return all active endpoints if no filter exists. | -
| [endpoint_policy] | -|
| = |
- (StrOpt) Entrypoint for the endpoint policy backend driver in the keystone.endpoint_policy namespace. | -
| = |
- (BoolOpt) Enable endpoint_policy functionality. | -
| [eventlet_server] | -|
| = |
- (StrOpt) The IP address of the network interface for the admin service to listen on. | -
| = |
- (IntOpt) The port number which the admin service listens on. | -
| = |
- (IntOpt) The number of worker processes to serve the admin eventlet application. Defaults to number of CPUs (minimum of 2). | -
| = |
- (IntOpt) Timeout for socket operations on a client connection. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. | -
| = |
- (StrOpt) The IP address of the network interface for the public service to listen on. | -
| = |
- (IntOpt) The port number which the public service listens on. | -
| = |
- (IntOpt) The number of worker processes to serve the public eventlet application. Defaults to number of CPUs (minimum of 2). | -
| = |
- (BoolOpt) Set this to true if you want to enable TCP_KEEPALIVE on server sockets, i.e. sockets used by the Keystone wsgi server for client connections. | -
| = |
- (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Only applies if tcp_keepalive is true. | -
| = |
- (BoolOpt) If set to false, disables keepalives on the server; all connections will be closed after serving one request. | -
| [oslo_middleware] | -|
| = |
- (IntOpt) The maximum body size for each request, in bytes. | -
| = |
- (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. | -
| [paste_deploy] | -|
| = |
- (StrOpt) Name of the paste configuration file that defines the available pipelines. | -
| [resource] | -|
| = |
- (IntOpt) TTL (in seconds) to cache resource data. This has no effect unless global caching is enabled. | -
| = |
- (BoolOpt) Toggle for resource caching. This has no effect unless global caching is enabled. | -
| = |
- (StrOpt) Entrypoint for the resource backend driver in the keystone.resource namespace. Supplied drivers are ldap and sql. If a resource driver is not specified, the assignment driver will choose the resource driver. | -
| = |
- (IntOpt) Maximum number of entities that will be returned in a resource collection. | -
| Configuration option = Default value | -Description | -
|---|---|
| [assignment] | -|
| = |
- (StrOpt) Entrypoint for the assignment backend driver in the keystone.assignment namespace. Supplied drivers are ldap and sql. If an assignment driver is not specified, the identity driver will choose the assignment driver. | -
| Configuration option = Default value | -Description | -
|---|---|
| [auth] | -|
| = |
- (StrOpt) Entrypoint for the external (REMOTE_USER) auth plugin module in the keystone.auth.external namespace. Supplied drivers are DefaultDomain and Domain. The default driver is DefaultDomain. | -
| = |
- (ListOpt) Allowed authentication methods. | -
| = |
- (StrOpt) Entrypoint for the oAuth1.0 auth plugin module in the keystone.auth.oauth1 namespace. | -
| = |
- (StrOpt) Entrypoint for the password auth plugin module in the keystone.auth.password namespace. | -
| = |
- (StrOpt) Entrypoint for the token auth plugin module in the keystone.auth.token namespace. | -
| Configuration option = Default value | -Description | -
|---|---|
| [keystone_authtoken] | -|
| = |
- (StrOpt) Service user password. | -
| = |
- (StrOpt) Service tenant name. | -
| = |
- (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | -
| = |
- (StrOpt) Service username. | -
| = |
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Name of the plugin to load | -
| = |
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | -
| = |
- (StrOpt) Config Section from which to load plugin specific options | -
| = |
- (StrOpt) Complete public Identity API endpoint. | -
| = |
- (StrOpt) API version of the admin Identity API endpoint. | -
| = |
- (StrOpt) Env key for the swift cache. | -
| = |
- (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. | -
| = |
- (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. | -
| = |
- (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| = |
- (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | -
| = |
- (IntOpt) Request timeout value for communicating with Identity API server. | -
| = |
- (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| = |
- (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | -
| = |
- (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. | -
| = |
- (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. | -
| = |
- (IntOpt) (Optional) Maximum total number of open connections to every memcached server. | -
| = |
- (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. | -
| = |
- (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. | -
| = |
- (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. | -
| = |
- (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. | -
| = |
- (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. | -
| = |
- (StrOpt) The region in which the identity server can be found. | -
| = |
- (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| = |
- (StrOpt) Directory used to cache files related to PKI tokens. | -
| = |
- (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | -Description | -
|---|---|
| [eventlet_server_ssl] | -|
| = |
- (StrOpt) Path of the CA cert file for SSL. | -
| = |
- (BoolOpt) Require client certificate. | -
| = |
- (StrOpt) Path of the certfile for SSL. For non-production environments, you may be interested in using `keystone-manage ssl_setup` to generate self-signed certificates. | -
| = |
- (BoolOpt) Toggle for SSL support on the Keystone eventlet servers. | -
| = |
- (StrOpt) Path of the keyfile for SSL. | -
| [signing] | -|
| = |
- (StrOpt) Path of the CA for token signing. | -
| = |
- (StrOpt) Path of the CA key for token signing. | -
| = |
- (StrOpt) Certificate subject (auto generated certificate) for token signing. | -
| = |
- (StrOpt) Path of the certfile for token signing. For non-production environments, you may be interested in using `keystone-manage pki_setup` to generate self-signed certificates. | -
| = |
- (IntOpt) Key size (in bits) for token signing cert (auto generated certificate). | -
| = |
- (StrOpt) Path of the keyfile for token signing. | -
| = |
- (IntOpt) Days the token signing cert is valid for (auto generated certificate). | -
| [ssl] | -|
| = |
- (StrOpt) Path of the CA key file for SSL. | -
| = |
- (StrOpt) SSL certificate subject (auto generated certificate). | -
| = |
- (IntOpt) SSL key length (in bits) (auto generated certificate). | -
| = |
- (IntOpt) Days the certificate is valid for once signed (auto generated certificate). | -
| Configuration option = Default value | -Description | -
|---|---|
| [cache] | -|
| = |
- (StrOpt) Dogpile.cache backend module. It is recommended that Memcache with pooling (keystone.cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. | -
| = |
- (MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: "<argname>:<value>". | -
| = |
- (StrOpt) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. | -
| = |
- (BoolOpt) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. | -
| = |
- (BoolOpt) Global toggle for all caching using the should_cache_fn mechanism. | -
| = |
- (IntOpt) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. | -
| = |
- (IntOpt) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and keystone.cache.memcache_pool backends only). | -
| = |
- (IntOpt) Number of seconds that an operation will wait to get a memcache client connection. | -
| = |
- (IntOpt) Max total number of open connections to every memcached server. (keystone.cache.memcache_pool backend only). | -
| = |
- (IntOpt) Number of seconds a connection to memcached is held unused in the pool before it is closed. (keystone.cache.memcache_pool backend only). | -
| = |
- (ListOpt) Memcache servers in the format of "host:port". (dogpile.cache.memcache and keystone.cache.memcache_pool backends only). | -
| = |
- (IntOpt) Timeout in seconds for every call to a server. (dogpile.cache.memcache and keystone.cache.memcache_pool backends only). | -
| = |
- (ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. | -
| [memcache] | -|
| = |
- (IntOpt) Number of seconds memcached server is considered dead before it is tried again. This is used by the key value store system (e.g. token pooled memcached persistence backend). | -
| = |
- (IntOpt) Number of seconds that an operation will wait to get a memcache client connection. This is used by the key value store system (e.g. token pooled memcached persistence backend). | -
| = |
- (IntOpt) Max total number of open connections to every memcached server. This is used by the key value store system (e.g. token pooled memcached persistence backend). | -
| = |
- (IntOpt) Number of seconds a connection to memcached is held unused in the pool before it is closed. This is used by the key value store system (e.g. token pooled memcached persistence backend). | -
| Configuration option = Default value | -Description | -
|---|---|
| [catalog] | -|
| = |
- (IntOpt) Time to cache catalog data (in seconds). This has no effect unless global and catalog caching are enabled. | -
| = |
- (BoolOpt) Toggle for catalog caching. This has no effect unless global caching is enabled. | -
| = |
- (StrOpt) Entrypoint for the catalog backend driver in the keystone.catalog namespace. Supplied drivers are kvs, sql, templated, and endpoint_filter.sql | -
| = |
- (IntOpt) Maximum number of entities that will be returned in a catalog collection. | -
| = |
- (StrOpt) Catalog template file name for use with the template catalog backend. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Size of executor thread pool. | -
| = |
- (ListOpt) Memcached servers or None for in process cache. | -
| [keystone_authtoken] | -|
| = |
- (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| [oslo_concurrency] | -|
| = |
- (BoolOpt) Enables or disables inter-process locks. | -
| = |
- (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. | -
| Configuration option = Default value | -Description | -
|---|---|
| [cors] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| [credential] | -|
| = |
- (StrOpt) Entrypoint for the credential backend driver in the keystone.credential namespace. | -
| Configuration option = Default value | -Description | -
|---|---|
| [database] | -|
| = |
- (StrOpt) The back end to use for the database. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the database. | -
| = |
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. | -
| = |
- (BoolOpt) Add Python stack traces to SQL as comment strings. | -
| = |
- (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. | -
| = |
- (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. | -
| = |
- (IntOpt) Seconds between retries of a database transaction. | -
| = |
- (IntOpt) Timeout before idle SQL connections are reaped. | -
| = |
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy. | -
| = |
- (IntOpt) Maximum number of SQL connections to keep open in a pool. | -
| = |
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) Minimum number of SQL connections to keep open in a pool. | -
| = |
- (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | -
| = |
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. | -
| = |
- (IntOpt) Interval between retries of opening a SQL connection. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. | -
| = |
- (StrOpt) The file name to use with SQLite. | -
| = |
- (BoolOpt) If True, SQLite uses synchronous mode. | -
| = |
- (BoolOpt) Enable the experimental use of database reconnect on connection lost. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Host to connect to for remote debugger. | -
| = |
- (IntOpt) Port to connect to for remote debugger. | -
| = |
- (BoolOpt) Do not monkey-patch threading system modules. | -
| [audit] | -|
| = |
- (StrOpt) namespace prefix for generated id | -
| Configuration option = Default value | -Description | -
|---|---|
| [domain_config] | -|
| = |
- (IntOpt) TTL (in seconds) to cache domain config data. This has no effect unless domain config caching is enabled. | -
| = |
- (BoolOpt) Toggle for domain config caching. This has no effect unless global caching is enabled. | -
| = |
- (StrOpt) Entrypoint for the domain config backend driver in the keystone.resource.domain_config namespace. | -
| Configuration option = Default value | -Description | -
|---|---|
| [federation] | -|
| = |
- (StrOpt) Value to be used when filtering assertion parameters from the environment. | -
| = |
- (StrOpt) Entrypoint for the federation backend driver in the keystone.federation namespace. | -
| = |
- (StrOpt) A domain name that is reserved to allow federated ephemeral users to have a domain concept. Note that an admin will not be able to create a domain with this name or update an existing domain to this name. You are not advised to change this value unless you really have to. | -
| = |
- (StrOpt) Value to be used to obtain the entity ID of the Identity Provider from the environment (e.g. if using the mod_shib plugin this value is `Shib-Identity-Provider`). | -
| = |
- (StrOpt) Location of Single Sign-On callback handler, will return a token to a trusted dashboard host. | -
| = |
- (MultiStrOpt) A list of trusted dashboard hosts. Before accepting a Single Sign-On request to return a token, the origin host must be a member of the trusted_dashboard list. This configuration option may be repeated for multiple values. For example: trusted_dashboard=http://acme.com/auth/websso trusted_dashboard=http://beta.com/auth/websso | -
| Configuration option = Default value | -Description | -
|---|---|
| [fernet_tokens] | -|
| = |
- (StrOpt) Directory containing Fernet token keys. | -
| = |
- (IntOpt) This controls how many keys are held in rotation by keystone-manage fernet_rotate before they are discarded. The default value of 3 means that keystone will maintain one staged key, one primary key, and one secondary key. Increasing this value means that additional secondary keys will be kept in the rotation. | -
| Configuration option = Default value | -Description | -
|---|---|
| [identity] | -|
| = |
- (IntOpt) Time to cache identity data (in seconds). This has no effect unless global and identity caching are enabled. | -
| = |
- (BoolOpt) Toggle for identity caching. This has no effect unless global caching is enabled. | -
| = |
- (StrOpt) This references the domain to use for all Identity API v2 requests (which are not aware of domains). A domain with this ID will be created for you by keystone-manage db_sync in migration 008. The domain referenced by this ID cannot be deleted on the v3 API, to prevent accidentally breaking the v2 API. There is nothing special about this domain, other than the fact that it must exist to order to maintain support for your v2 clients. | -
| = |
- (StrOpt) Path for Keystone to locate the domain specific identity configuration files if domain_specific_drivers_enabled is set to true. | -
| = |
- (BoolOpt) Extract the domain specific configuration options from the resource backend where they have been stored with the domain data. This feature is disabled by default (in which case the domain specific options will be loaded from files in the domain configuration directory); set to true to enable. | -
| = |
- (BoolOpt) A subset (or all) of domains can have their own identity driver, each with their own partial configuration options, stored in either the resource backend or in a file in a domain configuration directory (depending on the setting of domain_configurations_from_database). Only values specific to the domain need to be specified in this manner. This feature is disabled by default; set to true to enable. | -
| = |
- (StrOpt) Entrypoint for the identity backend driver in the keystone.identity namespace. Supplied drivers are ldap and sql. | -
| = |
- (IntOpt) Maximum number of entities that will be returned in an identity collection. | -
| = |
- (IntOpt) Maximum supported length for user passwords; decrease to improve performance. | -
| Configuration option = Default value | -Description | -
|---|---|
| [kvs] | -|
| = |
- (ListOpt) Extra dogpile.cache backend modules to register with the dogpile.cache library. | -
| = |
- (StrOpt) Prefix for building the configuration dictionary for the KVS region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. | -
| = |
- (IntOpt) Default lock timeout (in seconds) for distributed locking. | -
| = |
- (BoolOpt) Toggle to disable using a key-mangling function to ensure fixed length keys. This is toggle-able for debugging purposes, it is highly recommended to always leave this set to true. | -
| Configuration option = Default value | -Description | -
|---|---|
| [ldap] | -|
| = |
- (StrOpt) The LDAP dereferencing option for queries. The "default" option falls back to using default dereferencing configured by your ldap.conf. | -
| = |
- (BoolOpt) Delete subtrees using the subtree delete control. Only enable this option if your LDAP server supports subtree deletion. | -
| = |
- (IntOpt) End user auth connection lifetime in seconds. | -
| = |
- (IntOpt) End user auth connection pool size. | -
| = |
- (BoolOpt) Override the system's default referral chasing behavior for queries. | -
| = |
- (IntOpt) Sets the LDAP debugging level for LDAP calls. A value of 0 means that debugging is not enabled. This value is a bitmask, consult your LDAP documentation for possible values. | -
| = |
- (StrOpt) DN of the "dummy member" to use when "use_dumb_member" is enabled. | -
| = |
- (ListOpt) Additional attribute mappings for groups. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. | -
| = |
- (BoolOpt) Allow group creation in LDAP backend. | -
| = |
- (BoolOpt) Allow group deletion in LDAP backend. | -
| = |
- (BoolOpt) Allow group update in LDAP backend. | -
| = |
- (ListOpt) List of attributes stripped off the group on update. | -
| = |
- (StrOpt) LDAP attribute mapped to group description. | -
| = |
- (StrOpt) LDAP search filter for groups. | -
| = |
- (StrOpt) LDAP attribute mapped to group id. | -
| = |
- (StrOpt) LDAP attribute mapped to show group membership. | -
| = |
- (StrOpt) LDAP attribute mapped to group name. | -
| = |
- (StrOpt) LDAP objectclass for groups. | -
| = |
- (StrOpt) Search base for groups. Defaults to the suffix value. | -
| = |
- (IntOpt) Maximum results per page; a value of zero ("0") disables paging. | -
| = |
- (StrOpt) Password for the BindDN to query the LDAP server. | -
| = |
- (IntOpt) Connection lifetime in seconds. | -
| = |
- (IntOpt) Connector timeout in seconds. Value -1 indicates indefinite wait for response. | -
| = |
- (FloatOpt) Time span in seconds to wait between two reconnect trials. | -
| = |
- (IntOpt) Maximum count of reconnect trials. | -
| = |
- (IntOpt) Connection pool size. | -
| = |
- (ListOpt) Additional attribute mappings for projects. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. | -
| = |
- (BoolOpt) Allow project creation in LDAP backend. | -
| = |
- (BoolOpt) Allow project deletion in LDAP backend. | -
| = |
- (BoolOpt) Allow project update in LDAP backend. | -
| = |
- (ListOpt) List of attributes stripped off the project on update. | -
| = |
- (StrOpt) LDAP attribute mapped to project description. | -
| = |
- (StrOpt) LDAP attribute mapped to project domain_id. | -
| = |
- (StrOpt) LDAP attribute mapped to project enabled. | -
| = |
- (BoolOpt) If true, Keystone uses an alternative method to determine if a project is enabled or not by checking if they are a member of the "project_enabled_emulation_dn" group. | -
| = |
- (StrOpt) DN of the group entry to hold enabled projects when using enabled emulation. | -
| = |
- (StrOpt) LDAP search filter for projects. | -
| = |
- (StrOpt) LDAP attribute mapped to project id. | -
| = |
- (StrOpt) LDAP attribute mapped to project membership for user. | -
| = |
- (StrOpt) LDAP attribute mapped to project name. | -
| = |
- (StrOpt) LDAP objectclass for projects. | -
| = |
- (StrOpt) Search base for projects. Defaults to the suffix value. | -
| = |
- (StrOpt) The LDAP scope for queries, "one" represents oneLevel/singleLevel and "sub" represents subtree/wholeSubtree options. | -
| = |
- (ListOpt) Additional attribute mappings for roles. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. | -
| = |
- (BoolOpt) Allow role creation in LDAP backend. | -
| = |
- (BoolOpt) Allow role deletion in LDAP backend. | -
| = |
- (BoolOpt) Allow role update in LDAP backend. | -
| = |
- (ListOpt) List of attributes stripped off the role on update. | -
| = |
- (StrOpt) LDAP search filter for roles. | -
| = |
- (StrOpt) LDAP attribute mapped to role id. | -
| = |
- (StrOpt) LDAP attribute mapped to role membership. | -
| = |
- (StrOpt) LDAP attribute mapped to role name. | -
| = |
- (StrOpt) LDAP objectclass for roles. | -
| = |
- (StrOpt) Search base for roles. Defaults to the suffix value. | -
| = |
- (StrOpt) LDAP server suffix | -
| = |
- (StrOpt) CA certificate directory path for communicating with LDAP servers. | -
| = |
- (StrOpt) CA certificate file path for communicating with LDAP servers. | -
| = |
- (StrOpt) Specifies what checks to perform on client certificates in an incoming TLS session. | -
| = |
- (StrOpt) URL for connecting to the LDAP server. | -
| = |
- (BoolOpt) Enable LDAP connection pooling for end user authentication. If use_pool is disabled, then this setting is meaningless and is not used at all. | -
| = |
- (BoolOpt) If true, will add a dummy member to groups. This is required if the objectclass for groups requires the "member" attribute. | -
| = |
- (BoolOpt) Enable LDAP connection pooling. | -
| = |
- (BoolOpt) Enable TLS for communicating with LDAP servers. | -
| = |
- (StrOpt) User BindDN to query the LDAP server. | -
| = |
- (ListOpt) List of additional LDAP attributes used for mapping additional attribute mappings for users. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. | -
| = |
- (BoolOpt) Allow user creation in LDAP backend. | -
| = |
- (BoolOpt) Allow user deletion in LDAP backend. | -
| = |
- (BoolOpt) Allow user updates in LDAP backend. | -
| = |
- (ListOpt) List of attributes stripped off the user on update. | -
| = |
- (StrOpt) LDAP attribute mapped to default_project_id for users. | -
| = |
- (StrOpt) LDAP attribute mapped to user enabled flag. | -
| = |
- (StrOpt) Default value to enable users. This should match an appropriate int value if the LDAP server uses non-boolean (bitmask) values to indicate if a user is enabled or disabled. If this is not set to "True" the typical value is "512". This is typically used when "user_enabled_attribute = userAccountControl". | -
| = |
- (BoolOpt) If true, Keystone uses an alternative method to determine if a user is enabled or not by checking if they are a member of the "user_enabled_emulation_dn" group. | -
| = |
- (StrOpt) DN of the group entry to hold enabled users when using enabled emulation. | -
| = |
- (BoolOpt) Invert the meaning of the boolean enabled values. Some LDAP servers use a boolean lock attribute where "true" means an account is disabled. Setting "user_enabled_invert = true" will allow these lock attributes to be used. This setting will have no effect if "user_enabled_mask" or "user_enabled_emulation" settings are in use. | -
| = |
- (IntOpt) Bitmask integer to indicate the bit that the enabled value is stored in if the LDAP server represents "enabled" as a bit on an integer rather than a boolean. A value of "0" indicates the mask is not used. If this is not set to "0" the typical value is "2". This is typically used when "user_enabled_attribute = userAccountControl". | -
| = |
- (StrOpt) LDAP search filter for users. | -
| = |
- (StrOpt) LDAP attribute mapped to user id. WARNING: must not be a multivalued attribute. | -
| = |
- (StrOpt) LDAP attribute mapped to user email. | -
| = |
- (StrOpt) LDAP attribute mapped to user name. | -
| = |
- (StrOpt) LDAP objectclass for users. | -
| = |
- (StrOpt) LDAP attribute mapped to password. | -
| = |
- (StrOpt) Search base for users. Defaults to the suffix value. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). | -
| = |
- (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Enables or disables fatal status of deprecations. | -
| = |
- (StrOpt) The format for an instance that is passed with the log message. | -
| = |
- (StrOpt) The format for an instance UUID that is passed with the log message. | -
| = |
- (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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). | -
| = |
- (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. | -
| = |
- (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. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) Format string to use for log messages with context. | -
| = |
- (StrOpt) Data to append to log format when level is DEBUG. | -
| = |
- (StrOpt) Format string to use for log messages without context. | -
| = |
- (StrOpt) Prefix each line of exception output with this format. | -
| = |
- (BoolOpt) Enables or disables publication of error events. | -
| = |
- (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. | -
| = |
- (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 Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. | -
| = |
- (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| Configuration option = Default value | -Description | -
|---|---|
| [identity_mapping] | -|
| = |
- (BoolOpt) The format of user and group IDs changed in Juno for backends that do not generate UUIDs (e.g. LDAP), with keystone providing a hash mapping to the underlying attribute in LDAP. By default this mapping is disabled, which ensures that existing IDs will not change. Even when the mapping is enabled by using domain specific drivers, any users and groups from the default domain being handled by LDAP will still not be mapped to ensure their IDs remain backward compatible. Setting this value to False will enable the mapping for even the default LDAP driver. It is only safe to do this if you do not already have assignments for users and groups from the default LDAP domain, and it is acceptable for Keystone to provide the different IDs to clients than it did previously. Typically this means that the only time you can set this value to False is when configuring a fresh installation. | -
| = |
- (StrOpt) Entrypoint for the identity mapping backend driver in the keystone.identity.id_mapping namespace. | -
| = |
- (StrOpt) Entrypoint for the public ID generator for user and group entities in the keystone.identity.id_generator namespace. The Keystone identity mapper only supports generators that produce no more than 64 characters. | -
| Configuration option = Default value | -Description | -
|---|---|
| [memcache] | -|
| = |
- (ListOpt) Memcache servers in the format of "host:port". | -
| = |
- (IntOpt) Timeout in seconds for every call to a server. This is used by the key value store system (e.g. token pooled memcached persistence backend). | -
| Configuration option = Default value | -Description | -
|---|---|
| [oauth1] | -|
| = |
- (IntOpt) Duration (in seconds) for the OAuth Access Token. | -
| = |
- (StrOpt) Entrypoint for hte OAuth backend driver in the keystone.oauth1 namespace. | -
| = |
- (IntOpt) Duration (in seconds) for the OAuth Request Token. | -
| Configuration option = Default value | -Description | -
|---|---|
| [os_inherit] | -|
| = |
- (BoolOpt) role-assignment inheritance to projects from owning domain or from projects higher in the hierarchy can be optionally enabled. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_policy] | -|
| = |
- (StrOpt) Default rule. Enforced when a requested rule is not found. | -
| = |
- (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. | -
| = |
- (StrOpt) The JSON file that defines policies. | -
| [policy] | -|
| = |
- (StrOpt) Entrypoint for the policy backend driver in the keystone.policy namespace. Supplied drivers are rules and sql. | -
| = |
- (IntOpt) Maximum number of entities that will be returned in a policy collection. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_qpid] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (IntOpt) Seconds between connection keepalive heartbeats. | -
| = |
- (StrOpt) Qpid broker hostname. | -
| = |
- (ListOpt) Qpid HA cluster host:port pairs. | -
| = |
- (StrOpt) Password for Qpid connection. | -
| = |
- (IntOpt) Qpid broker port. | -
| = |
- (StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| = |
- (IntOpt) The number of prefetched messages held by receiver. | -
| = |
- (StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| = |
- (BoolOpt) Whether to disable the Nagle algorithm. | -
| = |
- (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. | -
| = |
- (StrOpt) Username for Qpid connection. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_rabbit] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake | -
| = |
- (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. | -
| = |
- (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL | -
| = |
- (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| = |
- (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). | -
| = |
- (StrOpt) SSL cert file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL key file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. | -
| = |
- (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| = |
- (StrOpt) The RabbitMQ broker address where a single node is used. | -
| = |
- (ListOpt) RabbitMQ HA cluster host:port pairs. | -
| = |
- (StrOpt) The RabbitMQ login method. | -
| = |
- (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| = |
- (StrOpt) The RabbitMQ password. | -
| = |
- (IntOpt) The RabbitMQ broker port where a single node is used. | -
| = |
- (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| = |
- (IntOpt) How frequently to retry connecting with RabbitMQ. | -
| = |
- (BoolOpt) Connect over SSL for RabbitMQ. | -
| = |
- (StrOpt) The RabbitMQ userid. | -
| = |
- (StrOpt) The RabbitMQ virtual host. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Host to locate redis. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| [matchmaker_redis] | -|
| = |
- (StrOpt) Host to locate redis. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| Configuration option = Default value | -Description | -
|---|---|
| [revoke] | -|
| = |
- (IntOpt) Time to cache the revocation list and the revocation events (in seconds). This has no effect unless global and token caching are enabled. | -
| = |
- (BoolOpt) Toggle for revocation event caching. This has no effect unless global caching is enabled. | -
| = |
- (StrOpt) Entrypoint for an implementation of the backend for persisting revocation events in the keystone.revoke namespace. Supplied drivers are kvs and sql. | -
| = |
- (IntOpt) This value (calculated in seconds) is added to token expiration before a revocation event may be removed from the backend. | -
| Configuration option = Default value | -Description | -
|---|---|
| [role] | -|
| = |
- (IntOpt) TTL (in seconds) to cache role data. This has no effect unless global caching is enabled. | -
| = |
- (BoolOpt) Toggle for role caching. This has no effect unless global caching is enabled. | -
| = |
- (StrOpt) Entrypoint for the role backend driver in the keystone.role namespace. Supplied drivers are ldap and sql. | -
| = |
- (IntOpt) Maximum number of entities that will be returned in a role collection. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| = |
- (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| = |
- (IntOpt) Size of RPC connection pool. | -
| = |
- (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| = |
- (IntOpt) Seconds to wait for a response from a call. | -
| [oslo_messaging_amqp] | -|
| = |
- (BoolOpt) Accept clients using either SSL or plain TCP | -
| = |
- (StrOpt) address prefix used when broadcasting to all servers | -
| = |
- (StrOpt) Name for the AMQP container | -
| = |
- (StrOpt) address prefix when sending to any server in group | -
| = |
- (IntOpt) Timeout for inactive connections (in seconds) | -
| = |
- (StrOpt) Password for message broker authentication | -
| = |
- (StrOpt) Path to directory that contains the SASL configuration | -
| = |
- (StrOpt) Name of configuration file (without .conf suffix) | -
| = |
- (StrOpt) Space separated list of acceptable SASL mechanisms | -
| = |
- (StrOpt) address prefix used when sending to a specific server | -
| = |
- (StrOpt) CA certificate PEM file to verify server certificate | -
| = |
- (StrOpt) Identifying certificate PEM file to present to clients | -
| = |
- (StrOpt) Private key PEM file used to sign cert_file certificate | -
| = |
- (StrOpt) Password for decrypting ssl_key_file (if encrypted) | -
| = |
- (BoolOpt) Debug: dump AMQP frames to stdout | -
| = |
- (StrOpt) User name for message broker authentication | -
| Configuration option = Default value | -Description | -
|---|---|
| [saml] | -|
| = |
- (IntOpt) Default TTL, in seconds, for any generated SAML assertion created by Keystone. | -
| = |
- (StrOpt) Path of the certfile for SAML signing. For non-production environments, you may be interested in using `keystone-manage pki_setup` to generate self-signed certificates. Note, the path cannot contain a comma. | -
| = |
- (StrOpt) Company of contact person. | -
| = |
- (StrOpt) Email address of contact person. | -
| = |
- (StrOpt) Given name of contact person | -
| = |
- (StrOpt) Surname of contact person. | -
| = |
- (StrOpt) Telephone number of contact person. | -
| = |
- (StrOpt) The contact type describing the main point of contact for the identity provider. | -
| = |
- (StrOpt) Entity ID value for unique Identity Provider identification. Usually FQDN is set with a suffix. A value is required to generate IDP Metadata. For example: https://keystone.example.com/v3/OS-FEDERATION/saml2/idp | -
| = |
- (StrOpt) Language used by the organization. | -
| = |
- (StrOpt) Path to the Identity Provider Metadata file. This file should be generated with the keystone-manage saml_idp_metadata command. | -
| = |
- (StrOpt) Organization name to be displayed. | -
| = |
- (StrOpt) Organization name the installation belongs to. | -
| = |
- (StrOpt) URL of the organization. | -
| = |
- (StrOpt) Identity Provider Single-Sign-On service value, required in the Identity Provider's metadata. A value is required to generate IDP Metadata. For example: https://keystone.example.com/v3/OS-FEDERATION/saml2/sso | -
| = |
- (StrOpt) Path of the keyfile for SAML signing. Note, the path cannot contain a comma. | -
| = |
- (StrOpt) The prefix to use for the RelayState SAML attribute, used when generating ECP wrapped assertions. | -
| = |
- (StrOpt) Binary to be called for XML signing. Install the appropriate package, specify absolute path or adjust your PATH environment variable if the binary cannot be found. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) The value passed as the keyword "rounds" to passlib's encrypt method. | -
| Configuration option = Default value | -Description | -
|---|---|
| [token] | -|
| = |
- (BoolOpt) Allow rescoping of scoped token. Setting allow_rescoped_scoped_token to false prevents a user from exchanging a scoped token for any other token. | -
| = |
- (ListOpt) External auth mechanisms that should add bind information to token, e.g., kerberos,x509. | -
| = |
- (IntOpt) Time to cache tokens (in seconds). This has no effect unless global and token caching are enabled. | -
| = |
- (BoolOpt) Toggle for token system caching. This has no effect unless global caching is enabled. | -
| = |
- (StrOpt) Entrypoint for the token persistence backend driver in the keystone.token.persistence namespace. Supplied drivers are kvs, memcache, memcache_pool, and sql. | -
| = |
- (StrOpt) Enforcement policy on tokens presented to Keystone with bind information. One of disabled, permissive, strict, required or a specifically required bind mode, e.g., kerberos or x509 to require binding to that authentication. | -
| = |
- (IntOpt) Amount of time a token should remain valid (in seconds). | -
| = |
- (StrOpt) The hash algorithm to use for PKI tokens. This can be set to any algorithm that hashlib supports. WARNING: Before changing this value, the auth_token middleware must be configured with the hash_algorithms, otherwise token revocation will not be processed correctly. | -
| = |
- (StrOpt) Controls the token construction, validation, and revocation operations. Entrypoint in the keystone.token.provider namespace. Core providers are [fernet|pkiz|pki|uuid]. | -
| = |
- (BoolOpt) Revoke token by token identifier. Setting revoke_by_id to true enables various forms of enumerating tokens, e.g. `list tokens for user`. These enumerations are processed to determine the list of tokens to revoke. Only disable if you are switching to using the Revoke extension with a backend other than KVS, which stores events in memory. | -
| Configuration option = Default value | -Description | -
|---|---|
| [tokenless_auth] | -|
| = |
- (StrOpt) The issuer attribute that is served as an IdP ID for the X.509 tokenless authorization along with the protocol to look up its corresponding mapping. It is the environment variable in the WSGI environment that references to the issuer of the client certificate. | -
| = |
- (StrOpt) The protocol name for the X.509 tokenless authorization along with the option issuer_attribute below can look up its corresponding mapping. | -
| = |
- (MultiStrOpt) The list of trusted issuers to further filter the certificates that are allowed to participate in the X.509 tokenless authorization. If the option is absent then no certificates will be allowed. The naming format for the attributes of a Distinguished Name(DN) must be separated by a comma and contain no spaces. This configuration option may be repeated for multiple values. For example: trusted_issuer=CN=john,OU=keystone,O=openstack trusted_issuer=CN=mary,OU=eng,O=abc | -
| Configuration option = Default value | -Description | -
|---|---|
| [trust] | -|
| = |
- (BoolOpt) Enable redelegation feature. | -
| = |
- (StrOpt) Entrypoint for the trust backend driver in the keystone.trust namespace. | -
| = |
- (BoolOpt) Delegation and impersonation features can be optionally disabled. | -
| = |
- (IntOpt) Maximum depth of trust redelegation. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| = |
- (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| = |
- (StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| = |
- (IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| = |
- (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. | -
| = |
- (StrOpt) Directory for holding IPC sockets. | -
| = |
- (StrOpt) MatchMaker driver. | -
| = |
- (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| = |
- (BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| = |
- (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop | -
| = |
- (ListOpt) AMQP topic used for OpenStack notifications. | -
| = |
- (StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. | -
| = |
- (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) File name for the paste.deploy config for manila-api. | -
| = |
- (BoolOpt) Whether to rate limit the API. | -
| = |
- (BoolOpt) Deploy v1 of the Manila API. This option is deprecated, is not used, and will be removed in a future release. | -
| = |
- (BoolOpt) Deploy v2 of the Manila API. This option is deprecated, is not used, and will be removed in a future release. | -
| = |
- (IntOpt) Maximum line size of message headers to be accepted. Option max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). | -
| = |
- (IntOpt) The maximum number of items returned in a single response from a collection resource. | -
| = |
- (StrOpt) Base URL to be presented to users in links to the Share API | -
| = |
- (ListOpt) Specify list of extensions to load when using osapi_share_extension option with manila.api.contrib.select_extensions. | -
| = |
- (MultiStrOpt) The osapi share extension to load. | -
| = |
- (StrOpt) IP address for OpenStack Share API to listen on. | -
| = |
- (PortOpt) Port for OpenStack Share API to listen on. | -
| = |
- (IntOpt) Number of workers for OpenStack Share API service. | -
| = |
- (StrOpt) The full class name of the share API class to use. | -
| = |
- (StrOpt) The full class name of the Volume API class to use. | -
| = |
- (StrOpt) Volume name template. | -
| = |
- (StrOpt) Volume snapshot name template. | -
| [oslo_middleware] | -|
| = |
- (IntOpt) The maximum body size for each request, in bytes. | -
| = |
- (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] | -|
| = |
- (StrOpt) Default rule. Enforced when a requested rule is not found. | -
| = |
- (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. | -
| = |
- (StrOpt) The JSON file that defines policies. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated. | -
| Configuration option = Default value | -Description | -
|---|---|
| [keystone_authtoken] | -|
| = |
- (StrOpt) Service user password. | -
| = |
- (StrOpt) Service tenant name. | -
| = |
- (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | -
| = |
- (StrOpt) Service username. | -
| = |
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | -
| = |
- (Opt) Config Section from which to load plugin specific options | -
| = |
- (Opt) Authentication type to load | -
| = |
- (StrOpt) Complete public Identity API endpoint. | -
| = |
- (StrOpt) API version of the admin Identity API endpoint. | -
| = |
- (StrOpt) Env key for the swift cache. | -
| = |
- (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. | -
| = |
- (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. | -
| = |
- (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| = |
- (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | -
| = |
- (IntOpt) Request timeout value for communicating with Identity API server. | -
| = |
- (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| = |
- (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | -
| = |
- (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. | -
| = |
- (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. | -
| = |
- (IntOpt) (Optional) Maximum total number of open connections to every memcached server. | -
| = |
- (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. | -
| = |
- (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. | -
| = |
- (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. | -
| = |
- (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. | -
| = |
- (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. | -
| = |
- (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| = |
- (StrOpt) The region in which the identity server can be found. | -
| = |
- (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| = |
- (StrOpt) Directory used to cache files related to PKI tokens. | -
| = |
- (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) CA certificate file to use to verify connecting clients. | -
| = |
- (StrOpt) Certificate file to use when starting the server securely. | -
| = |
- (StrOpt) Private key file to use when starting the server securely. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Timeout for client connections socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. | -
| = |
- (StrOpt) The full class name of the Compute API class to use. | -
| = |
- (BoolOpt) Services to be added to the available pool on create. | -
| = |
- (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. | -
| = |
- (FloatOpt) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 is invalid. | -
| = |
- (ListOpt) Memcached servers or None for in process cache. | -
| = |
- (BoolOpt) Whether to log monkey patching. | -
| = |
- (ListOpt) List of modules or decorators to monkey patch. | -
| = |
- (StrOpt) IP address of this host. | -
| = |
- (IntOpt) Number of times to attempt to run flakey shell commands. | -
| = |
- (IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) | -
| = |
- (FloatOpt) Interval in seconds between execution of periodic hooks. Used when option 'enable_periodic_hooks' is set to True. Default is 300. | -
| = |
- (IntOpt) Seconds between running periodic tasks. | -
| = |
- (IntOpt) Seconds between nodes reporting state to datastore. | -
| = |
- (IntOpt) The percentage of backend capacity reserved. | -
| = |
- (StrOpt) Path to the rootwrap configuration file to use for running commands as root. | -
| = |
- (IntOpt) Maximum time since last check-in for up service. | -
| = |
- (StrOpt) Path to smb config. | -
| = |
- (IntOpt) Timeout before idle SQL connections are reaped. | -
| = |
- (IntOpt) Maximum database connection retries during startup. (setting -1 implies an infinite retry count). | -
| = |
- (IntOpt) Interval between retries of opening a SQL connection. | -
| = |
- (StrOpt) File name of clean sqlite database. | -
| = |
- (StrOpt) The filename to use with sqlite. | -
| = |
- (BoolOpt) If passed, use synchronous mode for sqlite. | -
| = |
- (StrOpt) Top-level directory for maintaining manila's state. | -
| = |
- (StrOpt) Availability zone of this node. | -
| = |
- (BoolOpt) Sets the value of TCP_KEEPALIVE (True/False) for each server socket. | -
| = |
- (IntOpt) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X. | -
| = |
- (IntOpt) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X. | -
| = |
- (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. | -
| = |
- (IntOpt) Count of reservations until usage is refreshed. | -
| = |
- (BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. | -
| = |
- (BoolOpt) If False, closes the client socket connection explicitly. Setting it to True to maintain backward compatibility. Recommended setting is set it to False. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Identity service URL. | -
| = |
- (StrOpt) Nova admin password. | -
| = |
- (StrOpt) Nova admin tenant name. | -
| = |
- (StrOpt) Nova admin username. | -
| = |
- (BoolOpt) Allow to perform insecure SSL requests to nova. | -
| = |
- (StrOpt) Version of Nova API to be used. | -
| = |
- (StrOpt) Location of CA certificates file to use for nova client requests. | -
| = |
- (StrOpt) Same as nova_catalog_info, but for admin endpoint. | -
| = |
- (StrOpt) Info to match when looking for nova in the service catalog. Format is separated values of the form: <service_type>:<service_name>:<endpoint_type> | -
| = |
- (StrOpt) Region name of this node. | -
| Configuration option = Default value | -Description | -
|---|---|
| [cors] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The backend to use for database. | -
| = |
- (StrOpt) Driver to use for database access. | -
| [database] | -|
| = |
- (StrOpt) The back end to use for the database. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the database. | -
| = |
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. | -
| = |
- (BoolOpt) Add Python stack traces to SQL as comment strings. | -
| = |
- (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. | -
| = |
- (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. | -
| = |
- (IntOpt) Seconds between retries of a database transaction. | -
| = |
- (IntOpt) Timeout before idle SQL connections are reaped. | -
| = |
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy. | -
| = |
- (IntOpt) Maximum number of SQL connections to keep open in a pool. | -
| = |
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) Minimum number of SQL connections to keep open in a pool. | -
| = |
- (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | -
| = |
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. | -
| = |
- (IntOpt) Interval between retries of opening a SQL connection. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. | -
| = |
- (StrOpt) The file name to use with SQLite. | -
| = |
- (BoolOpt) If True, SQLite uses synchronous mode. | -
| = |
- (BoolOpt) Enable the experimental use of database reconnect on connection lost. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) User name for the EMC server. | -
| = |
- (StrOpt) Password for the EMC server. | -
| = |
- (StrOpt) EMC pool name. | -
| = |
- (StrOpt) The root directory where shares will be located. | -
| = |
- (StrOpt) EMC server hostname or IP address. | -
| = |
- (StrOpt) Container of share servers. | -
| = |
- (PortOpt) Port number for the EMC server. | -
| = |
- (BoolOpt) Use secure connection to server. | -
| = |
- (StrOpt) Share backend. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Directory where Ganesha config files are stored. | -
| = |
- (StrOpt) Path to main Ganesha config file. | -
| = |
- (StrOpt) Location of Ganesha database file. (Ganesha module only.) | -
| = |
- (StrOpt) Path to directory containing Ganesha export configuration. (Ganesha module only.) | -
| = |
- (StrOpt) Path to directory containing Ganesha export block templates. (Ganesha module only.) | -
| = |
- (StrOpt) Options to use when exporting a share using ganesha NFS server. Note that these defaults can be overridden when a share is created by passing metadata with key name export_options. Also note the complete set of default ganesha export options is specified in ganesha_utils. (GPFS only.) | -
| = |
- (StrOpt) Name of the ganesha nfs service. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Identity service URL. | -
| = |
- (StrOpt) Cinder admin password. | -
| = |
- (StrOpt) Cinder admin tenant name. | -
| = |
- (StrOpt) Cinder admin username. | -
| = |
- (BoolOpt) Allow to perform insecure SSL requests to cinder. | -
| = |
- (StrOpt) Location of CA certificates file to use for cinder client requests. | -
| = |
- (StrOpt) Info to match when looking for cinder in the service catalog. Format is separated values of the form: <service_type>:<service_name>:<endpoint_type> | -
| = |
- (BoolOpt) Allow attaching between instances and volumes in different availability zones. | -
| = |
- (IntOpt) Number of cinderclient retries on failed HTTP calls. | -
| = |
- (StrOpt) Name or id of cinder volume type which will be used for all volumes created by driver. | -
| = |
- (BoolOpt) Attach share server directly to share network. Used only with Neutron. | -
| = |
- (BoolOpt) There are two possible approaches for share drivers in Manila. First is when share driver is able to handle share-servers and second when not. Drivers can support either both or only one of these approaches. So, set this opt to True if share driver is able to handle share servers and it is desired mode else set False. It is set to None by default to make this choice intentional. | -
| = |
- (StrOpt) Vif driver. Used only with Neutron. | -
| = |
- (StrOpt) Keypair name that will be created and used for service instances. | -
| = |
- (IntOpt) Maximum time to wait for attaching cinder volume. | -
| = |
- (IntOpt) Maximum time in seconds to wait for creating service instance. | -
| = |
- (IntOpt) Maximum time to wait for creating cinder volume. | -
| = |
- (IntOpt) Maximum time to wait for extending cinder volume. | -
| = |
- (StrOpt) Name of Open vSwitch bridge to use. | -
| = |
- (StrOpt) Path to host's private key. | -
| = |
- (StrOpt) Path to hosts public key. | -
| = |
- (StrOpt) Name of image in Glance, that will be used for service instance creation. | -
| = |
- (IntOpt) ID of flavor, that will be used for service instance creation. | -
| = |
- (StrOpt) Name or ID of service instance in Nova to use for share exports. Used only when share servers handling is disabled. | -
| = |
- (StrOpt) Name of service instance. | -
| = |
- (StrOpt) Allowed values are ['nova', 'neutron']. | -
| = |
- (StrOpt) Password for service instance user. | -
| = |
- (StrOpt) Security group name, that will be used for service instance creation. | -
| = |
- (StrOpt) Path to SMB config in service instance. | -
| = |
- (StrOpt) User in service instance that will be used for authentication. | -
| = |
- (StrOpt) Can be either name of network that is used by service instance within Nova to get IP address or IP address itself for managing shares there. Used only when share servers handling is disabled. | -
| = |
- (StrOpt) CIDR of manila service network. Used only with Neutron. | -
| = |
- (IntOpt) This mask is used for dividing service network into subnets, IP capacity of subnet with this mask directly defines possible amount of created service VMs per tenant's subnet. Used only with Neutron. | -
| = |
- (StrOpt) Name of manila service network. Used only with Neutron. | -
| = |
- (ListOpt) Specify list of share export helpers. | -
| = |
- (StrOpt) Parent path in service instance where shares will be mounted. | -
| = |
- (StrOpt) Filesystem type of the share volume. | -
| = |
- (StrOpt) Can be either name of network that is used by service instance within Nova to get IP address or IP address itself for exporting shares. Used only when share servers handling is disabled. | -
| = |
- (StrOpt) Volume name template. | -
| = |
- (StrOpt) Volume snapshot name template. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Remote Ganesha server node's IP address. | -
| = |
- (StrOpt) Remote Ganesha server node's login password. This is not required if 'glusterfs_path_to_private_key' is configured. | -
| = |
- (StrOpt) Remote Ganesha server node's username. | -
| = |
- (StrOpt) Base directory containing mount points for Gluster volumes. | -
| = |
- (StrOpt) Type of NFS server that mediate access to the Gluster volumes (Gluster or Ganesha). | -
| = |
- (StrOpt) Path of Manila host's private SSH key file. | -
| = |
- (StrOpt) Remote GlusterFS server node's login password. This is not required if 'glusterfs_path_to_private_key' is configured. | -
| = |
- (ListOpt) List of GlusterFS servers that can be used to create shares. Each GlusterFS server should be of the form [remoteuser@]<volserver>, and they are assumed to belong to distinct Gluster clusters. | -
| = |
- (StrOpt) Specifies GlusterFS share layout, that is, the method of associating backing GlusterFS resources to shares. | -
| = |
- (StrOpt) Specifies the GlusterFS volume to be mounted on the Manila host. It is of the form [remoteuser@]<volserver>:<volid>. | -
| = |
- (StrOpt) Regular expression template used to filter GlusterFS volumes for share creation. The regex template can optionally (ie. with support of the GlusterFS backend) contain the #{size} parameter which matches an integer (sequence of digits) in which case the value shall be interpreted as size of the volume in GB. Examples: "manila-share-volume-\d+$", "manila-share-volume-#{size}G-\d+$"; with matching volume names, respectively: "manila-share-volume-12", "manila-share-volume-3G-13". In latter example, the number that matches "#{size}", that is, 3, is an indication that the size of volume is 3G. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Base folder where exported shares are located. | -
| = |
- (ListOpt) A list of the fully qualified NFS server names that make up the OpenStack Manila configuration. | -
| = |
- (StrOpt) NFS Server type. Valid choices are "KNFS" (kernel NFS) or "GNFS" (Ganesha NFS). | -
| = |
- (StrOpt) IP to be added to GPFS export string. | -
| = |
- (ListOpt) Specify list of share export helpers. | -
| = |
- (StrOpt) GPFS server SSH login name. | -
| = |
- (StrOpt) GPFS server SSH login password. The password is not needed, if 'gpfs_ssh_private_key' is configured. | -
| = |
- (PortOpt) GPFS server SSH port. | -
| = |
- (StrOpt) Path to GPFS server SSH private key for login. | -
| = |
- (StrOpt) Options to use when exporting a share using kernel NFS server. Note that these defaults can be overridden when a share is created by passing metadata with key name export_options. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The IP of the HDFS namenode. | -
| = |
- (PortOpt) The port of HDFS namenode service. | -
| = |
- (StrOpt) HDFS namenode ssh login name. | -
| = |
- (PortOpt) HDFS namenode SSH port. | -
| = |
- (StrOpt) Path to HDFS namenode SSH private key for login. | -
| = |
- (StrOpt) HDFS namenode SSH login password, This parameter is not necessary, if 'hdfs_ssh_private_key' is configured. | -
| Configuration option = Default value | -Description | -
|---|---|
| [hnas1] | -|
| = |
- (StrOpt) The IP of the clusters admin node. Only set in HNAS multinode clusters. | -
| = |
- (StrOpt) Specify which EVS this backend is assigned to. | -
| = |
- (StrOpt) Specify IP for mounting shares. | -
| = |
- (StrOpt) Specify file-system name for creating shares. | -
| = |
- (StrOpt) HNAS management interface IP for communication between Manila controller and HNAS. | -
| = |
- (StrOpt) HNAS user password. Required only if private key is not provided. | -
| = |
- (StrOpt) RSA/DSA private key value used to connect into HNAS. Required only if password is not provided. | -
| = |
- (IntOpt) The time (in seconds) to wait for stalled HNAS jobs before aborting. | -
| = |
- (StrOpt) HNAS username Base64 String in order to perform tasks such as create file-systems and network interfaces. | -
| = |
- (StrOpt) The backend name for a given driver implementation. | -
| = |
- (StrOpt) Driver to use for share creation. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1 | -
| = |
- (BoolOpt) Enable HTTP debugging to 3PAR | -
| = |
- (StrOpt) The File Provisioning Group (FPG) to use | -
| = |
- (BoolOpt) Use one filestore per share | -
| = |
- (StrOpt) 3PAR password for the user specified in hpe3par_username | -
| = |
- (StrOpt) IP address of SAN controller | -
| = |
- (StrOpt) Username for SAN controller | -
| = |
- (StrOpt) Password for SAN controller | -
| = |
- (PortOpt) SSH port to use with SAN | -
| = |
- (StrOpt) The IP address for shares not using a share server | -
| = |
- (StrOpt) 3PAR username with the 'edit' role | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The configuration file for the Manila Huawei driver. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). | -
| = |
- (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Enables or disables fatal status of deprecations. | -
| = |
- (BoolOpt) Whether to make exception message format errors fatal. | -
| = |
- (StrOpt) The format for an instance that is passed with the log message. | -
| = |
- (StrOpt) The format for an instance UUID that is passed with the log message. | -
| = |
- (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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). | -
| = |
- (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. | -
| = |
- (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. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) Format string to use for log messages with context. | -
| = |
- (StrOpt) Data to append to log format when level is DEBUG. | -
| = |
- (StrOpt) Format string to use for log messages without context. | -
| = |
- (StrOpt) Prefix each line of exception output with this format. | -
| = |
- (StrOpt) Format string for user_identity field of the logging_context_format_string | -
| = |
- (BoolOpt) Enables or disables publication of error events. | -
| = |
- (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. | -
| = |
- (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 Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. | -
| = |
- (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Pattern for searching available aggregates for provisioning. | -
| = |
- (StrOpt) Logical interface (LIF) name template | -
| = |
- (StrOpt) Administrative user account name used to access the storage system. | -
| = |
- (StrOpt) Password for the administrative user account specified in the netapp_login option. | -
| = |
- (StrOpt) Pattern for overriding the selection of network ports on which to create Vserver LIFs. | -
| = |
- (StrOpt) Root volume name. | -
| = |
- (StrOpt) Name of aggregate to create Vserver root volumes on. This option only applies when the option driver_handles_share_servers is set to True. | -
| = |
- (StrOpt) The hostname (or IP address) for the storage system. | -
| = |
- (PortOpt) 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. | -
| = |
- (StrOpt) The storage family type used on the storage system; valid values include ontap_cluster for using clustered Data ONTAP. | -
| = |
- (StrOpt) Comma-separated list of options that control which trace info is written to the debug logs. Values include method and api. | -
| = |
- (StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https. | -
| = |
- (StrOpt) NetApp volume name template. | -
| = |
- (StrOpt) Name template to use for new Vserver. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_qpid] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (IntOpt) Seconds between connection keepalive heartbeats. | -
| = |
- (StrOpt) Qpid broker hostname. | -
| = |
- (ListOpt) Qpid HA cluster host:port pairs. | -
| = |
- (StrOpt) Password for Qpid connection. | -
| = |
- (IntOpt) Qpid broker port. | -
| = |
- (StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| = |
- (IntOpt) The number of prefetched messages held by receiver. | -
| = |
- (StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| = |
- (BoolOpt) Whether to disable the Nagle algorithm. | -
| = |
- (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. | -
| = |
- (StrOpt) Username for Qpid connection. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The X.509 CA file to verify the server cert. | -
| = |
- (StrOpt) Password for Quobyte API server | -
| = |
- (StrOpt) URL of the Quobyte API server (http or https) | -
| = |
- (StrOpt) Username for Quobyte API server. | -
| = |
- (StrOpt) Default owning group for new volumes. | -
| = |
- (StrOpt) Default owning user for new volumes. | -
| = |
- (BoolOpt) Actually deletes shares (vs. unexport) | -
| = |
- (StrOpt) Name of volume configuration used for new shares. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Number of seconds between subsequent usage refreshes. | -
| = |
- (IntOpt) Maximum number of volume gigabytes to allow per host. | -
| = |
- (StrOpt) Default driver to use for quota checks. | -
| = |
- (IntOpt) Number of share gigabytes allowed per project. | -
| = |
- (IntOpt) Number of share-networks allowed per project. | -
| = |
- (IntOpt) Number of shares allowed per project. | -
| = |
- (IntOpt) Number of snapshot gigabytes allowed per project. | -
| = |
- (IntOpt) Number of share snapshots allowed per project. | -
| = |
- (IntOpt) Number of seconds until a reservation expires. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_rabbit] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake | -
| = |
- (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. | -
| = |
- (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL | -
| = |
- (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| = |
- (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). | -
| = |
- (StrOpt) SSL cert file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL key file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. | -
| = |
- (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| = |
- (StrOpt) The RabbitMQ broker address where a single node is used. | -
| = |
- (ListOpt) RabbitMQ HA cluster host:port pairs. | -
| = |
- (StrOpt) The RabbitMQ login method. | -
| = |
- (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| = |
- (StrOpt) The RabbitMQ password. | -
| = |
- (IntOpt) The RabbitMQ broker port where a single node is used. | -
| = |
- (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| = |
- (IntOpt) How frequently to retry connecting with RabbitMQ. | -
| = |
- (BoolOpt) Connect over SSL for RabbitMQ. | -
| = |
- (StrOpt) The RabbitMQ userid. | -
| = |
- (StrOpt) The RabbitMQ virtual host. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| [matchmaker_redis] | -|
| = |
- (StrOpt) Host to locate redis. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| = |
- (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| = |
- (IntOpt) Size of RPC connection pool. | -
| = |
- (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| = |
- (IntOpt) Seconds to wait for a response from a call. | -
| = |
- (StrOpt) The topic share nodes listen on. | -
| [oslo_concurrency] | -|
| = |
- (BoolOpt) Enables or disables inter-process locks. | -
| = |
- (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. | -
| [oslo_messaging_amqp] | -|
| = |
- (BoolOpt) Accept clients using either SSL or plain TCP | -
| = |
- (StrOpt) address prefix used when broadcasting to all servers | -
| = |
- (StrOpt) Name for the AMQP container | -
| = |
- (StrOpt) address prefix when sending to any server in group | -
| = |
- (IntOpt) Timeout for inactive connections (in seconds) | -
| = |
- (StrOpt) Password for message broker authentication | -
| = |
- (StrOpt) Path to directory that contains the SASL configuration | -
| = |
- (StrOpt) Name of configuration file (without .conf suffix) | -
| = |
- (StrOpt) Space separated list of acceptable SASL mechanisms | -
| = |
- (StrOpt) address prefix used when sending to a specific server | -
| = |
- (StrOpt) CA certificate PEM file to verify server certificate | -
| = |
- (StrOpt) Identifying certificate PEM file to present to clients | -
| = |
- (StrOpt) Private key PEM file used to sign cert_file certificate | -
| = |
- (StrOpt) Password for decrypting ssl_key_file (if encrypted) | -
| = |
- (BoolOpt) Debug: dump AMQP frames to stdout | -
| = |
- (StrOpt) User name for message broker authentication | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Backend server SSH connection timeout. | -
| = |
- (IntOpt) Maximum number of connections in the SSH pool. | -
| = |
- (IntOpt) Minimum number of connections in the SSH pool. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (FloatOpt) Multiplier used for weighing share capacity. Negative numbers mean to stack vs spread. | -
| = |
- (FloatOpt) Multiplier used for weighing pools which have existing share servers. Negative numbers mean to spread vs stack. | -
| = |
- (ListOpt) Which filter class names to use for filtering hosts when not specified in the request. | -
| = |
- (ListOpt) Which weigher class names to use for weighing hosts. | -
| = |
- (StrOpt) Default scheduler driver to use. | -
| = |
- (StrOpt) The scheduler host manager class to use. | -
| = |
- (StrOpt) Absolute path to scheduler configuration JSON file. | -
| = |
- (StrOpt) Full class name for the scheduler manager. | -
| = |
- (IntOpt) Maximum number of attempts to schedule a share. | -
| = |
- (StrOpt) The topic scheduler nodes listen on. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) If set to True, then Manila will delete all share servers which were unused more than specified time .If set to False - automatic deletion of share servers will be disabled. | -
| = |
- (IntOpt) Number of backlog requests to configure the socket with. | -
| = |
- (StrOpt) Default share type to use. | -
| = |
- (BoolOpt) Whether share servers will be deleted on deletion of the last share. | -
| = |
- (BoolOpt) There are two possible approaches for share drivers in Manila. First is when share driver is able to handle share-servers and second when not. Drivers can support either both or only one of these approaches. So, set this opt to True if share driver is able to handle share servers and it is desired mode else set False. It is set to None by default to make this choice intentional. | -
| = |
- (BoolOpt) Whether to enable periodic hooks or not. | -
| = |
- (BoolOpt) Whether to enable post hooks or not. | -
| = |
- (BoolOpt) Whether to enable pre hooks or not. | -
| = |
- (ListOpt) A list of share backend names to use. These backend names should be backed by a unique [CONFIG] group with its options. | -
| = |
- (ListOpt) Specify list of protocols to be allowed for share creation. Available values are '('NFS', 'CIFS', 'GLUSTERFS', 'HDFS')' | -
| = |
- (IntOpt) Size of executor thread pool. | -
| = |
- (ListOpt) Driver(s) to perform some additional actions before and after share driver actions and on a periodic basis. Default is []. | -
| = |
- (IntOpt) Timeout for creating and deleting share instances when performing share migration (seconds). | -
| = |
- (StrOpt) The IP of the node responsible for copying data during migration, such as the data copy service node, reachable by the backend. | -
| = |
- (ListOpt) List of files and folders to be ignored when migrating shares. Items should be names (not including any path). | -
| = |
- (StrOpt) Backend IP in admin network to use for mounting shares during migration. | -
| = |
- (StrOpt) The command for mounting shares for this backend. Must specifythe executable and all necessary parameters for the protocol supported. It is advisable to separate protocols per backend. | -
| = |
- (BoolOpt) Specify whether read only access mode is supported in thisbackend. | -
| = |
- (StrOpt) Temporary path to create and mount shares during migration. | -
| = |
- (IntOpt) Time to wait for access rules to be allowed/denied on backends when migrating shares using generic approach (seconds). | -
| = |
- (StrOpt) Name of the configuration group in the Manila conf file to look for network config options.If not set, the share backend's config group will be used.If an option is not found within provided group, then'DEFAULT' group will be used for search of option. | -
| = |
- (StrOpt) Deprecated: command to use for running commands as root. | -
| = |
- (StrOpt) Full class name for the share manager. | -
| = |
- (StrOpt) Template string to be used to generate share names. | -
| = |
- (StrOpt) Template string to be used to generate share snapshot names. | -
| = |
- (StrOpt) Time period to generate share usages for. Time period must be hour, day, month or year. | -
| = |
- (BoolOpt) Whether to suppress post hook errors (allow driver's results to pass through) or not. | -
| = |
- (BoolOpt) Whether to suppress pre hook errors (allow driver perform actions) or not. | -
| = |
- (BoolOpt) If set to True, then manila will deny access and remove all access rules on share unmanage.If set to False - nothing will be changed. | -
| = |
- (IntOpt) Unallocated share servers reclamation time interval (minutes). Minimum value is 10 minutes, maximum is 60 minutes. The reclamation function is run every 10 minutes and delete share servers which were unused more than unused_share_server_cleanup_interval option defines. This value reflects the shortest time Manila will wait for a share server to go unutilized before deleting it. | -
| = |
- (BoolOpt) If set to False, then share creation from snapshot will be performed on the same host. If set to True, then scheduling step will be used. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Path to the x509 certificate key. | -
| = |
- (StrOpt) Path to the x509 certificate used for accessing the serviceinstance. | -
| = |
- (IntOpt) WinRM connection timeout. | -
| = |
- (IntOpt) WinRM operation timeout. | -
| = |
- (IntOpt) WinRM retry count. | -
| = |
- (IntOpt) WinRM retry interval in seconds | -
| = |
- (BoolOpt) Use x509 certificates in order to authenticate to theservice instance. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| = |
- (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| = |
- (IntOpt) Number of retries to find free port number before fail with ZMQBindError. | -
| = |
- (StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| = |
- (IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| = |
- (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. | -
| = |
- (StrOpt) Directory for holding IPC sockets. | -
| = |
- (StrOpt) MatchMaker driver. | -
| = |
- (IntOpt) Maximal port number for random ports range. | -
| = |
- (IntOpt) Minimal port number for random ports range. | -
| = |
- (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| = |
- (BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) ZFSSA management authorized userpassword. | -
| = |
- (StrOpt) ZFSSA management authorized username. | -
| = |
- (StrOpt) IP address for data. | -
| = |
- (StrOpt) ZFSSA management IP address. | -
| = |
- (StrOpt) Controls checksum used for data blocks. | -
| = |
- (StrOpt) Data compression-off, lzjb, gzip-2, gzip, gzip-9. | -
| = |
- (StrOpt) Controls behavior when servicing synchronous writes. | -
| = |
- (StrOpt) Location of project in ZFS/SA. | -
| = |
- (StrOpt) Controls whether a share quota includes snapshot. | -
| = |
- (StrOpt) Controls whether file ownership can be changed. | -
| = |
- (StrOpt) Controls whether the share is scanned for viruses. | -
| = |
- (StrOpt) ZFSSA storage pool name. | -
| = |
- (StrOpt) ZFSSA project name. | -
| = |
- (StrOpt) REST connection timeout (in seconds). | -
| Extra spec | -Type | -Description | -
|---|---|---|
| String | -Limit the candidate volume list based on one of the following raid types: |
- |
| String | -Limit the candidate volume list based on one of the following disk types: |
- |
| String | -Specify the name of a QoS policy group, which defines measurable Service Level Objectives, that should be applied to the OpenStack Block Storage volume at the time of volume creation. Ensure that the QoS policy group object within Data ONTAP should be defined before an OpenStack Block Storage volume is created, and that the QoS policy group is not associated with the destination FlexVol volume. | -|
| Boolean | -Limit the candidate volume list to only the ones that are mirrored on the storage controller. | -|
| Boolean | -Limit the candidate volume list to only the ones that are not mirrored on the storage controller. | -|
| Boolean | -Limit the candidate volume list to only the ones that have deduplication enabled on the storage controller. | -|
| Boolean | -Limit the candidate volume list to only the ones that have deduplication disabled on the storage controller. | -|
| Boolean | -Limit the candidate volume list to only the ones that have compression enabled on the storage controller. | -|
| Boolean | -Limit the candidate volume list to only the ones that have compression disabled on the storage controller. | -|
| Boolean | -Limit the candidate volume list to only the ones that support thin provisioning on the storage controller. | -|
| Boolean | -Limit the candidate volume list to only the ones that support thick provisioning on the storage controller. | -
| Configuration option = Default value | -Description | -
|---|---|
| [auth] | -|
| = |
- (StrOpt) The saml2 auth plugin module. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Location to store child pid files | -
| = |
- (IntOpt) MTU setting for device. | -
| = |
- (StrOpt) Driver used for ipv6 prefix delegation. This needs to be an entry point defined in the neutron.agent.linux.pd_drivers namespace. See setup.cfg for entry points included with the neutron source. | -
| = |
- (BoolOpt) Start and use a daemon that can run the commands that need to be run with root privileges. This option is usually enabled on nodes that run nova compute processes | -
| [AGENT] | -|
| = |
- (StrOpt) Selects the Agent Type reported | -
| = |
- (LengthStrOpt) Availability zone of this node | -
| = |
- (ListOpt) List of <physical_network>:<physical_interface> | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| = |
- (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop | -
| = |
- (ListOpt) AMQP topic used for OpenStack notifications. | -
| = |
- (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Allow the usage of the bulk API | -
| = |
- (BoolOpt) Allow the usage of the pagination | -
| = |
- (BoolOpt) Allow the usage of the sorting | -
| = |
- (StrOpt) The path for API extensions | -
| = |
- (StrOpt) File name for the paste.deploy config for api service | -
| = |
- (IntOpt) Number of backlog requests to configure the socket with | -
| = |
- (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. | -
| = |
- (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). | -
| = |
- (StrOpt) The maximum number of items returned in a single response, value was 'infinite' or negative integer means no limit | -
| = |
- (IntOpt) Number of seconds to keep retrying to listen | -
| = |
- (ListOpt) The service plugins Neutron will use | -
| = |
- (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. | -
| = |
- (BoolOpt) If False, closes the client socket connection explicitly. | -
| [oslo_middleware] | -|
| = |
- (IntOpt) The maximum body size for each request, in bytes. | -
| = |
- (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] | -|
| = |
- (StrOpt) Default rule. Enforced when a requested rule is not found. | -
| = |
- (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. | -
| = |
- (StrOpt) The JSON file that defines policies. | -
| [service_providers] | -|
| = |
- (MultiStrOpt) Defines providers for advanced services using the format: <service_type>:<name>:<driver>[:default] | -
| Configuration option = Default value | -Description | -
|---|---|
| [keystone_authtoken] | -|
| = |
- (StrOpt) Service user password. | -
| = |
- (StrOpt) Service tenant name. | -
| = |
- (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | -
| = |
- (StrOpt) Service username. | -
| = |
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Name of the plugin to load | -
| = |
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | -
| = |
- (StrOpt) Config Section from which to load plugin specific options | -
| = |
- (StrOpt) Complete public Identity API endpoint. | -
| = |
- (StrOpt) API version of the admin Identity API endpoint. | -
| = |
- (StrOpt) Env key for the swift cache. | -
| = |
- (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. | -
| = |
- (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. | -
| = |
- (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| = |
- (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | -
| = |
- (IntOpt) Request timeout value for communicating with Identity API server. | -
| = |
- (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| = |
- (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | -
| = |
- (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. | -
| = |
- (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. | -
| = |
- (IntOpt) (Optional) Maximum total number of open connections to every memcached server. | -
| = |
- (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. | -
| = |
- (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. | -
| = |
- (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. | -
| = |
- (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. | -
| = |
- (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. | -
| = |
- (StrOpt) The region in which the identity server can be found. | -
| = |
- (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| = |
- (StrOpt) Directory used to cache files related to PKI tokens. | -
| = |
- (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | -Description | -
|---|---|
| [BAGPIPE] | -|
| = |
- (StrOpt) BGP component REST service IP address. | -
| = |
- (IntOpt) BGP component REST service IP port. | -
| = |
- (StrOpt) OVS MPLS bridge to use | -
| = |
- (StrOpt) OVS Peer patch port in MPLS bridge to tunnel bridge (traffic from tunnel bridge) | -
| = |
- (StrOpt) OVS Peer patch port in MPLS bridge to tunnel bridge(traffic to tunnel bridge) | -
| = |
- (IntOpt) The number of seconds the BGP component client will wait between polling for restart detection. | -
| = |
- (StrOpt) OVS Peer patch port in tunnel bridge to MPLS bridge (traffic from MPLS bridge) | -
| = |
- (StrOpt) OVS Peer patch port in tunnel bridge to MPLS bridge(traffic to MPLS bridge) | -
| Configuration option = Default value | -Description | -
|---|---|
| [NOVA] | -|
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to 802.1qbg | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to 802.1qbh | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to binding_failed | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to bridge | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to distributed | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to dvs | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to hw_web | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to hyperv | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to ib_hostdev | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to iovisor | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to ivs | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to midonet | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to other | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to ovs | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to unbound | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to vhostuser | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to vrouter | -
| = |
- (StrOpt) Virtual interface type to configure on Nova compute nodes | -
| = |
- (ListOpt) List of allowed vif_type values. | -
| [RESTPROXY] | -|
| = |
- (BoolOpt) Flag to decide if a route to the metadata server should be injected into the VM | -
| = |
- (BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, the plugin automatically triggers a full data synchronization to the controller. | -
| = |
- (BoolOpt) Re-use HTTP/HTTPS connections to the controller. | -
| = |
- (IntOpt) Time between verifications that the backend controller database is consistent with Neutron. (0 to disable) | -
| = |
- (StrOpt) User defined identifier for this Neutron deployment | -
| = |
- (BoolOpt) Disables SSL certificate validation for controllers | -
| = |
- (StrOpt) The username and password for authenticating against the Big Switch or Floodlight controller. | -
| = |
- (BoolOpt) If True, Use SSL when connecting to the Big Switch or Floodlight controller. | -
| = |
- (IntOpt) Maximum number of seconds to wait for proxy request to connect and complete. | -
| = |
- (ListOpt) A comma separated list of Big Switch or Floodlight servers and port numbers. The plugin proxies the requests to the Big Switch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover. | -
| = |
- (StrOpt) Directory containing ca_certs and host_certs certificate directories. | -
| = |
- (BoolOpt) Trust and store the first certificate received for each controller address and use it to validate future connections to that address. | -
| = |
- (BoolOpt) Sync data on connect | -
| = |
- (IntOpt) Maximum number of threads to spawn to handle large volumes of port creations. | -
| [RESTPROXYAGENT] | -|
| = |
- (StrOpt) Name of integration bridge on compute nodes used for security group insertion. | -
| = |
- (IntOpt) Seconds between agent checks for port changes | -
| = |
- (StrOpt) Virtual switch type. | -
| [ROUTER] | -|
| = |
- (IntOpt) Maximum number of router rules | -
| = |
- (MultiStrOpt) The default router rules installed in new tenant routers. Repeat the config option for each rule. Format is <tenant>:<source>:<destination>:<action> Use an * to specify default for all tenants. | -
| Configuration option = Default value | -Description | -
|---|---|
| [PHYSICAL_INTERFACE] | -|
| = |
- (StrOpt) The network interface to use when creating a port | -
| [SWITCH] | -|
| = |
- (StrOpt) The address of the host to SSH to | -
| = |
- (StrOpt) Currently unused | -
| = |
- (StrOpt) The SSH password to use | -
| = |
- (StrOpt) The SSH username to use | -
| Configuration option = Default value | -Description | -
|---|---|
| [VROUTER] | -|
| = |
- (StrOpt) Nova VM flavor for instances of Vyatta vRouter. | -
| = |
- (StrOpt) Nova image id for instances of Vyatta vRouter. | -
| = |
- (StrOpt) Keystone URL. | -
| = |
- (StrOpt) Vyatta vRouter management network id. | -
| = |
- (IntOpt) Number of seconds between consecutive Nova queries when waiting for router instance status change. | -
| = |
- (IntOpt) Number of seconds to wait for Nova to activate instance before setting resource to error state. | -
| = |
- (StrOpt) Name of tenant admin user. | -
| = |
- (StrOpt) Tenant admin password. | -
| = |
- (StrOpt) UUID of tenant that holds Vyatta vRouter instances. | -
| = |
- (IntOpt) Number of seconds to wait for Vyatta vRouter to boot before setting resource to error state. | -
| = |
- (StrOpt) Vyatta vRouter login credentials | -
| = |
- (IntOpt) Number of seconds between consecutive Vyatta vRouter queries when waiting for router instance boot. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) CA certificate file to use to verify connecting clients | -
| = |
- (StrOpt) Certificate file to use when starting the server securely | -
| = |
- (StrOpt) Private key file to use when starting the server securely | -
| Configuration option = Default value | -Description | -
|---|---|
| [cfg_agent] | -|
| = |
- (IntOpt) Time in seconds for connecting to a hosting device | -
| = |
- (StrOpt) Path of the firewall service helper class. | -
| = |
- (IntOpt) The time in seconds until a backlogged hosting device is presumed dead. This value should be set up high enough to recover from a period of connectivity loss or high load when the device may not be responding. | -
| = |
- (StrOpt) Path of the routing service helper class. | -
| = |
- (IntOpt) Interval when the process_services() loop executes in seconds. This is when the config agent lets each service helper to process its neutron resources. | -
| [cisco_csr_ipsec] | -|
| = |
- (IntOpt) Status check interval for Cisco CSR IPSec connections | -
| [general] | -|
| = |
- (IntOpt) Time in seconds between renewed scheduling attempts of non-scheduled routers. | -
| = |
- (IntOpt) Seconds of no status update until a cfg agent is considered down. | -
| = |
- (StrOpt) Default security group applied on management port. Default value is mgmt_sec_grp. | -
| = |
- (BoolOpt) Ensure that Nova is running before attempting to create any VM. | -
| = |
- (StrOpt) Name of the L3 admin tenant. | -
| = |
- (StrOpt) Name of management network for device configuration. Default value is osn_mgmt_nw | -
| = |
- (StrOpt) Path to config drive files for service VM instances. | -
| = |
- (StrOpt) Path to templates for hosting devices. | -
| [hosting_devices] | -|
| = |
- (IntOpt) Booting time in seconds before a CSR1kv becomes operational. | -
| = |
- (StrOpt) Config agent driver for CSR1kv. | -
| = |
- (StrOpt) CSR1kv configdrive template file. | -
| = |
- (StrOpt) Hosting device driver for CSR1kv. | -
| = |
- (StrOpt) UUID of Nova flavor for CSR1kv. | -
| = |
- (StrOpt) Name of Glance image for CSR1kv. | -
| = |
- (StrOpt) Password to use for CSR1kv configurations. | -
| = |
- (StrOpt) Plugging driver for CSR1kv. | -
| = |
- (StrOpt) Username to use for CSR1kv configurations. | -
| [ml2_cisco_n1kv] | -|
| = |
- (IntOpt) Maximum number of retry attempts for VSM REST API. | -
| [n1kv] | -|
| = |
- (StrOpt) Name of N1kv port profile for management ports. | -
| = |
- (StrOpt) Name of N1kv network profile for T1 networks (i.e., trunk networks for VXLAN segmented traffic). | -
| = |
- (StrOpt) Name of N1kv port profile for T1 ports (i.e., ports carrying traffic from VXLAN segmented networks). | -
| = |
- (StrOpt) Name of N1kv network profile for T2 networks (i.e., trunk networks for VLAN segmented traffic). | -
| = |
- (StrOpt) Name of N1kv port profile for T2 ports (i.e., ports carrying traffic from VLAN segmented networks). | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Admin password | -
| = |
- (StrOpt) Admin tenant name | -
| = |
- (StrOpt) Admin user | -
| = |
- (IntOpt) Seconds to regard the agent is down; should be at least twice report_interval, to be sure the agent is down for good. | -
| = |
- (IntOpt) Number of separate API worker processes for service. If not specified, the default is equal to the number of CPUs available for best performance. | -
| = |
- (StrOpt) Certificate Authority public key (CA cert) file for ssl | -
| = |
- (BoolOpt) Turn off verification of the certificate for ssl | -
| = |
- (StrOpt) Authentication region | -
| = |
- (StrOpt) The type of authentication to use | -
| = |
- (StrOpt) Authentication URL | -
| = |
- (StrOpt) The base MAC address Neutron will use for VIFs | -
| = |
- (StrOpt) The host IP to bind to | -
| = |
- (IntOpt) The port to bind to | -
| = |
- (StrOpt) The core plugin Neutron will use | -
| = |
- (StrOpt) Default IPv4 subnet-pool to be used for automatic subnet CIDR allocation | -
| = |
- (StrOpt) Default IPv6 subnet-pool to be used for automatic subnet CIDR allocation | -
| = |
- (MultiStrOpt) Drivers used to manage loadbalancing devices | -
| = |
- (BoolOpt) Allow sending resource operation notification to DHCP agent | -
| = |
- (IntOpt) Number of DHCP agents scheduled to host a tenant network. If this number is greater than 1, the scheduler automatically assigns multiple DHCP agents for a given tenant network, providing high availability for DHCP service. | -
| = |
- (BoolOpt) Use broadcast in DHCP replies | -
| = |
- (StrOpt) Location to store DHCP server config files | -
| = |
- (BoolOpt) Delete namespace after removing a dhcp server.This option is deprecated and will be removed in a future release. | -
| = |
- (StrOpt) Domain to use for building the hostnames.This option is deprecated. It has been moved to neutron.conf as dns_domain. It will removed from here in a future release | -
| = |
- (IntOpt) DHCP lease duration (in seconds). Use -1 to tell dnsmasq to use infinite lease times. | -
| = |
- (StrOpt) Representing the resource type whose load is being reported by the agent. This can be "networks", "subnets" or "ports". When specified (Default is networks), the server will extract particular load sent as part of its agent configuration object from the agent report state, which is the number of resources being consumed, at every report_interval.dhcp_load_type can be used in combination with network_scheduler_driver = neutron.scheduler.dhcp_agent_scheduler.WeightScheduler When the network_scheduler_driver is WeightScheduler, dhcp_load_type can be configured to represent the choice for the resource being balanced. Example: dhcp_load_type=networks | -
| = |
- (StrOpt) Domain to use for building the hostnames | -
| = |
- (BoolOpt) Agent starts with admin_state_up=False when enable_new_agents=False. In the case, user's resources will not be scheduled automatically to the agent until admin changes admin_state_up to True. | -
| = |
- (BoolOpt) Enable services on an agent with admin_state_up False. If this option is False, when admin_state_up of an agent is turned False, services on it will be disabled. Agents with admin_state_up False are not selected for automatic scheduling regardless of this option. But manual scheduling to such agents is available if this option is True. | -
| = |
- (StrOpt) Network service endpoint type to pull from the keystone catalog | -
| = |
- (StrOpt) Neutron endpoint URL, if not set will use endpoint from the keystone catalog along with endpoint_type | -
| = |
- (IntOpt) Size of executor thread pool. | -
| = |
- (BoolOpt) Ensure that configured gateway is on subnet. For IPv6, validate only if gateway is not a link local address. Deprecated, to be removed during the K release, at which point the check will be mandatory. | -
| = |
- (StrOpt) Hostname to be used by the neutron server, agents and services running on this machine. All the agents and services running on this machine must use the same host value. | -
| = |
- (StrOpt) The driver used to manage the virtual interface. | -
| = |
- (BoolOpt) Force ip_lib calls to use the root helper | -
| = |
- (StrOpt) IPAM driver to use. | -
| = |
- (IntOpt) How many times Neutron will retry MAC generation | -
| = |
- (IntOpt) Maximum number of allowed address pairs | -
| = |
- (IntOpt) Maximum number of DNS nameservers | -
| = |
- (IntOpt) Maximum number of fixed ips per port | -
| = |
- (IntOpt) Maximum number of host routes per subnet | -
| = |
- (ListOpt) Memcached servers or None for in process cache. | -
| = |
- (IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) | -
| = |
- (IntOpt) Seconds between running periodic tasks | -
| = |
- (IntOpt) Periodic interval at which the plugin checks for the monitoring L2 gateway agent | -
| = |
- (IntOpt) Interval between two metering reports | -
| = |
- (StrOpt) Path to the rootwrap configuration file to use for running commands as root | -
| = |
- (StrOpt) Where to store Neutron state files. This directory must be writable by the agent. | -
| = |
- (BoolOpt) If True, then allow plugins that support it to create VLAN transparent networks. | -
| [AGENT] | -|
| = |
- (StrOpt) Action to be executed when a child process dies | -
| = |
- (IntOpt) Interval between checks of child process liveness (seconds), use 0 to disable | -
| = |
- (BoolOpt) Log agent heartbeats | -
| = |
- (StrOpt) Root helper application. | -
| = |
- (StrOpt) Root helper daemon application to use when possible. | -
| [certificates] | -|
| = |
- (StrOpt) Certificate Manager plugin. Defaults to barbican. | -
| = |
- (StrOpt) Absolute path to the certificate storage directory. Defaults to env[OS_LBAAS_TLS_STORAGE]. | -
| [heleos] | -|
| = |
- (StrOpt) ESM admin password. | -
| [keystone_authtoken] | -|
| = |
- (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| [qos] | -|
| = |
- (ListOpt) Drivers list to use to send the update notification | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Send notification to nova when port data (fixed_ips/floatingip) changes so nova can update its cache. | -
| = |
- (BoolOpt) Send notification to nova when port status changes | -
| = |
- (StrOpt) Authorization URL for connecting to nova in admin context. Deprecated in favour of an auth plugin in [nova]. | -
| = |
- (StrOpt) Password for connection to nova in admin context. Deprecated in favour of an auth plugin in [nova]. | -
| = |
- (StrOpt) The uuid of the admin nova tenant. Deprecated in favour of an auth plugin in [nova]. | -
| = |
- (StrOpt) The name of the admin nova tenant. Deprecated in favour of an auth plugin in [nova]. | -
| = |
- (StrOpt) Username for connecting to nova in admin context. Deprecated in favour of an auth plugin in [nova]. | -
| = |
- (StrOpt) Client certificate for nova metadata api server. | -
| = |
- (StrOpt) Private key of client certificate. | -
| = |
- (StrOpt) URL for connection to nova. Deprecated in favour of an auth plugin in [nova]. | -
| = |
- (IntOpt) Number of seconds between sending events to nova if there are any events to send. | -
| Configuration option = Default value | -Description | -
|---|---|
| [cors] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| [database] | -|
| = |
- (StrOpt) The back end to use for the database. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the database. | -
| = |
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. | -
| = |
- (BoolOpt) Add Python stack traces to SQL as comment strings. | -
| = |
- (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. | -
| = |
- (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. | -
| = |
- (IntOpt) Seconds between retries of a database transaction. | -
| = |
- (IntOpt) Timeout before idle SQL connections are reaped. | -
| = |
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy. | -
| = |
- (IntOpt) Maximum number of SQL connections to keep open in a pool. | -
| = |
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) Minimum number of SQL connections to keep open in a pool. | -
| = |
- (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | -
| = |
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. | -
| = |
- (IntOpt) Interval between retries of opening a SQL connection. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. | -
| = |
- (StrOpt) The file name to use with SQLite. | -
| = |
- (BoolOpt) If True, SQLite uses synchronous mode. | -
| = |
- (BoolOpt) Enable the experimental use of database reconnect on connection lost. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) If True, effort is made to advertise MTU settings to VMs via network methods (DHCP and RA MTU options) when the network's preferred MTU is known. | -
| = |
- (StrOpt) The driver used to manage the DHCP server. | -
| = |
- (StrOpt) Base log dir for dnsmasq logging. The log contains DHCP and DNS log information and is useful for debugging issues with either DHCP or DNS. If this section is null, disable dnsmasq log. | -
| = |
- (StrOpt) Override the default dnsmasq settings with this file | -
| = |
- (ListOpt) Comma-separated list of the DNS servers which will be used as forwarders. | -
| = |
- (IntOpt) Limit number of leases to prevent a denial-of-service. | -
| = |
- (BoolOpt) Support Metadata requests on isolated networks. | -
| = |
- (BoolOpt) Allows for serving metadata requests from a dedicated network. Requires enable_isolated_metadata = True | -
| = |
- (BoolOpt) Force to use DHCP to get Metadata on all networks. | -
| = |
- (IntOpt) Number of threads to use during sync process. | -
| = |
- (IntOpt) Interval to resync. | -
| = |
- (BoolOpt) Allow overlapping IP. This option is deprecated and will be removed in a future release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The base mac address used for unique DVR instances by Neutron. The first 3 octets will remain unchanged. If the 4th octet is not 00, it will also be used. The others will be randomly generated. The 'dvr_base_mac' *must* be different from 'base_mac' to avoid mixing them up with MAC's allocated for tenant ports. A 4 octet example would be dvr_base_mac = fa:16:3f:4f:00:00. The default is 3 octet | -
| = |
- (BoolOpt) System-wide flag to determine the type of router that tenants can create. Only admin can override. | -
| Configuration option = Default value | -Description | -
|---|---|
| [dvs] | -|
| = |
- (IntOpt) The number of times we retry on failures, e.g., socket error, etc. | -
| = |
- (StrOpt) Specify a CA bundle file to use in verifying the vCenter server certificate. | -
| = |
- (StrOpt) The name of the preconfigured DVS. | -
| = |
- (StrOpt) Hostname or IP address for connection to VMware vCenter host. | -
| = |
- (StrOpt) Password for connection to VMware vCenter host. | -
| = |
- (IntOpt) Port for connection to VMware vCenter host. | -
| = |
- (StrOpt) Username for connection to VMware vCenter host. | -
| = |
- (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 "ca_file" is set. | -
| = |
- (FloatOpt) The interval used for polling of remote tasks. | -
| Configuration option = Default value | -Description | -
|---|---|
| [heleos] | -|
| = |
- (StrOpt) ESM admin username. | -
| = |
- (BoolOpt) Define if the requests have run asynchronously or not | -
| = |
- (StrOpt) Dummy user traffic Security Zone id | -
| = |
- (StrOpt) ESM management root address | -
| = |
- (StrOpt) In band Security Zone id | -
| = |
- (StrOpt) Management Security Zone id | -
| = |
- (StrOpt) Out of band Security Zone id | -
| = |
- (StrOpt) Shared resource pool id | -
| = |
- (StrOpt) Router image id (Embrane FW/VPN) | -
| Configuration option = Default value | -Description | -
|---|---|
| [fujitsu_cfab] | -|
| = |
- (StrOpt) The address of the C-Fabric to telnet to. | -
| = |
- (StrOpt) The C-Fabric password to use. | -
| = |
- (ListOpt) List of <physical_network>:<vfab_id> tuples specifying physical_network names and corresponding vfab ids. | -
| = |
- (StrOpt) The prefix string for pprofile name. | -
| = |
- (BoolOpt) Whether to save configuration. | -
| = |
- (BoolOpt) Whether to share a C-Fabric pprofile among Neutron ports using the same VLAN ID. | -
| = |
- (StrOpt) The C-Fabric username to use. | -
| Configuration option = Default value | -Description | -
|---|---|
| [fujitsu_ism] | -|
| = |
- (StrOpt) The IP address or hostname of the ISM. | -
| = |
- (StrOpt) The certification authority for ISM. | -
| = |
- (StrOpt) The ISM password to use. | -
| = |
- (StrOpt) The port number of the ISM. | -
| = |
- (StrOpt) The API timeout value for ISM. | -
| = |
- (StrOpt) The ISM username to use. | -
| Configuration option = Default value | -Description | -
|---|---|
| [fwaas] | -|
| = |
- (BoolOpt) Enable FWaaS | -
| Configuration option = Default value | -Description | -
|---|---|
| [ngfw] | -|
| = |
- (StrOpt) Authentication key to SMC API | -
| = |
- (StrOpt) verion of SMC API | -
| = |
- (StrOpt) URL to contact SMC server | -
| Configuration option = Default value | -Description | -
|---|---|
| [vArmour] | -|
| = |
- (StrOpt) vArmour director ip | -
| = |
- (StrOpt) vArmour director port | -
| = |
- (StrOpt) vArmour director password | -
| = |
- (StrOpt) vArmour director username | -
| Configuration option = Default value | -Description | -
|---|---|
| [AGENT] | -|
| = |
- (BoolOpt) Enables metrics collections for switch ports by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above | -
| = |
- (StrOpt) Private vswitch name used for local networks | -
| = |
- (IntOpt) Specifies the maximum number of retries to enable Hyper-V's port metrics collection. The agent will try to enable the feature once every polling_interval period for at most metrics_max_retries or until it succeedes. | -
| = |
- (StrOpt) Specifies the address which will serve the metadata for the instance. | -
| = |
- (ListOpt) List of <physical_network>:<vswitch> where the physical networks can be expressed with wildcards, e.g.: ."*:external" | -
| = |
- (IntOpt) The number of seconds the agent will wait between polling for local device changes. | -
| [NVGRE] | -|
| = |
- (BoolOpt) Enables Hyper-V NVGRE. Requires Windows Server 2012 or above. | -
| = |
- (StrOpt) Specifies the tunnel IP which will be used and reported by this host for NVGRE networks. | -
| = |
- (IntOpt) Specifies the VLAN ID of the physical network, required for setting the NVGRE Provider Address. | -
| [hyperv] | -|
| = |
- (BoolOpt) Force V1 WMI utility classes | -
| [neutron] | -|
| = |
- (StrOpt) auth url for connecting to neutron in admin context | -
| = |
- (StrOpt) password for connecting to neutron in admin context | -
| = |
- (StrOpt) tenant name for connecting to neutron in admin context | -
| = |
- (StrOpt) username for connecting to neutron in admin context | -
| = |
- (StrOpt) auth strategy for connecting to neutron in admin context | -
| = |
- (StrOpt) URL for connecting to neutron | -
| = |
- (IntOpt) timeout value for connecting to neutron in seconds | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Location to store IPv6 RA config files | -
| Configuration option = Default value | -Description | -
|---|---|
| [agent] | -|
| = |
- (ListOpt) Extensions list to use | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) default_device_name of the l2 gateway | -
| = |
- (StrOpt) Unique identifier of the NSX L2 Gateway service which will be used by default for network gateways | -
| = |
- (StrOpt) Unique identifier of the NSX L3 Gateway service which will be used for implementing routers and floating IPs | -
| = |
- (StrOpt) L2 gateway plugin callback class where theRPCs from the agent are going to get invoked | -
| = |
- (IntOpt) Number of l2 gateways allowed per tenant, -1 for unlimited | -
| [ovsdb] | -|
| = |
- (BoolOpt) Set to True if ovsdb Manager manages the client | -
| = |
- (StrOpt) Trusted issuer CA cert | -
| = |
- (StrOpt) L2 gateway agent public certificate | -
| = |
- (StrOpt) L2 gateway agent private key | -
| = |
- (IntOpt) Maximum number of retries to open a socket with the OVSDB server | -
| = |
- (StrOpt) OVSDB server name:host/IP:port | -
| = |
- (IntOpt) Seconds between periodic task runs | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The working mode for the agent. Allowed modes are: 'legacy' - this preserves the existing behavior where the L3 agent is deployed on a centralized networking node to provide L3 services like DNAT, and SNAT. Use this mode if you do not want to adopt DVR. 'dvr' - this mode enables DVR functionality and must be used for an L3 agent that runs on a compute host. 'dvr_snat' - this enables centralized SNAT support in conjunction with DVR. This mode must be used for an L3 agent running on a centralized node (or in single-host deployments, e.g. devstack) | -
| = |
- (BoolOpt) Automatically remove networks from offline DHCP agents. | -
| = |
- (BoolOpt) Automatically reschedule routers from offline L3 agents to online L3 agents. | -
| = |
- (BoolOpt) Allow running metadata proxy. | -
| = |
- (BoolOpt) Define the default value of enable_snat if not provided in external_gateway_info. | -
| = |
- (StrOpt) Iptables mangle mark used to mark ingress from external network. This mark will be masked with 0xffff so that only the lower 16 bits will be used. | -
| = |
- (StrOpt) Name of bridge used for external network traffic. | -
| = |
- (StrOpt) UUID of external network for routers implemented by the agents. | -
| = |
- (StrOpt) Location to store keepalived/conntrackd config files | -
| = |
- (IntOpt) The advertisement interval in seconds | -
| = |
- (StrOpt) VRRP authentication password | -
| = |
- (StrOpt) VRRP authentication type | -
| = |
- (BoolOpt) Agent should implement routers with no gateway | -
| = |
- (StrOpt) With IPv6, the network used for the external gateway does not need to have an associated subnet, since the automatically assigned link-local address (LLA) can be used. However, an IPv6 gateway address is needed for use as the next-hop for the default route. If no IPv6 gateway address is configured here, (and only then) the neutron router will be configured to get its default route from router advertisements (RAs) from the upstream router; in which case the upstream router must also be configured to send these RAs. The ipv6_gateway, when configured, should be the LLA of the interface on the upstream router. If a next-hop using a global unique address (GUA) is desired, it needs to be done via a subnet allocated to the network and not through this parameter. | -
| = |
- (BoolOpt) Enable HA mode for virtual routers. | -
| = |
- (StrOpt) Subnet used for the l3 HA admin network. | -
| = |
- (StrOpt) The physical network name with which the HA network can be created. | -
| = |
- (StrOpt) The network type to use when creating the HA network for an HA router. By default or if empty, the first 'tenant_network_types' is used. This is helpful when the VRRP traffic should use a specific network which is not the default one. | -
| = |
- (IntOpt) Maximum number of agents on which a router will be scheduled. | -
| = |
- (IntOpt) Minimum number of agents on which a router will be scheduled. | -
| = |
- (StrOpt) If namespaces is disabled, the l3 agent can only configure a router that has the matching router ID. | -
| = |
- (IntOpt) Send this many gratuitous ARPs for HA setup, if less than or equal to 0, the feature is disabled | -
| [AGENT] | -|
| = |
- (BoolOpt) Add comments to iptables rules. | -
| = |
- (BoolOpt) Use the root helper to read the namespaces from the operating system. | -
| Configuration option = Default value | -Description | -
|---|---|
| [l3_arista] | -|
| = |
- (IntOpt) Sync interval in seconds between L3 Service plugin and EOS. This interval defines how often the synchronization is performed. This is an optional field. If not set, a value of 180 seconds is assumed | -
| = |
- (BoolOpt) This flag is used indicate if Arista Switches are configured in MLAG mode. If yes, all L3 config is pushed to both the switches automatically. If this flag is set to True, ensure to specify IP addresses of both switches. This is optional. If not set, a value of "False" is assumed. | -
| = |
- (StrOpt) Arista EOS IP address. This is required field. If not set, all communications to Arista EOS will fail | -
| = |
- (StrOpt) Password for Arista EOS. This is required field. If not set, all communications to Arista EOS will fail | -
| = |
- (StrOpt) Username for Arista EOS. This is required field. If not set, all communications to Arista EOS will fail | -
| = |
- (StrOpt) Arista EOS IP address for second Switch MLAGed with the first one. This an optional field, however, if mlag_config flag is set, then this is required. If not set, all communications to Arista EOS will fail | -
| = |
- (BoolOpt) A "True" value for this flag indicates to create a router in VRF. If not set, all routers are created in default VRF. This is optional. If not set, a value of "False" is assumed. | -
| Configuration option = Default value | -Description | -
|---|---|
| [L3_BROCADE_MLX_EXAMPLE] | -|
| = |
- (StrOpt) The IP address of the MLX switch | -
| = |
- (StrOpt) The SSH password of the switch | -
| = |
- (StrOpt) Allowed physical networks where VLAN can be configured on this switch | -
| = |
- (StrOpt) Ports to be tagged in the VLAN being configured on the switch | -
| = |
- (StrOpt) The SSH username of the switch | -
| [l3_brocade_mlx] | -|
| = |
- (StrOpt) Switches connected to the compute nodes | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The driver used to manage the virtual interface. | -
| = |
- (StrOpt) Driver to use for scheduling pool to a default loadbalancer agent | -
| = |
- (StrOpt) Driver to use for scheduling to a default loadbalancer agent | -
| = |
- (IntOpt) Seconds between running periodic tasks | -
| = |
- (StrOpt) Driver to use for scheduling to a default loadbalancer agent | -
| = |
- (StrOpt) Driver to use for scheduling pool to a default loadbalancer agent | -
| [service_auth] | -|
| = |
- (StrOpt) Authentication endpoint | -
| = |
- (StrOpt) The service admin tenant name | -
| = |
- (StrOpt) The service admin user name | -
| = |
- (StrOpt) The service admin password | -
| = |
- (StrOpt) The admin user domain name | -
| = |
- (StrOpt) The admin project domain name | -
| = |
- (StrOpt) The deployment region | -
| = |
- (StrOpt) The name of the service | -
| = |
- (StrOpt) The auth version used to authenticate | -
| [service_providers] | -|
| = |
- (MultiStrOpt) Defines providers for advanced services using the format: <service_type>:<name>:<driver>[:default] | -
| [certificates] | -|
| = |
- (StrOpt) Certificate Manager plugin. Defaults to barbican. | -
| = |
- (StrOpt) Absolute path to the certificate storage directory. Defaults to env[OS_LBAAS_TLS_STORAGE]. | -
| [service_auth] | -|
| = |
- (StrOpt) The service admin password | -
| = |
- (StrOpt) The admin project domain name | -
| = |
- (StrOpt) The service admin tenant name | -
| = |
- (StrOpt) The service admin user name | -
| = |
- (StrOpt) The admin user domain name | -
| = |
- (StrOpt) Authentication endpoint | -
| = |
- (StrOpt) The auth version used to authenticate | -
| = |
- (StrOpt) The deployment region | -
| = |
- (StrOpt) The name of the service | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Seconds between running periodic tasks | -
| = |
- (StrOpt) The driver used to manage the virtual interface. | -
| = |
- (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). | -
| = |
- (BoolOpt) Uses veth for an interface or not | -
| = |
- (MultiStrOpt) Drivers used to manage loadbalancing devices | -
| [haproxy] | -|
| = |
- (StrOpt) Location to store config and state files | -
| = |
- (IntOpt) When delete and re-add the same vip, send this many gratuitous ARPs to flush the ARP cache in the Router. Set it below or equal to 0 to disable this feature. | -
| = |
- (StrOpt) The user group | -
| Configuration option = Default value | -Description | -
|---|---|
| [octavia] | -|
| = |
- (StrOpt) URL of Octavia controller root | -
| = |
- (IntOpt) Interval in seconds to poll octavia when an entity is created, updated, or deleted. | -
| = |
- (IntOpt) Time to stop polling octavia when a status of an entity does not change. | -
| Configuration option = Default value | -Description | -
|---|---|
| [haproxy] | -|
| = |
- (IntOpt) When delete and re-add the same vip, send this many gratuitous ARPs to flush the ARP cache in the Router. Set it below or equal to 0 to disable this feature. | -
| = |
- (StrOpt) The user group | -
| = |
- (StrOpt) Location to store config and state files | -
| = |
- (IntOpt) Seconds between periodic task runs | -
| = |
- (StrOpt) The driver used to manage the virtual interface. | -
| = |
- (StrOpt) Jinja template file for haproxy configuration | -
| [octavia] | -|
| = |
- (StrOpt) URL of Octavia controller root | -
| [heleoslb] | -|
| = |
- (StrOpt) ESM admin password. | -
| = |
- (StrOpt) ESM admin username. | -
| = |
- (BoolOpt) Define if the requests have run asynchronously or not | -
| = |
- (StrOpt) Dummy user traffic Security Zone id for LBs | -
| = |
- (StrOpt) ESM management root address | -
| = |
- (StrOpt) In band Security Zone id for LBs | -
| = |
- (StrOpt) choose LB image flavor to use, accepted values: small, medium | -
| = |
- (StrOpt) Load Balancer image id (Embrane LB) | -
| = |
- (StrOpt) Management Security Zone id for LBs | -
| = |
- (StrOpt) Out of band Security Zone id for LBs | -
| = |
- (StrOpt) Shared resource pool id | -
| = |
- (IntOpt) resource synchronization interval in seconds | -
| [netscaler_driver] | -|
| = |
- (StrOpt) Setting for option to enable synchronous operationsNetScaler Control Center Server. | -
| = |
- (StrOpt) Setting to enable/disable cleanup mode for NetScaler Control Center Server | -
| = |
- (StrOpt) Password to login to the NetScaler Control Center Server. | -
| = |
- (StrOpt) The URL to reach the NetScaler Control Center Server. | -
| = |
- (StrOpt) Username to login to the NetScaler Control Center Server. | -
| = |
- (StrOpt) Setting for member status collection fromNetScaler Control Center Server. | -
| = |
- (StrOpt) Setting for periodic task collection interval fromNetScaler Control Center Server.. | -
| [octavia] | -|
| = |
- (StrOpt) URL of Octavia controller root | -
| = |
- (IntOpt) Interval in seconds to poll octavia when an entity is created, updated, or deleted. | -
| = |
- (IntOpt) Time to stop polling octavia when a status of an entity does not change. | -
| [radware] | -|
| = |
- (ListOpt) List of actions that are not pushed to the completion queue. | -
| = |
- (StrOpt) IP address of secondary vDirect server. | -
| = |
- (DictOpt) Parameter for l2_l3 workflow constructor. | -
| = |
- (DictOpt) Parameter for l2_l3 workflow setup. | -
| = |
- (StrOpt) Name of l2_l3 workflow. Default: openstack_l2_l3. | -
| = |
- (StrOpt) Name of the l4 workflow action. Default: BaseCreate. | -
| = |
- (StrOpt) Name of l4 workflow. Default: openstack_l4. | -
| = |
- (StrOpt) Service ADC type. Default: VA. | -
| = |
- (StrOpt) Service ADC version. | -
| = |
- (IntOpt) Size of service cache. Default: 20. | -
| = |
- (IntOpt) Service compression throughput. Default: 100. | -
| = |
- (BoolOpt) Enables or disables the Service HA pair. Default: False. | -
| = |
- (IntOpt) A required VLAN for the interswitch link to use. | -
| = |
- (ListOpt) Resource pool IDs. | -
| = |
- (BoolOpt) Enable or disable Alteon interswitch link for stateful session failover. Default: False. | -
| = |
- (IntOpt) Service SSL throughput. Default: 100. | -
| = |
- (IntOpt) Service throughput. Default: 1000. | -
| = |
- (StrOpt) IP address of vDirect server. | -
| = |
- (StrOpt) vDirect user password. | -
| = |
- (StrOpt) vDirect user name. | -
| [radwarev2] | -|
| = |
- (ListOpt) Name of child workflow templates used.Default: manage_l3 | -
| = |
- (StrOpt) IP address of secondary vDirect server. | -
| = |
- (StrOpt) Service ADC type. Default: VA. | -
| = |
- (StrOpt) Service ADC version. | -
| = |
- (IntOpt) Size of service cache. Default: 20. | -
| = |
- (IntOpt) Service compression throughput. Default: 100. | -
| = |
- (BoolOpt) Enables or disables the Service HA pair. Default: False. | -
| = |
- (IntOpt) A required VLAN for the interswitch link to use. | -
| = |
- (ListOpt) Resource pool IDs. | -
| = |
- (BoolOpt) Enable or disable Alteon interswitch link for stateful session failover. Default: False. | -
| = |
- (IntOpt) Service SSL throughput. Default: 100. | -
| = |
- (IntOpt) Service throughput. Default: 1000. | -
| = |
- (StrOpt) Name of the workflow action for statistics. Default: stats. | -
| = |
- (StrOpt) IP address of vDirect server. | -
| = |
- (StrOpt) vDirect user password. | -
| = |
- (StrOpt) vDirect user name. | -
| = |
- (StrOpt) Name of the workflow action. Default: apply. | -
| = |
- (DictOpt) Parameter for l2_l3 workflow constructor. | -
| = |
- (StrOpt) Name of the workflow template. Default: os_lb_v2. | -
| [radwarev2_debug] | -|
| = |
- (BoolOpt) Configule ADC with L3 parameters? | -
| = |
- (BoolOpt) Configule ADC with L4 parameters? | -
| = |
- (BoolOpt) Provision ADC service? | -
| Configuration option = Default value | -Description | -
|---|---|
| [LINUX_BRIDGE] | -|
| = |
- (ListOpt) List of <physical_network>:<physical_bridge> | -
| = |
- (ListOpt) List of <physical_network>:<physical_interface> | -
| [VXLAN] | -|
| = |
- (BoolOpt) Enable VXLAN on the agent. Can be enabled when agent is managed by ml2 plugin using linuxbridge mechanism driver | -
| = |
- (BoolOpt) Extension to use alongside ml2 plugin's l2population mechanism driver. It enables the plugin to populate VXLAN forwarding table. | -
| = |
- (IPOpt) Local IP address of the VXLAN endpoints. | -
| = |
- (IntOpt) TOS for vxlan interface protocol packets. | -
| = |
- (IntOpt) TTL for vxlan interface protocol packets. | -
| = |
- (StrOpt) Multicast group(s) for vxlan interface. A range of group addresses may be specified by using CIDR notation. To reserve a unique group for each possible (24-bit) VNI, use a /8 such as 239.0.0.0/8. This setting must be the same on all the agents. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). | -
| = |
- (ListOpt) List of logger=LEVEL pairs. | -
| = |
- (BoolOpt) Enables or disables fatal status of deprecations. | -
| = |
- (BoolOpt) Make exception message format errors fatal | -
| = |
- (StrOpt) The format for an instance that is passed with the log message. | -
| = |
- (StrOpt) The format for an instance UUID that is passed with the log message. | -
| = |
- (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. | -
| = |
- (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . | -
| = |
- (StrOpt) (Optional) The base directory used for relative --log-file paths. | -
| = |
- (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | -
| = |
- (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) Format string to use for log messages with context. | -
| = |
- (StrOpt) Data to append to log format when level is DEBUG. | -
| = |
- (StrOpt) Format string to use for log messages without context. | -
| = |
- (StrOpt) Prefix each line of exception output with this format. | -
| = |
- (BoolOpt) Enables or disables publication of error events. | -
| = |
- (StrOpt) Syslog facility to receive log lines. | -
| = |
- (BoolOpt) Enable SSL on the API server | -
| = |
- (BoolOpt) Log output to standard error. | -
| = |
- (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. | -
| = |
- (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 Kilo, and will be removed in Mitaka, along with this option. | -
| = |
- (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. | -
| [oslo_versionedobjects] | -|
| = |
- (BoolOpt) Make exception message format errors fatal | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Iptables mangle mark used to mark metadata valid requests. This mark will be masked with 0xffff so that only the lower 16 bits will be used. | -
| = |
- (IntOpt) Number of backlog requests to configure the metadata server socket with | -
| = |
- (IntOpt) TCP Port used by Neutron metadata namespace proxy. | -
| = |
- (StrOpt) Group (gid or name) running metadata proxy after its initialization (if empty: agent effective group). | -
| = |
- (StrOpt) Shared secret to sign instance-id request | -
| = |
- (StrOpt) Location for Metadata Proxy UNIX domain socket. | -
| = |
- (StrOpt) Metadata Proxy UNIX domain socket mode, 4 values allowed: 'deduce': deduce mode from metadata_proxy_user/group values, 'user': set metadata proxy socket mode to 0o644, to use when metadata_proxy_user is agent effective user or root, 'group': set metadata proxy socket mode to 0o664, to use when metadata_proxy_group is agent effective group or root, 'all': set metadata proxy socket mode to 0o666, to use otherwise. | -
| = |
- (StrOpt) User (uid or name) running metadata proxy after its initialization (if empty: agent effective user). | -
| = |
- (BoolOpt) Enable/Disable log watch by metadata proxy. It should be disabled when metadata_proxy_user/group is not allowed to read/write its log file and copytruncate logrotate option must be used if logrotate is enabled on metadata proxy log files. Option default value is deduced from metadata_proxy_user: watch log is enabled if metadata_proxy_user is agent effective user id/name. | -
| = |
- (IntOpt) Number of separate worker processes for metadata server (defaults to half of the number of CPUs) | -
| = |
- (BoolOpt) Allow to perform insecure SSL (https) requests to nova metadata | -
| = |
- (StrOpt) IP address used by Nova metadata server. | -
| = |
- (IntOpt) TCP Port used by Nova metadata server. | -
| = |
- (StrOpt) Protocol to access nova metadata, http or https | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Metering driver | -
| = |
- (IntOpt) Interval between two metering measures | -
| [AGENT] | -|
| = |
- (FloatOpt) Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time. | -
| Configuration option = Default value | -Description | -
|---|---|
| [MIDONET] | -|
| = |
- (StrOpt) MidoNet client used to access MidoNet data storage. | -
| = |
- (StrOpt) IP that the cluster service can be reached on | -
| = |
- (StrOpt) Port that the cluster service can be reached on | -
| = |
- (StrOpt) MidoNet API server URI. | -
| = |
- (StrOpt) MidoNet admin password. | -
| = |
- (StrOpt) ID of the project that MidoNet admin user belongs to. | -
| = |
- (StrOpt) Tunnel protocol used by Midonet | -
| = |
- (StrOpt) MidoNet admin username. | -
| Configuration option = Default value | -Description | -
|---|---|
| [ml2] | -|
| = |
- (ListOpt) An ordered list of extension driver entrypoints to be loaded from the neutron.ml2.extension_drivers namespace. | -
| = |
- (StrOpt) Default network type for external networks when no provider attributes are specified. By default it is None, which means that if provider attributes are not specified while creating external networks then they will have the same type as tenant networks. Allowed values for external_network_type config option depend on the network type values configured in type_drivers config option. | -
| = |
- (ListOpt) An ordered list of networking mechanism driver entrypoints to be loaded from the neutron.ml2.mechanism_drivers namespace. | -
| = |
- (IntOpt) The maximum permissible size of an unfragmented packet travelling from and to addresses where encapsulated Neutron traffic is sent. If <= 0, the path MTU is indeterminate. | -
| = |
- (ListOpt) A list of mappings of physical networks to MTU values. The format of the mapping is <physnet>:<mtu val>. This mapping allows specifying a physical network MTU value that differs from the default segment_mtu value. | -
| = |
- (IntOpt) The maximum permissible size of an unfragmented packet travelling a L2 network segment. If <= 0, the segment MTU is indeterminate. | -
| = |
- (ListOpt) Ordered list of network_types to allocate as tenant networks. | -
| = |
- (ListOpt) List of network type driver entrypoints to be loaded from the neutron.ml2.type_drivers namespace. | -
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_ale_omniswitch] | -|
| = |
- (StrOpt) No help text available for this option. | -
| = |
- (ListOpt) No help text available for this option. | -
| = |
- (ListOpt) No help text available for this option. | -
| = |
- (IntOpt) No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_arista] | -|
| = |
- (StrOpt) Arista EOS IP address. This is required field. If not set, all communications to Arista EOS will fail. | -
| = |
- (StrOpt) Password for Arista EOS. This is required field. If not set, all communications to Arista EOS will fail. | -
| = |
- (StrOpt) Username for Arista EOS. This is required field. If not set, all communications to Arista EOS will fail. | -
| = |
- (StrOpt) Defines Region Name that is assigned to this OpenStack Controller. This is useful when multiple OpenStack/Neutron controllers are managing the same Arista HW clusters. Note that this name must match with the region name registered (or known) to keystone service. Authentication with Keysotne is performed by EOS. This is optional. If not set, a value of "RegionOne" is assumed. | -
| = |
- (IntOpt) Sync interval in seconds between Neutron plugin and EOS. This interval defines how often the synchronization is performed. This is an optional field. If not set, a value of 180 seconds is assumed. | -
| = |
- (BoolOpt) Defines if hostnames are sent to Arista EOS as FQDNs ("node1.domain.com") or as short names ("node1"). This is optional. If not set, a value of "True" is assumed. | -
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_bagpipe] | -|
| = |
- (IntOpt) Autonomous System number | -
| [ml2_type_route_target] | -|
| = |
- (IntOpt) Route Target Autonomous System number. | -
| = |
- (ListOpt) Comma-separated list of <rt_nn_min>:<rt_nn_max> tuples enumerating ranges of Route Target number that are available for tenant network allocation | -
| Configuration option = Default value | -Description | -
|---|---|
| [NOVA] | -|
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to 802.1qbg | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to 802.1qbh | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to binding_failed | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to bridge | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to distributed | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to dvs | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to hw_web | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to hyperv | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to ib_hostdev | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to iovisor | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to ivs | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to midonet | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to other | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to ovs | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to unbound | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to vhostuser | -
| = |
- (ListOpt) Nova compute nodes to manually set VIF type to vrouter | -
| = |
- (StrOpt) Virtual interface type to configure on Nova compute nodes | -
| = |
- (ListOpt) List of allowed vif_type values. | -
| [RESTPROXY] | -|
| = |
- (BoolOpt) Flag to decide if a route to the metadata server should be injected into the VM | -
| = |
- (BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, the plugin automatically triggers a full data synchronization to the controller. | -
| = |
- (BoolOpt) Re-use HTTP/HTTPS connections to the controller. | -
| = |
- (IntOpt) Time between verifications that the backend controller database is consistent with Neutron. (0 to disable) | -
| = |
- (StrOpt) User defined identifier for this Neutron deployment | -
| = |
- (BoolOpt) Disables SSL certificate validation for controllers | -
| = |
- (StrOpt) The username and password for authenticating against the Big Switch or Floodlight controller. | -
| = |
- (BoolOpt) If True, Use SSL when connecting to the Big Switch or Floodlight controller. | -
| = |
- (IntOpt) Maximum number of seconds to wait for proxy request to connect and complete. | -
| = |
- (ListOpt) A comma separated list of Big Switch or Floodlight servers and port numbers. The plugin proxies the requests to the Big Switch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover. | -
| = |
- (StrOpt) Directory containing ca_certs and host_certs certificate directories. | -
| = |
- (BoolOpt) Trust and store the first certificate received for each controller address and use it to validate future connections to that address. | -
| = |
- (BoolOpt) Sync data on connect | -
| = |
- (IntOpt) Maximum number of threads to spawn to handle large volumes of port creations. | -
| [RESTPROXYAGENT] | -|
| = |
- (StrOpt) Name of integration bridge on compute nodes used for security group insertion. | -
| = |
- (IntOpt) Seconds between agent checks for port changes | -
| = |
- (StrOpt) Virtual switch type. | -
| [ROUTER] | -|
| = |
- (IntOpt) Maximum number of router rules | -
| = |
- (MultiStrOpt) The default router rules installed in new tenant routers. Repeat the config option for each rule. Format is <tenant>:<source>:<destination>:<action> Use an * to specify default for all tenants. | -
| Configuration option = Default value | -Description | -
|---|---|
| [ML2_BROCADE_MLX_EXAMPLE] | -|
| = |
- (StrOpt) The address of the host to SSH to | -
| = |
- (StrOpt) OS type of the device. | -
| = |
- (StrOpt) The SSH password to use | -
| = |
- (StrOpt) Allowed physical networks | -
| = |
- (StrOpt) Ports | -
| = |
- (StrOpt) Protocol used to communicate with Switch | -
| = |
- (StrOpt) The SSH username to use | -
| [ml2_brocade] | -|
| = |
- (StrOpt) The address of the host to SSH to | -
| = |
- (StrOpt) OS Type of the switch | -
| = |
- (StrOpt) OS Version number | -
| = |
- (StrOpt) The SSH password to use | -
| = |
- (StrOpt) Allowed physical networks | -
| = |
- (StrOpt) Rbridge id of provider edge router(s) | -
| = |
- (StrOpt) The SSH username to use | -
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_brocade_fi_ni] | -|
| = |
- (StrOpt) Switches connected to the compute nodes | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Prefix for APIC domain/names/profiles created | -
| [ml2_cisco] | -|
| = |
- (BoolOpt) Enable strict host key checks when connecting to Nexus switches | -
| = |
- (StrOpt) The physical network managed by the switches. | -
| = |
- (BoolOpt) Prevent caching ssh connections to Nexus device | -
| = |
- (BoolOpt) To make Nexus configuration persistent | -
| = |
- (BoolOpt) Provider VLANs are automatically created as needed on the Nexus switch | -
| = |
- (BoolOpt) Provider VLANs are automatically trunked as needed on the ports of the Nexus switch | -
| = |
- (StrOpt) VLAN Name prefix for provider vlans | -
| = |
- (BoolOpt) Distribute SVI interfaces over all switches | -
| = |
- (IntOpt) Periodic time to check switch connection. (0=disabled) | -
| = |
- (StrOpt) VLAN Name prefix | -
| = |
- (BoolOpt) Create and delete Nexus switch VXLAN global settings; feature nv overlay, feature vn-segment-vlan-based, interface nve + source-interface loopback | -
| [ml2_cisco_apic] | -|
| = |
- (FloatOpt) Interval between agent poll for topology (in sec) | -
| = |
- (FloatOpt) Interval between agent status updates (in sec) | -
| = |
- (StrOpt) Name for the app profile used for Openstack | -
| = |
- (StrOpt) Name for the domain created on APIC | -
| = |
- (StrOpt) Name of the entity profile to be created | -
| = |
- (StrOpt) Name of the function profile to be created | -
| = |
- (ListOpt) The uplink ports to check for ACI connectivity | -
| = |
- (ListOpt) An ordered list of host names or IP addresses of the APIC controller(s). | -
| = |
- (StrOpt) Name of the LACP profile to be created | -
| = |
- (StrOpt) Name mapping strategy to use: use_uuid | use_name | -
| = |
- (StrOpt) Name of the node profile to be created | -
| = |
- (StrOpt) Password for the APIC controller | -
| = |
- (IntOpt) Synchronization interval in seconds | -
| = |
- (BoolOpt) Use SSL to connect to the APIC controller | -
| = |
- (StrOpt) Username for the APIC controller | -
| = |
- (StrOpt) Name for the vlan namespace to be used for Openstack | -
| = |
- (StrOpt) Range of VLAN's to be used for Openstack | -
| = |
- (ListOpt) The switch pairs for VPC connectivity | -
| [ml2_cisco_n1kv] | -|
| = |
- (StrOpt) Cisco Nexus1000V default policy profile. | -
| = |
- (IntOpt) Number of threads to use to make HTTP requests. | -
| = |
- (IntOpt) HTTP timeout, in seconds, for connections to the Cisco Nexus1000V VSMs. | -
| = |
- (ListOpt) Comma Separated IP Addresses of the Cisco Nexus1000V VSMs. | -
| = |
- (StrOpt) Password for all configured Cisco Nexus1000V VSMs. | -
| = |
- (IntOpt) Cisco Nexus1000V policy profile polling duration in seconds. | -
| = |
- (BoolOpt) Restrict the visibility of network profiles to the tenants. | -
| = |
- (BoolOpt) Restrict the visibility of policy profiles to the tenants. | -
| = |
- (IntOpt) Time interval between consecutive neutron-VSM syncs. | -
| = |
- (StrOpt) Username for all configured Cisco Nexus1000V VSMs. | -
| [ml2_cisco_ucsm] | -|
| = |
- (ListOpt) List of comma separated vendor_id:product_id of SR_IOV capable devices supported by this MD. This MD supports both VM-FEX and SR-IOV devices. | -
| = |
- (ListOpt) List of comma separated Host:Service Profile tuples providing the Service Profile associated with each Host to be supported by this MD. | -
| = |
- (StrOpt) Cisco UCS Manager IP address. This is a required field to communicate with a Cisco UCS Manager. | -
| = |
- (StrOpt) Password for UCS Manager. This is a required field to communicate with a Cisco UCS Manager. | -
| = |
- (StrOpt) Username for UCS Manager. This is a required field to communicate with a Cisco UCS Manager. | -
| [ml2_type_nexus_vxlan] | -|
| = |
- (ListOpt) List of multicast groups to be used for global VNIDsin the format - a:b,c,e:f. | -
| = |
- (ListOpt) List of global VNID ranges in the format - a:b, c:d.Multiple ranges can be separated by a comma | -
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_type_flat] | -|
| = |
- (ListOpt) List of physical_network names with which flat networks can be created. Use * to allow flat networks with arbitrary physical_network names. | -
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_fslsdn] | -|
| = |
- (BoolOpt) If set, ignore any SSL validation issues. | -
| = |
- (StrOpt) Auth strategy for connecting to neutron in admin context. | -
| = |
- (StrOpt) CRD Auth URL. | -
| = |
- (StrOpt) Location of ca certificates file to use for CRD client requests. | -
| = |
- (StrOpt) CRD Service Password. | -
| = |
- (StrOpt) Region name for connecting to CRD Service in admin context. | -
| = |
- (StrOpt) CRD Tenant Name. | -
| = |
- (StrOpt) URL for connecting to CRD service. | -
| = |
- (IntOpt) Timeout value for connecting to CRD service in seconds. | -
| = |
- (StrOpt) CRD service Username. | -
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_type_geneve] | -|
| = |
- (IntOpt) Geneve encapsulation header size is dynamic, this value is used to calculate the maximum MTU for the driver.this is the sum of the sizes of the outer ETH + IP + UDP + GENEVE header sizes | -
| = |
- (ListOpt) Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of Geneve VNI IDs that are available for tenant network allocation | -
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_type_gre] | -|
| = |
- (ListOpt) Comma-separated list of <tun_min>:<tun_max> tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation | -
| Configuration option = Default value | -Description | -
|---|---|
| [l2pop] | -|
| = |
- (IntOpt) Delay within which agent is expected to update existing ports whent it restarts | -
| Configuration option = Default value | -Description | -
|---|---|
| [ESWITCH] | -|
| = |
- (IntOpt) backoff rate multiplier for waiting period between retries for request to daemon, i.e. value of 2 will double the request timeout each retry | -
| = |
- (StrOpt) eswitch daemon end point | -
| = |
- (ListOpt) List of <physical_network>:<physical_interface> | -
| = |
- (IntOpt) The number of milliseconds the agent will wait for response on request to daemon. | -
| = |
- (IntOpt) The number of retries the agent will send request to daemon before giving up | -
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_ncs] | -|
| = |
- (StrOpt) HTTP password for authentication | -
| = |
- (IntOpt) HTTP timeout in seconds. | -
| = |
- (StrOpt) HTTP URL of Tail-f NCS REST interface. | -
| = |
- (StrOpt) HTTP username for authentication | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (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. | -
| = |
- (StrOpt) Default rule. Enforced when a requested rule is not found. | -
| = |
- (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. | -
| = |
- (StrOpt) The JSON file that defines policies. | -
| = |
- (BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here? | -
| [ml2_odl] | -|
| = |
- (StrOpt) HTTP password for authentication | -
| = |
- (IntOpt) Tomcat session timeout in minutes. | -
| = |
- (IntOpt) HTTP timeout in seconds. | -
| = |
- (StrOpt) HTTP URL of OpenDaylight REST interface. | -
| = |
- (StrOpt) HTTP username for authentication | -
| Configuration option = Default value | -Description | -
|---|---|
| [AGENT] | -|
| = |
- (BoolOpt) Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel. | -
| = |
- (IntOpt) Number of seconds to retry acquiring an Open vSwitch datapath | -
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_sriov] | -|
| = |
- (BoolOpt) SRIOV neutron agent is required for port binding. DEPRECATED: This option is deprecated in the Liberty release and will be removed in the Mitaka release. From Mitaka the agent will always be required. | -
| = |
- (ListOpt) Supported PCI vendor devices, defined by vendor_id:product_id according to the PCI ID Repository. Default enables support for Intel and Mellanox SR-IOV capable NICs | -
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_type_vlan] | -|
| = |
- (ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks. | -
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_type_vxlan] | -|
| = |
- (ListOpt) Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation | -
| = |
- (StrOpt) Multicast group for VXLAN. If unset, disables VXLAN multicast mode. | -
| Configuration option = Default value | -Description | -
|---|---|
| [OFC] | -|
| = |
- (IntOpt) Maximum attempts per OFC API request. NEC plugin retries API request to OFC when OFC returns ServiceUnavailable (503). The value must be greater than 0. | -
| = |
- (StrOpt) Location of certificate file. | -
| = |
- (StrOpt) Driver to use. | -
| = |
- (BoolOpt) Enable packet filter. | -
| = |
- (StrOpt) Host to connect to. | -
| = |
- (BoolOpt) Disable SSL certificate verification. | -
| = |
- (StrOpt) Location of key file. | -
| = |
- (StrOpt) Base URL of OFC REST API. It is prepended to each API request. | -
| = |
- (StrOpt) Port to connect to. | -
| = |
- (BoolOpt) Support packet filter on OFC router interface. | -
| = |
- (BoolOpt) Use SSL to connect. | -
| [PROVIDER] | -|
| = |
- (StrOpt) Default router provider to use. | -
| = |
- (ListOpt) List of enabled router providers. | -
| [fwaas] | -|
| = |
- (StrOpt) Name of the FWaaS Driver | -
| Configuration option = Default value | -Description | -
|---|---|
| [nova] | -|
| = |
- (StrOpt) Name of the plugin to load | -
| = |
- (StrOpt) Config Section from which to load plugin specific options | -
| = |
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections. | -
| = |
- (StrOpt) PEM encoded client certificate cert file | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) PEM encoded client certificate key file | -
| = |
- (StrOpt) Name of nova region to use. Useful if keystone manages more than one region. | -
| = |
- (IntOpt) Timeout value for http requests | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Reconnect connection to nsx if not used within this amount of time. | -
| = |
- (StrOpt) Unique identifier of the Service Cluster which will be used by logical services like dhcp and metadata | -
| = |
- (StrOpt) This is uuid of the default NSX Transport zone that will be used for creating tunneled isolated "Neutron" networks. It needs to be created in NSX before starting Neutron with the nsx plugin. | -
| = |
- (IntOpt) Time before aborting a request | -
| = |
- (ListOpt) Lists the NSX controllers in this cluster | -
| = |
- (StrOpt) Name of the interface on a L2 Gateway transport nodewhich should be used by default when setting up a network connection | -
| = |
- (StrOpt) Class path for the L2 gateway backend driver | -
| = |
- (StrOpt) Password for NSX controllers in this cluster | -
| = |
- (StrOpt) User name for NSX controllers in this cluster | -
| = |
- (IntOpt) Number of times a redirect should be followed | -
| = |
- (IntOpt) Number of time a request should be retried | -
| [NSX] | -|
| = |
- (StrOpt) The mode used to implement DHCP/metadata services. | -
| = |
- (IntOpt) Maximum concurrent connections to each NSX controller. | -
| = |
- (StrOpt) The default network tranport type to use (stt, gre, bridge, ipsec_gre, or ipsec_stt) | -
| = |
- (IntOpt) Maximum number of ports of a logical switch on a bridged transport zone (default 5000) | -
| = |
- (IntOpt) Maximum number of ports of a logical switch on an overlay transport zone (default 256) | -
| = |
- (StrOpt) If set to access_network this enables a dedicated connection to the metadata proxy for metadata server access via Neutron router. If set to dhcp_host_route this enables host route injection via the dhcp agent. This option is only useful if running on a host that does not support namespaces otherwise access_network should be used. | -
| = |
- (IntOpt) Number of seconds a generation id should be valid for (default -1 meaning do not time out) | -
| = |
- (StrOpt) The default option leverages service nodes to perform packet replication though one could set to this to 'source' to perform replication locally. This is useful if one does not want to deploy a service node(s). It must be set to 'service' for leveraging distributed routers. | -
| [NSX_DHCP] | -|
| = |
- (IntOpt) Default DHCP lease time | -
| = |
- (StrOpt) Domain to use for building the hostnames | -
| = |
- (ListOpt) Comma separated list of additional domain name servers | -
| [NSX_LSN] | -|
| = |
- (BoolOpt) Pull LSN information from NSX in case it is missing from the local data store. This is useful to rebuild the local store in case of server recovery. | -
| [NSX_METADATA] | -|
| = |
- (StrOpt) IP address used by Metadata server. | -
| = |
- (IntOpt) TCP Port used by Metadata server. | -
| = |
- (StrOpt) Shared secret to sign instance-id request | -
| [NSX_SYNC] | -|
| = |
- (BoolOpt) Always read operational status from backend on show operations. Enabling this option might slow down the system. | -
| = |
- (IntOpt) Maximum value for the additional random delay in seconds between runs of the state synchronization task | -
| = |
- (IntOpt) Minimum number of resources to be retrieved from NSX during state synchronization | -
| = |
- (IntOpt) Minimum delay, in seconds, between two state synchronization queries to NSX. It must not exceed state_sync_interval | -
| = |
- (IntOpt) Interval in seconds between runs of the state synchronization task. Set it to 0 to disable it | -
| [nsx_v3] | -|
| = |
- (StrOpt) Specify a CA bundle file to use in verifying the NSX Manager server certificate. | -
| = |
- (StrOpt) Default bridge cluster identifier for L2 gateway. This needs to be created in NSX before using the L2 gateway service plugin. | -
| = |
- (StrOpt) Default edge cluster identifier | -
| = |
- (StrOpt) This is the UUID of the default NSX overlay transport zone that will be used for creating tunneled isolated Neutron networks. It needs to be created in NSX before starting Neutron with the NSX plugin. | -
| = |
- (StrOpt) Default tier0 router identifier | -
| = |
- (StrOpt) This is the UUID of the default NSX VLAN transport zone that will be used for bridging between Neutron networks. It needs to be created in NSX before starting Neutron with the NSX plugin. | -
| = |
- (BoolOpt) If true, the NSX Manager server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "ca_file" is set. | -
| = |
- (StrOpt) IP address of the NSX manager | -
| = |
- (StrOpt) Password for the NSX manager | -
| = |
- (StrOpt) User name for the NSX manager | -
| = |
- (IntOpt) Maximum number of times to retry API request | -
| [nsxv] | -|
| = |
- (ListOpt) Defines edge pool using the format: <edge_type>:[edge_size]:<min_edges>:<max_edges>.edge_type: service,vdr. edge_size: compact, large, xlarge, quadlarge and default is large. | -
| = |
- (StrOpt) Specify a CA bundle file to use in verifying the NSXv server certificate. | -
| = |
- (ListOpt) Parameter listing the IDs of the clusters which are used by OpenStack. | -
| = |
- (StrOpt) Optional parameter identifying the ID of datacenter to deploy NSX Edges | -
| = |
- (StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges | -
| = |
- (StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges | -
| = |
- (IntOpt) DHCP default lease time. | -
| = |
- (StrOpt) DVS ID for VLANs | -
| = |
- (StrOpt) Password to configure for Edge appliance login | -
| = |
- (StrOpt) Username to configure for Edge appliance login | -
| = |
- (BoolOpt) Enable HA for NSX Edges | -
| = |
- (StrOpt) Edge appliance size to be used for creating exclusive router. Valid values: ['compact', 'large', 'xlarge', 'quadlarge']. This edge_appliance_size will be picked up if --router-size parameter is not specified while doing neutron router-create | -
| = |
- (StrOpt) Network ID for physical network connectivity | -
| = |
- (BoolOpt) If true, the NSXv server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "ca_file" is set. | -
| = |
- (StrOpt) A URL to a locking mechanism coordinator | -
| = |
- (StrOpt) uri for vsm | -
| = |
- (IntOpt) Maximum number of sub interfaces supported per vnic in edge. | -
| = |
- (BoolOpt) If True, the server instance will attempt to initialize the metadata infrastructure | -
| = |
- (StrOpt) Shared secret to sign metadata requests | -
| = |
- (StrOpt) Management network default gateway for metadata proxy | -
| = |
- (StrOpt) Network ID for management network connectivity | -
| = |
- (ListOpt) Management network IP address for metadata proxy | -
| = |
- (StrOpt) Management network netmask for metadata proxy | -
| = |
- (ListOpt) IP addresses used by Nova metadata service | -
| = |
- (IntOpt) TCP Port used by Nova metadata server | -
| = |
- (StrOpt) Password for vsm | -
| = |
- (StrOpt) Optional parameter identifying the ID of resource to deploy NSX Edges | -
| = |
- (IntOpt) Maximum number of API retries on endpoint. | -
| = |
- (BoolOpt) If True then plugin will use NSXV spoofguard component for port-security feature. | -
| = |
- (IntOpt) Task status check interval | -
| = |
- (ListOpt) Ordered list of router_types to allocate as tenant routers. | -
| = |
- (StrOpt) User name for vsm | -
| = |
- (StrOpt) Network scope ID for VXLAN virtual wires | -
| Configuration option = Default value | -Description | -
|---|---|
| [AGENT] | -|
| = |
- (StrOpt) integration bridge | -
| [nvsd] | -|
| = |
- (StrOpt) NVSD Controller IP address | -
| = |
- (StrOpt) NVSD Controller password | -
| = |
- (IntOpt) NVSD Controller Port number | -
| = |
- (IntOpt) Number of login retries to NVSD controller | -
| = |
- (StrOpt) NVSD Controller username | -
| = |
- (IntOpt) NVSD controller REST API request timeout in seconds | -
| Configuration option = Default value | -Description | -
|---|---|
| [onos] | -|
| = |
- (StrOpt) Password for authentication. | -
| = |
- (StrOpt) ONOS ReST interface URL | -
| = |
- (StrOpt) Username for authentication. | -
| Configuration option = Default value | -Description | -
|---|---|
| [CONTRAIL] | -|
| = |
- (StrOpt) IP address to connect to opencontrail controller | -
| = |
- (IntOpt) Port to connect to opencontrail controller | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Name of Open vSwitch bridge to use | -
| = |
- (BoolOpt) Uses veth for an interface or not | -
| = |
- (IntOpt) Timeout in seconds for ovs-vsctl commands | -
| [AGENT] | -|
| = |
- (BoolOpt) Enable local ARP responder if it is supported. Requires OVS 2.1 and ML2 l2population driver. Allows the switch (when supporting an overlay) to respond to an ARP request locally without performing a costly ARP broadcast into the overlay. | -
| = |
- (BoolOpt) Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel. | -
| = |
- (BoolOpt) Reset flow table on start. Setting this to True will cause brief traffic interruption. | -
| = |
- (BoolOpt) Make the l2 agent run in DVR mode. | -
| = |
- (BoolOpt) Use ML2 l2population mechanism driver to learn remote MAC and IPs and improve tunnel scalability. | -
| = |
- (BoolOpt) Minimize polling by monitoring ovsdb for interface changes. | -
| = |
- (IntOpt) The number of seconds to wait before respawning the ovsdb monitor after losing communication with it. | -
| = |
- (BoolOpt) Enable suppression of ARP responses that don't match an IP address that belongs to the port from which they originate. Note: This prevents the VMs attached to this agent from spoofing, it doesn't protect them from other devices which have the capability to spoof (e.g. bare metal or VMs attached to agents without this flag set to True). Spoofing rules will not be added to any ports that have port security disabled. For LinuxBridge, this requires ebtables. For OVS, it requires a version that supports matching ARP headers. | -
| = |
- (IntOpt) Set new timeout in seconds for new rpc calls after agent receives SIGTERM. If value is set to 0, rpc timeout won't be changed | -
| = |
- (BoolOpt) Set or un-set the tunnel header checksum on outgoing IP packet carrying GRE/VXLAN tunnel. | -
| = |
- (ListOpt) Network types supported by the agent (gre and/or vxlan). | -
| = |
- (IntOpt) MTU size of veth interfaces | -
| = |
- (IntOpt) The UDP port to use for VXLAN tunnels. | -
| [OVS] | -|
| = |
- (ListOpt) List of <physical_network>:<bridge>. Deprecated for ofagent. | -
| = |
- (StrOpt) OVS datapath to use. | -
| = |
- (StrOpt) Peer patch port in integration bridge for tunnel bridge. | -
| = |
- (StrOpt) Integration bridge to use. | -
| = |
- (IPOpt) Local IP address of tunnel endpoint. | -
| = |
- (IntOpt) Timeout in seconds to wait for the local switch connecting the controller. Used only for 'native' driver. | -
| = |
- (StrOpt) OpenFlow interface to use. | -
| = |
- (IPOpt) Address to listen on for OpenFlow connections. Used only for 'native' driver. | -
| = |
- (IntOpt) Port to listen on for OpenFlow connections. Used only for 'native' driver. | -
| = |
- (IntOpt) Timeout in seconds to wait for a single OpenFlow request. Used only for 'native' driver. | -
| = |
- (StrOpt) The connection string for the native OVSDB backend | -
| = |
- (StrOpt) The interface for interacting with the OVSDB | -
| = |
- (StrOpt) Peer patch port in tunnel bridge for integration bridge. | -
| = |
- (StrOpt) Tunnel bridge to use. | -
| = |
- (BoolOpt) Use veths instead of patch ports to interconnect the integration bridge to physical bridges. | -
| Configuration option = Default value | -Description | -
|---|---|
| [ovn] | -|
| = |
- (StrOpt) The synchronization mode of OVN with Neutron DB. -off - synchronization is off -log - during neutron-server startup, check to see if OVN is in sync with the Neutron database. Log warnings for any inconsistencies found so that an admin can investigate -repair - during neutron-server startup, automatically create resources found in Neutron but not in OVN. Also remove resources from OVN that are no longer in Neutron. | -
| = |
- (StrOpt) The connection string for the native OVSDB backend | -
| = |
- (IntOpt) Timeout in seconds for the OVSDB connection transaction | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Location to store IPv6 PD files. | -
| = |
- (StrOpt) Service to handle DHCPv6 Prefix delegation. | -
| = |
- (StrOpt) A decimal value as Vendor's Registered Private Enterprise Number as required by RFC3315 DUID-EN. | -
| Configuration option = Default value | -Description | -
|---|---|
| [plumgriddirector] | -|
| = |
- (StrOpt) PLUMgrid Director server to connect to | -
| = |
- (IntOpt) PLUMgrid Director server port to connect to | -
| = |
- (BoolOpt) Distributed locking is enabled or disabled | -
| = |
- (StrOpt) PLUMgrid Driver | -
| = |
- (StrOpt) PLUMgrid Director admin password | -
| = |
- (IntOpt) PLUMgrid Director server timeout | -
| = |
- (StrOpt) PLUMgrid Director admin username | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Allow overlapping IP support in Neutron | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_qpid] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (IntOpt) Seconds between connection keepalive heartbeats. | -
| = |
- (StrOpt) Qpid broker hostname. | -
| = |
- (ListOpt) Qpid HA cluster host:port pairs. | -
| = |
- (StrOpt) Password for Qpid connection. | -
| = |
- (IntOpt) Qpid broker port. | -
| = |
- (StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| = |
- (IntOpt) The number of prefetched messages held by receiver. | -
| = |
- (StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| = |
- (BoolOpt) Whether to disable the Nagle algorithm. | -
| = |
- (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. | -
| = |
- (StrOpt) Username for Qpid connection. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Maximum number of routes | -
| [QUOTAS] | -|
| = |
- (IntOpt) Default number of resource allowed per tenant. A negative value means unlimited. | -
| = |
- (StrOpt) Default driver to use for quota checks | -
| = |
- (IntOpt) Number of firewalls allowed per tenant. A negative value means unlimited. | -
| = |
- (IntOpt) Number of firewall policies allowed per tenant. A negative value means unlimited. | -
| = |
- (IntOpt) Number of firewall rules allowed per tenant. A negative value means unlimited. | -
| = |
- (IntOpt) Number of floating IPs allowed per tenant. A negative value means unlimited. | -
| = |
- (IntOpt) Number of health monitors allowed per tenant. A negative value means unlimited. | -
| = |
- (IntOpt) Number of health monitors allowed per tenant. A negative value means unlimited. | -
| = |
- (ListOpt) Resource name(s) that are supported in quota features. This option is now deprecated for removal. | -
| = |
- (IntOpt) Number of Loadbalancer Listeners allowed per tenant. A negative value means unlimited. | -
| = |
- (IntOpt) Number of LoadBalancers allowed per tenant. A negative value means unlimited. | -
| = |
- (IntOpt) Number of pool members allowed per tenant. A negative value means unlimited. | -
| = |
- (IntOpt) Number of networks allowed per tenant. A negative value means unlimited. | -
| = |
- (IntOpt) Number of network gateways allowed per tenant, -1 for unlimited | -
| = |
- (IntOpt) Number of packet_filters allowed per tenant, -1 for unlimited | -
| = |
- (IntOpt) Number of pools allowed per tenant. A negative value means unlimited. | -
| = |
- (IntOpt) Number of ports allowed per tenant. A negative value means unlimited. | -
| = |
- (IntOpt) Default number of RBAC entries allowed per tenant. A negative value means unlimited. | -
| = |
- (IntOpt) Number of routers allowed per tenant. A negative value means unlimited. | -
| = |
- (IntOpt) Number of security groups allowed per tenant. A negative value means unlimited. | -
| = |
- (IntOpt) Number of security rules allowed per tenant. A negative value means unlimited. | -
| = |
- (IntOpt) Number of subnets allowed per tenant, A negative value means unlimited. | -
| = |
- (IntOpt) Number of vips allowed per tenant. A negative value means unlimited. | -
| = |
- (BoolOpt) Keep in track in the database of current resourcequota usage. Plugins which do not leverage the neutron database should set this flag to False | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_rabbit] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake | -
| = |
- (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. | -
| = |
- (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL | -
| = |
- (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| = |
- (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). | -
| = |
- (StrOpt) SSL cert file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL key file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. | -
| = |
- (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| = |
- (StrOpt) The RabbitMQ broker address where a single node is used. | -
| = |
- (ListOpt) RabbitMQ HA cluster host:port pairs. | -
| = |
- (StrOpt) The RabbitMQ login method. | -
| = |
- (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| = |
- (StrOpt) The RabbitMQ password. | -
| = |
- (IntOpt) The RabbitMQ broker port where a single node is used. | -
| = |
- (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| = |
- (IntOpt) How frequently to retry connecting with RabbitMQ. | -
| = |
- (BoolOpt) Connect over SSL for RabbitMQ. | -
| = |
- (StrOpt) The RabbitMQ userid. | -
| = |
- (StrOpt) The RabbitMQ virtual host. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [matchmaker_redis] | -|
| = |
- (StrOpt) Host to locate redis. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| [matchmaker_ring] | -|
| = |
- (StrOpt) Matchmaker ring file (JSON). | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Heartbeat frequency. | -
| = |
- (IntOpt) Heartbeat time-to-live. | -
| = |
- (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| = |
- (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| = |
- (IntOpt) Size of RPC connection pool. | -
| = |
- (IntOpt) Seconds to wait for a response from a call. | -
| = |
- (IntOpt) Number of RPC worker processes for service | -
| [oslo_concurrency] | -|
| = |
- (BoolOpt) Enables or disables inter-process locks. | -
| = |
- (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. | -
| [oslo_messaging_amqp] | -|
| = |
- (BoolOpt) Accept clients using either SSL or plain TCP | -
| = |
- (StrOpt) address prefix used when broadcasting to all servers | -
| = |
- (StrOpt) Name for the AMQP container | -
| = |
- (StrOpt) address prefix when sending to any server in group | -
| = |
- (IntOpt) Timeout for inactive connections (in seconds) | -
| = |
- (StrOpt) address prefix used when sending to a specific server | -
| = |
- (StrOpt) CA certificate PEM file to verify server certificate | -
| = |
- (StrOpt) Identifying certificate PEM file to present to clients | -
| = |
- (StrOpt) Private key PEM file used to sign cert_file certificate | -
| = |
- (StrOpt) Password for decrypting ssl_key_file (if encrypted) | -
| = |
- (BoolOpt) Debug: dump AMQP frames to stdout | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Allow auto scheduling networks to DHCP agent. | -
| = |
- (StrOpt) Driver to use for scheduling network to DHCP agent | -
| = |
- (BoolOpt) Allow auto scheduling of routers to L3 agent. | -
| = |
- (BoolOpt) Delete namespace after removing a router.This option is deprecated and will be removed in a future release. | -
| = |
- (StrOpt) Driver to use for scheduling router to a default L3 agent | -
| Configuration option = Default value | -Description | -
|---|---|
| [SDNVE] | -|
| = |
- (StrOpt) Base URL for SDN-VE controller REST API. | -
| = |
- (ListOpt) List of IP addresses of SDN-VE controller(s). | -
| = |
- (StrOpt) Tenant type: OVERLAY (default) or OF. | -
| = |
- (StrOpt) SDN-VE request/response format. | -
| = |
- (StrOpt) SDN-VE RPC subject. | -
| = |
- (StrOpt) Integration bridge to use. | -
| = |
- (ListOpt) List of <physical_network_name>:<interface_name> mappings. | -
| = |
- (StrOpt) The string in tenant description that indicates the tenant is a OF tenant. | -
| = |
- (BoolOpt) Indicating if controller is out of band or not. | -
| = |
- (StrOpt) The string in tenant description that indicates the tenant is a OVERLAY tenant. | -
| = |
- (StrOpt) SDN-VE administrator password. | -
| = |
- (StrOpt) SDN-VE controller port number. | -
| = |
- (BoolOpt) Whether to reset the integration bridge before use. | -
| = |
- (BoolOpt) Whether to use a fake controller. | -
| = |
- (StrOpt) SDN-VE administrator user ID. | -
| [SDNVE_AGENT] | -|
| = |
- (IntOpt) Agent polling interval if necessary. | -
| = |
- (BoolOpt) Whether to use rpc. | -
| Configuration option = Default value | -Description | -
|---|---|
| [SECURITYGROUP] | -|
| = |
- (BoolOpt) Enable defer_apply on security bridge. | -
| = |
- (BoolOpt) Use ipset to speed-up the iptables based security groups. | -
| = |
- (BoolOpt) Controls whether the neutron security group API is enabled in the server. It should be false when using no security groups or using the nova security group API. | -
| = |
- (StrOpt) Driver for security groups firewall in the L2 agent | -
| = |
- (StrOpt) DriverManager implementation for OVS based Firewall. | -
| = |
- (StrOpt) <security_bridge>:<phy_interface> | -
| Configuration option = Default value | -Description | -
|---|---|
| [SRIOV_NIC] | -|
| = |
- (ListOpt) List of <network_device>:<excluded_devices> mapping network_device to the agent's node-specific list of virtual functions that should not be used for virtual networking. excluded_devices is a semicolon separated list of virtual functions (BDF format).to exclude from network_device. The network_device in the mapping should appear in the physical_device_mappings list. | -
| = |
- (ListOpt) List of <physical_network>:<network_device> mapping physical network names to the agent's node-specific physical network device of SR-IOV physical function to be used for VLAN networks. All physical networks listed in network_vlan_ranges on the server should have mappings to appropriate interfaces on each agent | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) default_interface_name of the l2 gateway | -
| [OVSVAPP] | -|
| = |
- (StrOpt) OVSvApp Agent implementation. | -
| = |
- (ListOpt) Bridge mappings. | -
| = |
- (IntOpt) Do not fragment. | -
| = |
- (BoolOpt) To monitor the OVSvApp Agents. | -
| = |
- (StrOpt) Integration Bridge. | -
| = |
- (StrOpt) Local IP address of VXLAN tunnel endpoint. | -
| = |
- (StrOpt) IP address for monitoring OVS Status. | -
| = |
- (StrOpt) Driver Manager implementation for NetworkDriver. | -
| = |
- (IntOpt) The number of seconds the agent will wait between polling for local device changes. | -
| = |
- (IntOpt) Seconds between nodes reporting state to server. | -
| = |
- (StrOpt) Network type for tenant networks | -
| = |
- (StrOpt) Tunnel Bridge for tunneling. | -
| = |
- (BoolOpt) Set or un-set the tunnel header checksum on outgoing IP packet carrying GRE/VXLAN tunnel. | -
| = |
- (ListOpt) Tunnel network types supported by the OVSvApp Agent. | -
| = |
- (IntOpt) MTU size of veth interfaces. | -
| = |
- (IntOpt) The UDP port to use for VXLAN tunnels. | -
| [VMWARE] | -|
| = |
- (BoolOpt) Enable SSL certificate check for vCenter. | -
| = |
- (StrOpt) Certificate chain path containing cacert of vCenters. | -
| = |
- (MultiStrOpt) vCenter cluster to DVS mapping. | -
| = |
- (StrOpt) ESX host name where this OVSvApp is hosted. | -
| = |
- (BoolOpt) Set host into maintenance mode. | -
| = |
- (IntOpt) Customized https_port for vCenter communication. | -
| = |
- (StrOpt) Number of retries while connecting to vcenter server. | -
| = |
- (StrOpt) Unique ID of the vCenter Server on which this OVSvApp ishosted | -
| = |
- (StrOpt) vCenter server IP. | -
| = |
- (StrOpt) vCenter server password. | -
| = |
- (StrOpt) vCenter server user name. | -
| = |
- (StrOpt) vCenter server wsdl location. | -
| [vmware] | -|
| = |
- (IntOpt) Set this value if affected by an increased network latency causing repeated characters when typing in a remote console. | -
| = |
- (IntOpt) The maximum number of ObjectContent data objects that should be returned in a single result. A positive value will cause the operation to suspend the retrieval when the count of objects reaches the specified maximum. The server may still limit the count to something less than the configured value. Any remaining objects may be retrieved with additional requests. | -
| = |
- (StrOpt) Identifies a proxy service that provides network access to the serial_port_service_uri. This option is ignored if serial_port_service_uri is not specified. | -
| = |
- (StrOpt) Identifies the remote system that serial port traffic will be sent to. If this is not set, no serial ports will be added to the created VMs. | -
| Configuration option = Default value | -Description | -
|---|---|
| [vpnagent] | -|
| = |
- (MultiStrOpt) The vpn device drivers Neutron will use | -
| Configuration option = Default value | -Description | -
|---|---|
| [ipsec] | -|
| = |
- (StrOpt) Location to store ipsec server config files | -
| = |
- (BoolOpt) Enable detail logging for ipsec pluto process. If the flag set to True, the detailed logging will be written into config_base_dir/<pid>/logs. | -
| = |
- (IntOpt) Interval for checking ipsec status | -
| Configuration option = Default value | -Description | -
|---|---|
| [libreswan] | -|
| = |
- (FloatOpt) A factor to increase the retry interval for each retry | -
| = |
- (IntOpt) The maximum number of retries for checking for pluto daemon shutdown | -
| = |
- (IntOpt) Initial interval in seconds for checking if pluto daemon is shutdown | -
| Configuration option = Default value | -Description | -
|---|---|
| [openswan] | -|
| = |
- (StrOpt) Template file for ipsec configuration | -
| = |
- (StrOpt) Template file for ipsec secret configuration | -
| Configuration option = Default value | -Description | -
|---|---|
| [strongswan] | -|
| = |
- (StrOpt) The area where default StrongSwan configuration files are located. | -
| = |
- (StrOpt) Template file for ipsec configuration. | -
| = |
- (StrOpt) Template file for ipsec secret configuration. | -
| = |
- (StrOpt) Template file for strongswan configuration. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| = |
- (IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| = |
- (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. | -
| = |
- (StrOpt) Directory for holding IPC sockets. | -
| = |
- (StrOpt) MatchMaker driver. | -
| = |
- (IntOpt) ZeroMQ receiver listening port. | -
| = |
- (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| = |
- (StrOpt) Default publisher_id for outgoing notifications | -
| = |
- (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop | -
| = |
- (ListOpt) AMQP topic used for OpenStack notifications. | -
| = |
- (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) File name for the paste.deploy config for nova-api | -
| = |
- (BoolOpt) Whether to use per-user rate limiting for the api. This option is only used by v2 api. Rate limiting is removed from v2.1 api. | -
| = |
- (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. | -
| = |
- (BoolOpt) Services to be added to the available pool on create | -
| = |
- (ListOpt) A list of APIs to enable by default | -
| = |
- (ListOpt) A list of APIs with enabled SSL | -
| = |
- (StrOpt) Template string to be used to generate instance names | -
| = |
- (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). | -
| = |
- (StrOpt) When creating multiple instances with a single request using the os-multiple-create API extension, this template will be used to build the display name for each instance. The benefit is that the instances end up with different hostnames. To restore legacy behavior of every instance having the same name, set this option to "%(name)s". Valid keys for the template are: name, uuid, count. | -
| = |
- (ListOpt) These are image properties which a snapshot should not inherit from an instance | -
| = |
- (StrOpt) Kernel image that indicates not to use a kernel, but to use a raw disk image instead | -
| = |
- (ListOpt) DEPRECATED: Specify list of extensions to load when using osapi_compute_extension option with nova.api.openstack.compute.legacy_v2.contrib.select_extensions This option will be removed in the near future. After that point you have to run all of the API. | -
| = |
- (MultiStrOpt) osapi compute extension to load. This option will be removed in the near future. After that point you have to run all of the API. | -
| = |
- (StrOpt) Base URL that will be presented to users in links to the OpenStack Compute API | -
| = |
- (StrOpt) The IP address on which the OpenStack API will listen. | -
| = |
- (IntOpt) The port on which the OpenStack API will listen. | -
| = |
- (IntOpt) Number of workers for OpenStack API service. The default will be the number of CPUs available. | -
| = |
- (ListOpt) List of instance states that should hide network info | -
| = |
- (StrOpt) The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is "HTTP_X_FORWARDED_PROTO". | -
| = |
- (StrOpt) The driver for servicegroup service (valid options are: db, zk, mc) | -
| = |
- (StrOpt) Template string to be used to generate snapshot names | -
| = |
- (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. | -
| = |
- (BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. | -
| = |
- (IntOpt) Size of the pool of greenthreads used by wsgi | -
| = |
- (BoolOpt) If False, closes the client socket connection explicitly. | -
| = |
- (StrOpt) A python format string that is used as the template to generate log lines. The following values can be formatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds. | -
| [oslo_middleware] | -|
| = |
- (IntOpt) The maximum body size for each request, in bytes. | -
| = |
- (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_versionedobjects] | -|
| = |
- (BoolOpt) Make exception message format errors fatal | -
| Configuration option = Default value | -Description | -
|---|---|
| [osapi_v21] | -|
| = |
- (BoolOpt) DEPRECATED: Whether the V2.1 API is enabled or not. This option will be removed in the near future. | -
| = |
- (ListOpt) DEPRECATED: A list of v2.1 API extensions to never load. Specify the extension aliases here. This option will be removed in the near future. After that point you have to run all of the API. | -
| = |
- (ListOpt) DEPRECATED: If the list is not empty then a v2.1 API extension will only be loaded if it exists in this list. Specify the extension aliases here. This option will be removed in the near future. After that point you have to run all of the API. | -
| Configuration option = Default value | -Description | -
|---|---|
| [osapi_v3] | -|
| = |
- (BoolOpt) Whether the V3 API is enabled or not | -
| = |
- (ListOpt) A list of v3 API extensions to never load. Specify the extension aliases here. | -
| = |
- (ListOpt) If the list is not empty then a v3 API extension will only be loaded if it exists in this list. Specify the extension aliases here. | -
| Configuration option = Default value | -Description | -
|---|---|
| [keystone_authtoken] | -|
| = |
- (StrOpt) Service user password. | -
| = |
- (StrOpt) Service tenant name. | -
| = |
- (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | -
| = |
- (StrOpt) Service username. | -
| = |
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Name of the plugin to load | -
| = |
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | -
| = |
- (StrOpt) Config Section from which to load plugin specific options | -
| = |
- (StrOpt) Complete public Identity API endpoint. | -
| = |
- (StrOpt) API version of the admin Identity API endpoint. | -
| = |
- (StrOpt) Env key for the swift cache. | -
| = |
- (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. | -
| = |
- (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. | -
| = |
- (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| = |
- (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | -
| = |
- (IntOpt) Request timeout value for communicating with Identity API server. | -
| = |
- (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| = |
- (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | -
| = |
- (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. | -
| = |
- (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. | -
| = |
- (IntOpt) (Optional) Maximum total number of open connections to every memcached server. | -
| = |
- (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. | -
| = |
- (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. | -
| = |
- (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. | -
| = |
- (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. | -
| = |
- (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. | -
| = |
- (StrOpt) The region in which the identity server can be found. | -
| = |
- (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| = |
- (StrOpt) Directory used to cache files related to PKI tokens. | -
| = |
- (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The strategy to use for auth: keystone or noauth2. noauth2 is designed for -testing only, as it does no actual credential checking. noauth2 provides -administrative credentials only if 'admin' is specified as the username. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Default compute node availability_zone | -
| = |
- (StrOpt) Availability zone to use when user doesn't specify one | -
| = |
- (StrOpt) The availability_zone to show internal services under | -
| Configuration option = Default value | -Description | -
|---|---|
| [barbican] | -|
| = |
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections. | -
| = |
- (StrOpt) Info to match when looking for barbican in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> | -
| = |
- (StrOpt) PEM encoded client certificate cert file | -
| = |
- (StrOpt) Override service catalog lookup with template for barbican endpoint e.g. http://localhost:9311/v1/%(project_id)s | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) PEM encoded client certificate key file | -
| = |
- (StrOpt) Region name of this node | -
| = |
- (IntOpt) Timeout value for http requests | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Filename of root CA | -
| = |
- (StrOpt) Where we keep our root CA | -
| = |
- (StrOpt) SSL certificate file | -
| = |
- (StrOpt) Full class name for the Manager for cert | -
| = |
- (StrOpt) The topic cert nodes listen on | -
| = |
- (StrOpt) Filename of root Certificate Revocation List | -
| = |
- (StrOpt) Filename of private key | -
| = |
- (StrOpt) Where we keep our keys | -
| = |
- (StrOpt) Subject for certificate for projects, %s for project, timestamp | -
| = |
- (StrOpt) CA certificate file to use to verify connecting clients | -
| = |
- (StrOpt) SSL certificate of API server | -
| = |
- (StrOpt) SSL private key of API server | -
| = |
- (BoolOpt) Should we use a CA for each project? | -
| = |
- (StrOpt) Subject for certificate for users, %s for project, user, timestamp | -
| [ssl] | -|
| = |
- (StrOpt) CA certificate file to use to verify connecting clients. | -
| = |
- (StrOpt) Certificate file to use when starting the server securely. | -
| = |
- (StrOpt) Private key file to use when starting the server securely. | -
| Configuration option = Default value | -Description | -
|---|---|
| [cells] | -|
| = |
- (IntOpt) Seconds to wait for response from a call to a cell. | -
| = |
- (ListOpt) Key/Multi-value list with the capabilities of the cell | -
| = |
- (StrOpt) Type of cell | -
| = |
- (StrOpt) Configuration file from which to read cells configuration. If given, overrides reading cells from the database. | -
| = |
- (IntOpt) Interval, in seconds, for getting fresh cell information from the database. | -
| = |
- (StrOpt) Cells communication driver to use | -
| = |
- (BoolOpt) Enable cell functionality | -
| = |
- (IntOpt) Number of instances to update per periodic task run | -
| = |
- (IntOpt) Number of seconds after an instance was updated or deleted to continue to update cells | -
| = |
- (StrOpt) Manager for cells | -
| = |
- (IntOpt) Maximum number of hops for cells routing. | -
| = |
- (IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute. | -
| = |
- (FloatOpt) Multiplier used to weigh mute children. (The value should be negative.) | -
| = |
- (StrOpt) Name of this cell | -
| = |
- (FloatOpt) Multiplier used to weigh offset weigher. | -
| = |
- (FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization | -
| = |
- (StrOpt) The topic cells nodes listen on | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Directory where nova binaries are installed | -
| = |
- (StrOpt) The topic compute nodes listen on | -
| = |
- (StrOpt) The topic console proxy nodes listen on | -
| = |
- (StrOpt) The topic console auth proxy nodes listen on | -
| = |
- (IntOpt) Size of executor thread pool. | -
| = |
- (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address | -
| = |
- (ListOpt) Memcached servers or None for in process cache. | -
| = |
- (StrOpt) IP address of this host | -
| = |
- (BoolOpt) If set, send api.fault notifications on caught exceptions in the API service. | -
| = |
- (StrOpt) If set, send compute.instance.update notifications on instance state changes. Valid values are None for no notifications, "vm_state" for notifications on VM state changes, or "vm_and_task_state" for notifications on VM and task state changes. | -
| = |
- (StrOpt) Directory where the nova python module is installed | -
| = |
- (IntOpt) Seconds between nodes reporting state to datastore | -
| = |
- (StrOpt) Path to the rootwrap configuration file to use for running commands as root | -
| = |
- (IntOpt) Maximum time since last check-in for up service | -
| = |
- (StrOpt) Top-level directory for maintaining nova's state | -
| = |
- (StrOpt) Explicitly specify the temporary working directory | -
| = |
- (BoolOpt) Start and use a daemon that can run the commands that need to be run with root privileges. This option is usually enabled on nodes that run nova compute processes | -
| [keystone_authtoken] | -|
| = |
- (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| [workarounds] | -|
| = |
- (BoolOpt) DEPRECATED: Whether to destroy instances on startup when we suspect they have previously been evacuated. This can result in data loss if undesired. See https://launchpad.net/bugs/1419785 | -
| = |
- (BoolOpt) When using libvirt 1.2.2 live snapshots fail intermittently under load. This config option provides a mechanism to enable live snapshot while this is resolved. See https://bugs.launchpad.net/nova/+bug/1334398 | -
| = |
- (BoolOpt) This option allows a fallback to sudo for performance reasons. For example see https://bugs.launchpad.net/nova/+bug/1415106 | -
| = |
- (BoolOpt) Whether or not to handle events raised from the compute driver's 'emit_event' method. These are lifecycle events raised from compute drivers that implement the method. An example of a lifecycle event is an instance starting or stopping. If the instance is going through task state changes due to an API operation, like resize, the events are ignored. However, this is an advanced feature which allows the hypervisor to signal to the compute service that an unexpected state change has occurred in an instance and the instance can be shutdown automatically - which can inherently race in reboot operations or when the compute service or host is rebooted, either planned or due to an unexpected outage. Care should be taken when using this and sync_power_state_interval is negative since then if any instances are out of sync between the hypervisor and the Nova database they will have to be synchronized manually. See https://bugs.launchpad.net/bugs/1444630 | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (MultiStrOpt) Monitor classes available to the compute which may be specified more than once. This option is DEPRECATED and no longer used. Use setuptools entry points to list available monitor plugins. | -
| = |
- (StrOpt) Driver to use for controlling virtualization. Options include: libvirt.LibvirtDriver, xenapi.XenAPIDriver, fake.FakeDriver, ironic.IronicDriver, vmwareapi.VMwareVCDriver, hyperv.HyperVDriver | -
| = |
- (StrOpt) Full class name for the Manager for compute | -
| = |
- (ListOpt) A list of monitors that can be used for getting compute metrics. You can use the alias/name from the setuptools entry points for nova.compute.monitors.* namespaces. If no namespace is supplied, the "cpu." namespace is assumed for backwards-compatibility. An example value that would enable both the CPU and NUMA memory bandwidth monitors that used the virt driver variant: ["cpu.virt_driver", "numa_mem_bw.virt_driver"] | -
| = |
- (ListOpt) The names of the extra resources to track. | -
| = |
- (StrOpt) Class that will manage stats for the local compute host | -
| = |
- (StrOpt) Console proxy host to use to connect to instances on this host. | -
| = |
- (StrOpt) Full class name for the Manager for console proxy | -
| = |
- (StrOpt) Default flavor to use for the EC2 API only. The Nova API does not support a default flavor. | -
| = |
- (StrOpt) Default notification level for outgoing notifications | -
| = |
- (BoolOpt) Enables returning of the instance password by the relevant server API calls such as create, rebuild or rescue, If the hypervisor does not support password injection then the password returned will not be correct | -
| = |
- (IntOpt) Number of seconds between instance network information cache updates | -
| = |
- (IntOpt) Number of seconds to wait between runs of the image cache manager. Set to -1 to disable. Setting this to 0 will run at the default rate. | -
| = |
- (StrOpt) Where cached images are stored under $instances_path. This is NOT the full path - just a folder name. For per-compute-host cached images, set to _base_$my_ip | -
| = |
- (IntOpt) Amount of time in seconds an instance can be in BUILD before going into ERROR status. Set to 0 to disable. | -
| = |
- (IntOpt) Interval in seconds for retrying failed instance file deletes. Set to -1 to disable. Setting this to 0 will run at the default rate. | -
| = |
- (BoolOpt) Generate periodic compute.instance.exists notifications | -
| = |
- (StrOpt) Time period to generate instance usages for. Time period must be hour, day, month or year | -
| = |
- (StrOpt) Where instances are stored on disk | -
| = |
- (IntOpt) Maximum number of instance builds to run concurrently | -
| = |
- (IntOpt) The number of times to attempt to reap an instance's files. | -
| = |
- (IntOpt) Automatically hard reboot an instance if it has been stuck in a rebooting state longer than N seconds. Set to 0 to disable. | -
| = |
- (IntOpt) Interval in seconds for reclaiming deleted instances | -
| = |
- (IntOpt) Automatically unrescue an instance after N seconds. Set to 0 to disable. | -
| = |
- (IntOpt) Automatically confirm resizes after N seconds. Set to 0 to disable. | -
| = |
- (BoolOpt) Whether to start guests that were running before the host rebooted | -
| = |
- (StrOpt) Action to take if a running deleted instance is detected.Set to 'noop' to take no action. | -
| = |
- (IntOpt) Number of seconds to wait between runs of the cleanup task. | -
| = |
- (IntOpt) Number of seconds after being deleted when a running instance should be considered eligible for cleanup. | -
| = |
- (IntOpt) Time in seconds before a shelved instance is eligible for removing from a host. -1 never offload, 0 offload immediately when shelved | -
| = |
- (IntOpt) Interval in seconds for polling shelved instances to offload. Set to -1 to disable.Setting this to 0 will run at the default rate. | -
| = |
- (IntOpt) Total amount of time to wait in seconds for an instance to perform a clean shutdown. | -
| = |
- (IntOpt) Interval to sync power states between the database and the hypervisor. Set to -1 to disable. Setting this to 0 will run at the default rate. | -
| = |
- (IntOpt) Interval in seconds for updating compute resources. A number less than 0 means to disable the task completely. Leaving this at the default of 0 will cause this to run at the default periodic interval. Setting it to any positive value will cause it to run at approximately that number of seconds. | -
| = |
- (BoolOpt) Fail instance boot if vif plugging fails | -
| = |
- (IntOpt) Number of seconds to wait for neutron vif plugging events to arrive before continuing or failing (see vif_plugging_is_fatal). If this is set to zero and vif_plugging_is_fatal is False, events should not be expected to arrive at all. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Number of times to retry live-migration before failing. If == -1, try until out of hosts. If == 0, only try once, no retries. | -
| [conductor] | -|
| = |
- (StrOpt) Full class name for the Manager for conductor | -
| = |
- (StrOpt) The topic on which conductor nodes listen | -
| = |
- (BoolOpt) Perform nova-conductor operations locally | -
| = |
- (IntOpt) Number of workers for OpenStack Conductor service. The default will be the number of CPUs available. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Config drive format. | -
| = |
- (StrOpt) List of metadata versions to skip placing into the config drive | -
| = |
- (StrOpt) Set to "always" to force injection to take place on a config drive. NOTE: The "always" will be deprecated in the Liberty release cycle. | -
| = |
- (StrOpt) Name and optionally path of the tool used for ISO image creation | -
| [hyperv] | -|
| = |
- (BoolOpt) Attaches the Config Drive image as a cdrom drive instead of a disk drive | -
| = |
- (BoolOpt) Sets the admin password in the config drive image | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (ListOpt) Allowed Origin header hostnames for access to console proxy servers | -
| = |
- (StrOpt) Publicly visible name for this console host | -
| = |
- (IntOpt) How many seconds before deleting tokens | -
| = |
- (StrOpt) Manager for console auth | -
| [mks] | -|
| = |
- (BoolOpt) Enable MKS related features | -
| = |
- (StrOpt) Location of MKS web console proxy, in the form "http://127.0.0.1:6090/" | -
| Configuration option = Default value | -Description | -
|---|---|
| [cors] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The driver to use for database access | -
| [api_database] | -|
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the Nova API database. | -
| = |
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. | -
| = |
- (BoolOpt) Add Python stack traces to SQL as comment strings. | -
| = |
- (IntOpt) Timeout before idle SQL connections are reaped. | -
| = |
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy. | -
| = |
- (IntOpt) Maximum number of SQL connections to keep open in a pool. | -
| = |
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. | -
| = |
- (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | -
| = |
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. | -
| = |
- (IntOpt) Interval between retries of opening a SQL connection. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. | -
| = |
- (BoolOpt) If True, SQLite uses synchronous mode. | -
| [database] | -|
| = |
- (StrOpt) The back end to use for the database. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the database. | -
| = |
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. | -
| = |
- (BoolOpt) Add Python stack traces to SQL as comment strings. | -
| = |
- (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. | -
| = |
- (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. | -
| = |
- (IntOpt) Seconds between retries of a database transaction. | -
| = |
- (IntOpt) Timeout before idle SQL connections are reaped. | -
| = |
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy. | -
| = |
- (IntOpt) Maximum number of SQL connections to keep open in a pool. | -
| = |
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) Minimum number of SQL connections to keep open in a pool. | -
| = |
- (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | -
| = |
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. | -
| = |
- (IntOpt) Interval between retries of opening a SQL connection. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. | -
| = |
- (StrOpt) The file name to use with SQLite. | -
| = |
- (BoolOpt) If True, SQLite uses synchronous mode. | -
| = |
- (BoolOpt) Enable the experimental use of database reconnect on connection lost. | -
| = |
- (BoolOpt) Enable the experimental use of thread pooling for all DB API calls | -
| Configuration option = Default value | -Description | -
|---|---|
| [guestfs] | -|
| = |
- (BoolOpt) Enable guestfs debug | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The internal IP address of the EC2 API server | -
| = |
- (StrOpt) The IP address of the EC2 API server | -
| = |
- (StrOpt) The IP address on which the EC2 API will listen. | -
| = |
- (IntOpt) The port on which the EC2 API will listen. | -
| = |
- (StrOpt) The path prefix used to call the ec2 API server | -
| = |
- (IntOpt) The port of the EC2 API server | -
| = |
- (BoolOpt) Return the IP address as private dns hostname in describe instances | -
| = |
- (StrOpt) The protocol to use when connecting to the EC2 API server | -
| = |
- (BoolOpt) Validate security group names according to EC2 specification | -
| = |
- (IntOpt) Time in seconds before ec2 timestamp expires | -
| = |
- (IntOpt) Number of workers for EC2 API service. The default will be equal to the number of CPUs available. | -
| = |
- (BoolOpt) Disable SSL certificate verification. | -
| = |
- (StrOpt) URL to get token from ec2 request. | -
| = |
- (IntOpt) Number of failed auths before lockout. | -
| = |
- (IntOpt) Number of minutes to lockout if triggered. | -
| = |
- (IntOpt) Number of minutes for lockout window. | -
| = |
- (ListOpt) List of region=fqdn pairs separated by commas | -
| Configuration option = Default value | -Description | -
|---|---|
| [ephemeral_storage_encryption] | -|
| = |
- (StrOpt) The cipher and mode to be used to encrypt ephemeral storage. Which ciphers are available ciphers depends on kernel support. See /proc/crypto for the list of available options. | -
| = |
- (BoolOpt) Whether to encrypt ephemeral storage | -
| = |
- (IntOpt) The bit length of the encryption key to be used to encrypt ephemeral storage (in XTS mode only half of the bits are used for encryption key) | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Full path to fping. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Base URL that will be presented to users in links to glance resources | -
| [glance] | -|
| = |
- (ListOpt) A list of url scheme that can be downloaded directly via the direct_url. Currently supported schemes: [file]. | -
| = |
- (BoolOpt) Allow to perform insecure SSL (https) requests to glance | -
| = |
- (ListOpt) A list of the glance api servers available to nova. Prefix with https:// for ssl-based glance api servers. ([hostname|ip]:port) | -
| = |
- (StrOpt) Default glance hostname or IP address | -
| = |
- (IntOpt) Number of retries when uploading / downloading an image to / from glance. | -
| = |
- (IntOpt) Default glance port | -
| = |
- (StrOpt) Default protocol to use when connecting to glance. Set to https for SSL. | -
| [image_file_url] | -|
| = |
- (ListOpt) List of file systems that are configured in this file in the image_file_url:<list entry name> sections | -
| Configuration option = Default value | -Description | -
|---|---|
| [hyperv] | -|
| = |
- (FloatOpt) Enables dynamic memory allocation (ballooning) when set to a value greater than 1. The value expresses the ratio between the total RAM assigned to an instance and its startup RAM amount. For example a ratio of 2.0 for an instance with 1024MB of RAM implies 512MB of RAM allocated at startup | -
| = |
- (BoolOpt) Enables metrics collections for an instance by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above | -
| = |
- (BoolOpt) Force V1 WMI utility classes | -
| = |
- (StrOpt) The name of a Windows share name mapped to the "instances_path" dir and used by the resize feature to copy files to the target host. If left blank, an administrative share will be used, looking for the same "instances_path" used locally | -
| = |
- (BoolOpt) Required for live migration among hosts with different CPU features | -
| = |
- (IntOpt) The number of times to retry checking for a disk mounted via iSCSI. | -
| = |
- (IntOpt) Interval between checks for a mounted iSCSI disk, in seconds. | -
| = |
- (IntOpt) The timeframe to be checked for instance power state changes. | -
| = |
- (IntOpt) Instance power state change event polling frequency. | -
| = |
- (StrOpt) Path of qemu-img command which is used to convert between different image types | -
| = |
- (StrOpt) External virtual switch Name, if not provided, the first external virtual switch is used | -
| = |
- (IntOpt) Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The default format an ephemeral_volume will be formatted with on creation. | -
| = |
- (BoolOpt) Force backing images to raw format | -
| = |
- (StrOpt) VM image preallocation mode: "none" => no storage provisioning is done up front, "space" => storage is fully allocated at instance start | -
| = |
- (IntOpt) Amount of time, in seconds, to wait for NBD device start up. | -
| = |
- (BoolOpt) Whether to use cow images | -
| = |
- (StrOpt) Defines which pcpus that instance vcpus can use. For example, "4-12,^8,15" | -
| = |
- (MultiStrOpt) Name of the mkfs commands for ephemeral device. The format is <os_type>=<mkfs command> | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Fixed IPv6 address block | -
| = |
- (StrOpt) Default IPv6 gateway | -
| = |
- (StrOpt) Backend to use for IPv6 generation | -
| = |
- (BoolOpt) Use IPv6 | -
| Configuration option = Default value | -Description | -
|---|---|
| [ironic] | -|
| = |
- (StrOpt) Ironic keystone auth token.DEPRECATED: use admin_username, admin_password, and admin_tenant_name instead | -
| = |
- (StrOpt) Ironic keystone admin password. | -
| = |
- (StrOpt) Ironic keystone tenant name. | -
| = |
- (StrOpt) Keystone public API endpoint. | -
| = |
- (StrOpt) Ironic keystone admin name | -
| = |
- (StrOpt) URL for Ironic API endpoint. | -
| = |
- (IntOpt) How many retries when a request does conflict. If <= 0, only try once, no retries. | -
| = |
- (IntOpt) How often to retry in seconds when a request does conflict | -
| = |
- (IntOpt) Version of Ironic API service endpoint. | -
| = |
- (StrOpt) Log level override for ironicclient. Set this in order to override the global "default_log_levels", "verbose", and "debug" settings. DEPRECATED: use standard logging configuration. | -
| Configuration option = Default value | -Description | -
|---|---|
| [keymgr] | -|
| = |
- (StrOpt) The full class name of the key manager API class | -
| = |
- (StrOpt) Fixed key returned by key manager, specified in hex | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Base DN for DNS entries in LDAP | -
| = |
- (StrOpt) Password for LDAP DNS | -
| = |
- (MultiStrOpt) DNS Servers for LDAP DNS driver | -
| = |
- (StrOpt) Expiry interval (in seconds) for LDAP DNS driver Statement of Authority | -
| = |
- (StrOpt) Hostmaster for LDAP DNS driver Statement of Authority | -
| = |
- (StrOpt) Minimum interval (in seconds) for LDAP DNS driver Statement of Authority | -
| = |
- (StrOpt) Refresh interval (in seconds) for LDAP DNS driver Statement of Authority | -
| = |
- (StrOpt) Retry interval (in seconds) for LDAP DNS driver Statement of Authority | -
| = |
- (StrOpt) URL for LDAP server which will store DNS entries | -
| = |
- (StrOpt) User for LDAP DNS | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Should unused base images be removed? | -
| = |
- (IntOpt) Unused unresized base images younger than this will not be removed | -
| [libvirt] | -|
| = |
- (StrOpt) Migration flags to be set for block migration | -
| = |
- (BoolOpt) Write a checksum for files in _base to disk | -
| = |
- (IntOpt) How frequently to checksum base images | -
| = |
- (StrOpt) Override the default libvirt URI (which is dependent on virt_type) | -
| = |
- (StrOpt) Set to "host-model" to clone the host CPU feature flags; to "host-passthrough" to use the host CPU model exactly; to "custom" to use a named CPU model; to "none" to not set any CPU model. If virt_type="kvm|qemu", it will default to "host-model", otherwise it will default to "none" | -
| = |
- (StrOpt) Set to a named libvirt CPU model (see names listed in /usr/share/libvirt/cpu_map.xml). Only has effect if cpu_mode="custom" and virt_type="kvm|qemu" | -
| = |
- (ListOpt) Specific cachemodes to use for different disk types e.g: file=directsync,block=none | -
| = |
- (StrOpt) Override the default disk prefix for the devices attached to a server, which is dependent on virt_type. (valid options are: sd, xvd, uvd, vd) | -
| = |
- (ListOpt) List of guid targets and ranges.Syntax is guest-gid:host-gid:countMaximum of 5 allowed. | -
| = |
- (StrOpt) Discard option for nova managed disks. Need Libvirt(1.0.6) Qemu1.5 (raw format) Qemu1.6(qcow2 format) | -
| = |
- (ListOpt) For qemu or KVM guests, set this option to specify a default machine type per host architecture. You can find a list of supported machine types in your environment by checking the output of the "virsh capabilities"command. The format of the value for this config option is host-arch=machine-type. For example: x86_64=machinetype1,armv7l=machinetype2 | -
| = |
- (StrOpt) Allows image information files to be stored in non-standard locations | -
| = |
- (StrOpt) Path to the ceph configuration file to use | -
| = |
- (StrOpt) The RADOS pool in which rbd volumes are stored | -
| = |
- (StrOpt) VM Images format. If default is specified, then use_cow_images flag is used instead of this one. | -
| = |
- (StrOpt) LVM Volume Group that is used for VM images, when you specify images_type=lvm. | -
| = |
- (BoolOpt) Inject the ssh public key at boot time | -
| = |
- (IntOpt) The partition to inject to : -2 => disable, -1 => inspect (libguestfs only), 0 => not partitioned, >0 => partition number | -
| = |
- (BoolOpt) Inject the admin password at boot time, without an agent. | -
| = |
- (StrOpt) The iSCSI transport iface to use to connect to target in case offload support is desired. Default format is of the form <transport_name>.<hwaddress> where <transport_name> is one of (be2iscsi, bnx2i, cxgb3i, cxgb4i, qla4xxx, ocs) and <hwaddress> is the MAC address of the interface and can be generated via the iscsiadm -m iface command. Do not confuse the iscsi_iface parameter to be provided here with the actual transport name. | -
| = |
- (BoolOpt) Use multipath connection of the iSCSI volume | -
| = |
- (BoolOpt) Use multipath connection of the iSER volume | -
| = |
- (IntOpt) A number of seconds to memory usage statistics period. Zero or negative value mean to disable memory usage statistics. | -
| = |
- (BoolOpt) DEPRECATED: Should unused kernel images be removed? This is only safe to enable if all compute nodes have been updated to support this option (running Grizzly or newer level compute). This will be the default behavior in the 13.0.0 release. | -
| = |
- (IntOpt) Unused resized base images younger than this will not be removed | -
| = |
- (StrOpt) Rescue ami image. This will not be used if an image id is provided by the user. | -
| = |
- (StrOpt) Rescue aki image | -
| = |
- (StrOpt) Rescue ari image | -
| = |
- (StrOpt) A path to a device that will be used as source of entropy on the host. Permitted options are: /dev/random or /dev/hwrng | -
| = |
- (BoolOpt) Compress snapshot images when possible. This currently applies exclusively to qcow2 images | -
| = |
- (StrOpt) Snapshot image format. Defaults to same as source image | -
| = |
- (StrOpt) Location where libvirt driver will store snapshots before uploading them to image service | -
| = |
- (BoolOpt) Create sparse logical volumes (with virtualsize) if this flag is set to True. | -
| = |
- (StrOpt) The data source used to the populate the host "serial" UUID exposed to guest in the virtual BIOS. | -
| = |
- (ListOpt) List of uid targets and ranges.Syntax is guest-uid:host-uid:countMaximum of 5 allowed. | -
| = |
- (BoolOpt) Sync virtual and real mouse cursors in Windows VMs | -
| = |
- (BoolOpt) Use virtio for bridge interfaces with KVM/QEMU | -
| = |
- (StrOpt) Libvirt domain type | -
| = |
- (StrOpt) Method used to wipe old volumes. | -
| = |
- (IntOpt) Size in MiB to wipe at start of old volumes. 0 => all | -
| = |
- (IntOpt) Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Number of 1 second retries needed in live_migration | -
| = |
- (IntOpt) Maximum number of live migrations to run concurrently. This limit is enforced to avoid outbound live migrations overwhelming the host/network and causing failures. It is not recommended that you change this unless you are very sure that doing so is safe and stable in your environment. | -
| [libvirt] | -|
| = |
- (IntOpt) Maximum bandwidth(in MiB/s) to be used during migration. If set to 0, will choose a suitable default. Some hypervisors do not support this feature and will return an error if bandwidth is not 0. Please refer to the libvirt documentation for further details | -
| = |
- (IntOpt) Time to wait, in seconds, for migration to successfully complete transferring data before aborting the operation. Value is per GiB of guest RAM + disk to be transferred, with lower bound of a minimum of 2 GiB. Should usually be larger than downtime delay * downtime steps. Set to 0 to disable timeouts. | -
| = |
- (IntOpt) Maximum permitted downtime, in milliseconds, for live migration switchover. Will be rounded up to a minimum of 100ms. Use a large value if guest liveness is unimportant. | -
| = |
- (IntOpt) Time to wait, in seconds, between each step increase of the migration downtime. Minimum delay is 10 seconds. Value is per GiB of guest RAM + disk to be transferred, with lower bound of a minimum of 2 GiB per device | -
| = |
- (IntOpt) Number of incremental steps to reach max downtime value. Will be rounded up to a minimum of 3 steps | -
| = |
- (StrOpt) Migration flags to be set for live migration | -
| = |
- (IntOpt) Time to wait, in seconds, for migration to make forward progress in transferring data before aborting the operation. Set to 0 to disable timeouts. | -
| = |
- (StrOpt) Migration target URI (any included "%s" is replaced with the migration target hostname) | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). | -
| = |
- (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Enables or disables fatal status of deprecations. | -
| = |
- (BoolOpt) Make exception message format errors fatal | -
| = |
- (StrOpt) The format for an instance that is passed with the log message. | -
| = |
- (StrOpt) The format for an instance UUID that is passed with the log message. | -
| = |
- (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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). | -
| = |
- (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. | -
| = |
- (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. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) Format string to use for log messages with context. | -
| = |
- (StrOpt) Data to append to log format when level is DEBUG. | -
| = |
- (StrOpt) Format string to use for log messages without context. | -
| = |
- (StrOpt) Prefix each line of exception output with this format. | -
| = |
- (BoolOpt) Enables or disables publication of error events. | -
| = |
- (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. | -
| = |
- (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 Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. | -
| = |
- (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Time in seconds to cache metadata; 0 to disable metadata caching entirely (not recommended). Increasingthis should improve response times of the metadata API when under heavy load. Higher values may increase memoryusage and result in longer times for host metadata changes to take effect. | -
| = |
- (StrOpt) The IP address for the metadata API server | -
| = |
- (StrOpt) The IP address on which the metadata API will listen. | -
| = |
- (IntOpt) The port on which the metadata API will listen. | -
| = |
- (StrOpt) OpenStack metadata service manager | -
| = |
- (IntOpt) The port for the metadata API port | -
| = |
- (IntOpt) Number of workers for metadata service. The default will be the number of CPUs available. | -
| = |
- (StrOpt) Driver to use for vendor data | -
| = |
- (StrOpt) File to load JSON formatted vendor data from | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Whether to allow network traffic from same network | -
| = |
- (BoolOpt) Autoassigning floating IP to VM | -
| = |
- (IntOpt) Number of addresses reserved for vpn clients | -
| = |
- (IntOpt) Number of attempts to create unique mac address | -
| = |
- (StrOpt) Name of network to use to set access IPs for instances | -
| = |
- (StrOpt) Default pool for floating IPs | -
| = |
- (BoolOpt) Whether to batch up the application of IPTables rules during a host restart and apply all at the end of the init phase | -
| = |
- (StrOpt) Domain to use for building the hostnames | -
| = |
- (IntOpt) Lifetime of a DHCP lease in seconds | -
| = |
- (StrOpt) Location of nova-dhcpbridge | -
| = |
- (MultiStrOpt) Location of flagfiles for dhcpbridge | -
| = |
- (MultiStrOpt) If set, uses specific DNS server for dnsmasq. Can be specified multiple times. | -
| = |
- (IntOpt) Number of seconds to wait between runs of updates to DNS entries. | -
| = |
- (StrOpt) Override the default dnsmasq settings with this file | -
| = |
- (IntOpt) Number of times to retry ebtables commands on failure. | -
| = |
- (FloatOpt) Number of seconds to wait between ebtables retries. | -
| = |
- (StrOpt) Firewall driver (defaults to hypervisor specific iptables driver) | -
| = |
- (IntOpt) Seconds after which a deallocated IP is disassociated | -
| = |
- (BoolOpt) Whether to attempt to inject network setup into guest | -
| = |
- (StrOpt) FlatDhcp will bridge into this interface if set | -
| = |
- (StrOpt) Bridge for simple network instances | -
| = |
- (StrOpt) DNS server for simple network | -
| = |
- (StrOpt) Full class name for the DNS Manager for floating IPs | -
| = |
- (BoolOpt) If True, send a dhcp release on instance termination | -
| = |
- (MultiStrOpt) Traffic to this range will always be snatted to the fallback ip, even if it would normally be bridged out of the node. Can be specified multiple times. | -
| = |
- (MultiStrOpt) An interface that bridges can forward to. If this is set to all then all traffic will be forwarded. Can be specified multiple times. | -
| = |
- (StrOpt) Default IPv4 gateway | -
| = |
- (StrOpt) Template file for injected network | -
| = |
- (StrOpt) Full class name for the DNS Zone for instance IPs | -
| = |
- (StrOpt) Full class name for the DNS Manager for instance IPs | -
| = |
- (StrOpt) Regular expression to match the iptables rule that should always be on the bottom. | -
| = |
- (StrOpt) The table that iptables to jump to when a packet is to be dropped. | -
| = |
- (StrOpt) Regular expression to match the iptables rule that should always be on the top. | -
| = |
- (StrOpt) Indicates underlying L3 management library | -
| = |
- (StrOpt) Driver used to create ethernet devices. | -
| = |
- (StrOpt) Name of Open vSwitch bridge used with linuxnet | -
| = |
- (BoolOpt) Default value for multi_host in networks. Also, if set, some rpc network calls will be sent directly to host. | -
| = |
- (IntOpt) Number of times to retry network allocation on failures | -
| = |
- (StrOpt) The full class name of the network API class to use | -
| = |
- (IntOpt) DEPRECATED: THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK. MTU setting for network interface. | -
| = |
- (StrOpt) Driver to use for network creation | -
| = |
- (StrOpt) Full class name for the Manager for network | -
| = |
- (IntOpt) Number of addresses in each private subnet | -
| = |
- (StrOpt) The topic network nodes listen on | -
| = |
- (StrOpt) Location to keep network config files | -
| = |
- (IntOpt) Number of networks to support | -
| = |
- (IntOpt) Amount of time, in seconds, that ovs_vsctl should wait for a response from the database. 0 is to wait forever. | -
| = |
- (StrOpt) Interface for public IP addresses | -
| = |
- (StrOpt) Public IP of network host | -
| = |
- (StrOpt) The full class name of the security API class | -
| = |
- (BoolOpt) Send gratuitous ARPs for HA setup | -
| = |
- (IntOpt) Send this many gratuitous ARPs for HA setup | -
| = |
- (BoolOpt) DEPRECATED: THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK. If True in multi_host mode, all compute hosts share the same dhcp address. The same IP address used for DHCP will be added on each nova-network node which is only visible to the vms on the same host. | -
| = |
- (BoolOpt) If True, unused gateway devices (VLAN and bridge) are deleted in VLAN network mode with multi hosted networks | -
| = |
- (BoolOpt) If True, when a DNS entry must be updated, it sends a fanout cast to all network hosts to update their DNS entries in multi host mode | -
| = |
- (BoolOpt) If set, uses the dns1 and dns2 from the network ref. as dns servers. | -
| = |
- (StrOpt) Control for checking for default networks | -
| = |
- (BoolOpt) Use single default gateway. Only first nic of vm will get default gateway from dhcp server | -
| = |
- (StrOpt) VLANs will bridge into this interface if set | -
| = |
- (IntOpt) First VLAN for private networks | -
| [libvirt] | -|
| = |
- (StrOpt) Use ssh or rsync transport for creating, copying, removing files on the remote host. | -
| [vmware] | -|
| = |
- (StrOpt) Physical ethernet adapter name for vlan networking | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Default tenant id when creating neutron networks | -
| [neutron] | -|
| = |
- (StrOpt) Authorization URL for connecting to neutron in admin context. DEPRECATED: specify an auth_plugin and appropriate credentials instead. | -
| = |
- (StrOpt) Password for connecting to neutron in admin context DEPRECATED: specify an auth_plugin and appropriate credentials instead. | -
| = |
- (StrOpt) Tenant id for connecting to neutron in admin context DEPRECATED: specify an auth_plugin and appropriate credentials instead. | -
| = |
- (StrOpt) Tenant name for connecting to neutron in admin context. This option will be ignored if neutron_admin_tenant_id is set. Note that with Keystone V3 tenant names are only unique within a domain. DEPRECATED: specify an auth_plugin and appropriate credentials instead. | -
| = |
- (StrOpt) User id for connecting to neutron in admin context. DEPRECATED: specify an auth_plugin and appropriate credentials instead. | -
| = |
- (StrOpt) Username for connecting to neutron in admin context DEPRECATED: specify an auth_plugin and appropriate credentials instead. | -
| = |
- (StrOpt) Name of the plugin to load | -
| = |
- (StrOpt) Config Section from which to load plugin specific options | -
| = |
- (StrOpt) Authorization strategy for connecting to neutron in admin context. DEPRECATED: specify an auth_plugin and appropriate credentials instead. If an auth_plugin is specified strategy will be ignored. | -
| = |
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections. | -
| = |
- (StrOpt) PEM encoded client certificate cert file | -
| = |
- (IntOpt) Number of seconds before querying neutron for extensions | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) PEM encoded client certificate key file | -
| = |
- (StrOpt) Shared secret to validate proxies Neutron metadata requests | -
| = |
- (StrOpt) Name of Integration Bridge used by Open vSwitch | -
| = |
- (StrOpt) Region name for connecting to neutron in admin context | -
| = |
- (BoolOpt) Set flag to indicate Neutron will proxy metadata requests and resolve instance ids. | -
| = |
- (IntOpt) Timeout value for http requests | -
| = |
- (StrOpt) URL for connecting to neutron | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (MultiStrOpt) An alias for a PCI passthrough device requirement. This allows users to specify the alias in the extra_spec for a flavor, without needing to repeat all the PCI property requirements. For example: pci_alias = { "name": "QuickAssist", "product_id": "0443", "vendor_id": "8086", "device_type": "ACCEL" } defines an alias for the Intel QuickAssist card. (multi valued) | -
| = |
- (MultiStrOpt) White list of PCI devices available to VMs. For example: pci_passthrough_whitelist = [{"vendor_id": "8086", "product_id": "0443"}] | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Enable periodic tasks | -
| = |
- (IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Permit instance snapshot operations. | -
| = |
- (BoolOpt) Allow destination machine to match source for resize. Useful when testing in single-host environments. | -
| = |
- (IntOpt) Number of seconds between subsequent usage refreshes. This defaults to 0(off) to avoid additional load but it is useful to turn on to help keep quota usage up to date and reduce the impact of out of sync usage issues. Note that quotas are not updated on a periodic task, they will update on a new reservation if max_age has passed since the last reservation | -
| = |
- (IntOpt) Maximum number of devices that will result in a local image being created on the hypervisor node. A negative number means unlimited. Setting max_local_block_devices to 0 means that any request that attempts to create a local disk will fail. This option is meant to limit the number of local discs (so root local disc that is the result of --image being used, and any other ephemeral and swap disks). 0 does not mean that images will be automatically converted to volumes and boot instances from volumes - it just means that all requests that attempt to create a local disk will fail. | -
| = |
- (StrOpt) When set, compute API will consider duplicate hostnames invalid within the specified scope, regardless of case. Should be empty, "project" or "global". | -
| = |
- (IntOpt) The maximum number of items returned in a single response from a collection resource | -
| = |
- (IntOpt) Length of generated instance admin passwords | -
| = |
- (StrOpt) Default rule. Enforced when a requested rule is not found. | -
| = |
- (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. | -
| = |
- (StrOpt) The JSON file that defines policies. | -
| = |
- (IntOpt) Number of seconds until a reservation expires | -
| = |
- (BoolOpt) Attempt to resize the filesystem by accessing the image over a block device. This is done by the host and may not be necessary if the image contains a recent version of cloud-init. Possible mechanisms require the nbd driver (for qcow and raw), or loop (for raw). | -
| = |
- (IntOpt) Count of reservations until usage is refreshed. This defaults to 0(off) to avoid additional load but it is useful to turn on to help keep quota usage up to date and reduce the impact of out of sync usage issues. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_qpid] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (IntOpt) Seconds between connection keepalive heartbeats. | -
| = |
- (StrOpt) Qpid broker hostname. | -
| = |
- (ListOpt) Qpid HA cluster host:port pairs. | -
| = |
- (StrOpt) Password for Qpid connection. | -
| = |
- (IntOpt) Qpid broker port. | -
| = |
- (StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| = |
- (IntOpt) The number of prefetched messages held by receiver. | -
| = |
- (StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| = |
- (BoolOpt) Whether to disable the Nagle algorithm. | -
| = |
- (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. | -
| = |
- (StrOpt) Username for Qpid connection. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [libvirt] | -|
| = |
- (StrOpt) Path to a Quobyte Client configuration file. | -
| = |
- (StrOpt) Directory where the Quobyte volume is mounted on the compute node | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Interval to pull network bandwidth usage info. Not supported on all hypervisors. Set to -1 to disable. Setting this to 0 will run at the default rate. | -
| = |
- (BoolOpt) Enables or disables quota checking for tenant networks | -
| = |
- (IntOpt) Number of instance cores allowed per project | -
| = |
- (StrOpt) Default driver to use for quota checks | -
| = |
- (IntOpt) Number of fixed IPs allowed per project (this should be at least the number of instances allowed) | -
| = |
- (IntOpt) Number of floating IPs allowed per project | -
| = |
- (IntOpt) Number of bytes allowed per injected file | -
| = |
- (IntOpt) Length of injected file path | -
| = |
- (IntOpt) Number of injected files allowed | -
| = |
- (IntOpt) Number of instances allowed per project | -
| = |
- (IntOpt) Number of key pairs per user | -
| = |
- (IntOpt) Number of metadata items allowed per instance | -
| = |
- (IntOpt) Number of private networks allowed per project | -
| = |
- (IntOpt) Megabytes of instance RAM allowed per project | -
| = |
- (IntOpt) Number of security rules per security group | -
| = |
- (IntOpt) Number of security groups per project | -
| = |
- (IntOpt) Number of servers per server group | -
| = |
- (IntOpt) Number of server groups per project | -
| [cells] | -|
| = |
- (IntOpt) Seconds between bandwidth updates for cells. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_rabbit] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake | -
| = |
- (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. | -
| = |
- (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL | -
| = |
- (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| = |
- (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). | -
| = |
- (StrOpt) SSL cert file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL key file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. | -
| = |
- (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| = |
- (StrOpt) The RabbitMQ broker address where a single node is used. | -
| = |
- (ListOpt) RabbitMQ HA cluster host:port pairs. | -
| = |
- (StrOpt) The RabbitMQ login method. | -
| = |
- (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| = |
- (StrOpt) The RabbitMQ password. | -
| = |
- (IntOpt) The RabbitMQ broker port where a single node is used. | -
| = |
- (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| = |
- (IntOpt) How frequently to retry connecting with RabbitMQ. | -
| = |
- (BoolOpt) Connect over SSL for RabbitMQ. | -
| = |
- (StrOpt) The RabbitMQ userid. | -
| = |
- (StrOpt) The RabbitMQ virtual host. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [rdp] | -|
| = |
- (BoolOpt) Enable RDP related features | -
| = |
- (StrOpt) Location of RDP html5 console proxy, in the form "http://127.0.0.1:6083/" | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| [matchmaker_redis] | -|
| = |
- (StrOpt) Host to locate redis. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| = |
- (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| = |
- (IntOpt) Size of RPC connection pool. | -
| = |
- (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| = |
- (IntOpt) Seconds to wait for a response from a call. | -
| [cells] | -|
| = |
- (StrOpt) Base queue name to use when communicating between cells. Various topics by message type will be appended to this. | -
| [oslo_concurrency] | -|
| = |
- (BoolOpt) Enables or disables inter-process locks. | -
| = |
- (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. | -
| [oslo_messaging_amqp] | -|
| = |
- (BoolOpt) Accept clients using either SSL or plain TCP | -
| = |
- (StrOpt) address prefix used when broadcasting to all servers | -
| = |
- (StrOpt) Name for the AMQP container | -
| = |
- (StrOpt) address prefix when sending to any server in group | -
| = |
- (IntOpt) Timeout for inactive connections (in seconds) | -
| = |
- (StrOpt) Password for message broker authentication | -
| = |
- (StrOpt) Path to directory that contains the SASL configuration | -
| = |
- (StrOpt) Name of configuration file (without .conf suffix) | -
| = |
- (StrOpt) Space separated list of acceptable SASL mechanisms | -
| = |
- (StrOpt) address prefix used when sending to a specific server | -
| = |
- (StrOpt) CA certificate PEM file to verify server certificate | -
| = |
- (StrOpt) Identifying certificate PEM file to present to clients | -
| = |
- (StrOpt) Private key PEM file used to sign cert_file certificate | -
| = |
- (StrOpt) Password for decrypting ssl_key_file (if encrypted) | -
| = |
- (BoolOpt) Debug: dump AMQP frames to stdout | -
| = |
- (StrOpt) User name for message broker authentication | -
| [upgrade_levels] | -|
| = |
- (StrOpt) Set a version cap for messages sent to the base api in any service | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Path to S3 buckets | -
| = |
- (StrOpt) Parent directory for tempdir used for image decryption | -
| = |
- (StrOpt) Access key to use for S3 server for images | -
| = |
- (BoolOpt) Whether to affix the tenant id to the access key when downloading from S3 | -
| = |
- (StrOpt) Hostname or IP for OpenStack to use when accessing the S3 api | -
| = |
- (StrOpt) IP address for S3 API to listen | -
| = |
- (IntOpt) Port for S3 API to listen | -
| = |
- (IntOpt) Port used when accessing the S3 api | -
| = |
- (StrOpt) Secret key to use for S3 server for images | -
| = |
- (BoolOpt) Whether to use SSL when talking to S3 | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Force the filter to consider only keys matching the given namespace. | -
| = |
- (StrOpt) The separator used between the namespace and keys | -
| = |
- (ListOpt) Which filter class names to use for filtering baremetal hosts when not specified in the request. | -
| = |
- (FloatOpt) Virtual CPU to physical CPU allocation ratio which affects all CPU filters. This configuration specifies a global ratio for CoreFilter. For AggregateCoreFilter, it will fall back to this configuration value if no per-aggregate setting found. NOTE: This can be set per-compute, or if set to 0.0, the value set on the scheduler node(s) will be used and defaulted to 16.0 | -
| = |
- (FloatOpt) Virtual disk to physical disk allocation ratio | -
| = |
- (FloatOpt) Multiplier used for weighing host io ops. Negative numbers mean a preference to choose light workload compute hosts. | -
| = |
- (ListOpt) Host reserved for specific images | -
| = |
- (ListOpt) Images to run on isolated host | -
| = |
- (IntOpt) Ignore hosts that have too many instances | -
| = |
- (IntOpt) Tells filters to ignore hosts that have this many or more instances currently in build, resize, snapshot, migrate, rescue or unshelve task states | -
| = |
- (FloatOpt) Virtual ram to physical ram allocation ratio which affects all ram filters. This configuration specifies a global ratio for RamFilter. For AggregateRamFilter, it will fall back to this configuration value if no per-aggregate setting found. NOTE: This can be set per-compute, or if set to 0.0, the value set on the scheduler node(s) will be used and defaulted to 1.5 | -
| = |
- (FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread. | -
| = |
- (IntOpt) Amount of disk in MB to reserve for the host | -
| = |
- (IntOpt) Amount of memory in MB to reserve for the host | -
| = |
- (BoolOpt) Whether to force isolated hosts to run only isolated images | -
| = |
- (MultiStrOpt) Filter classes available to the scheduler which may be specified more than once. An entry of "nova.scheduler.filters.all_filters" maps to all filters included with nova. | -
| = |
- (ListOpt) Which filter class names to use for filtering hosts when not specified in the request. | -
| = |
- (StrOpt) Default driver to use for the scheduler | -
| = |
- (IntOpt) How often (in seconds) to run periodic tasks in the scheduler driver of your choice. Please note this is likely to interact with the value of service_down_time, but exactly how they interact will depend on your choice of scheduler driver. | -
| = |
- (StrOpt) The scheduler host manager class to use | -
| = |
- (IntOpt) New instances will be scheduled on a host chosen randomly from a subset of the N best hosts. This property defines the subset size that a host is chosen from. A value of 1 chooses the first host returned by the weighing functions. This value must be at least 1. Any value less than 1 will be ignored, and 1 will be used instead | -
| = |
- (IntOpt) Waiting time interval (seconds) between sending the scheduler a list of current instance UUIDs to verify that its view of instances is in sync with nova. If the CONF option `scheduler_tracks_instance_changes` is False, changing this option will have no effect. | -
| = |
- (StrOpt) Absolute path to scheduler configuration JSON file. | -
| = |
- (StrOpt) Full class name for the Manager for scheduler | -
| = |
- (IntOpt) Maximum number of attempts to schedule an instance | -
| = |
- (StrOpt) The topic scheduler nodes listen on | -
| = |
- (BoolOpt) Determines if the Scheduler tracks changes to instances to help with its filtering decisions. | -
| = |
- (BoolOpt) Flag to decide whether to use baremetal_scheduler_default_filters or not. | -
| = |
- (ListOpt) Which weight class names to use for weighing hosts | -
| [cells] | -|
| = |
- (FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread. | -
| = |
- (ListOpt) Filter classes the cells scheduler should use. An entry of "nova.cells.filters.all_filters" maps to all cells filters included with nova. | -
| = |
- (IntOpt) How many retries when no cells are available. | -
| = |
- (IntOpt) How often to retry in seconds when no cells are available. | -
| = |
- (ListOpt) Weigher classes the cells scheduler should use. An entry of "nova.cells.weights.all_weighers" maps to all cell weighers included with nova. | -
| [metrics] | -|
| = |
- (BoolOpt) How to treat the unavailable metrics. When a metric is NOT available for a host, if it is set to be True, it would raise an exception, so it is recommended to use the scheduler filter MetricFilter to filter out those hosts. If it is set to be False, the unavailable metric would be treated as a negative factor in weighing process, the returned value would be set by the option weight_of_unavailable. | -
| = |
- (FloatOpt) Multiplier used for weighing metrics. | -
| = |
- (FloatOpt) The final weight value to be returned if required is set to False and any one of the metrics set by weight_setting is unavailable. | -
| = |
- (ListOpt) How the metrics are going to be weighed. This should be in the form of "<name1>=<ratio1>, <name2>=<ratio2>, ...", where <nameX> is one of the metrics to be weighed, and <ratioX> is the corresponding ratio. So for "name1=1.0, name2=-1.0" The final weight would be name1.value * 1.0 + name2.value * -1.0. | -
| Configuration option = Default value | -Description | -
|---|---|
| [serial_console] | -|
| = |
- (StrOpt) Location of serial console proxy. | -
| = |
- (BoolOpt) Enable serial console related features | -
| = |
- (StrOpt) IP address on which instance serial console should listen | -
| = |
- (StrOpt) Range of TCP ports to use for serial ports on compute hosts | -
| = |
- (StrOpt) The address to which proxy clients (like nova-serialproxy) should connect | -
| = |
- (StrOpt) Host on which to listen for incoming requests | -
| = |
- (IntOpt) Port on which to listen for incoming requests | -
| Configuration option = Default value | -Description | -
|---|---|
| [spice] | -|
| = |
- (BoolOpt) Enable spice guest agent support | -
| = |
- (BoolOpt) Enable spice related features | -
| = |
- (StrOpt) Location of spice HTML5 console proxy, in the form "http://127.0.0.1:6082/spice_auto.html" | -
| = |
- (StrOpt) Host on which to listen for incoming requests | -
| = |
- (IntOpt) Port on which to listen for incoming requests | -
| = |
- (StrOpt) Keymap for spice | -
| = |
- (StrOpt) IP address on which instance spice server should listen | -
| = |
- (StrOpt) The address to which proxy clients (like nova-spicehtml5proxy) should connect | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) If True, skip using the queue and make local calls | -
| = |
- (BoolOpt) If passed, use fake network devices and addresses | -
| = |
- (BoolOpt) Whether to log monkey patching | -
| = |
- (ListOpt) List of modules/decorators to monkey patch | -
| Configuration option = Default value | -Description | -
|---|---|
| [trusted_computing] | -|
| = |
- (StrOpt) Attestation web API URL | -
| = |
- (StrOpt) Attestation authorization blob - must change | -
| = |
- (IntOpt) Attestation status cache valid period length | -
| = |
- (BoolOpt) Disable SSL cert verification for Attestation service | -
| = |
- (StrOpt) Attestation server port | -
| = |
- (StrOpt) Attestation server HTTP | -
| = |
- (StrOpt) Attestation server Cert file for Identity verification | -
| Configuration option = Default value | -Description | -
|---|---|
| [cells] | -|
| = |
- (StrOpt) Cells scheduler to use | -
| [upgrade_levels] | -|
| = |
- (StrOpt) Set a version cap for messages sent to local cells services | -
| = |
- (StrOpt) Set a version cap for messages sent to cert services | -
| = |
- (StrOpt) Set a version cap for messages sent to compute services. If you plan to do a live upgrade from an old version to a newer version, you should set this option to the old version before beginning the live upgrade procedure. Only upgrading to the next version is supported, so you cannot skip a release for the live upgrade procedure. | -
| = |
- (StrOpt) Set a version cap for messages sent to conductor services | -
| = |
- (StrOpt) Set a version cap for messages sent to console services | -
| = |
- (StrOpt) Set a version cap for messages sent to consoleauth services | -
| = |
- (StrOpt) Set a version cap for messages sent between cells services | -
| = |
- (StrOpt) Set a version cap for messages sent to network services | -
| = |
- (StrOpt) Set a version cap for messages sent to scheduler services | -
| Configuration option = Default value | -Description | -
|---|---|
| [vmware] | -|
| = |
- (IntOpt) The number of times we retry on failures, e.g., socket error, etc. | -
| = |
- (StrOpt) Specify a CA bundle file to use in verifying the vCenter server certificate. | -
| = |
- (StrOpt) The prefix for where cached images are stored. This is NOT the full path - just a folder prefix. This should only be used when a datastore cache should be shared between compute nodes. Note: this should only be used when the compute nodes have a shared file system. | -
| = |
- (StrOpt) Name of a VMware Cluster ComputeResource. | -
| = |
- (IntOpt) Set this value if affected by an increased network latency causing repeated characters when typing in a remote console. | -
| = |
- (StrOpt) Regex to match the name of a datastore. | -
| = |
- (StrOpt) Hostname or IP address for connection to VMware vCenter host. | -
| = |
- (StrOpt) Password for connection to VMware vCenter host. | -
| = |
- (IntOpt) Port for connection to VMware vCenter host. | -
| = |
- (StrOpt) Username for connection to VMware vCenter host. | -
| = |
- (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 "ca_file" is set. | -
| = |
- (StrOpt) Name of Integration Bridge | -
| = |
- (IntOpt) The maximum number of ObjectContent data objects that should be returned in a single result. A positive value will cause the operation to suspend the retrieval when the count of objects reaches the specified maximum. The server may still limit the count to something less than the configured value. Any remaining objects may be retrieved with additional requests. | -
| = |
- (StrOpt) The PBM default policy. If pbm_wsdl_location is set and there is no defined storage policy for the specific request then this policy will be used. | -
| = |
- (BoolOpt) The PBM status. | -
| = |
- (StrOpt) PBM service WSDL file location URL. e.g. file:///opt/SDK/spbm/wsdl/pbmService.wsdl Not setting this will disable storage policy based placement of instances. | -
| = |
- (StrOpt) Identifies a proxy service that provides network access to the serial_port_service_uri. This option is ignored if serial_port_service_uri is not specified. | -
| = |
- (StrOpt) Identifies the remote system that serial port traffic will be sent to. If this is not set, no serial ports will be added to the created VMs. | -
| = |
- (FloatOpt) The interval used for polling of remote tasks. | -
| = |
- (BoolOpt) Whether to use linked clone | -
| = |
- (StrOpt) Optional VIM Service WSDL Location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Become a daemon (background process) | -
| = |
- (StrOpt) SSL key file (if separate from cert) | -
| = |
- (StrOpt) Host on which to listen for incoming requests | -
| = |
- (IntOpt) Port on which to listen for incoming requests | -
| = |
- (BoolOpt) Record sessions to FILE.[session_number] | -
| = |
- (BoolOpt) Source is ipv6 | -
| = |
- (BoolOpt) Disallow non-encrypted connections | -
| = |
- (StrOpt) Run webserver on same port. Serve files from DIR. | -
| [vmware] | -|
| = |
- (IntOpt) VNC starting port | -
| = |
- (IntOpt) Total number of VNC ports | -
| [vnc] | -|
| = |
- (BoolOpt) Enable VNC related features | -
| = |
- (StrOpt) Keymap for VNC | -
| = |
- (StrOpt) Location of VNC console proxy, in the form "http://127.0.0.1:6080/vnc_auto.html" | -
| = |
- (StrOpt) IP address on which instance vncservers should listen | -
| = |
- (StrOpt) The address to which proxy clients (like nova-xvpvncproxy) should connect | -
| = |
- (StrOpt) Location of nova xvp VNC console proxy, in the form "http://127.0.0.1:6081/console" | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Number of times to retry block device allocation on failures | -
| = |
- (IntOpt) Waiting time interval (seconds) between block device allocation retries on failures | -
| = |
- (StrOpt) Block storage IP address of this host | -
| = |
- (StrOpt) The full class name of the volume API class to use | -
| = |
- (IntOpt) Interval in seconds for gathering volume usages | -
| [cinder] | -|
| = |
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections. | -
| = |
- (StrOpt) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> | -
| = |
- (StrOpt) PEM encoded client certificate cert file | -
| = |
- (BoolOpt) Allow attach between instance and volume in different availability zones. | -
| = |
- (StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s | -
| = |
- (IntOpt) Number of cinderclient retries on failed http calls | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) PEM encoded client certificate key file | -
| = |
- (StrOpt) Region name of this node | -
| = |
- (IntOpt) Timeout value for http requests | -
| [hyperv] | -|
| = |
- (BoolOpt) Force V1 volume utility class | -
| = |
- (IntOpt) The number of times to retry to attach a volume | -
| = |
- (IntOpt) Interval between volume attachment attempts, in seconds | -
| [libvirt] | -|
| = |
- (StrOpt) Directory where the glusterfs volume is mounted on the compute node | -
| = |
- (StrOpt) Mount options passed to the NFS client. See section of the nfs man page for details | -
| = |
- (StrOpt) Directory where the NFS volume is mounted on the compute node | -
| = |
- (IntOpt) Number of times to rediscover AoE target to find volume | -
| = |
- (IntOpt) Number of times to rescan iSCSI target to find volume | -
| = |
- (IntOpt) Number of times to rescan iSER target to find volume | -
| = |
- (ListOpt) Protocols listed here will be accessed directly from QEMU. Currently supported protocols: [gluster] | -
| = |
- (StrOpt) The libvirt UUID of the secret for the rbd_uservolumes | -
| = |
- (StrOpt) The RADOS client name for accessing rbd volumes | -
| = |
- (StrOpt) Path or URL to Scality SOFS configuration file | -
| = |
- (StrOpt) Base dir where Scality SOFS shall be mounted | -
| = |
- (StrOpt) Mount options passed to the SMBFS client. See mount.cifs man page for details. Note that the libvirt-qemu uid and gid must be specified. | -
| = |
- (StrOpt) Directory where the SMBFS shares are mounted on the compute node | -
| [xenserver] | -|
| = |
- (IntOpt) Time to wait for a block device to be created | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Template for cloudpipe instance boot script | -
| = |
- (ListOpt) A list of dmz ranges that should be accepted | -
| = |
- (StrOpt) Netmask to push into openvpn config | -
| = |
- (StrOpt) Network to push into openvpn config | -
| = |
- (StrOpt) Flavor for vpn instances | -
| = |
- (StrOpt) Image ID used when starting up a cloudpipe vpn server | -
| = |
- (StrOpt) Public IP for the cloudpipe VPN servers | -
| = |
- (StrOpt) Suffix to add to project name for vpn key and secgroups | -
| = |
- (IntOpt) First Vpn port for private networks | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Driver to use for the console proxy | -
| = |
- (StrOpt) Generated XVP conf file | -
| = |
- (StrOpt) XVP conf template | -
| = |
- (StrOpt) XVP log file | -
| = |
- (IntOpt) Port for XVP to multiplex VNC connections on | -
| = |
- (StrOpt) XVP master process pid file | -
| = |
- (BoolOpt) Stub calls to compute worker for tests | -
| [libvirt] | -|
| = |
- (StrOpt) Location where the Xen hvmloader is kept | -
| [xenserver] | -|
| = |
- (StrOpt) Specifies the path in which the XenAPI guest agent should be located. If the agent is present, network configuration is not injected into the image. Used if compute_driver=xenapi.XenAPIDriver and flat_injected=True | -
| = |
- (IntOpt) Number of seconds to wait for agent reply to resetnetwork request | -
| = |
- (IntOpt) Number of seconds to wait for agent reply | -
| = |
- (IntOpt) Number of seconds to wait for agent to be fully operational | -
| = |
- (StrOpt) Cache glance images locally. `all` will cache all images, `some` will only cache images that have the image_property `cache_in_nova=True`, and `none` turns off caching entirely | -
| = |
- (BoolOpt) Ensure compute service is running on host XenAPI connects to. | -
| = |
- (IntOpt) Maximum number of concurrent XenAPI connections. Used only if compute_driver=xenapi.XenAPIDriver | -
| = |
- (StrOpt) Password for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver | -
| = |
- (StrOpt) URL for connection to XenServer/Xen Cloud Platform. A special value of unix://local can be used to connect to the local unix socket. Required if compute_driver=xenapi.XenAPIDriver | -
| = |
- (StrOpt) Username for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver | -
| = |
- (StrOpt) Default OS type | -
| = |
- (BoolOpt) Disables the use of the XenAPI agent in any image regardless of what image properties are present. | -
| = |
- (IntOpt) Compression level for images, e.g., 9 for gzip -9. Range is 1-9, 9 being most compressed but most CPU intensive on dom0. | -
| = |
- (StrOpt) Dom0 plugin driver used to handle image uploads. | -
| = |
- (IntOpt) Number of seconds to wait for an SR to settle if the VDI does not exist when first introduced | -
| = |
- (StrOpt) URL to the iPXE boot menu | -
| = |
- (StrOpt) Name and optionally path of the tool used for ISO image creation | -
| = |
- (StrOpt) Name of network to use for booting iPXE ISOs | -
| = |
- (StrOpt) IQN Prefix | -
| = |
- (IntOpt) Timeout in seconds for XenAPI login. | -
| = |
- (IntOpt) Maximum size in bytes of kernel or ramdisk images | -
| = |
- (IntOpt) Maximum number of retries to unplug VBD. if <=0, should try once and no retry | -
| = |
- (StrOpt) Name of Integration Bridge used by Open vSwitch | -
| = |
- (BoolOpt) Used to enable the remapping of VBD dev (Works around an issue in Ubuntu Maverick) | -
| = |
- (StrOpt) Specify prefix to remap VBD dev to (ex. /dev/xvdb -> /dev/sdb) | -
| = |
- (IntOpt) Number of seconds to wait for instance to go to running state | -
| = |
- (BoolOpt) Whether to use sparse_copy for copying data on a resize down (False will use standard dd). This speeds up resizes down considerably since large runs of zeros won't have to be rsynced | -
| = |
- (StrOpt) Base path to the storage repository | -
| = |
- (StrOpt) Filter for finding the SR to be used to install guest instances on. To use the Local Storage in default XenServer/XCP installations set this flag to other-config:i18n-key=local-storage. To select an SR with a different matching criteria, you could set it to other-config:my_favorite_sr=true. On the other hand, to fall back on the Default SR, as displayed by XenCenter, set this flag to: default-sr:true | -
| = |
- (StrOpt) The iSCSI Target Host | -
| = |
- (StrOpt) The iSCSI Target Port, default is port 3260 | -
| = |
- (StrOpt) Base URL for torrent files; must contain a slash character (see RFC 1808, step 6) | -
| = |
- (IntOpt) Number of seconds a download can remain at the same progress percentage w/o being considered a stall | -
| = |
- (StrOpt) Whether or not to download images via Bit Torrent. | -
| = |
- (IntOpt) End of port range to listen on | -
| = |
- (IntOpt) Beginning of port range to listen on | -
| = |
- (IntOpt) Cached torrent files not accessed within this number of seconds can be reaped | -
| = |
- (IntOpt) Maximum number of seeder processes to run concurrently within a given dom0. (-1 = no limit) | -
| = |
- (FloatOpt) Probability that peer will become a seeder. (1.0 = 100%) | -
| = |
- (IntOpt) Number of seconds after downloading an image via BitTorrent that it should be seeded for other peers. | -
| = |
- (BoolOpt) Determines if the XenAPI agent should be used when the image used does not contain a hint to declare if the agent is present or not. The hint is a glance property "xenapi_use_agent" that has the value "True" or "False". Note that waiting for the agent when it is not present will significantly increase server boot times. | -
| = |
- (BoolOpt) To use for hosts with different CPUs | -
| = |
- (IntOpt) Max number of times to poll for VHD to coalesce. Used only if compute_driver=xenapi.XenAPIDriver | -
| = |
- (FloatOpt) The interval used for polling of coalescing vhds. Used only if compute_driver=xenapi.XenAPIDriver | -
| = |
- (StrOpt) The XenAPI VIF driver using XenServer Network APIs. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Address that the XCP VNC proxy should bind to | -
| = |
- (IntOpt) Port that the XCP VNC proxy should bind to | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| = |
- (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| = |
- (StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| = |
- (IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| = |
- (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. | -
| = |
- (StrOpt) Directory for holding IPC sockets. | -
| = |
- (StrOpt) MatchMaker driver. | -
| = |
- (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| = |
- (BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| Configuration option = Default value | -Description | -
|---|---|
| [zookeeper] | -|
| = |
- (StrOpt) The ZooKeeper addresses for servicegroup service in the format of host1:port,host2:port,host3:port | -
| = |
- (IntOpt) The recv_timeout parameter for the zk session | -
| = |
- (StrOpt) The prefix used in ZooKeeper to store ephemeral nodes | -
| = |
- (IntOpt) Number of seconds to wait until retrying to join the session | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | -
| = |
- (BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | -
| = |
- (StrOpt) The host IP to bind to the api service to . | -
| = |
- (IntOpt) The port to bind to the api service to. | -
| = |
- (StrOpt) The handler that the API communicates with. | -
| = |
- (StrOpt) Name of the controller plugin to use. | -
| = |
- (StrOpt) Region in Identity service catalog to use for communication with the OpenStack services. | -
| = |
- (StrOpt) Hostname to be used by the host machine for services running on it.The default value is the hostname of the host machine. | -
| [database] | -|
| = |
- (StrOpt) The SQLAlchemy connection string used to connect to the database. | -
| [health_manager] | -|
| = |
- (StrOpt) IP address the controller will listen on for heart beats from the amphora. | -
| = |
- (IntOpt) Port number the controller will listen on for heart beats from the amphora. | -
| = |
- (StrOpt) List of controller ip and port pairs for the heartbeat receivers. Example [127.0.0.1:5555, 127.0.0.1:5555]. | -
| = |
- (IntOpt) Number of threads performing amphora failovers. | -
| = |
- (IntOpt) Number of threads performing amphora status update. | -
| = |
- (IntOpt) Sleep time between sending hearthbeats from the amphora. | -
| = |
- (StrOpt) key used to authenticate the heartbeat message sent by the amphora. | -
| = |
- (IntOpt) Interval, in seconds, to wait before failing over an amphora. | -
| = |
- (IntOpt) Sleep time between health checks in seconds. | -
| = |
- (IntOpt) sets the value of the heartbeat recv buffer. | -
| [keystone_authtoken] | -|
| = |
- (StrOpt) Complete public Identity API endpoint. | -
| = |
- (StrOpt) Keystone account username. | -
| = |
- (StrOpt) Keystone account password. | -
| = |
- (StrOpt) Keystone service account tenant name to validate user tokens. | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| [keystone_authtoken_v3] | -|
| = |
- (StrOpt) Admin user keystone authentication domain. | -
| = |
- (StrOpt) Admin project keystone authentication domain. | -
| [certificates] | -|
| = |
- (StrOpt) Class name which generate certificates. | -
| = |
- (StrOpt) Class name of certificate manager. | -
| = |
- (StrOpt) Absolute path to the CA Certificate for signing. Defaults to env[OS_OCTAVIA_TLS_CA_CERT].Local Cert generator only. | -
| = |
- (StrOpt) Absolute path to the Private Key for signing. Defaults to env[OS_OCTAVIA_TLS_CA_KEY].Local Cert generator only. | -
| = |
- (StrOpt) Passphrase for the Private Key. Defaults to env[OS_OCTAVIA_CA_KEY_PASS] or None.Local Cert generator only. | -
| = |
- (StrOpt) Certificate signing digest. Defaults to env[OS_OCTAVIA_CA_SIGNING_DIGEST] or sha256.Local Cert generator only. | -
| = |
- (StrOpt) Absolute path to the certificate storage directory. Defaults to env[OS_OCTAVIA_TLS_STORAGE].Local Cert manager only. | -
| [octavia_network] | -|
| = |
- (StrOpt) Network to communicate with amphora. | -
| = |
- (IntOpt) The maximum attempts to retry an action with the networking service. | -
| = |
- (IntOpt) Seconds to wait before retrying an action with the networking service. | -
| [haproxy_amphora] | -|
| = |
- (StrOpt) Base directory for amphora files on amphora. | -
| = |
- (StrOpt) Base directory for cert storage on amphora. | -
| = |
- (StrOpt) Custom haproxy template. | -
| = |
- (StrOpt) Base director for log on amphora. | -
| = |
- (IntOpt) Retry threshold for connecting to amphorae. | -
| = |
- (IntOpt) Retry threshold for connecting to amphorae. | -
| = |
- (StrOpt) Name of the cert manager to use. | -
| = |
- (StrOpt) Name of user for access to amphora,ssh driver only. | -
| = |
- (StrOpt) Local absolute path to the private key loaded on amphora at boot,ssh driver only. | -
| = |
- (StrOpt) The host IP to bind to amphora hose/REST driver only. | -
| = |
- (IntOpt) The port to bind to.REST driver only. | -
| = |
- (StrOpt) The full path to haproxy. | -
| = |
- (IntOpt) The respawn count for haproxy's upstart script. | -
| = |
- (IntOpt) The respawn interval for haproxy's upstart script. | -
| = |
- (StrOpt) The directory to store haproxy cert files in. | -
| [controller_worker] | -|
| = |
- (IntOpt) Retry attempts to wait for Amphora to become active. | -
| = |
- (IntOpt) Seconds to wait for an Amphora to become active. | -
| = |
- (StrOpt) Nova instance flavor id for the Amphora. | -
| = |
- (StrOpt) Glance image id for the Amphora image to boot. | -
| = |
- (StrOpt) SSH key name used to boot the Amphora.REST driver/or debugging. | -
| = |
- (StrOpt) Network to attach to the Amphora. | -
| = |
- (StrOpt) List of security groups to attach to the Amphora. | -
| = |
- (StrOpt) Client CA for the amphora agent to use.REST driver only. | -
| = |
- (StrOpt) Name of the amphora driver to use. | -
| = |
- (StrOpt) Name of the compute driver to use. | -
| = |
- (StrOpt) Name of the network driver to use. | -
| = |
- (StrOpt) Name of the cert generator to use. | -
| [task_flow] | -|
| = |
- (StrOpt) TaskFlow engine to use. | -
| = |
- (IntOpt) The maximum number of workers. | -
| [oslo_messaging_rabbi] | -|
| = |
- (StrOpt) RabbitMQ username. | -
| = |
- (StrOpt) RabbitMQ password. | -
| = |
- (IntOpt) RabbitMQ port. | -
| = |
- (StrOpt) RabbitMQ host. | -
| [oslo_messaging] | -|
| = |
- (IntOpt) Queue Consumer Thread Pool Size. | -
| = |
- (StrOpt) Topic (i.e. Queue) Name. | -
| [house_keeping] | -|
| = |
- (IntOpt) Interval in seconds to initiate spare amphora checks. | -
| = |
- (IntOpt) Number of spare amphorae. | -
| = |
- (IntOpt) Cleanup interval for Deleted amphora. | -
| = |
- (IntOpt) Amphora expiry age in seconds. Default is 1 week. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| = |
- (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop | -
| = |
- (StrOpt) Notification level for outgoing notifications | -
| = |
- (StrOpt) Notification publisher_id for outgoing notifications | -
| = |
- (ListOpt) AMQP topic used for OpenStack notifications. | -
| = |
- (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_middleware] | -|
| = |
- (IntOpt) The maximum body size for each request, in bytes. | -
| = |
- (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. | -
| [retries] | -|
| = |
- (IntOpt) Number of times to retry the request to client before failing | -
| = |
- (IntOpt) Time between the retries to client (in seconds). | -
| Configuration option = Default value | -Description | -
|---|---|
| [keystone_authtoken] | -|
| = |
- (StrOpt) Service user password. | -
| = |
- (StrOpt) Service tenant name. | -
| = |
- (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | -
| = |
- (StrOpt) Service username. | -
| = |
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Name of the plugin to load | -
| = |
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | -
| = |
- (StrOpt) Config Section from which to load plugin specific options | -
| = |
- (StrOpt) Complete public Identity API endpoint. | -
| = |
- (StrOpt) API version of the admin Identity API endpoint. | -
| = |
- (StrOpt) Env key for the swift cache. | -
| = |
- (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. | -
| = |
- (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. | -
| = |
- (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| = |
- (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | -
| = |
- (IntOpt) Request timeout value for communicating with Identity API server. | -
| = |
- (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| = |
- (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | -
| = |
- (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. | -
| = |
- (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. | -
| = |
- (IntOpt) (Optional) Maximum total number of open connections to every memcached server. | -
| = |
- (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. | -
| = |
- (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. | -
| = |
- (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. | -
| = |
- (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. | -
| = |
- (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. | -
| = |
- (StrOpt) The region in which the identity server can be found. | -
| = |
- (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| = |
- (StrOpt) Directory used to cache files related to PKI tokens. | -
| = |
- (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | -Description | -
|---|---|
| [cinder] | -|
| = |
- (BoolOpt) Allow to perform insecure SSL requests to cinder. | -
| = |
- (IntOpt) Version of the Cinder API to use. | -
| = |
- (StrOpt) Location of ca certificates file to use for cinder client requests. | -
| = |
- (StrOpt) Endpoint type for cinder client requests | -
| [heat] | -|
| = |
- (BoolOpt) Allow to perform insecure SSL requests to heat. | -
| = |
- (StrOpt) Location of ca certificates file to use for heat client requests. | -
| = |
- (StrOpt) Endpoint type for heat client requests | -
| [keystone] | -|
| = |
- (BoolOpt) Allow to perform insecure SSL requests to keystone. | -
| = |
- (StrOpt) Location of ca certificates file to use for keystone client requests. | -
| = |
- (StrOpt) Endpoint type for keystone client requests | -
| [manila] | -|
| = |
- (BoolOpt) Allow to perform insecure SSL requests to manila. | -
| = |
- (IntOpt) Version of the manila API to use. | -
| = |
- (StrOpt) Location of ca certificates file to use for manila client requests. | -
| [neutron] | -|
| = |
- (BoolOpt) Allow to perform insecure SSL requests to neutron. | -
| = |
- (StrOpt) Location of ca certificates file to use for neutron client requests. | -
| = |
- (StrOpt) Endpoint type for neutron client requests | -
| [nova] | -|
| = |
- (BoolOpt) Allow to perform insecure SSL requests to nova. | -
| = |
- (StrOpt) Location of ca certificates file to use for nova client requests. | -
| = |
- (StrOpt) Endpoint type for nova client requests | -
| [swift] | -|
| = |
- (BoolOpt) Allow to perform insecure SSL requests to swift. | -
| = |
- (StrOpt) Location of ca certificates file to use for swift client requests. | -
| = |
- (StrOpt) Endpoint type for swift client requests | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The name of the domain for the service project(ex. tenant). | -
| = |
- (StrOpt) The name of the domain to which the admin user belongs. | -
| = |
- (IntOpt) Number of workers for Sahara API service (0 means all-in-one-thread configuration). | -
| = |
- (IntOpt) Maximal time (in hours) for clusters allowed to be in states other than "Active", "Deleting" or "Error". If a cluster is not in "Active", "Deleting" or "Error" state and last update of it was longer than "cleanup_time_for_incomplete_clusters" hours ago then it will be deleted automatically. (0 value means that automatic clean up is disabled). | -
| = |
- (IntOpt) Defines the period of time (in hours) after which trusts created to allow sahara to create or scale a cluster will expire. Note that this value should be significantly larger than the value of the cleanup_time_for_incomplete_clusters configuration key if use of the cluster cleanup feature is desired (the trust must last at least as long as a cluster could validly take to stall in its creation, plus the timeout value set in that key, plus one hour for the period of the cleanup job). | -
| = |
- (IntOpt) The same as global_remote_threshold, but for a single cluster. | -
| = |
- (StrOpt) File with nova compute topology. It should contain mapping between nova computes and racks. | -
| = |
- (StrOpt) Default ntp server for time sync | -
| = |
- (BoolOpt) Disables event log feature. | -
| = |
- (BoolOpt) Enables data locality for hadoop cluster. Also enables data locality for Swift used by hadoop. If enabled, 'compute_topology' and 'swift_topology' configuration parameters should point to OpenStack and Swift topology correspondingly. | -
| = |
- (BoolOpt) Enables four-level topology for data locality. Works only if corresponding plugin supports such mode. | -
| = |
- (BoolOpt) Enables sending notifications to Ceilometer | -
| = |
- (IntOpt) Size of executor thread pool. | -
| = |
- (IntOpt) Maximum number of remote operations that will be running at the same time. Note that each remote operation requires its own process to run. | -
| = |
- (ListOpt) List of tags to be used during operating with stack. | -
| = |
- (StrOpt) An engine which will be used to provision infrastructure for Hadoop cluster. | -
| = |
- (IntOpt) Maximum length of job binary data in kilobytes that may be stored or retrieved in a single operation. | -
| = |
- (IntOpt) Timeout for canceling job execution (in seconds). Sahara will try to cancel job execution during this time. | -
| = |
- (StrOpt) Postfix for storing jobs in hdfs. Will be added to '/user/<hdfs user>/' path. | -
| = |
- (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). | -
| = |
- (ListOpt) Memcached servers or None for in process cache. | -
| = |
- (IntOpt) Minimal "lifetime" in seconds for a transient cluster. Cluster is guaranteed to be "alive" within this time period. | -
| = |
- (StrOpt) The suffix of the node's FQDN. In nova-network that is the dhcp_domain config parameter. | -
| = |
- (StrOpt) Region name used to get services endpoints. | -
| = |
- (BoolOpt) Enable periodic tasks. | -
| = |
- (IntOpt) Range in seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0). | -
| = |
- (IntOpt) Max interval size between periodic tasks execution in seconds. | -
| = |
- (ListOpt) List of plugins to be loaded. Sahara preserves the order of the list when returning it. | -
| = |
- (StrOpt) Proxy command used to connect to instances. If set, this command should open a netcat socket, that Sahara will use for SSH and HTTP connections. Use {host} and {port} to describe the destination. Other available keywords: {tenant_id}, {network_id}, {router_id}. | -
| = |
- (StrOpt) A method for Sahara to execute commands on VMs. | -
| = |
- (StrOpt) Rootwrap command to leverage. Use in conjunction with use_rootwrap=True | -
| = |
- (StrOpt) File with Swift topology.It should contain mapping between Swift nodes and racks. | -
| = |
- (BoolOpt) Enable Sahara to use an external key manager service provided by the identity service catalog. Sahara will store all keys with the manager service. | -
| = |
- (BoolOpt) If set to True, Sahara will use floating IPs to communicate with instances. To make sure that all instances have floating IPs assigned in Nova Network set "auto_assign_floating_ip=True" in nova.conf. If Neutron is used for networking, make sure that all Node Groups have "floating_ip_pool" parameter defined. | -
| = |
- (BoolOpt) Enables Sahara to use Keystone API v3. If that flag is disabled, per-job clusters will not be terminated automatically. | -
| = |
- (BoolOpt) Use network namespaces for communication (only valid to use in conjunction with use_neutron=True). | -
| = |
- (BoolOpt) Use Neutron Networking (False indicates the use of Nova networking). | -
| = |
- (BoolOpt) Use rootwrap facility to allow non-root users to run the sahara-all server instance and access private network IPs (only valid to use in conjunction with use_namespaces=True) | -
| [conductor] | -|
| = |
- (BoolOpt) Perform sahara-conductor operations locally. | -
| [keystone_authtoken] | -|
| = |
- (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| Configuration option = Default value | -Description | -
|---|---|
| [cors] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] | -|
| = |
- (BoolOpt) Indicate that the actual request can include user credentials | -
| = |
- (ListOpt) Indicate which header field names may be used during the actual request. | -
| = |
- (ListOpt) Indicate which methods can be used during the actual request. | -
| = |
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| = |
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| = |
- (IntOpt) Maximum cache age of CORS preflight requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Driver to use for database access. | -
| [database] | -|
| = |
- (StrOpt) The back end to use for the database. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the database. | -
| = |
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. | -
| = |
- (BoolOpt) Add Python stack traces to SQL as comment strings. | -
| = |
- (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. | -
| = |
- (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. | -
| = |
- (IntOpt) Seconds between retries of a database transaction. | -
| = |
- (IntOpt) Timeout before idle SQL connections are reaped. | -
| = |
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy. | -
| = |
- (IntOpt) Maximum number of SQL connections to keep open in a pool. | -
| = |
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. | -
| = |
- (IntOpt) Minimum number of SQL connections to keep open in a pool. | -
| = |
- (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | -
| = |
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. | -
| = |
- (IntOpt) Interval between retries of opening a SQL connection. | -
| = |
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. | -
| = |
- (StrOpt) The file name to use with SQLite. | -
| = |
- (BoolOpt) If True, SQLite uses synchronous mode. | -
| = |
- (BoolOpt) Enable the experimental use of database reconnect on connection lost. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The domain Sahara will use to create new proxy users for Swift object access. | -
| = |
- (ListOpt) A list of the role names that the proxy user should assume through trust for Swift object access. | -
| = |
- (BoolOpt) Enables Sahara to use a domain for creating temporary proxy users to access Swift. If this is enabled a domain must be created for Sahara to use. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). | -
| = |
- (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Enables or disables fatal status of deprecations. | -
| = |
- (StrOpt) The format for an instance that is passed with the log message. | -
| = |
- (StrOpt) The format for an instance UUID that is passed with the log message. | -
| = |
- (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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). | -
| = |
- (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. | -
| = |
- (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. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) Format string to use for log messages with context. | -
| = |
- (StrOpt) Data to append to log format when level is DEBUG. | -
| = |
- (StrOpt) Format string to use for log messages without context. | -
| = |
- (StrOpt) Prefix each line of exception output with this format. | -
| = |
- (BoolOpt) Enables or disables publication of error events. | -
| = |
- (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. | -
| = |
- (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 Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. | -
| = |
- (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| Configuration option = Default value | -Description | -
|---|---|
| [object_store_access] | -|
| = |
- (StrOpt) Location of ca certificate file to use for identity client requests via public endpoint | -
| = |
- (StrOpt) Location of ca certificate file to use for object-store client requests via public endpoint | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_policy] | -|
| = |
- (StrOpt) Default rule. Enforced when a requested rule is not found. | -
| = |
- (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. | -
| = |
- (StrOpt) The JSON file that defines policies. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_qpid] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (IntOpt) Seconds between connection keepalive heartbeats. | -
| = |
- (StrOpt) Qpid broker hostname. | -
| = |
- (ListOpt) Qpid HA cluster host:port pairs. | -
| = |
- (StrOpt) Password for Qpid connection. | -
| = |
- (IntOpt) Qpid broker port. | -
| = |
- (StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| = |
- (IntOpt) The number of prefetched messages held by receiver. | -
| = |
- (StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| = |
- (BoolOpt) Whether to disable the Nagle algorithm. | -
| = |
- (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. | -
| = |
- (StrOpt) Username for Qpid connection. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_rabbit] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake | -
| = |
- (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. | -
| = |
- (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL | -
| = |
- (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| = |
- (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). | -
| = |
- (StrOpt) SSL cert file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL key file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. | -
| = |
- (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| = |
- (StrOpt) The RabbitMQ broker address where a single node is used. | -
| = |
- (ListOpt) RabbitMQ HA cluster host:port pairs. | -
| = |
- (StrOpt) The RabbitMQ login method. | -
| = |
- (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| = |
- (StrOpt) The RabbitMQ password. | -
| = |
- (IntOpt) The RabbitMQ broker port where a single node is used. | -
| = |
- (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| = |
- (IntOpt) How frequently to retry connecting with RabbitMQ. | -
| = |
- (BoolOpt) Connect over SSL for RabbitMQ. | -
| = |
- (StrOpt) The RabbitMQ userid. | -
| = |
- (StrOpt) The RabbitMQ virtual host. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Host to locate redis. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| [matchmaker_redis] | -|
| = |
- (StrOpt) Host to locate redis. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| = |
- (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| = |
- (IntOpt) Size of RPC connection pool. | -
| = |
- (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| = |
- (IntOpt) Seconds to wait for a response from a call. | -
| [oslo_concurrency] | -|
| = |
- (BoolOpt) Enables or disables inter-process locks. | -
| = |
- (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. | -
| [oslo_messaging_amqp] | -|
| = |
- (BoolOpt) Accept clients using either SSL or plain TCP | -
| = |
- (StrOpt) address prefix used when broadcasting to all servers | -
| = |
- (StrOpt) Name for the AMQP container | -
| = |
- (StrOpt) address prefix when sending to any server in group | -
| = |
- (IntOpt) Timeout for inactive connections (in seconds) | -
| = |
- (StrOpt) Password for message broker authentication | -
| = |
- (StrOpt) Path to directory that contains the SASL configuration | -
| = |
- (StrOpt) Name of configuration file (without .conf suffix) | -
| = |
- (StrOpt) Space separated list of acceptable SASL mechanisms | -
| = |
- (StrOpt) address prefix used when sending to a specific server | -
| = |
- (StrOpt) CA certificate PEM file to verify server certificate | -
| = |
- (StrOpt) Identifying certificate PEM file to present to clients | -
| = |
- (StrOpt) Private key PEM file used to sign cert_file certificate | -
| = |
- (StrOpt) Password for decrypting ssl_key_file (if encrypted) | -
| = |
- (BoolOpt) Debug: dump AMQP frames to stdout | -
| = |
- (StrOpt) User name for message broker authentication | -
| Configuration option = Default value | -Description | -
|---|---|
| [timeouts] | -|
| = |
- (IntOpt) Wait for attaching volumes to instances, in seconds | -
| = |
- (IntOpt) Wait for instances to become active, in seconds | -
| = |
- (IntOpt) Wait for instances to be deleted, in seconds | -
| = |
- (IntOpt) Timeout for detaching volumes from instance, in seconds | -
| = |
- (IntOpt) Assign IPs timeout, in seconds | -
| = |
- (IntOpt) Wait for volumes to become available, in seconds | -
| = |
- (IntOpt) Wait for instance accessibility, in seconds | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| = |
- (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| = |
- (StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| = |
- (IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| = |
- (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. | -
| = |
- (StrOpt) Directory for holding IPC sockets. | -
| = |
- (StrOpt) MatchMaker driver. | -
| = |
- (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| = |
- (BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Maximum number of allowed pending TCP connections | -
| = |
- IP Address for server to bind to | -
| = |
- Port for server to bind to | -
| = |
- Seconds to attempt bind before giving up | -
| = |
- If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#account`. replication passes account can be reclaimed | -
| = |
- Parent directory of where devices are mounted | -
| = |
- Disable "fast fail" fallocate checks if the underlying filesystem does not support it. | -
| = |
- If true, turn on debug logging for eventlet | -
| = |
- You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`. | -
| = |
- Location where syslog sends the logs to | -
| = |
- Comma-separated list of functions to call to setup custom log handlers. | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Caps the length of log lines to the value given; no limit if set to 0, the default. | -
| = |
- Label used when logging | -
| = |
- Defines the probability of sending a sample for any given event or - timing measurement. | -
| = |
- If not set, the StatsD feature is disabled. | -
| = |
- Value will be prepended to every metric sent to the StatsD server. | -
| = |
- Port value for the StatsD server. | -
| = |
- Not recommended to set this to a value less than 1.0, if frequency - of logging is too high, tune the - log_statsd_default_sample_rate instead. | -
| = |
- If not set, the UDP receiver for syslog is disabled. | -
| = |
- Port value for UDP receiver, if enabled. | -
| = |
- Maximum number of clients one worker can process simultaneously -Lowering the number of clients handled per worker, and raising the -number of workers can lessen the impact that a CPU intensive, or -blocking, request can have on other requests served by the same -worker. If the maximum number of clients is set to one, then a given worker -will not perform another call while processing, allowing -other workers a chance to process it. | -
| = |
- Whether or not check if the devices are mounted to prevent accidentally writing to the root device | -
| = |
- Swift configuration directory | -
| = |
- User to run as | -
| = |
- a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Maximum accounts audited per second. Should be tuned according to individual system specs. 0 is unlimited. | -
| = |
- Minimum time for a pass to take | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Label used when logging | -
| = |
- Directory where stats for a few items will be stored | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Number of replication workers to spawn | -
| = |
- Connection timeout to external services | -
| = |
- Normally, the reaper begins deleting account information for deleted accounts immediately; you can set this to delay its work however. The value is in seconds, 2592000 = 30 days, for example. bind to giving up worker can process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | -
| = |
- Minimum time for a pass to take | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Label used when logging | -
| = |
- Request timeout to external services | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Number of replication workers to spawn | -
| = |
- Connection timeout to external services | -
| = |
- Minimum time for a pass to take | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Label used when logging | -
| = |
- Caps how long the replicator spends trying to sync a database per pass | -
| = |
- Request timeout to external services | -
| = |
- Limit number of items to get per diff | -
| = |
- Time elapsed in seconds before an object can be reclaimed | -
| = |
- Directory where stats for a few items will be stored | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- Time in seconds to wait between replication passes | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Prefix to use when automatically creating accounts | -
| = |
- If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request. | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Log level | -
| = |
- Label to use when logging | -
| = |
- Whether or not to log requests | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Directory where stats for a few items will be stored | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Location where syslog sends the logs to | -
| = |
- Comma-separated list of functions to call to setup custom log handlers. | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Label used when logging | -
| = |
- Defines the probability of sending a sample for any given event or - timing measurement. | -
| = |
- If not set, the StatsD feature is disabled. | -
| = |
- Value will be prepended to every metric sent to the StatsD server. | -
| = |
- Port value for the StatsD server. | -
| = |
- Not recommended to set this to a value less than 1.0, if frequency - of logging is too high, tune the - log_statsd_default_sample_rate instead. | -
| = |
- If not set, the UDP receiver for syslog is disabled. | -
| = |
- Port value for UDP receiver, if enabled. | -
| = |
- Swift configuration directory | -
| = |
- User to run as | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Minimum time for a pass to take | -
| = |
- Time elapsed in seconds before an object can be reclaimed | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- Maximum number of allowed pending TCP connections | -
| = |
- IP Address for server to bind to | -
| = |
- Port for server to bind to | -
| = |
- Seconds to attempt bind before giving up | -
| = |
- If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#account`. replication passes account can be reclaimed | -
| = |
- Parent directory of where devices are mounted | -
| = |
- Disable "fast fail" fallocate checks if the underlying filesystem does not support it. | -
| = |
- If true, turn on debug logging for eventlet | -
| = |
- You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`. | -
| = |
- Location where syslog sends the logs to | -
| = |
- Comma-separated list of functions to call to setup custom log handlers. | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Caps the length of log lines to the value given; no limit if set to 0, the default. | -
| = |
- Label used when logging | -
| = |
- Defines the probability of sending a sample for any given event or - timing measurement. | -
| = |
- If not set, the StatsD feature is disabled. | -
| = |
- Value will be prepended to every metric sent to the StatsD server. | -
| = |
- Port value for the StatsD server. | -
| = |
- Not recommended to set this to a value less than 1.0, if frequency - of logging is too high, tune the - log_statsd_default_sample_rate instead. | -
| = |
- If not set, the UDP receiver for syslog is disabled. | -
| = |
- Port value for UDP receiver, if enabled. | -
| = |
- Maximum number of clients one worker can process simultaneously -Lowering the number of clients handled per worker, and raising the -number of workers can lessen the impact that a CPU intensive, or -blocking, request can have on other requests served by the same -worker. If the maximum number of clients is set to one, then a given worker -will not perform another call while processing, allowing -other workers a chance to process it. | -
| = |
- Whether or not check if the devices are mounted to prevent accidentally writing to the root device | -
| = |
- Swift configuration directory | -
| = |
- User to run as | -
| = |
- a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Enable/Disable object versioning feature | -
| = |
- Prefix to use when automatically creating accounts | -
| = |
- Connection timeout to external services | -
| = |
- Request timeout to external services | -
| = |
- If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request. | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Log level | -
| = |
- Label to use when logging | -
| = |
- Whether or not to log requests | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Maximum containers audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | -
| = |
- Minimum time for a pass to take | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Label used when logging | -
| = |
- Directory where stats for a few items will be stored | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Number of replication workers to spawn | -
| = |
- Connection timeout to external services | -
| = |
- Minimum time for a pass to take | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Label used when logging | -
| = |
- Caps how long the replicator spends trying to sync a database per pass | -
| = |
- Request timeout to external services | -
| = |
- Limit number of items to get per diff | -
| = |
- Time elapsed in seconds before an object can be reclaimed | -
| = |
- Directory where stats for a few items will be stored | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- Time in seconds to wait between replication passes | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Connection timeout to external services | -
| = |
- Maximum amount of time to spend syncing each container | -
| = |
- No help text available for this option. | -
| = |
- Minimum time for a pass to take | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Label used when logging | -
| = |
- No help text available for this option. | -
| = |
- If you need to use an HTTP proxy, set it here. Defaults to no proxy. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Seconds to suppress updating an account that has generated an - error (timeout, not yet found, etc.) | -
| = |
- Number of replication workers to spawn | -
| = |
- Connection timeout to external services | -
| = |
- Minimum time for a pass to take | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Label used when logging | -
| = |
- Request timeout to external services | -
| = |
- Directory where stats for a few items will be stored | -
| = |
- Time in seconds to wait between objects | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Directory where stats for a few items will be stored | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- Endpoint for auth server, such as keystone | -
| = |
- Default user for dispersion in this context | -
| = |
- Indicates which version of auth | -
| = |
- Number of replication workers to spawn | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- Indicates whether endpoint for auth is public or internal | -
| = |
- Allow accessing insecure keystone server. The keystone's certificate will not be verified. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- Swift configuration directory | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Directory devices are mounted under | -
| = |
- Number of errors to find before a device is unmounted | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Location of the log file with globbing pattern to check against device errors locate device blocks with errors in the log file | -
| = |
- Logging level | -
| = |
- Caps the length of log lines to the value given; no limit if set to 0, the default. | -
| = |
- No help text available for this option. | -
| = |
- Number of minutes to look back in `/var/log/kern.log` | -
| = |
- Directory where stats for a few items will be stored | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Location where syslog sends the logs to | -
| = |
- Comma-separated list of functions to call to setup custom log handlers. | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Label used when logging | -
| = |
- Defines the probability of sending a sample for any given event or - timing measurement. | -
| = |
- If not set, the StatsD feature is disabled. | -
| = |
- Value will be prepended to every metric sent to the StatsD server. | -
| = |
- Port value for the StatsD server. | -
| = |
- Not recommended to set this to a value less than 1.0, if frequency - of logging is too high, tune the - log_statsd_default_sample_rate instead. | -
| = |
- If not set, the UDP receiver for syslog is disabled. | -
| = |
- Port value for UDP receiver, if enabled. | -
| = |
- Swift configuration directory | -
| = |
- User to run as | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Timeout in seconds (float) for connection | -
| = |
- Timeout in seconds (float) for read and write | -
| = |
- Max number of connections to each memcached server per worker services | -
| = |
- Sets how memcache values are serialized and deserialized | -
| = |
- Comma-separated list of memcached servers ip:port services | -
| = |
- Timeout in seconds (float) for pooled connection | -
| = |
- Number of servers to retry on failures getting a pooled connection | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Location where syslog sends the logs to | -
| = |
- Comma-separated list of functions to call to setup custom log handlers. | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Caps the length of log lines to the value given; no limit if set to 0, the default. | -
| = |
- Label used when logging | -
| = |
- Defines the probability of sending a sample for any given event or - timing measurement. | -
| = |
- If not set, the StatsD feature is disabled. | -
| = |
- Value will be prepended to every metric sent to the StatsD server. | -
| = |
- Port value for the StatsD server. | -
| = |
- Not recommended to set this to a value less than 1.0, if frequency - of logging is too high, tune the - log_statsd_default_sample_rate instead. | -
| = |
- If not set, the UDP receiver for syslog is disabled. | -
| = |
- Port value for UDP receiver, if enabled. | -
| = |
- Swift configuration directory | -
| = |
- User to run as | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- If access_log_headers is True and access_log_headers_only is set only - these headers are logged. Multiple headers can be defined as comma separated list like this: - access_log_headers_only = Host, X-Object-Meta-Mtime | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- The X-Auth-Token is sensitive data. If revealed to an unauthorised person, - they can now make requests against an account until the token expires. - - Set reveal_sensitive_prefix to the number of characters of the token that are logged. - For example reveal_sensitive_prefix = 12 so only first 12 characters of the token are logged. - Or, set to 0 to completely remove the token. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Prefix to use when automatically creating accounts | -
| = |
- Number of replication workers to spawn | -
| = |
- No help text available for this option. | -
| = |
- Minimum time for a pass to take | -
| = |
- (it will actually accept(2) N + 1). Setting this to one (1) will - only handle one request at a time, without - accepting another request concurrently. | -
| = |
- for each port (disk) in the ring. If you have 24 disks per server, and this setting is 4, then each storage node will have 1 + (24 * 4) = 97 total object-server processes running. This gives complete I/O isolation, drastically reducing the impact of slow disks on storage node performance. The object-replicator and object-reconstructor need to see this setting too, so it must be in the [DEFAULT] section. See :ref:`server-per-port-configuration`. | -
| = |
- Time elapsed in seconds before an object can be reclaimed | -
| = |
- Directory where stats for a few items will be stored | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Maximum number of allowed pending TCP connections | -
| = |
- IP Address for server to bind to | -
| = |
- Port for server to bind to | -
| = |
- Seconds to attempt bind before giving up | -
| = |
- Timeout to read one chunk from a client external services | -
| = |
- Connection timeout to external services | -
| = |
- Time to wait while sending a container update on object update. object server. For most cases, this should be `egg:swift#object`. request | -
| = |
- Parent directory of where devices are mounted | -
| = |
- Disable "fast fail" fallocate checks if the underlying filesystem does not support it. | -
| = |
- Size of chunks to read/write to disk | -
| = |
- If true, turn on debug logging for eventlet | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`. | -
| = |
- Location where syslog sends the logs to | -
| = |
- Comma-separated list of functions to call to setup custom log handlers. | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Caps the length of log lines to the value given; no limit if set to 0, the default. | -
| = |
- Label used when logging | -
| = |
- Defines the probability of sending a sample for any given event or - timing measurement. | -
| = |
- If not set, the StatsD feature is disabled. | -
| = |
- Value will be prepended to every metric sent to the StatsD server. | -
| = |
- Port value for the StatsD server. | -
| = |
- Not recommended to set this to a value less than 1.0, if frequency - of logging is too high, tune the - log_statsd_default_sample_rate instead. | -
| = |
- If not set, the UDP receiver for syslog is disabled. | -
| = |
- Port value for UDP receiver, if enabled. | -
| = |
- Maximum number of clients one worker can process simultaneously -Lowering the number of clients handled per worker, and raising the -number of workers can lessen the impact that a CPU intensive, or -blocking, request can have on other requests served by the same -worker. If the maximum number of clients is set to one, then a given worker -will not perform another call while processing, allowing -other workers a chance to process it. | -
| = |
- Whether or not check if the devices are mounted to prevent accidentally writing to the root device | -
| = |
- Size of chunks to read/write over the network | -
| = |
- Request timeout to external services | -
| = |
- If each disk in each storage policy ring has unique port numbers for its "ip" value, you can use this setting to have each object-server worker only service requests for the single disk matching the port in the ring. The value of this setting determines how many worker processes run for each port (disk) in the | -
| = |
- Swift configuration directory | -
| = |
- User to run as | -
| = |
- a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Comma-separated list of headers that can be set in metadata of an object | -
| = |
- Prefix to use when automatically creating accounts | -
| = |
- Allow non-public objects to stay in kernel's buffer cache | -
| = |
- Largest object size to keep in buffer cache | -
| = |
- Maximum time allowed to upload an object | -
| = |
- On PUT requests, sync file every n MB | -
| = |
- Set to restrict the number of concurrent incoming REPLICATION requests; set to 0 for unlimited | -
| = |
- If the value of failures / successes of REPLICATION subrequests exceeds this ratio, the overall REPLICATION request will be aborted | -
| = |
- The number of subrequest failures before the replication_failure_ratio is checked | -
| = |
- Number of seconds to wait for an existing replication device lock before giving up. | -
| = |
- Restricts incoming REPLICATION requests to one per device, replication_currency above allowing. This can help control I/O to each device, but you may wish to set this to False to allow multiple REPLICATION requests (up to the above replication_concurrency setting) per device. | -
| = |
- If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request. | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Log level | -
| = |
- Label to use when logging | -
| = |
- Whether or not to log requests | -
| = |
- If > 0, Minimum time in seconds for a PUT or DELETE request to complete | -
| = |
- No help text available for this option. | -
| = |
- Size of the per-disk thread pool used for performing disk I/O. The default of 0 means to not use a per-disk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Directory where stats for a few items will be stored | -
| = |
- No help text available for this option. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Maximum bytes audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. container server. For most cases, this should be `egg:swift#container`. | -
| = |
- Number of replication workers to spawn | -
| = |
- Size of chunks to read/write to disk | -
| = |
- Maximum files audited per second. Should be tuned according to individual system specs. 0 is unlimited. | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Label used when logging | -
| = |
- Frequency of status logs in seconds. | -
| = |
- No help text available for this option. | -
| = |
- Directory where stats for a few items will be stored | -
| = |
- Maximum zero byte files audited per second. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Number of replication workers to spawn | -
| = |
- Whether or not to run replication as a daemon | -
| = |
- If set to True, partitions that are not supposed to be on the node will be replicated first. The default setting should not be changed, except for extreme situations. | -
| = |
- Maximum duration for an HTTP request | -
| = |
- Minimum time for a pass to take | -
| = |
- Attempts to kill all workers if nothing replications for lockup_timeout seconds | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Label used when logging | -
| = |
- Request timeout to external services | -
| = |
- Time elapsed in seconds before an object can be reclaimed | -
| = |
- Directory where stats for a few items will be stored | -
| = |
- How often (in seconds) to check the ring | -
| = |
- Time in seconds to wait between replication passes | -
| = |
- Interval in seconds between logging replication statistics | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Number of replication workers to spawn | -
| = |
- Whether or not to run replication as a daemon | -
| = |
- By default handoff partitions will be removed when it has successfully replicated to all the canonical nodes. If set to an integer n, it will remove the partition if it is successfully replicated to n nodes. The default setting should not be changed, except for extremem situations. This uses what's set here, or what's set in the DEFAULT section, or 10 (though other sections use 3 as the final default). | -
| = |
- If set to True, partitions that are not supposed to be on the node will be replicated first. The default setting should not be changed, except for extreme situations. | -
| = |
- Maximum duration for an HTTP request | -
| = |
- Minimum time for a pass to take | -
| = |
- Attempts to kill all workers if nothing replications for lockup_timeout seconds | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Label used when logging | -
| = |
- Request timeout to external services | -
| = |
- Time elapsed in seconds before an object can be reclaimed | -
| = |
- Directory where stats for a few items will be stored | -
| = |
- How often (in seconds) to check the ring | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- Passed to rsync for a max duration (seconds) of an I/O op | -
| = |
- No help text available for this option. | -
| = |
- Max duration (seconds) of a partition rsync | -
| = |
- Time in seconds to wait between replication passes | -
| = |
- Interval in seconds between logging replication statistics | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Number of replication workers to spawn | -
| = |
- Minimum time for a pass to take | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Logging level | -
| = |
- Label used when logging | -
| = |
- Request timeout to external services | -
| = |
- Directory where stats for a few items will be stored | -
| = |
- Time in seconds to wait between objects | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- to use for admin calls that are HMAC signed. Default is empty, which will disable admin calls to /info. the proxy server. For most cases, this should be `egg:swift#proxy`. request whenever it has to failover to a handoff node | -
| = |
- Maximum number of allowed pending TCP connections | -
| = |
- IP Address for server to bind to | -
| = |
- Port for server to bind to | -
| = |
- Seconds to attempt bind before giving up | -
| = |
- to the ssl .crt. This should be enabled for testing purposes only. | -
| = |
- Timeout to read one chunk from a client external services | -
| = |
- is a list of hosts that are included with any CORS request by default and returned with the Access-Control-Allow-Origin header in addition to what the container has set. to call to setup custom log handlers. for eventlet the proxy server. For most cases, this should be `egg:swift#proxy`. request whenever it has to failover to a handoff node | -
| = |
- No help text available for this option. | -
| = |
- If true, turn on debug logging for eventlet | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- Enables exposing configuration settings via HTTP GET /info. | -
| = |
- to the ssl .key. This should be enabled for testing purposes only. | -
| = |
- Location where syslog sends the logs to | -
| = |
- Comma-separated list of functions to call to setup custom log handlers. | -
| = |
- Syslog log facility | -
| = |
- No help text available for this option. | -
| = |
- Logging level | -
| = |
- Caps the length of log lines to the value given; no limit if set to 0, the default. | -
| = |
- Label used when logging | -
| = |
- Defines the probability of sending a sample for any given event or - timing measurement. | -
| = |
- If not set, the StatsD feature is disabled. | -
| = |
- Value will be prepended to every metric sent to the StatsD server. | -
| = |
- Port value for the StatsD server. | -
| = |
- Not recommended to set this to a value less than 1.0, if frequency - of logging is too high, tune the - log_statsd_default_sample_rate instead. | -
| = |
- If not set, the UDP receiver for syslog is disabled. | -
| = |
- Port value for UDP receiver, if enabled. | -
| = |
- Maximum number of clients one worker can process simultaneously -Lowering the number of clients handled per worker, and raising the -number of workers can lessen the impact that a CPU intensive, or -blocking, request can have on other requests served by the same -worker. If the maximum number of clients is set to one, then a given worker -will not perform another call while processing, allowing -other workers a chance to process it. | -
| = |
- No help text available for this option. | -
| = |
- Swift configuration directory | -
| = |
- No help text available for this option. | -
| = |
- User to run as | -
| = |
- a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- If set to 'true' authorized accounts that do not yet exist within the Swift cluster will be automatically created. | -
| = |
- Whether account PUTs and DELETEs are even callable | -
| = |
- Prefix to use when automatically creating accounts | -
| = |
- Chunk size to read from clients | -
| = |
- Connection timeout to external services | -
| = |
- No help text available for this option. | -
| = |
- Time in seconds that must elapse since the last error for a node to be considered no longer error limited | -
| = |
- Error count to consider a node error limited | -
| = |
- No help text available for this option. | -
| = |
- If set to a positive value, trying to create a container when the account already has at least this maximum containers will result in a 403 Forbidden. Note: This is a soft limit, meaning a user might exceed the cap for recheck_account_existence before the 403s kick in. | -
| = |
- is a comma separated list of account names that ignore the max_containers_per_account cap. | -
| = |
- No help text available for this option. | -
| = |
- Request timeout to external services | -
| = |
- Chunk size to read from object servers | -
| = |
- Set object_post_as_copy = false to turn on fast posts where only the metadata changes are stored anew and the original data file is kept in place. This makes for quicker posts; but since the container metadata isn't updated in this mode, features like container sync won't be able to sync posts. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- Cache timeout in seconds to send memcached for account existence | -
| = |
- Cache timeout in seconds to send memcached for container existence | -
| = |
- Request timeout to external services for requests that, on failure, can be recovered from. For example, object GET. from a client external services | -
| = |
- * replicas Set to the number of nodes to contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. conf file for values will only be shown to the list of swift_owners. The exact default definition of a swift_owner is headers> up to the auth system in use, but usually indicates administrative responsibilities. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- Log level | -
| = |
- Label to use when logging | -
| = |
- No help text available for this option. | -
| = |
- These are the headers whose conf file for values will only be shown to the list of swift_owners. The exact default definition of a swift_owner is headers> up to the auth system in use, but usually indicates administrative responsibilities. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request | -
| = |
- No help text available for this option. | -
| = |
- Entry point of paste.deploy in the server | -
| = |
- This setting lets you trade data distribution for throughput. It makes the proxy server prefer local back-end servers for object PUT requests over non-local ones. Note that only object PUT requests are affected by the write_affinity setting; POST, GET, HEAD, DELETE, OPTIONS, and account/container PUT requests are not affected. The format is r<N> for region N or r<N>z<M> for region N, zone M. If this is set, then when handling an object PUT request, some number (see the write_affinity_node_count setting) of local backend servers will be tried before any nonlocal ones. Example: try to write to regions 1 and 2 before writing to any other nodes: write_affinity = r1, r2 | -
| = |
- This setting is only useful in conjunction with write_affinity; it governs how many local object servers will be tried before falling back to non-local ones. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request: write_affinity_node_count = 2 * replicas | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- Entry point of paste.deploy in the server | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Max number of connections to each memcached server per worker services | -
| = |
- Sets how memcache values are serialized and deserialized | -
| = |
- Comma-separated list of memcached servers ip:port services | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- If True, log headers in each request | -
| = |
- Log level | -
| = |
- Label to use when logging | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- If True, log headers in each request | -
| = |
- Log level | -
| = |
- Label to use when logging | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Because CNAMES can be recursive, specifies the number of levels through which to search. | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- If True, log headers in each request | -
| = |
- Log level | -
| = |
- Label to use when logging | -
| = |
- Domain that matches your cloud. Multiple domains can be specified using a comma-separated - list. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- Rate limit the download of large object segments after this segment is downloaded. | -
| = |
- Rate limit large object downloads at this rate. contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- Root path | -
| = |
- Reseller prefix | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- If True, log headers in each request | -
| = |
- Log level | -
| = |
- Label to use when logging | -
| = |
- Domain that matches your cloud. Multiple domains can be specified using a comma-separated - list. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- If True, log headers in each request | -
| = |
- Log level | -
| = |
- Label to use when logging | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- The backwards compatible behavior can be disabled by setting this -option to False. | -
| = |
- This option allows middleware higher in the WSGI pipeline to override auth -processing, useful for middleware such as tempurl and formpost. If you know -you are not going to use such middleware and you want a bit of extra security, -you can set this to False. | -
| = |
- Name of the default domain. It is identified by its UUID, which by default has the value "default". | -
| = |
- If this option is set to True, it allows to give a user whose username is the same as the project name and who has any role in the project access rights elevated to be the same as if the user had one of the operator_roles. Note that the condition compares names rather than -UUIDs. This option is deprecated. It is False by default. | -
| = |
- Operator role defines the user which is allowed to manage a tenant and create containers or give ACL to others. This parameter may be prefixed with an appropriate -prefix. | -
| = |
- The reseller admin role gives the ability to create and delete accounts. | -
| = |
- The naming scope for the auth service. Swift | -
| = |
- When present, this option requires that the X-Service-Token header supplies a token from a user who has a role listed in service_roles. This parameter may be prefixed with an appropriate -prefix. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Characters that are not allowed in a name | -
| = |
- Substrings to forbid, using regular expression syntax | -
| = |
- Maximum length of a name | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- If access_log_headers is True and access_log_headers_only is set only - these headers are logged. Multiple headers can be defined as comma separated list like this: - access_log_headers_only = Host, X-Object-Meta-Mtime | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- The X-Auth-Token is sensitive data. If revealed to an unauthorised person, - they can now make requests against an account until the token expires. - - Set reveal_sensitive_prefix to the number of characters of the token that are logged. - For example reveal_sensitive_prefix = 12 so only first 12 characters of the token are logged. - Or, set to 0 to completely remove the token. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Comma separated lists of account names that will not be allowed. Returns a 497 response. r: for containers of size x, limit requests per second to r. Will limit PUT, DELETE, and POST requests to /a/c/o. container_listing_ratelimit_x = r: for containers of size x, limit listing requests per second to r. Will limit GET requests to /a/c. | -
| = |
- If set, will limit PUT and DELETE requests to /account_name/container_name. Number is in requests per second. | -
| = |
- Comma separated lists of account names that will not be rate limited. | -
| = |
- Represents how accurate the proxy servers' system clocks are with each other. 1000 means that all the proxies' clock are accurate to each other within 1 millisecond. No ratelimit should be higher than the clock accuracy. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- To allow visibility into rate limiting set this value > 0 and all sleeps greater than the number will be logged. | -
| = |
- App will immediately return a 498 response if the necessary sleep time ever exceeds the given max_sleep_time_seconds. | -
| = |
- Number of seconds the rate counter can drop and be allowed to catch up (at a faster than listed rate). A larger number will result in larger spikes in rate but better average accuracy. | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- If True, log headers in each request | -
| = |
- Log level | -
| = |
- Label to use when logging | -
| = |
- Entry point of paste.deploy in the server | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- Rate limit the download of large object segments after this segment is downloaded. | -
| = |
- Rate limit large object downloads at this rate. contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- This option allows middleware higher in the WSGI pipeline to override auth -processing, useful for middleware such as tempurl and formpost. If you know -you are not going to use such middleware and you want a bit of extra security, -you can set this to False. | -
| = |
- The HTTP request path prefix for the auth service. Swift itself reserves anything beginning with the letter `v`. | -
| = |
- No help text available for this option. | -
| = |
- The naming scope for the auth service. Swift | -
| = |
- Location where syslog sends the logs to | -
| = |
- Syslog log facility | -
| = |
- If True, log headers in each request | -
| = |
- Log level | -
| = |
- Label to use when logging | -
| = |
- Scheme to return with storage urls: http, https, or default (chooses based on what the server is running as) This can be useful with an SSL load balancer in front of a non-SSL server. | -
| = |
- The number of seconds a token is valid. | -
| = |
- Entry point of paste.deploy in the server | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- Headers allowed as exceptions to incoming_remove_headers. Simply a whitespace - delimited list of header names and names can optionally end with '*' to indicate - a prefix match. | -
| = |
- Headers to remove from incoming requests. Simply a whitespace delimited list of header names and - names can optionally end with '*' to indicate a prefix match. | -
| = |
- HTTP methods allowed with Temporary URLs | -
| = |
- Headers allowed as exceptions to outgoing_allow_headers. Simply a whitespace delimited list of - header names and names can optionally end with '*' to indicate a prefix match. | -
| = |
- Headers to remove from outgoing responses. Simply a whitespace delimited list of - header names and names can optionally end with '*' to indicate a prefix - match. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- Entry point of paste.deploy in the server | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- 0 means to not use a per-disk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- The default (and maximum) number of items returned for an account listing request. | -
| = |
- The default (and maximum) number of items returned for a container listing request. | -
| = |
- By default the maximum number of allowed headers depends on the number of max allowed metadata settings plus a default value of 32 for regular http headers. If for some reason this is not enough (custom middleware for example) it can be increased with the extra_header_count constraint. | -
| = |
- The maximum number of bytes in the utf8 encoding of an account name. | -
| = |
- The maximum number of bytes in the utf8 encoding of a container name. | -
| = |
- The largest normal object that can be saved in the cluster. - This is also the limit on the size of each segment of a large object - when using the large object manifest support. This value is set in bytes. - Setting it to lower than 1MiB will cause some tests to fail. It is - STRONGLY recommended to leave this value at the default (5 * 2**30 + 2). | -
| = |
- The max number of bytes in the utf8 encoding of each header. - Using 8192 as default because eventlet use 8192 - as maximum size of header line. You may need to increase this value when using - identity v3 API tokens including more than 7 catalog entries. - See also include_service_catalog in proxy-server.conf-sample - (documented in overview_auth.rst). | -
| = |
- The max number of metadata keys that can be stored - on a single account, container, or object. | -
| = |
- The max number of bytes in the utf8 encoding - of the name portion of a metadata header. | -
| = |
- The max number of bytes in the utf8 encoding of the - metadata (keys + values). | -
| = |
- The max number of bytes in the utf8 encoding of a metadata value. | -
| = |
- The max number of bytes in the utf8 encoding - of an object name. | -
| = |
- No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| = |
- A prefix used by hash_path to offer a bit more security when generating hashes for - paths. It simply appends this value to all paths; if someone knows this suffix, - it's easier for them to guess the hash a path will end up with. - New installations are advised to set this parameter to a random secret, - which would not be disclosed ouside the organization. - The same secret needs to be used by all swift servers of the same cluster. - - Existing installations should set this parameter to an empty string. | -
| = |
- A suffix used by hash_path to offer a bit more security when generating hashes for - paths. It simply appends this value to all paths; if someone knows this suffix, - it's easier for them to guess the hash a path will end up with. - New installations are advised to set this parameter to a random secret, - which would not be disclosed ouside the organization. - The same secret needs to be used by all swift servers of the same cluster. - - Existing installations should set this parameter to an empty string. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Qualified class name to use for conductor manager. | -
| = |
- (StrOpt) Message queue name the Conductor will listen on. | -
| = |
- (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| = |
- (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop | -
| = |
- (DictOpt) Unique ID to tag notification events. | -
| = |
- (ListOpt) AMQP topic used for OpenStack notifications. | -
| = |
- (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (ListOpt) Roles to add to an admin user. | -
| = |
- (StrOpt) File name for the paste.deploy config for trove-api. | -
| = |
- (StrOpt) IP address the API server will listen on. | -
| = |
- (IntOpt) Port the API server will listen on. | -
| = |
- (StrOpt) Exclude IP addresses that match this regular expression. | -
| = |
- (StrOpt) API Implementation for Trove database access. | -
| = |
- (BoolOpt) Require user hostnames to be valid IP addresses. | -
| = |
- (IntOpt) Maximum number of HTTP 'DELETE' requests (per minute). | -
| = |
- (IntOpt) Maximum number of HTTP 'GET' requests (per minute). | -
| = |
- (IntOpt) Maximum number of management HTTP 'POST' requests (per minute). | -
| = |
- (IntOpt) Maximum number of HTTP 'POST' requests (per minute). | -
| = |
- (IntOpt) Maximum number of HTTP 'PUT' requests (per minute). | -
| = |
- (StrOpt) Path to folder on the Guest where config files will be injected during instance creation. | -
| = |
- (IntOpt) Page size for listing instances. | -
| = |
- (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). | -
| = |
- (StrOpt) Region name of this node. Used when searching catalog. | -
| = |
- (StrOpt) The region this service is located. | -
| = |
- (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. | -
| = |
- (IntOpt) Number of workers for the API service. The default will be the number of CPUs available. | -
| = |
- (StrOpt) Trove authentication URL. | -
| = |
- (IntOpt) Number of workers for the Conductor service. The default will be the number of CPUs available. | -
| = |
- (StrOpt) Prefix to use when creating Security Groups. | -
| = |
- (StrOpt) CIDR to use when creating Security Group Rules. | -
| = |
- (BoolOpt) Whether Trove should add Security Groups on create. | -
| = |
- (IntOpt) Page size for listing users. | -
| Configuration option = Default value | -Description | -
|---|---|
| [keystone_authtoken] | -|
| = |
- (StrOpt) Service user password. | -
| = |
- (StrOpt) Service tenant name. | -
| = |
- (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | -
| = |
- (StrOpt) Service username. | -
| = |
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Name of the plugin to load | -
| = |
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | -
| = |
- (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | -
| = |
- (StrOpt) Config Section from which to load plugin specific options | -
| = |
- (StrOpt) Complete public Identity API endpoint. | -
| = |
- (StrOpt) API version of the admin Identity API endpoint. | -
| = |
- (StrOpt) Env key for the swift cache. | -
| = |
- (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. | -
| = |
- (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. | -
| = |
- (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| = |
- (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | -
| = |
- (IntOpt) Request timeout value for communicating with Identity API server. | -
| = |
- (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| = |
- (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | -
| = |
- (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| = |
- (BoolOpt) Verify HTTPS connections. | -
| = |
- (StrOpt) Required if identity server requires client certificate | -
| = |
- (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. | -
| = |
- (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. | -
| = |
- (IntOpt) (Optional) Maximum total number of open connections to every memcached server. | -
| = |
- (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. | -
| = |
- (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. | -
| = |
- (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. | -
| = |
- (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. | -
| = |
- (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. | -
| = |
- (StrOpt) The region in which the identity server can be found. | -
| = |
- (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| = |
- (StrOpt) Directory used to cache files related to PKI tokens. | -
| = |
- (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Default OpenSSL aes_cbc key. | -
| = |
- (IntOpt) Chunk size (in bytes) to stream to the Swift container. This should be in multiples of 128 bytes, since this is the size of an md5 digest block allowing the process to update the file checksum during streaming. See: http://stackoverflow.com/questions/1131220/ | -
| = |
- (StrOpt) Runner to use for backups. | -
| = |
- (DictOpt) Additional options to be passed to the backup runner. | -
| = |
- (IntOpt) Maximum size (in bytes) of each segment of the backup file. | -
| = |
- (StrOpt) Swift container to put backups in. | -
| = |
- (BoolOpt) Compress backups using gzip. | -
| = |
- (BoolOpt) Encrypt backups using OpenSSL. | -
| = |
- (BoolOpt) Send backup files over snet. | -
| = |
- (IntOpt) Page size for listing backups. | -
| Configuration option = Default value | -Description | -
|---|---|
| [ssl] | -|
| = |
- (StrOpt) CA certificate file to use to verify connecting clients | -
| = |
- (StrOpt) Certificate file to use when starting the server securely | -
| = |
- (StrOpt) Private key file to use when starting the server securely | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Client to send Cinder calls to. | -
| = |
- (StrOpt) Client to send DNS calls to. | -
| = |
- (StrOpt) Client to send Guest Agent calls to. | -
| = |
- (StrOpt) Client to send Heat calls to. | -
| = |
- (StrOpt) Client to send Neutron calls to. | -
| = |
- (StrOpt) Client to send Nova calls to. | -
| = |
- (StrOpt) Client to send Swift calls to. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Maximum time (in seconds) to wait for a cluster delete. | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a cluster to become active. | -
| = |
- (IntOpt) Page size for listing clusters. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Page size for listing configurations. | -
| = |
- (IntOpt) Page size for listing databases. | -
| = |
- (StrOpt) The default datastore id or name to use if one is not provided by the user. If the default value is None, the field becomes required in the instance create request. | -
| = |
- (ListOpt) List of IDs for management networks which should be attached to the instance regardless of what NICs are specified in the create API call. | -
| = |
- (IntOpt) Character length of generated passwords. | -
| = |
- (IntOpt) Size of executor thread pool. | -
| = |
- (ListOpt) Filetype endings not to be reattached to an ID by the utils method correct_id_with_req. | -
| = |
- (StrOpt) Host to listen for RPC messages. | -
| = |
- (ListOpt) Memcached servers or None for in process cache. | -
| = |
- (StrOpt) Directory where the Trove python module is installed. | -
| = |
- (StrOpt) Set path to pydevd library, used if pydevd is not found in python sys.path. | -
| = |
- (StrOpt) Message queue name the Taskmanager will listen to. | -
| = |
- (StrOpt) Path which leads to datastore templates. | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a service to become alive. | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a Guest to become active. | -
| [keystone_authtoken] | -|
| = |
- (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) List IP addresses that match this regular expression. | -
| = |
- (StrOpt) Service endpoint type to use when searching catalog. | -
| = |
- (StrOpt) Service type to use when searching catalog. | -
| = |
- (StrOpt) URL without the tenant segment. | -
| = |
- (ListOpt) Permissions to grant to the 'root' user. | -
| = |
- (BoolOpt) Assign the 'root' user GRANT permissions. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Allow insecure logging while executing queries through SQLAlchemy. | -
| [database] | -|
| = |
- (StrOpt) SQL Connection. | -
| = |
- (IntOpt) No help text available for this option. | -
| = |
- (BoolOpt) No help text available for this option. | -
| Configuration option = Default value | -Description | -
|---|---|
| [cassandra] | -|
| = |
- (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. | -
| = |
- (StrOpt) Namespace to load backup strategies from. | -
| = |
- (StrOpt) Default strategy to perform backups. | -
| = |
- (StrOpt) Device path for volume if volume support is enabled. | -
| = |
- (StrOpt) Filesystem path for mounting volumes if volume support is enabled. | -
| = |
- (StrOpt) Default strategy for replication. | -
| = |
- (StrOpt) Namespace to load restore strategies from. | -
| = |
- (StrOpt) Root controller implementation for cassandra. | -
| = |
- (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (BoolOpt) Whether to provision a Cinder volume for datadir. | -
| Configuration option = Default value | -Description | -
|---|---|
| [couchbase] | -|
| = |
- (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. | -
| = |
- (StrOpt) Namespace to load backup strategies from. | -
| = |
- (StrOpt) Default strategy to perform backups. | -
| = |
- (StrOpt) Device path for volume if volume support is enabled. | -
| = |
- (StrOpt) Filesystem path for mounting volumes if volume support is enabled. | -
| = |
- (StrOpt) Default strategy for replication. | -
| = |
- (StrOpt) Namespace to load restore strategies from. | -
| = |
- (StrOpt) Root controller implementation for couchbase. | -
| = |
- (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. | -
| = |
- (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (BoolOpt) Whether to provision a Cinder volume for datadir. | -
| [couchdb] | -|
| = |
- (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. | -
| = |
- (StrOpt) Namespace to load backup strategies from. | -
| = |
- (StrOpt) Default strategy to perform backups. | -
| = |
- (StrOpt) Device path for volume if volume support is enabled. | -
| = |
- (StrOpt) Filesystem path for mounting volumes if volume support is enabled. | -
| = |
- (StrOpt) Default strategy for replication. | -
| = |
- (StrOpt) Namespace to load restore strategies from. | -
| = |
- (StrOpt) Root controller implementation for couchdb. | -
| = |
- (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the "password" field. | -
| = |
- (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (BoolOpt) Whether to provision a Cinder volume for datadir. | -
| Configuration option = Default value | -Description | -
|---|---|
| [db2] | -|
| = |
- (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. | -
| = |
- (StrOpt) Namespace to load backup strategies from. | -
| = |
- (StrOpt) Default strategy to perform backups. | -
| = |
- (StrOpt) Device path for volume if volume support is enabled. | -
| = |
- (ListOpt) No help text available for this option. | -
| = |
- (StrOpt) Filesystem path for mounting volumes if volume support is enabled. | -
| = |
- (StrOpt) Default strategy for replication. | -
| = |
- (StrOpt) Namespace to load restore strategies from. | -
| = |
- (StrOpt) Root controller implementation for db2. | -
| = |
- (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. | -
| = |
- (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (BoolOpt) Whether to provision a Cinder volume for datadir. | -
| Configuration option = Default value | -Description | -
|---|---|
| [mariadb] | -|
| = |
- (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. | -
| = |
- (StrOpt) Namespace to load backup strategies from. | -
| = |
- (StrOpt) Default strategy to perform backups. | -
| = |
- (StrOpt) Device path for volume if volume support is enabled. | -
| = |
- (StrOpt) Filesystem path for mounting volumes if volume support is enabled. | -
| = |
- (StrOpt) Namespace to load replication strategies from. | -
| = |
- (StrOpt) Default strategy for replication. | -
| = |
- (StrOpt) Namespace to load restore strategies from. | -
| = |
- (StrOpt) Root controller implementation for mysql. | -
| = |
- (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. | -
| = |
- (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a Guest to become active. | -
| = |
- (BoolOpt) Whether to provision a Cinder volume for datadir. | -
| Configuration option = Default value | -Description | -
|---|---|
| [mongodb] | -|
| = |
- (IntOpt) Maximum time to wait (in seconds) for a replica set initialization process to complete. | -
| = |
- (StrOpt) Class that implements datastore-specific API logic. | -
| = |
- (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. | -
| = |
- (StrOpt) Namespace to load backup strategies from. | -
| = |
- (StrOpt) Default strategy to perform backups. | -
| = |
- (BoolOpt) Enable clusters to be created and managed. | -
| = |
- (IntOpt) Port for instances running as config servers. | -
| = |
- (StrOpt) Device path for volume if volume support is enabled. | -
| = |
- (StrOpt) Class that implements datastore-specific Guest Agent API logic. | -
| = |
- (ListOpt) Databases to exclude when listing databases. | -
| = |
- (ListOpt) Users to exclude when listing users. | -
| = |
- (IntOpt) Port for mongod and mongos instances. | -
| = |
- (StrOpt) Filesystem path for mounting volumes if volume support is enabled. | -
| = |
- (IntOpt) The number of config servers to create per cluster. | -
| = |
- (IntOpt) The number of query routers (mongos) to create per cluster. | -
| = |
- (StrOpt) Default strategy for replication. | -
| = |
- (StrOpt) Namespace to load restore strategies from. | -
| = |
- (StrOpt) Root controller implementation for mongodb. | -
| = |
- (StrOpt) Class that implements datastore-specific task manager logic. | -
| = |
- (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (BoolOpt) Whether to provision a Cinder volume for datadir. | -
| Configuration option = Default value | -Description | -
|---|---|
| [mysql] | -|
| = |
- (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. | -
| = |
- (StrOpt) Namespace to load backup strategies from. | -
| = |
- (StrOpt) Default strategy to perform backups. | -
| = |
- (StrOpt) Device path for volume if volume support is enabled. | -
| = |
- (StrOpt) Filesystem path for mounting volumes if volume support is enabled. | -
| = |
- (StrOpt) Namespace to load replication strategies from. | -
| = |
- (StrOpt) Default strategy for replication. | -
| = |
- (StrOpt) Namespace to load restore strategies from. | -
| = |
- (StrOpt) Root controller implementation for mysql. | -
| = |
- (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. | -
| = |
- (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a Guest to become active. | -
| = |
- (BoolOpt) Whether to provision a Cinder volume for datadir. | -
| Configuration option = Default value | -Description | -
|---|---|
| [percona] | -|
| = |
- (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. | -
| = |
- (StrOpt) Namespace to load backup strategies from. | -
| = |
- (StrOpt) Default strategy to perform backups. | -
| = |
- (StrOpt) Device path for volume if volume support is enabled. | -
| = |
- (StrOpt) Filesystem path for mounting volumes if volume support is enabled. | -
| = |
- (StrOpt) Namespace to load replication strategies from. | -
| = |
- (StrOpt) Password for replication slave user. | -
| = |
- (StrOpt) Default strategy for replication. | -
| = |
- (StrOpt) Userid for replication slave. | -
| = |
- (StrOpt) Namespace to load restore strategies from. | -
| = |
- (StrOpt) Root controller implementation for percona. | -
| = |
- (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. | -
| = |
- (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a Guest to become active. | -
| = |
- (BoolOpt) Whether to provision a Cinder volume for datadir. | -
| Configuration option = Default value | -Description | -
|---|---|
| [postgresql] | -|
| = |
- (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. | -
| = |
- (StrOpt) Namespace to load backup strategies from. | -
| = |
- (StrOpt) Default strategy to perform backups. | -
| = |
- (StrOpt) No help text available for this option. | -
| = |
- (ListOpt) No help text available for this option. | -
| = |
- (ListOpt) No help text available for this option. | -
| = |
- (StrOpt) Filesystem path for mounting volumes if volume support is enabled. | -
| = |
- (StrOpt) Namespace to load restore strategies from. | -
| = |
- (StrOpt) Root controller implementation for postgresql. | -
| = |
- (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. | -
| = |
- (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (BoolOpt) Whether to provision a Cinder volume for datadir. | -
| Configuration option = Default value | -Description | -
|---|---|
| [pxc] | -|
| = |
- (StrOpt) Class that implements datastore-specific API logic. | -
| = |
- (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. | -
| = |
- (StrOpt) Namespace to load backup strategies from. | -
| = |
- (StrOpt) Default strategy to perform backups. | -
| = |
- (BoolOpt) Enable clusters to be created and managed. | -
| = |
- (StrOpt) Device path for volume if volume support is enabled. | -
| = |
- (StrOpt) Class that implements datastore-specific Guest Agent API logic. | -
| = |
- (ListOpt) Users to exclude when listing users. | -
| = |
- (IntOpt) Minimum number of members in PXC cluster. | -
| = |
- (StrOpt) Filesystem path for mounting volumes if volume support is enabled. | -
| = |
- (StrOpt) Namespace to load replication strategies from. | -
| = |
- (StrOpt) Default strategy for replication. | -
| = |
- (StrOpt) Userid for replication slave. | -
| = |
- (StrOpt) Namespace to load restore strategies from. | -
| = |
- (StrOpt) Root controller implementation for pxc. | -
| = |
- (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. | -
| = |
- (StrOpt) Class that implements datastore-specific task manager logic. | -
| = |
- (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a Guest to become active. | -
| = |
- (BoolOpt) Whether to provision a Cinder volume for datadir. | -
| Configuration option = Default value | -Description | -
|---|---|
| [redis] | -|
| = |
- (StrOpt) Class that implements datastore-specific API logic. | -
| = |
- (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. | -
| = |
- (StrOpt) Namespace to load backup strategies from. | -
| = |
- (StrOpt) Default strategy to perform backups. | -
| = |
- (BoolOpt) Enable clusters to be created and managed. | -
| = |
- (StrOpt) Device path for volume if volume support is enabled. | -
| = |
- (StrOpt) Class that implements datastore-specific Guest Agent API logic. | -
| = |
- (StrOpt) Filesystem path for mounting volumes if volume support is enabled. | -
| = |
- (StrOpt) Namespace to load replication strategies from. | -
| = |
- (StrOpt) Default strategy for replication. | -
| = |
- (StrOpt) Namespace to load restore strategies from. | -
| = |
- (StrOpt) Root controller implementation for redis. | -
| = |
- (StrOpt) Class that implements datastore-specific task manager logic. | -
| = |
- (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (BoolOpt) Whether to provision a Cinder volume for datadir. | -
| Configuration option = Default value | -Description | -
|---|---|
| [vertica] | -|
| = |
- (StrOpt) Class that implements datastore-specific API logic. | -
| = |
- (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. | -
| = |
- (StrOpt) Namespace to load backup strategies from. | -
| = |
- (StrOpt) Default strategy to perform backups. | -
| = |
- (IntOpt) Number of members in Vertica cluster. | -
| = |
- (BoolOpt) Enable clusters to be created and managed. | -
| = |
- (StrOpt) Device path for volume if volume support is enabled. | -
| = |
- (StrOpt) Class that implements datastore-specific Guest Agent API logic. | -
| = |
- (StrOpt) Filesystem path for mounting volumes if volume support is enabled. | -
| = |
- (IntOpt) Size(MB) to be set as readahead_size for data volume | -
| = |
- (StrOpt) Default strategy for replication. | -
| = |
- (StrOpt) Namespace to load restore strategies from. | -
| = |
- (StrOpt) Root controller implementation for Vertica. | -
| = |
- (StrOpt) Class that implements datastore-specific task manager logic. | -
| = |
- (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| = |
- (BoolOpt) Whether to provision a Cinder volume for datadir. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Number of backlog requests to configure the socket with | -
| = |
- (StrOpt) Enable or disable pydev remote debugging. If value is 'auto' tries to connect to remote debugger server, but in case of error continues running with debugging disabled. | -
| = |
- (StrOpt) Pydev debug server host (localhost by default). | -
| = |
- (IntOpt) Pydev debug server port (5678 by default). | -
| [profiler] | -|
| = |
- (BoolOpt) If False fully disable profiling feature. | -
| = |
- (BoolOpt) If False doesn't trace SQL requests. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Tenant ID for DNSaaS. | -
| = |
- (StrOpt) Authentication URL for DNSaaS. | -
| = |
- (StrOpt) Domain ID used for adding DNS entries. | -
| = |
- (StrOpt) Domain name used for adding DNS entries. | -
| = |
- (StrOpt) Driver for DNSaaS. | -
| = |
- (StrOpt) Endpoint URL for DNSaaS. | -
| = |
- (StrOpt) Hostname used for adding DNS entries. | -
| = |
- (StrOpt) Factory for adding DNS entries. | -
| = |
- (StrOpt) Management URL for DNSaaS. | -
| = |
- (StrOpt) Passkey for DNSaaS. | -
| = |
- (StrOpt) Region name for DNSaaS. | -
| = |
- (StrOpt) Service Type for DNSaaS. | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a DNS entry add. | -
| = |
- (IntOpt) Time (in seconds) before a refresh of DNS information occurs. | -
| = |
- (StrOpt) Username for DNSaaS. | -
| = |
- (BoolOpt) Whether Trove should add DNS entries on create (using Designate DNSaaS). | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Maximum time (in seconds) to wait for Guest Agent 'slow' requests (such as restarting the database). | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for Guest Agent 'quick'requests (such as retrieving a list of users or databases). | -
| = |
- (IntOpt) Time (in seconds) after which a guest is considered unreachable | -
| = |
- (IntOpt) Maximum time (in seconds) for the Guest Agent to reply to a heartbeat request. | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for taking a Guest Agent replication snapshot. | -
| = |
- (StrOpt) Path to the Guest Agent config file to be injected during instance creation. | -
| = |
- (StrOpt) ID of the Guest Instance. | -
| = |
- (StrOpt) The guest info filename found in the injected config location. If a full path is specified then it will be used as the path to the guest info file | -
| = |
- (ListOpt) Databases to exclude when listing databases. | -
| = |
- (ListOpt) Users to exclude when listing users. | -
| = |
- (StrOpt) Options to use when mounting a volume. | -
| = |
- (StrOpt) Namespace to load the default storage strategy from. | -
| = |
- (StrOpt) Default strategy to store backups. | -
| = |
- (IntOpt) Time to sleep during the check for an active Guest. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Service endpoint type to use when searching catalog. | -
| = |
- (StrOpt) Service type to use when searching catalog. | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a Heat request to complete. | -
| = |
- (StrOpt) URL without the tenant segment. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). | -
| = |
- (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Enables or disables fatal status of deprecations. | -
| = |
- (StrOpt) Options to use when formatting a volume. | -
| = |
- (StrOpt) The format for an instance that is passed with the log message. | -
| = |
- (StrOpt) The format for an instance UUID that is passed with the log message. | -
| = |
- (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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). | -
| = |
- (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. | -
| = |
- (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. This option is ignored if log_config_append is set. | -
| = |
- (StrOpt) Format string to use for log messages with context. | -
| = |
- (StrOpt) Data to append to log format when level is DEBUG. | -
| = |
- (StrOpt) Format string to use for log messages without context. | -
| = |
- (StrOpt) Prefix each line of exception output with this format. | -
| = |
- (StrOpt) Regular expression to match Trove network labels. | -
| = |
- (BoolOpt) Enables or disables publication of error events. | -
| = |
- (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. | -
| = |
- (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 Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. | -
| = |
- (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. | -
| = |
- (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Describes the actual network manager used for the management of network attributes (security groups, floating IPs, etc.). | -
| = |
- (StrOpt) Service endpoint type to use when searching catalog. | -
| = |
- (StrOpt) Service type to use when searching catalog. | -
| = |
- (StrOpt) URL without the tenant segment. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Admin password used to connect to Nova. | -
| = |
- (StrOpt) Admin tenant ID used to connect to Nova. | -
| = |
- (StrOpt) Admin tenant name used to connect to Nova. | -
| = |
- (StrOpt) Admin username used to connect to Nova. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_qpid] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (IntOpt) Seconds between connection keepalive heartbeats. | -
| = |
- (StrOpt) Qpid broker hostname. | -
| = |
- (ListOpt) Qpid HA cluster host:port pairs. | -
| = |
- (StrOpt) Password for Qpid connection. | -
| = |
- (IntOpt) Qpid broker port. | -
| = |
- (StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| = |
- (IntOpt) The number of prefetched messages held by receiver. | -
| = |
- (StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| = |
- (BoolOpt) Whether to disable the Nagle algorithm. | -
| = |
- (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. | -
| = |
- (StrOpt) Username for Qpid connection. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Default maximum volume size (in GB) for an instance. | -
| = |
- (IntOpt) Default maximum number of backups created by a tenant. | -
| = |
- (IntOpt) Default maximum number of instances per tenant. | -
| = |
- (IntOpt) Default maximum volume capacity (in GB) spanning across all Trove volumes per tenant. | -
| = |
- (StrOpt) Default driver to use for quota checks. | -
| Configuration option = Default value | -Description | -
|---|---|
| [oslo_messaging_rabbit] | -|
| = |
- (BoolOpt) Auto-delete queues in AMQP. | -
| = |
- (BoolOpt) Use durable queues in AMQP. | -
| = |
- (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake | -
| = |
- (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. | -
| = |
- (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL | -
| = |
- (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| = |
- (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). | -
| = |
- (StrOpt) SSL cert file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL key file (valid only if SSL enabled). | -
| = |
- (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. | -
| = |
- (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| = |
- (StrOpt) The RabbitMQ broker address where a single node is used. | -
| = |
- (ListOpt) RabbitMQ HA cluster host:port pairs. | -
| = |
- (StrOpt) The RabbitMQ login method. | -
| = |
- (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| = |
- (StrOpt) The RabbitMQ password. | -
| = |
- (IntOpt) The RabbitMQ broker port where a single node is used. | -
| = |
- (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| = |
- (IntOpt) How frequently to retry connecting with RabbitMQ. | -
| = |
- (BoolOpt) Connect over SSL for RabbitMQ. | -
| = |
- (StrOpt) The RabbitMQ userid. | -
| = |
- (StrOpt) The RabbitMQ virtual host. | -
| = |
- (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 the Mitaka release. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| [matchmaker_redis] | -|
| = |
- (StrOpt) Host to locate redis. | -
| = |
- (StrOpt) Password for Redis server (optional). | -
| = |
- (IntOpt) Use this port to connect to redis host. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (IntOpt) Number of times to check if a volume exists. | -
| = |
- (IntOpt) The interval (in seconds) which periodic tasks are run. | -
| = |
- (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| = |
- (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| = |
- (IntOpt) Size of RPC connection pool. | -
| = |
- (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| = |
- (IntOpt) Seconds to wait for a response from a call. | -
| [oslo_concurrency] | -|
| = |
- (BoolOpt) Enables or disables inter-process locks. | -
| = |
- (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. | -
| [oslo_messaging_amqp] | -|
| = |
- (BoolOpt) Accept clients using either SSL or plain TCP | -
| = |
- (StrOpt) address prefix used when broadcasting to all servers | -
| = |
- (StrOpt) Name for the AMQP container | -
| = |
- (StrOpt) address prefix when sending to any server in group | -
| = |
- (IntOpt) Timeout for inactive connections (in seconds) | -
| = |
- (StrOpt) Password for message broker authentication | -
| = |
- (StrOpt) Path to directory that contains the SASL configuration | -
| = |
- (StrOpt) Name of configuration file (without .conf suffix) | -
| = |
- (StrOpt) Space separated list of acceptable SASL mechanisms | -
| = |
- (StrOpt) address prefix used when sending to a specific server | -
| = |
- (StrOpt) CA certificate PEM file to verify server certificate | -
| = |
- (StrOpt) Identifying certificate PEM file to present to clients | -
| = |
- (StrOpt) Private key PEM file used to sign cert_file certificate | -
| = |
- (StrOpt) Password for decrypting ssl_key_file (if encrypted) | -
| = |
- (BoolOpt) Debug: dump AMQP frames to stdout | -
| = |
- (StrOpt) User name for message broker authentication | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Service endpoint type to use when searching catalog. | -
| = |
- (StrOpt) Service type to use when searching catalog. | -
| = |
- (StrOpt) URL ending in AUTH_. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Path to folder with cloudinit scripts. | -
| = |
- (StrOpt) Manager class in the Guest Agent, set up by the Taskmanager on instance provision. | -
| = |
- (DictOpt) Extension for default datastore managers. Allows the use of custom managers for each of the datastores supported by Trove. | -
| = |
- (IntOpt) Seconds to wait between pushing events. | -
| = |
- (StrOpt) Transformer for exists notifications. | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a server reboot. | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a server resize. | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a Guest instance restored from a backup to become active. | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a server resize revert. | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a server delete. | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a state change. | -
| = |
- (BoolOpt) Set the service and instance task statuses to ERROR when an instance fails to become active within the configured usage_timeout. | -
| = |
- (IntOpt) Time to sleep during the check for an active Guest. | -
| = |
- (BoolOpt) Use Heat for provisioning. | -
| = |
- (BoolOpt) Use config drive for file injection when booting instance. | -
| = |
- (BoolOpt) Whether to provision a Cinder volume for the Nova instance. | -
| = |
- (BoolOpt) Enable verification of Swift checksum before starting restore. Makes sure the checksum of original backup matches the checksum of the Swift backup file. | -
| Configuration option = Default value | -Description | -
|---|---|
| [upgrade_levels] | -|
| = |
- (StrOpt) Set a version cap for messages sent to conductor services | -
| = |
- (StrOpt) Set a version cap for messages sent to guestagent services | -
| = |
- (StrOpt) Set a version cap for messages sent to taskmanager services | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (StrOpt) Block device to map onto the created instance. | -
| = |
- (StrOpt) Service endpoint type to use when searching catalog. | -
| = |
- (StrOpt) Service type to use when searching catalog. | -
| = |
- (StrOpt) URL without the tenant segment. | -
| = |
- (StrOpt) Volume type to use when provisioning a Cinder volume. | -
| = |
- (StrOpt) Device path for volume if volume support is enabled. | -
| = |
- (BoolOpt) Whether to provision a Cinder volume for datadir. | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a volume format. | -
| = |
- (StrOpt) File system type used to format a volume. | -
| = |
- (IntOpt) Maximum time (in seconds) to wait for a volume attach. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| = |
- (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| = |
- (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| = |
- (StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| = |
- (IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| = |
- (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. | -
| = |
- (StrOpt) Directory for holding IPC sockets. | -
| = |
- (StrOpt) MatchMaker driver. | -
| = |
- (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| = |
- (BoolOpt) Shows whether zmq-messaging uses broker or not. | -
'+ssd +10.0.0.0 +6nines -production iops.reserve=1000
- capacity.reserve=30%'. This query is satisfied by selecting SSD
- resources, accessible on the 10.0.0.0 network, with high resiliency, for
- non-production workloads, with guaranteed IOPS of 1000 and a storage
- reservation for 30% of the volume capacity specified at create
- time. Queries and parameters are completely administrator defined: they
- reflect the layout, resource, and organizational goals of a specific
- deployment.
- volume_backend_name. In this example, a volume type,
- 'Production', is associated with the volume_backend_name
- 'blockbridge_prod': volume_backend_name must match the value specified in the
- '+openstack'. Within Blockbridge,
- datastore resources that advertise the 'openstack' attribute will be
- selected to fulfill OpenStack provisioning requests. If you prefer a more
- specific query, define a custom pool configuration.
- volume_backend_name and pool configuration for each type. The
-
- ceph-mon daemons on separate
- servers.volume_driver = cinder.volume.drivers.emc.scaleio.ScaleIODriversan_ip = ScaleIO MDM IP sio_protection_domain_name = ScaleIO Protection Domain sio_storage_pool_name = ScaleIO Storage Pool sio_storage_pools = Comma separated list of protection domain:storage pool name san_login = ScaleIO username san_password = ScaleIO password | Feature | -Software Required | -
volume_driver = cinder.volume.drivers.emc.xtremio.XtremIOIscsiDrivervolume_driver = cinder.volume.drivers.emc.xtremio.XtremIOFibreChannelDriversan_ip = XMS Management IP xtremio_cluster_name = Cluster-Namesan_login = XMS username san_password = XMS username password max_over_subscription_ratio parameter.use_cow_images parameter in theuse_cow_images = falseuse_multipath_for_image_xfer parameter in theuse_multipath_for_image_xfer = true| Option | -Type | -Default | -Description | -
|
- |
-
- |
- ||
|
- |
-
- |
- ||
|
- |
-
- |
-
| Option | -Type | -Default | -Description | -
|
- |
- |||
|
- |
- |||
|
- |
- |||
|
- |
- |||
|
- |
- |||
|
- |
-
- |
-
- |
-
- |
-
|
- |
-
- |
- - | -
- |
-
|
- |
-
- |
-
- |
-
- |
-
|
- |
-
- |
-
- |
-
- |
-
| Description (Volume Driver Version) | -Storage System Version | -Volume Driver Version | -
|---|---|---|
|
- |
-
- |
- |
| |
-
- |
- 1.2.0 | -
| Parameter | -Default value | -Description | -Applicable to | -
|---|---|---|---|
|
- |
-
- |
-
- |
- All | -
| - | - | -
- |
- All | -
| - | - | -IP address of the primary controller on an OceanStor T series - V100R005 storage device. | -T series V1 | -
| - | - | -IP address of the secondary controller on an OceanStor T series - V100R005 storage device. | -T series V1 | -
| - | - | -Access address of the REST interface, - https://x.x.x.x/devicemanager/rest/. x.x.x.x indicates the - management IP address. OceanStor 18000 uses the preceding setting, - and V2 and V3 need to add port number 8088, for example, - https://x.x.x.x:8088/deviceManager/rest/. | -T series V2 V3 18000 | -
|
- |
-
- |
-
- |
- All | -
|
- |
-
- |
-
- |
-
- |
-
| - | - | -Name of a storage pool to be used. If you need to configure multiple - storage pools, separate them by semicolons (;). | -
- |
-
| - | - | -Default IP address of the iSCSI target port that is provided for - computing nodes. | -All | -
| - | Linux | -Operating system of the Nova computer node's host. | -All | -
| - | - | -IP address of the Nova computer node's host. | -All | -
| Parameter | -Default value | -Description | -Applicable to | -
|---|---|---|---|
|
- |
-
- |
- Type of the LUNs to be created. The value can be Thick or Thin. | -
- |
-
|
- |
-
- |
-
- |
- T series V1 | -
|
- |
-
- |
-
- |
- All | -
|
- |
-
- |
-
- |
- All | -
| - | 3 | -
- |
- T series V1 | -
| - | 0 | -
- |
-
- |
-
| - | 5 | -After LUN copy is enabled, the plug-in frequently queries the copy - progress. You can set a value to specify the query interval. | -T series V2 V3 18000 | -
| - | 432000 | -Timeout interval for waiting LUN copy of a storage device to - complete. The unit is second. | -T series V2 V3 18000 | -
| - | - | -
- |
-
- |
-
| - | - | -
- |
-
- |
-
| - | - | -
- |
- T series V2 V3 18000 | -
| Parameter | -Default value | -Description | -Applicable to | -
|---|---|---|---|
|
- |
-
- |
-
- |
- All | -
| - | - | -
- |
- All | -
| - | - | -IP address of the primary controller on an OceanStor T series - V100R005 storage device. | -T series V1 | -
| - | - | -IP address of the secondary controller on an OceanStor T series - V100R005 storage device. | -T series V1 | -
| - | - | -Access address of the REST interface, - https://x.x.x.x/devicemanager/rest/. x.x.x.x indicates the - management IP address. OceanStor 18000 uses the preceding setting, - and V2 and V3 need to add port number 8088, for example, - https://x.x.x.x:8088/deviceManager/rest/. | -T series V2 V3 18000 | -
|
- |
-
- |
-
- |
- All | -
|
- |
-
- |
-
- |
-
- |
-
| - | - | -Name of a storage pool to be used. If you need to configure multiple - storage pools, separate them by semicolons (;). | -
- |
-
| - | - | -Default IP address of the iSCSI target port that is provided for - computing nodes. | -All | -
| - | Linux | -Operating system of the Nova computer node's host. | -All | -
| - | - | -IP address of the Nova computer node's host. | -All | -
| Parameter | -Default value | -Description | -Applicable to | -
|---|---|---|---|
|
- |
-
- |
- Type of the LUNs to be created. The value can be Thick or Thin. | -
- |
-
|
- |
-
- |
-
- |
- T series V1 | -
|
- |
-
- |
-
- |
- All | -
|
- |
-
- |
-
- |
- All | -
| - | 3 | -
- |
- T series V1 | -
| - | 0 | -
- |
-
- |
-
| - | 5 | -After LUN copy is enabled, the plug-in frequently queries the copy - progress. You can set a value to specify the query interval. | -T series V2 V3 18000 | -
| - | 432000 | -Timeout interval for waiting LUN copy of a storage device to - complete. The unit is second. | -T series V2 V3 18000 | -
| Flag name | -Type | -Default | -Description | -
|---|---|---|---|
|
- |
-
| Flag name | -Type | -Default | -Description | -
|---|---|---|---|
|
- |
- |||
|
- |
- |||
|
- |
- |||
|
- |
-
| Metadata Item Name | -Description | -
|---|---|
| Specifies whether to create a file system or a swap
- area on the new volume. If
- |
-
- |
| Sets the file system label for
- the file system specified by |
- |
|
- |
- |
|
- |
- |
|
- |
- |
|
- |
- |
|
- |
- |
|
- |
-
| Flag name | -Type | -Default | -Description | -
|---|---|---|---|
| Disk file type | -Extra spec key | -Extra spec value | -
| thin | -vmware:vmdk_type | -thin | -
| lazyZeroedThick | -vmware:vmdk_type | -thick | -
| eagerZeroedThick | -vmware:vmdk_type | -eagerZeroedThick | -
vmdk_type extra spec entry,
- the disk file type will default to lazyZeroedThick VMDK volume by using the
- appropriate vmdk_type:vmware:clone_type extra spec key to
- specify the clone type. The following table captures the
- mapping for clone types:| Clone type | -Extra spec key | -Extra spec value | -
| full | -vmware:clone_type | -full | -
| linked/fast | -vmware:clone_type | -linked | -
scope=stmf - allow_configure=truescope=nas - allow_clone=true, allow_createProject=true, allow_createShare=true, allow_changeSpaceProps=true, allow_changeGeneralProps=true, allow_destroy=true, allow_rollback=true, allow_takeSnap=truezfssa_target_interfaces.
- scope=svc - allow_administer=true, allow_restart=true, allow_configure=truescope=nas - pool=pool_name, project=project_name, share=share_name, allow_clone=true, allow_createProject=true, allow_createShare=true, allow_changeSpaceProps=true, allow_changeGeneralProps=true, allow_destroy=true, allow_rollback=true, allow_takeSnap=true| - Log file - | -- Service/interface (for CentOS, Fedora, openSUSE, Red Hat - Enterprise Linux, and SUSE Linux Enterprise) - | -- Service/interface (for Ubuntu and Debian) - | -
|
- |
-
- |
-
- |
-
|
- |
-
- |
-
- |
-
|
- |
-
- |
-
- |
-
|
- |
-
- |
-
- |
-
[DEFAULT] section. You can override the default values
- by setting values in the other sections.$free_ram_mb$free_disk_mb$total_usable_ram_mb$vcpus_total$vcpus_used| Section | -Option | -Description | -
|---|---|---|
| [DEFAULT] | -By default, the scheduler spreads instances - across all hosts evenly. Set the - - option to a negative number if you prefer - stacking instead of spreading. Use a - floating-point value. | -|
| [DEFAULT] | -New instances are scheduled on a host that is - chosen randomly from a subset of the N best - hosts. This property defines the subset size - from which a host is chosen. A value of 1 - chooses the first host returned by the - weighting functions. This value must be at - least 1. A value less than 1 is ignored, and 1 - is used instead. Use an integer value. | -|
| [DEFAULT] | -Defaults to
- |
- |
| [DEFAULT] | -Multiplier used for weighing host I/O operations. A negative - value means a preference to choose light workload - compute hosts. | -|
| [metrics] | -Multiplier for weighting meters. Use a - floating-point value. | -|
| [metrics] | -Determines how meters are weighted. Use a
- comma-separated list of metricName=ratio. For
- example: "name1=1.0, name2=-1.0" results in:
- |
- |
| [metrics] | -||
| [metrics] | -If is set to False, - and any one of the meters set by - is - unavailable, the - - value is returned to the scheduler. | -
| Section | -Option | -Description | -
|---|---|---|
| [cells] | -Multiplier to weight mute children (hosts which - have not sent capacity or capacity updates for - some time). Use a negative, floating-point - value. | -|
| [cells] | -Multiplier to weight cells, so you can specify - a preferred cell. Use a floating point - value. | -|
| [cells] | -By default, the scheduler spreads instances - across all cells evenly. Set the - - option to a negative number if you prefer - stacking instead of spreading. Use a - floating-point value. | -|
| [cells] | -Defaults to
- |
-
| All Privileges | -- | - | - |
| - | Datastore | -- | - |
| - | - | Allocate space | -- |
| - | - | Browse datastore | -- |
| - | - | Low level file operation | -- |
| - | - | Remove file | -- |
| - | Extension | -- | - |
| - | - | Register extension | -- |
| - | Folder | -- | - |
| - | - | Create folder | -- |
| - | Host | -- | - |
| - | - | Configuration | -- |
| - | - | - | Maintenance | -
| - | - | - | Network configuration | -
| - | - | - | Storage partition configuration | -
| - | Network | -- | - |
| - | - | Assign network | -- |
| - | Resource | -- | - |
| - | - | Assign virtual machine to resource pool | -- |
| - | - | Migrate powered off virtual machine | -- |
| - | - | Migrate powered on virtual machine | -- |
| - | Virtual Machine | -- | - |
| - | - | Configuration | -- |
| - | - | - | Add existing disk | -
| - | - | - | Add new disk | -
| - | - | - | Add or remove device | -
| - | - | - | Advanced | -
| - | - | - | CPU count | -
| - | - | - | Disk change tracking | -
| - | - | - | Host USB device | -
| - | - | - | Memory | -
| - | - | - | Raw device | -
| - | - | - | Remove disk | -
| - | - | - | Rename | -
| - | - | - | Swapfile placement | -
| - | - | Interaction | -- |
| - | - | - | Configure CD media | -
| - | - | - | Power Off | -
| - | - | - | Power On | -
| - | - | - | Reset | -
| - | - | - | Suspend | -
| - | - | Inventory | -- |
| - | - | - | Create from existing | -
| - | - | - | Create new | -
| - | - | - | Move | -
| - | - | - | Remove | -
| - | - | - | Unregister | -
| - | - | Provisioning | -- |
| - | - | - | Clone virtual machine | -
| - | - | - | Customize | -
| - | - | Sessions | -- |
| - | - | - | Validate session | -
| - | - | - | View and stop sessions | -
| - | - | Snapshot management | -- |
| - | - | - | Create snapshot | -
| - | - | - | Remove snapshot | -
| - | vApp | -- | - |
| - | - | Export | -- |
| - | - | Import | -- |
wsdl_location=http://127.0.0.1:8080/vmware/SDK/wsdl/vim25/vimService.wsdl
- setting to the above configuration. For more
- information, see
- vSphere 5.0 and
- earlier additional set up.qemu-img
- utility.| vmware_disktype property | -VMDK disk type | -
|---|---|
| sparse | -
- |
-
| thin | -
- |
-
| preallocated (default) | -
- |
-
qemu-img utility, disk images in
- several formats (such as, qcow2) can be converted to the VMDK
- format.qemu-img are
- qemu-img conversion, the command to upload the
- VMDK disk should be something like:vmware_adaptertype is set to qemu-img
- utility, the vmware_disktype and
- vmware_adaptertype might be different. To
- determine the image adapter type from an image file, use the
- following command and look for the
- line:vmware-vdiskmanager is a utility that
- comes bundled with VMware Fusion and VMware Workstation.
- The following example converts a sparse disk to
- preallocated format:vmware_linked_clone property in the OpenStack
- Image service to
- override the linked_clone mode on a per-image basis.vmware_linked_clone property
- for the image is just ignored.wsdl_location option. For more
- information, see
- VMwareVCDriver
- configuration options above.VMWAREAPI_IP shell variable to the
- IP address for your vCenter or ESXi host from where you plan
- to mirror files. For example:| - Log file - | -- Service name (CentOS/Fedora/openSUSE/Red Hat Enterprise - Linux/SUSE Linux Enterprise) - | -- Service name (Ubuntu/Debian) - | -
|
- |
- - openstack-nova-api - | -- nova-api - | -
|
- |
-
- |
-
- |
-
|
- |
-
- |
-
- |
-
|
- |
-
- |
-
- |
-
|
- |
-
- |
-
- |
-
|
- |
-
- |
-
- |
-
|
- |
-
- |
-
- |
-
|
- |
-
- |
-
- |
-
| Option = default value | -(Type) Help string | -
| [DEFAULT] batch_polled_samples = True | -(BoolOpt) To reduce polling agent load, samples are sent to the notification agent in a batch. To gain higher throughput at the cost of load set this to False. | -
| [DEFAULT] ceilometer_control_exchange = ceilometer | -(StrOpt) Exchange name for ceilometer notifications. | -
| [DEFAULT] dns_control_exchange = central | -(StrOpt) Exchange name for DNS notifications. | -
| [DEFAULT] executor_thread_pool_size = 64 | -(IntOpt) Size of executor thread pool. | -
| [DEFAULT] magnum_control_exchange = magnum | -(StrOpt) Exchange name for Magnum notifications. | -
| [DEFAULT] password = | -(StrOpt) Password for Redis server (optional). | -
| [DEFAULT] pipeline_polling_interval = 20 | -(IntOpt) Polling interval for pipeline file configuration in seconds. | -
| [DEFAULT] port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| [DEFAULT] refresh_event_pipeline_cfg = False | -(BoolOpt) Refresh Event Pipeline configuration on-the-fly. | -
| [DEFAULT] refresh_pipeline_cfg = False | -(BoolOpt) Refresh Pipeline configuration on-the-fly. | -
| [DEFAULT] rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| [DEFAULT] rpc_poll_timeout = 1 | -(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| [DEFAULT] rpc_zmq_all_req_rep = True | -(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| [DEFAULT] rpc_zmq_concurrency = eventlet | -(StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| [DEFAULT] watch_log_file = False | -(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| [DEFAULT] zmq_use_broker = True | -(BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| [alarm] alarm_max_actions = -1 | -(IntOpt) Maximum count of actions for each state of an alarm, non-positive number means no limit. | -
| [api] aodh_is_enabled = None | -(BoolOpt) Set True to redirect alarms URLs to aodh. Default autodetection by querying keystone. | -
| [api] aodh_url = None | -(StrOpt) The endpoint of Aodh to redirect alarms URLs to Aodh API. Default autodetection by querying keystone. | -
| [api] default_api_return_limit = 100 | -(IntOpt) Default maximum number of items returned by API request. | -
| [api] gnocchi_is_enabled = None | -(BoolOpt) Set True to disable resource/meter/sample URLs. Default autodetection by querying keystone. | -
| [api] workers = 1 | -(IntOpt) Number of workers for api, default value is 1. | -
| [collector] enable_rpc = False | -(BoolOpt) Enable the RPC functionality of collector. This functionality is now deprecated in favour of notifier publisher and queues. | -
| [collector] workers = 1 | -(IntOpt) Number of workers for collector service. default value is 1. | -
| [cors] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors.subdomain] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors.subdomain] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors.subdomain] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors.subdomain] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors.subdomain] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [database] alarm_history_time_to_live = -1 | -(IntOpt) Number of seconds that alarm histories are kept in the database for (<= 0 means forever). | -
| [dispatcher_gnocchi] archive_policy = low | -(StrOpt) The archive policy to use when the dispatcher create a new metric. | -
| [dispatcher_gnocchi] archive_policy_file = gnocchi_archive_policy_map.yaml | -(StrOpt) The Yaml file that defines per metric archive policies. | -
| [dispatcher_gnocchi] filter_project = gnocchi | -(StrOpt) Gnocchi project used to filter out samples generated by Gnocchi service activity | -
| [dispatcher_gnocchi] filter_service_activity = True | -(BoolOpt) Filter out samples generated by Gnocchi service activity | -
| [dispatcher_gnocchi] resources_definition_file = gnocchi_resources.yaml | -(StrOpt) The Yaml file that defines mapping between samples and gnocchi resources/metrics | -
| [dispatcher_gnocchi] url = http://localhost:8041 | -(StrOpt) URL to Gnocchi. | -
| [hardware] meter_definitions_file = snmp.yaml | -(StrOpt) Configuration file for defining hardware snmp meters. | -
| [keystone_authtoken] region_name = None | -(StrOpt) The region in which the identity server can be found. | -
| [meter] meter_definitions_cfg_file = meters.yaml | -(StrOpt) Configuration file for defining meter notifications. | -
| [notification] pipeline_processing_queues = 10 | -(IntOpt) Number of queues to parallelize workload across. This value should be larger than the number of active notification agents for optimal results. | -
| [notification] workers = 1 | -(IntOpt) Number of workers for notification service, default value is 1. | -
| [oslo_messaging_amqp] password = | -(StrOpt) Password for message broker authentication | -
| [oslo_messaging_amqp] sasl_config_dir = | -(StrOpt) Path to directory that contains the SASL configuration | -
| [oslo_messaging_amqp] sasl_config_name = | -(StrOpt) Name of configuration file (without .conf suffix) | -
| [oslo_messaging_amqp] sasl_mechanisms = | -(StrOpt) Space separated list of acceptable SASL mechanisms | -
| [oslo_messaging_amqp] username = | -(StrOpt) User name for message broker authentication | -
| [oslo_messaging_qpid] send_single_reply = 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 the Mitaka release. | -
| [oslo_messaging_rabbit] kombu_reconnect_timeout = 60 | -(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. | -
| [oslo_messaging_rabbit] send_single_reply = 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 the Mitaka release. | -
| [oslo_middleware] secure_proxy_ssl_header = 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. | -
| [vmware] ca_file = None | -(StrOpt) CA bundle file to use in verifying the vCenter server certificate. | -
| [vmware] insecure = 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 "ca_file" is set. | -
| Option | -Previous default value | -New default value | -
| [DEFAULT] default_log_levels | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN | -
| [DEFAULT] logging_exception_prefix | -%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s | -
| [DEFAULT] rpc_zmq_matchmaker | -local | -redis | -
| [DEFAULT] use_syslog_rfc_format | -False | -True | -
| [DEFAULT] verbose | -False | -True | -
| [matchmaker_redis] password | -None | -- |
| [notification] disable_non_metric_meters | -False | -True | -
| [oslo_messaging_rabbit] heartbeat_timeout_threshold | -0 | -60 | -
| Deprecated option | -New Option | -
| [DEFAULT] api_workers | -[api] workers | -
| [DEFAULT] notification_workers | -[notification] workers | -
| [DEFAULT] database_connection | -None | -
| [DEFAULT] collector_workers | -[collector] workers | -
| [DEFAULT] rpc_thread_pool_size | -[DEFAULT] executor_thread_pool_size | -
| [DEFAULT] log_format | -None | -
| [DEFAULT] use_syslog | -None | -
| Option = default value | -(Type) Help string | -
| [DEFAULT] allow_availability_zone_fallback = False | -(BoolOpt) If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing. | -
| [DEFAULT] backup_posix_path = $state_path/backup | -(StrOpt) Path specifying where to store backups. | -
| [DEFAULT] backup_service_inithost_offload = False | -(BoolOpt) Offload pending backup delete during backup service startup. | -
| [DEFAULT] backup_swift_ca_cert_file = None | -(StrOpt) Location of the CA certificate file to use for swift client requests. | -
| [DEFAULT] blockbridge_api_host = None | -(StrOpt) IP address/hostname of Blockbridge API. | -
| [DEFAULT] blockbridge_api_port = None | -(IntOpt) Override HTTPS port to connect to Blockbridge API server. | -
| [DEFAULT] blockbridge_auth_password = None | -(StrOpt) Blockbridge API password (for auth scheme 'password') | -
| [DEFAULT] blockbridge_auth_scheme = token | -(StrOpt) Blockbridge API authentication scheme (token or password) | -
| [DEFAULT] blockbridge_auth_token = None | -(StrOpt) Blockbridge API token (for auth scheme 'token') | -
| [DEFAULT] blockbridge_auth_user = None | -(StrOpt) Blockbridge API user (for auth scheme 'password') | -
| [DEFAULT] blockbridge_default_pool = None | -(StrOpt) Default pool name if unspecified. | -
| [DEFAULT] blockbridge_pools = {'OpenStack': '+openstack'} | -(DictOpt) Defines the set of exposed pools and their associated backend query strings | -
| [DEFAULT] cb_auth_group = 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. | -
| [DEFAULT] cb_confirm_volume_delete_retries = 3 | -(IntOpt) Will confirm a successful volume deletion in CloudByte storage by making this many number of attempts. | -
| [DEFAULT] cb_confirm_volume_delete_retry_interval = 5 | -(IntOpt) A retry value in seconds. Will be used by the driver to check if volume deletion was successful in CloudByte storage. | -
| [DEFAULT] cinder_internal_tenant_project_id = None | -(StrOpt) ID of the project which will be used as the Cinder internal tenant. | -
| [DEFAULT] cinder_internal_tenant_user_id = None | -(StrOpt) ID of the user to be used in volume operations as the Cinder internal tenant. | -
| [DEFAULT] dell_sc_verify_cert = False | -(BoolOpt) Enable HTTPS SC certificate verification. | -
| [DEFAULT] dothill_api_protocol = https | -(StrOpt) DotHill API interface protocol. | -
| [DEFAULT] dothill_backend_name = A | -(StrOpt) Pool or Vdisk name to use for volume creation. | -
| [DEFAULT] dothill_backend_type = virtual | -(StrOpt) linear (for Vdisk) or virtual (for Pool). | -
| [DEFAULT] dothill_iscsi_ips = | -(ListOpt) List of comma-separated target iSCSI IP addresses. | -
| [DEFAULT] dothill_verify_certificate = False | -(BoolOpt) Whether to verify DotHill array SSL certificate. | -
| [DEFAULT] dothill_verify_certificate_path = None | -(StrOpt) DotHill array SSL certificate path. | -
| [DEFAULT] drbdmanage_redundancy = 1 | -(StrOpt) Number of nodes that should replicate the data. | -
| [DEFAULT] driver_ssl_cert_verify = False | -(BoolOpt) If set to True the http client will validate the SSL certificate of the backend endpoint. | -
| [DEFAULT] enable_force_upload = False | -(BoolOpt) Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it. | -
| [DEFAULT] executor_thread_pool_size = 64 | -(IntOpt) Size of executor thread pool. | -
| [DEFAULT] flashsystem_iscsi_portid = 0 | -(IntOpt) Default iSCSI Port ID of FlashSystem. (Default port is 0.) | -
| [DEFAULT] glusterfs_backup_mount_point = $state_path/backup_mount | -(StrOpt) Base dir containing mount point for gluster share. | -
| [DEFAULT] glusterfs_backup_share = None | -(StrOpt) GlusterFS share in <hostname|ipv4addr|ipv6addr>:<gluster_vol_name> format. Eg: 1.2.3.4:backup_vol | -
| [DEFAULT] hgst_net = Net 1 (IPv4) | -(StrOpt) Space network name to use for data transfer | -
| [DEFAULT] hgst_redundancy = 0 | -(StrOpt) Should spaces be redundantly stored (1/0) | -
| [DEFAULT] hgst_space_group = disk | -(StrOpt) Group to own created spaces | -
| [DEFAULT] hgst_space_mode = 0600 | -(StrOpt) UNIX mode for created spaces | -
| [DEFAULT] hgst_space_user = root | -(StrOpt) User to own created spaces | -
| [DEFAULT] hgst_storage_servers = os:gbd0 | -(StrOpt) Comma separated list of Space storage servers:devices. ex: os1_stor:gbd0,os2_stor:gbd0 | -
| [DEFAULT] hitachi_horcm_resource_lock_timeout = 600 | -(IntOpt) Timeout until a resource lock is released, in seconds. The value must be between 0 and 7200. | -
| [DEFAULT] hpmsa_api_protocol = https | -(StrOpt) HPMSA API interface protocol. | -
| [DEFAULT] hpmsa_backend_name = A | -(StrOpt) Pool or Vdisk name to use for volume creation. | -
| [DEFAULT] hpmsa_backend_type = virtual | -(StrOpt) linear (for Vdisk) or virtual (for Pool). | -
| [DEFAULT] hpmsa_iscsi_ips = | -(ListOpt) List of comma-separated target iSCSI IP addresses. | -
| [DEFAULT] hpmsa_verify_certificate = False | -(BoolOpt) Whether to verify HPMSA array SSL certificate. | -
| [DEFAULT] hpmsa_verify_certificate_path = None | -(StrOpt) HPMSA array SSL certificate path. | -
| [DEFAULT] hpxp_async_copy_check_interval = 10 | -(IntOpt) Interval to check copy asynchronously | -
| [DEFAULT] hpxp_compute_target_ports = None | -(ListOpt) Target port names of compute node for host group or iSCSI target | -
| [DEFAULT] hpxp_copy_check_interval = 3 | -(IntOpt) Interval to check copy | -
| [DEFAULT] hpxp_copy_speed = 3 | -(IntOpt) Copy speed of storage system | -
| [DEFAULT] hpxp_default_copy_method = 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" | -
| [DEFAULT] hpxp_group_request = False | -(BoolOpt) Request for creating host group or iSCSI target | -
| [DEFAULT] hpxp_horcm_add_conf = True | -(BoolOpt) Add to HORCM configuration | -
| [DEFAULT] hpxp_horcm_name_only_discovery = False | -(BoolOpt) Only discover a specific name of host group or iSCSI target | -
| [DEFAULT] hpxp_horcm_numbers = 200, 201 | -(ListOpt) Instance numbers for HORCM | -
| [DEFAULT] hpxp_horcm_resource_name = meta_resource | -(StrOpt) Resource group name of storage system for HORCM | -
| [DEFAULT] hpxp_horcm_user = None | -(StrOpt) Username of storage system for HORCM | -
| [DEFAULT] hpxp_ldev_range = None | -(StrOpt) Logical device range of storage system | -
| [DEFAULT] hpxp_pool = None | -(StrOpt) Pool of storage system | -
| [DEFAULT] hpxp_storage_cli = None | -(StrOpt) Type of storage command line interface | -
| [DEFAULT] hpxp_storage_id = None | -(StrOpt) ID of storage system | -
| [DEFAULT] hpxp_target_ports = None | -(ListOpt) Target port names for host group or iSCSI target | -
| [DEFAULT] hpxp_thin_pool = None | -(StrOpt) Thin pool of storage system | -
| [DEFAULT] hpxp_zoning_request = False | -(BoolOpt) Request for FC Zone creating host group | -
| [DEFAULT] ignore_pool_full_threshold = False | -(BoolOpt) Force LUN creation even if the full threshold of pool is reached. | -
| [DEFAULT] image_upload_use_cinder_backend = False | -(BoolOpt) 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. | -
| [DEFAULT] image_upload_use_internal_tenant = False | -(BoolOpt) 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. | -
| [DEFAULT] image_volume_cache_enabled = False | -(BoolOpt) Enable the image volume cache for this backend. | -
| [DEFAULT] image_volume_cache_max_count = 0 | -(IntOpt) Max number of entries allowed in the image volume cache. 0 => unlimited. | -
| [DEFAULT] image_volume_cache_max_size_gb = 0 | -(IntOpt) Max size of the image volume cache for this backend in GB. 0 => unlimited. | -
| [DEFAULT] infortrend_cli_max_retries = 5 | -(IntOpt) Maximum retry time for cli. Default is 5. | -
| [DEFAULT] infortrend_cli_path = /opt/bin/Infortrend/raidcmd_ESDS10.jar | -(StrOpt) The Infortrend CLI absolute path. By default, it is at /opt/bin/Infortrend/raidcmd_ESDS10.jar | -
| [DEFAULT] infortrend_cli_timeout = 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. | -
| [DEFAULT] infortrend_pools_name = | -(StrOpt) Infortrend raid pool name list. It is separated with comma. | -
| [DEFAULT] infortrend_provisioning = full | -(StrOpt) Let the volume use specific provisioning. By default, it is the full provisioning. The supported options are full or thin. | -
| [DEFAULT] infortrend_slots_a_channels_id = 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. | -
| [DEFAULT] infortrend_slots_b_channels_id = 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. | -
| [DEFAULT] infortrend_tiering = 0 | -(StrOpt) Let the volume use specific tiering level. By default, it is the level 0. The supported levels are 0,2,3,4. | -
| [DEFAULT] io_port_list = * | -(StrOpt) Comma separated iSCSI or FC ports to be used in Nova or Cinder. | -
| [DEFAULT] iscsi_target_flags = | -(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. | -
| [DEFAULT] lenovo_api_protocol = https | -(StrOpt) Lenovo api interface protocol. | -
| [DEFAULT] lenovo_backend_name = A | -(StrOpt) Pool or Vdisk name to use for volume creation. | -
| [DEFAULT] lenovo_backend_type = virtual | -(StrOpt) linear (for VDisk) or virtual (for Pool). | -
| [DEFAULT] lenovo_iscsi_ips = | -(ListOpt) List of comma-separated target iSCSI IP addresses. | -
| [DEFAULT] lenovo_verify_certificate = False | -(BoolOpt) Whether to verify Lenovo array SSL certificate. | -
| [DEFAULT] lenovo_verify_certificate_path = None | -(StrOpt) Lenovo array SSL certificate path. | -
| [DEFAULT] managed_replication_target = True | -(BoolOpt) There are two types of target configurations managed (replicate to another configured backend) or unmanaged (replicate to a device not managed by Cinder). | -
| [DEFAULT] management_ips = | -(StrOpt) List of Management IP addresses (separated by commas) | -
| [DEFAULT] nas_volume_prov_type = thin | -(StrOpt) Provisioning type that will be used when creating volumes. | -
| [DEFAULT] netapp_enable_multiattach = False | -(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. | -
| [DEFAULT] netapp_host_type = 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. | -
| [DEFAULT] netapp_lun_ostype = 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. | -
| [DEFAULT] netapp_lun_space_reservation = enabled | -(StrOpt) 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. | -
| [DEFAULT] netapp_pool_name_search_pattern = (.+) | -(StrOpt) 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. | -
| [DEFAULT] os_privileged_user_auth_url = None | -(StrOpt) Auth URL associated with the OpenStack privileged account. | -
| [DEFAULT] password = | -(StrOpt) Password for Redis server (optional). | -
| [DEFAULT] per_volume_size_limit = -1 | -(IntOpt) Max size allowed per volume, in gigabytes | -
| [DEFAULT] port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| [DEFAULT] query_volume_filters = 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'] | -
| [DEFAULT] rados_connection_interval = 5 | -(IntOpt) Interval value (in seconds) between connection retries to ceph cluster. | -
| [DEFAULT] rados_connection_retries = 3 | -(IntOpt) Number of retries if connection to ceph cluster failed. | -
| [DEFAULT] rbd_cluster_name = ceph | -(StrOpt) The name of ceph cluster | -
| [DEFAULT] replication_devices = None | -(ListOpt) List of k/v pairs representing a replication target for this backend device. For unmanaged the format is: {'key-1'='val1' 'key-2'='val2'...},{...} and for managed devices its simply a list of valid configured backend_names that the driver supports replicating to: backend-a,bakcend-b... | -
| [DEFAULT] rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| [DEFAULT] rpc_poll_timeout = 1 | -(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| [DEFAULT] rpc_zmq_all_req_rep = True | -(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| [DEFAULT] rpc_zmq_concurrency = eventlet | -(StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| [DEFAULT] sf_enable_volume_mapping = True | -(BoolOpt) 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. | -
| [DEFAULT] sheepdog_store_address = 127.0.0.1 | -(StrOpt) IP address of sheep daemon. | -
| [DEFAULT] sheepdog_store_port = 7000 | -(IntOpt) Port of sheep daemon. | -
| [DEFAULT] sio_force_delete = False | -(BoolOpt) Whether to allow force delete. | -
| [DEFAULT] sio_protection_domain_id = None | -(StrOpt) Protection domain id. | -
| [DEFAULT] sio_protection_domain_name = None | -(StrOpt) Protection domain name. | -
| [DEFAULT] sio_rest_server_port = 443 | -(StrOpt) REST server port. | -
| [DEFAULT] sio_round_volume_capacity = True | -(BoolOpt) Whether to round volume capacity. | -
| [DEFAULT] sio_server_certificate_path = None | -(StrOpt) Server certificate path. | -
| [DEFAULT] sio_storage_pool_id = None | -(StrOpt) Storage pool id. | -
| [DEFAULT] sio_storage_pool_name = None | -(StrOpt) Storage pool name. | -
| [DEFAULT] sio_storage_pools = None | -(StrOpt) Storage pools. | -
| [DEFAULT] sio_unmap_volume_before_deletion = False | -(BoolOpt) Whether to unmap volume before deletion. | -
| [DEFAULT] sio_verify_server_certificate = False | -(BoolOpt) Whether to verify server certificate. | -
| [DEFAULT] storage_vnx_pool_names = None | -(StrOpt) Comma-separated list of storage pool names to be used. | -
| [DEFAULT] tintri_api_version = v310 | -(StrOpt) API version for the storage system | -
| [DEFAULT] tintri_server_hostname = None | -(StrOpt) The hostname (or IP address) for the storage system | -
| [DEFAULT] tintri_server_password = None | -(StrOpt) Password for the storage system | -
| [DEFAULT] tintri_server_username = None | -(StrOpt) User name for the storage system | -
| [DEFAULT] trace_flags = 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. | -
| [DEFAULT] violin_request_timeout = 300 | -(IntOpt) Global backend request timeout, in seconds. | -
| [DEFAULT] vmware_ca_file = None | -(StrOpt) CA bundle file to use in verifying the vCenter server certificate. | -
| [DEFAULT] vmware_cluster_name = None | -(MultiStrOpt) Name of a vCenter compute cluster where volumes should be created. | -
| [DEFAULT] vmware_insecure = 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. | -
| [DEFAULT] vzstorage_mount_options = None | -(ListOpt) Mount options passed to the vzstorage client. See section of the pstorage-mount man page for details. | -
| [DEFAULT] vzstorage_mount_point_base = $state_path/mnt | -(StrOpt) Base dir containing mount points for vzstorage shares. | -
| [DEFAULT] vzstorage_shares_config = /etc/cinder/vzstorage_shares | -(StrOpt) File with the list of available vzstorage shares. | -
| [DEFAULT] vzstorage_sparsed_volumes = 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. | -
| [DEFAULT] vzstorage_used_ratio = 0.95 | -(FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. | -
| [DEFAULT] watch_log_file = False | -(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| [DEFAULT] xtremio_array_busy_retry_count = 5 | -(IntOpt) Number of retries in case array is busy | -
| [DEFAULT] xtremio_array_busy_retry_interval = 5 | -(IntOpt) Interval between retries in case array is busy | -
| [DEFAULT] zfssa_cache_directory = os-cinder-cache | -(StrOpt) Name of directory inside zfssa_nfs_share where cache volumes are stored. | -
| [DEFAULT] zfssa_cache_project = os-cinder-cache | -(StrOpt) Name of ZFSSA project where cache volumes are stored. | -
| [DEFAULT] zfssa_enable_local_cache = True | -(BoolOpt) Flag to enable local caching: True, False. | -
| [DEFAULT] zfssa_initiator = | -(StrOpt) iSCSI initiator IQNs. (comma separated) | -
| [DEFAULT] zfssa_initiator_config = | -(StrOpt) iSCSI initiators configuration. | -
| [DEFAULT] zfssa_initiator_group = | -(StrOpt) iSCSI initiator group. | -
| [DEFAULT] zfssa_initiator_password = | -(StrOpt) Secret of the iSCSI initiator CHAP user. | -
| [DEFAULT] zfssa_initiator_user = | -(StrOpt) iSCSI initiator CHAP user (name). | -
| [DEFAULT] zfssa_lun_compression = off | -(StrOpt) Data compression. | -
| [DEFAULT] zfssa_lun_logbias = latency | -(StrOpt) Synchronous write bias. | -
| [DEFAULT] zfssa_lun_sparse = False | -(BoolOpt) Flag to enable sparse (thin-provisioned): True, False. | -
| [DEFAULT] zfssa_lun_volblocksize = 8k | -(StrOpt) Block size. | -
| [DEFAULT] zfssa_pool = None | -(StrOpt) Storage pool name. | -
| [DEFAULT] zfssa_project = None | -(StrOpt) Project name. | -
| [DEFAULT] zfssa_replication_ip = | -(StrOpt) IP address used for replication data. (maybe the same as data ip) | -
| [DEFAULT] zfssa_target_group = tgt-grp | -(StrOpt) iSCSI target group name. | -
| [DEFAULT] zfssa_target_interfaces = None | -(StrOpt) Network interfaces of iSCSI targets. (comma separated) | -
| [DEFAULT] zfssa_target_password = | -(StrOpt) Secret of the iSCSI target CHAP user. | -
| [DEFAULT] zfssa_target_portal = None | -(StrOpt) iSCSI target portal (Data-IP:Port, w.x.y.z:3260). | -
| [DEFAULT] zfssa_target_user = | -(StrOpt) iSCSI target CHAP user (name). | -
| [DEFAULT] zmq_use_broker = True | -(BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| [cors] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors.subdomain] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors.subdomain] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors.subdomain] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors.subdomain] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors.subdomain] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [keystone_authtoken] region_name = None | -(StrOpt) The region in which the identity server can be found. | -
| [oslo_messaging_amqp] password = | -(StrOpt) Password for message broker authentication | -
| [oslo_messaging_amqp] sasl_config_dir = | -(StrOpt) Path to directory that contains the SASL configuration | -
| [oslo_messaging_amqp] sasl_config_name = | -(StrOpt) Name of configuration file (without .conf suffix) | -
| [oslo_messaging_amqp] sasl_mechanisms = | -(StrOpt) Space separated list of acceptable SASL mechanisms | -
| [oslo_messaging_amqp] username = | -(StrOpt) User name for message broker authentication | -
| [oslo_messaging_qpid] send_single_reply = 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 the Mitaka release. | -
| [oslo_messaging_rabbit] kombu_reconnect_timeout = 60 | -(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. | -
| [oslo_messaging_rabbit] send_single_reply = 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 the Mitaka release. | -
| [oslo_middleware] secure_proxy_ssl_header = 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] policy_default_rule = default | -(StrOpt) Default rule. Enforced when a requested rule is not found. | -
| [oslo_policy] policy_dirs = ['policy.d'] | -(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. | -
| [oslo_policy] policy_file = policy.json | -(StrOpt) The JSON file that defines policies. | -
| [oslo_versionedobjects] fatal_exception_format_errors = False | -(BoolOpt) Make exception message format errors fatal | -
| Option | -Previous default value | -New default value | -
| [DEFAULT] auth_strategy | -noauth | -keystone | -
| [DEFAULT] default_log_levels | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN | -
| [DEFAULT] logging_exception_prefix | -%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s | -
| [DEFAULT] rpc_zmq_matchmaker | -local | -redis | -
| [DEFAULT] storwize_svc_npiv_compatibility_mode | -False | -True | -
| [DEFAULT] use_syslog_rfc_format | -False | -True | -
| [DEFAULT] verbose | -False | -True | -
| [DEFAULT] vmware_volume_folder | -cinder-volumes | -Volumes | -
| [DEFAULT] volume_driver | -cinder.volume.drivers.lvm.LVMISCSIDriver | -cinder.volume.drivers.lvm.LVMVolumeDriver | -
| [matchmaker_redis] password | -None | -- |
| [oslo_messaging_rabbit] heartbeat_timeout_threshold | -0 | -60 | -
| Deprecated option | -New Option | -
| [DEFAULT] use_syslog | -None | -
| [DEFAULT] osapi_max_request_body_size | -[oslo_middleware] max_request_body_size | -
| [DEFAULT] eqlx_chap_password | -[DEFAULT] chap_password | -
| [DEFAULT] datera_api_token | -None | -
| [DEFAULT] glusterfs_sparsed_volumes | -[DEFAULT] nas_volume_prov_type | -
| [DEFAULT] glusterfs_qcow2_volumes | -[DEFAULT] nas_volume_prov_type | -
| [DEFAULT] eqlx_use_chap | -[DEFAULT] use_chap_auth | -
| [DEFAULT] rpc_thread_pool_size | -[DEFAULT] executor_thread_pool_size | -
| [DEFAULT] enable_v1_api | -None | -
| [DEFAULT] netapp_volume_list | -[DEFAULT] netapp_pool_name_search_pattern | -
| [DEFAULT] netapp_storage_pools | -[DEFAULT] netapp_pool_name_search_pattern | -
| [DEFAULT] host | -[DEFAULT] backend_host | -
| [DEFAULT] netapp_eseries_host_type | -[DEFAULT] netapp_host_type | -
| [DEFAULT] eqlx_chap_login | -[DEFAULT] chap_username | -
| [DEFAULT] log_format | -None | -
| [DEFAULT] storage_vnx_pool_name | -[DEFAULT] storage_vnx_pool_names | -
| Option = default value | -(Type) Help string | -
| [DEFAULT] enable_v3_api = False | -(BoolOpt) Deploy the v3 OpenStack Objects API. | -
| [DEFAULT] executor_thread_pool_size = 64 | -(IntOpt) Size of executor thread pool. | -
| [DEFAULT] max_request_id_length = 64 | -(IntOpt) Limits request ID length. | -
| [DEFAULT] password = | -(StrOpt) Password for Redis server (optional). | -
| [DEFAULT] port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| [DEFAULT] rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| [DEFAULT] rpc_poll_timeout = 1 | -(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| [DEFAULT] rpc_zmq_all_req_rep = True | -(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| [DEFAULT] rpc_zmq_concurrency = eventlet | -(StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| [DEFAULT] scrub_pool_size = 1 | -(IntOpt) The size of thread pool to be used for scrubbing images. The default is one, which signifies serial scrubbing. Any value above one indicates the max number of images that may be scrubbed in parallel. | -
| [DEFAULT] watch_log_file = False | -(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| [DEFAULT] zmq_use_broker = True | -(BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| [cors] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors.subdomain] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors.subdomain] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors.subdomain] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors.subdomain] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors.subdomain] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [glance_store] rados_connect_timeout = 0 | -(IntOpt) Timeout value (in seconds) used when connecting to ceph cluster. If value <= 0, no timeout is set and default librados value is used. | -
| [glance_store] s3_store_enable_proxy = False | -(BoolOpt) Enable the use of a proxy. | -
| [glance_store] s3_store_proxy_host = None | -(StrOpt) Address or hostname for the proxy server. | -
| [glance_store] s3_store_proxy_password = None | -(StrOpt) The password to use when connecting over a proxy. | -
| [glance_store] s3_store_proxy_port = 8080 | -(IntOpt) The port to use when connecting over a proxy. | -
| [glance_store] s3_store_proxy_user = None | -(StrOpt) The username to connect to the proxy. | -
| [keystone_authtoken] region_name = None | -(StrOpt) The region in which the identity server can be found. | -
| [oslo_messaging_amqp] password = | -(StrOpt) Password for message broker authentication | -
| [oslo_messaging_amqp] sasl_config_dir = | -(StrOpt) Path to directory that contains the SASL configuration | -
| [oslo_messaging_amqp] sasl_config_name = | -(StrOpt) Name of configuration file (without .conf suffix) | -
| [oslo_messaging_amqp] sasl_mechanisms = | -(StrOpt) Space separated list of acceptable SASL mechanisms | -
| [oslo_messaging_amqp] username = | -(StrOpt) User name for message broker authentication | -
| [oslo_messaging_qpid] send_single_reply = 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 the Mitaka release. | -
| [oslo_messaging_rabbit] kombu_reconnect_timeout = 60 | -(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. | -
| [oslo_messaging_rabbit] send_single_reply = 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 the Mitaka release. | -
| [oslo_middleware] max_request_body_size = 114688 | -(IntOpt) The maximum body size for each request, in bytes. | -
| [oslo_middleware] secure_proxy_ssl_header = 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. | -
| Option | -Previous default value | -New default value | -
| [DEFAULT] allowed_rpc_exception_modules | -openstack.common.exception, glance.common.exception, exceptions | -glance.common.exception, exceptions | -
| [DEFAULT] client_socket_timeout | -0 | -900 | -
| [DEFAULT] default_log_levels | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN | -
| [DEFAULT] digest_algorithm | -sha1 | -sha256 | -
| [DEFAULT] host | -localhost | -127.0.0.1 | -
| [DEFAULT] logging_exception_prefix | -%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s | -
| [DEFAULT] rpc_zmq_matchmaker | -local | -redis | -
| [DEFAULT] use_syslog_rfc_format | -False | -True | -
| [DEFAULT] verbose | -False | -True | -
| [matchmaker_redis] password | -None | -- |
| [oslo_messaging_rabbit] heartbeat_timeout_threshold | -0 | -60 | -
| Deprecated option | -New Option | -
| [glance_store] vmware_datacenter_path | -None | -
| [DEFAULT] log_format | -None | -
| [DEFAULT] use_syslog | -None | -
| [DEFAULT] rpc_thread_pool_size | -[DEFAULT] executor_thread_pool_size | -
| [glance_store] vmware_datastore_name | -None | -
| Option = default value | -(Type) Help string | -
| [DEFAULT] encrypt_parameters_and_properties = False | -(BoolOpt) Encrypt template parameters that were marked as hidden and also all the resource properties before storing them in database. | -
| [DEFAULT] executor_thread_pool_size = 64 | -(IntOpt) Size of executor thread pool. | -
| [DEFAULT] hidden_stack_tags = data-processing-cluster | -(ListOpt) Stacks containing these tag names will be hidden. Multiple tags should be given in a comma-delimited list (eg. hidden_stack_tags=hide_me,me_too). | -
| [DEFAULT] password = | -(StrOpt) Password for Redis server (optional). | -
| [DEFAULT] port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| [DEFAULT] rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| [DEFAULT] rpc_poll_timeout = 1 | -(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| [DEFAULT] rpc_zmq_all_req_rep = True | -(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| [DEFAULT] rpc_zmq_concurrency = eventlet | -(StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| [DEFAULT] watch_log_file = False | -(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| [DEFAULT] zmq_use_broker = True | -(BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| [cache] backend = dogpile.cache.null | -(StrOpt) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. | -
| [cache] backend_argument = [] | -(MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: "<argname>:<value>". | -
| [cache] config_prefix = cache.oslo | -(StrOpt) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. | -
| [cache] debug_cache_backend = False | -(BoolOpt) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. | -
| [cache] enabled = False | -(BoolOpt) Global toggle for caching. | -
| [cache] expiration_time = 600 | -(IntOpt) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. | -
| [cache] memcache_dead_retry = 300 | -(IntOpt) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). | -
| [cache] memcache_pool_connection_get_timeout = 10 | -(IntOpt) Number of seconds that an operation will wait to get a memcache client connection. | -
| [cache] memcache_pool_maxsize = 10 | -(IntOpt) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). | -
| [cache] memcache_pool_unused_timeout = 60 | -(IntOpt) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). | -
| [cache] memcache_servers = localhost:11211 | -(ListOpt) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). | -
| [cache] memcache_socket_timeout = 3 | -(IntOpt) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). | -
| [cache] proxies = | -(ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. | -
| [clients_keystone] auth_uri = | -(StrOpt) Unversioned keystone url in format like http://0.0.0.0:5000. | -
| [constraint_validation_cache] caching = True | -(BoolOpt) Toggle to enable/disable caching when Orchestration Engine validates property constraints of stack.During property validation with constraints Orchestration Engine caches requests to other OpenStack services. Please note that the global toggle for oslo.cache(enabled=True in [cache] group) must be enabled to use this feature. | -
| [constraint_validation_cache] expiration_time = 60 | -(IntOpt) TTL, in seconds, for any cached item in the dogpile.cache region used for caching of validation constraints. | -
| [cors] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors.subdomain] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors.subdomain] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors.subdomain] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors.subdomain] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors.subdomain] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [heat_api] tcp_keepidle = 600 | -(IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. | -
| [heat_api_cfn] tcp_keepidle = 600 | -(IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. | -
| [heat_api_cloudwatch] tcp_keepidle = 600 | -(IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. | -
| [keystone_authtoken] region_name = None | -(StrOpt) The region in which the identity server can be found. | -
| [oslo_messaging_amqp] password = | -(StrOpt) Password for message broker authentication | -
| [oslo_messaging_amqp] sasl_config_dir = | -(StrOpt) Path to directory that contains the SASL configuration | -
| [oslo_messaging_amqp] sasl_config_name = | -(StrOpt) Name of configuration file (without .conf suffix) | -
| [oslo_messaging_amqp] sasl_mechanisms = | -(StrOpt) Space separated list of acceptable SASL mechanisms | -
| [oslo_messaging_amqp] username = | -(StrOpt) User name for message broker authentication | -
| [oslo_messaging_qpid] send_single_reply = 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 the Mitaka release. | -
| [oslo_messaging_rabbit] kombu_reconnect_timeout = 60 | -(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. | -
| [oslo_messaging_rabbit] send_single_reply = 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 the Mitaka release. | -
| [oslo_middleware] secure_proxy_ssl_header = 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] policy_default_rule = default | -(StrOpt) Default rule. Enforced when a requested rule is not found. | -
| [oslo_policy] policy_dirs = ['policy.d'] | -(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. | -
| [oslo_policy] policy_file = policy.json | -(StrOpt) The JSON file that defines policies. | -
| [oslo_versionedobjects] fatal_exception_format_errors = False | -(BoolOpt) Make exception message format errors fatal | -
| [trustee] auth_plugin = None | -(StrOpt) Name of the plugin to load | -
| [trustee] auth_section = None | -(StrOpt) Config Section from which to load plugin specific options | -
| Option | -Previous default value | -New default value | -
| [DEFAULT] default_log_levels | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN | -
| [DEFAULT] enable_cloud_watch_lite | -True | -False | -
| [DEFAULT] heat_waitcondition_server_url | -- | None | -
| [DEFAULT] logging_exception_prefix | -%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s | -
| [DEFAULT] rpc_zmq_matchmaker | -local | -redis | -
| [DEFAULT] use_syslog_rfc_format | -False | -True | -
| [DEFAULT] verbose | -False | -True | -
| [heat_api] workers | -0 | -8 | -
| [matchmaker_redis] password | -None | -- |
| [oslo_messaging_rabbit] heartbeat_timeout_threshold | -0 | -60 | -
| Deprecated option | -New Option | -
| [DEFAULT] rpc_thread_pool_size | -[DEFAULT] executor_thread_pool_size | -
| [DEFAULT] log_format | -None | -
| [DEFAULT] use_syslog | -None | -
| Option = default value | -(Type) Help string | -
| [DEFAULT] executor_thread_pool_size = 64 | -(IntOpt) Size of executor thread pool. | -
| [DEFAULT] password = | -(StrOpt) Password for Redis server (optional). | -
| [DEFAULT] port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| [DEFAULT] rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| [DEFAULT] rpc_poll_timeout = 1 | -(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| [DEFAULT] rpc_zmq_all_req_rep = True | -(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| [DEFAULT] rpc_zmq_concurrency = eventlet | -(StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| [DEFAULT] watch_log_file = False | -(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| [DEFAULT] zmq_use_broker = True | -(BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| [agent] manage_agent_boot = True | -(BoolOpt) Whether Ironic will manage booting of the agent ramdisk. If set to False, you will need to configure your mechanism to allow booting the agent ramdisk. | -
| [agent] memory_consumed_by_agent = 0 | -(IntOpt) The memory size in MiB consumed by agent when it is booted on a bare metal node. This is used for checking if the image can be downloaded and deployed on the bare metal node after booting agent ramdisk. This may be set according to the memory consumed by the agent ramdisk image. | -
| [agent] post_deploy_get_power_state_retries = 6 | -(IntOpt) Number of times to retry getting power state to check if bare metal node has been powered off after a soft power off. | -
| [agent] post_deploy_get_power_state_retry_interval = 5 | -(IntOpt) Amount of time (in seconds) to wait between polling power state after trigger soft poweroff. | -
| [api] public_endpoint = None | -(StrOpt) Public URL to use when building the links to the API resources (for example, "https://ironic.rocks:6384"). If None the links will be built using the request's host URL. If the API is operating behind a proxy, you will want to change this to represent the proxy's URL. Defaults to None. | -
| [cimc] action_interval = 10 | -(IntOpt) Amount of time in seconds to wait in between power operations | -
| [cimc] max_retry = 6 | -(IntOpt) Number of times a power operation needs to be retried | -
| [cisco_ucs] action_interval = 5 | -(IntOpt) Amount of time in seconds to wait in between power operations | -
| [cisco_ucs] max_retry = 6 | -(IntOpt) Number of times a power operation needs to be retried | -
| [conductor] clean_callback_timeout = 1800 | -(IntOpt) Timeout (seconds) to wait for a callback from the ramdisk doing the cleaning. If the timeout is reached the node will be put in the "clean failed" provision state. Set to 0 to disable timeout. | -
| [cors] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors.subdomain] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors.subdomain] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors.subdomain] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors.subdomain] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors.subdomain] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [deploy] erase_devices_iterations = 1 | -(IntOpt) Number of iterations to be run for erasing devices. | -
| [deploy] erase_devices_priority = None | -(IntOpt) Priority to run in-band erase devices via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 10 for the GenericHardwareManager). If set to 0, will not run during cleaning. | -
| [deploy] http_root = /httpboot | -(StrOpt) ironic-conductor node's HTTP root path. | -
| [deploy] http_url = None | -(StrOpt) ironic-conductor node's HTTP server URL. Example: http://192.1.2.3:8080 | -
| [drac] client_retry_count = 5 | -(IntOpt) In case there is a communication failure, the DRAC client is going to resend the request as many times as defined in this setting. | -
| [drac] client_retry_delay = 5 | -(IntOpt) In case there is a communication failure, the DRAC client is going to wait for as many seconds as defined in this setting before resending the request. | -
| [iboot] max_retry = 3 | -(IntOpt) Maximum retries for iBoot operations | -
| [iboot] retry_interval = 1 | -(IntOpt) Time between retry attempts for iBoot operations | -
| [ilo] use_web_server_for_images = False | -(BoolOpt) Set this to True to use http web server to host floppy images and generated boot ISO. This requires http_root and http_url to be configured in the [deploy] section of the config file. If this is set to False, then Ironic will use Swift to host the floppy images and generated boot_iso. | -
| [inspector] enabled = False | -(BoolOpt) whether to enable inspection using ironic-inspector | -
| [inspector] service_url = None | -(StrOpt) ironic-inspector HTTP endpoint. If this is not set, the ironic-inspector client default (http://127.0.0.1:5050) will be used. | -
| [inspector] status_check_period = 60 | -(IntOpt) period (in seconds) to check status of nodes on inspection | -
| [irmc] remote_image_server = None | -(StrOpt) IP of remote image server | -
| [irmc] remote_image_share_name = share | -(StrOpt) share name of remote_image_server | -
| [irmc] remote_image_share_root = /remote_image_share_root | -(StrOpt) Ironic conductor node's "NFS" or "CIFS" root path | -
| [irmc] remote_image_share_type = CIFS | -(StrOpt) Share type of virtual media, either "NFS" or "CIFS" | -
| [irmc] remote_image_user_domain = | -(StrOpt) Domain name of remote_image_user_name | -
| [irmc] remote_image_user_name = None | -(StrOpt) User name of remote_image_server | -
| [irmc] remote_image_user_password = None | -(StrOpt) Password of remote_image_user_name | -
| [keystone_authtoken] region_name = None | -(StrOpt) The region in which the identity server can be found. | -
| [oslo_messaging_amqp] password = | -(StrOpt) Password for message broker authentication | -
| [oslo_messaging_amqp] sasl_config_dir = | -(StrOpt) Path to directory that contains the SASL configuration | -
| [oslo_messaging_amqp] sasl_config_name = | -(StrOpt) Name of configuration file (without .conf suffix) | -
| [oslo_messaging_amqp] sasl_mechanisms = | -(StrOpt) Space separated list of acceptable SASL mechanisms | -
| [oslo_messaging_amqp] username = | -(StrOpt) User name for message broker authentication | -
| [oslo_messaging_qpid] send_single_reply = 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 the Mitaka release. | -
| [oslo_messaging_rabbit] kombu_reconnect_timeout = 60 | -(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. | -
| [oslo_messaging_rabbit] send_single_reply = 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 the Mitaka release. | -
| [oslo_middleware] max_request_body_size = 114688 | -(IntOpt) The maximum body size for each request, in bytes. | -
| [oslo_middleware] secure_proxy_ssl_header = 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_versionedobjects] fatal_exception_format_errors = False | -(BoolOpt) Make exception message format errors fatal | -
| Option | -Previous default value | -New default value | -
| [DEFAULT] default_log_levels | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN | -
| [DEFAULT] logging_exception_prefix | -%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s | -
| [DEFAULT] rpc_zmq_matchmaker | -local | -redis | -
| [DEFAULT] tempdir | -None | -/tmp | -
| [DEFAULT] use_syslog_rfc_format | -False | -True | -
| [DEFAULT] verbose | -False | -True | -
| [matchmaker_redis] password | -None | -- |
| [oslo_messaging_rabbit] heartbeat_timeout_threshold | -0 | -60 | -
| Deprecated option | -New Option | -
| [agent] agent_pxe_append_params | -None | -
| [agent] agent_erase_devices_priority | -[deploy] erase_devices_priority | -
| [DEFAULT] rpc_thread_pool_size | -[DEFAULT] executor_thread_pool_size | -
| [DEFAULT] log_format | -None | -
| [agent] agent_pxe_config_template | -None | -
| [DEFAULT] use_syslog | -None | -
| [agent] manage_tftp | -[agent] manage_agent_boot | -
| Option = default value | -(Type) Help string | -
| [DEFAULT] executor_thread_pool_size = 64 | -(IntOpt) Size of executor thread pool. | -
| [DEFAULT] host = 127.0.0.1 | -(StrOpt) Host to locate redis. | -
| [DEFAULT] password = | -(StrOpt) Password for Redis server (optional). | -
| [DEFAULT] port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| [DEFAULT] rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| [DEFAULT] rpc_poll_timeout = 1 | -(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| [DEFAULT] rpc_zmq_all_req_rep = True | -(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| [DEFAULT] rpc_zmq_concurrency = eventlet | -(StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| [DEFAULT] watch_log_file = False | -(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| [DEFAULT] zmq_use_broker = True | -(BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| [cors] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors.subdomain] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors.subdomain] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors.subdomain] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors.subdomain] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors.subdomain] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [endpoint_policy] enabled = True | -(BoolOpt) Enable endpoint_policy functionality. | -
| [keystone_authtoken] region_name = None | -(StrOpt) The region in which the identity server can be found. | -
| [oslo_messaging_amqp] password = | -(StrOpt) Password for message broker authentication | -
| [oslo_messaging_amqp] sasl_config_dir = | -(StrOpt) Path to directory that contains the SASL configuration | -
| [oslo_messaging_amqp] sasl_config_name = | -(StrOpt) Name of configuration file (without .conf suffix) | -
| [oslo_messaging_amqp] sasl_mechanisms = | -(StrOpt) Space separated list of acceptable SASL mechanisms | -
| [oslo_messaging_amqp] username = | -(StrOpt) User name for message broker authentication | -
| [oslo_messaging_qpid] send_single_reply = 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 the Mitaka release. | -
| [oslo_messaging_rabbit] kombu_reconnect_timeout = 60 | -(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. | -
| [oslo_messaging_rabbit] send_single_reply = 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 the Mitaka release. | -
| [oslo_middleware] secure_proxy_ssl_header = 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. | -
| [tokenless_auth] issuer_attribute = SSL_CLIENT_I_DN | -(StrOpt) The issuer attribute that is served as an IdP ID for the X.509 tokenless authorization along with the protocol to look up its corresponding mapping. It is the environment variable in the WSGI environment that references to the issuer of the client certificate. | -
| [tokenless_auth] protocol = x509 | -(StrOpt) The protocol name for the X.509 tokenless authorization along with the option issuer_attribute below can look up its corresponding mapping. | -
| [tokenless_auth] trusted_issuer = [] | -(MultiStrOpt) The list of trusted issuers to further filter the certificates that are allowed to participate in the X.509 tokenless authorization. If the option is absent then no certificates will be allowed. The naming format for the attributes of a Distinguished Name(DN) must be separated by a comma and contain no spaces. This configuration option may be repeated for multiple values. For example: trusted_issuer=CN=john,OU=keystone,O=openstack trusted_issuer=CN=mary,OU=eng,O=abc | -
| Option | -Previous default value | -New default value | -
| [DEFAULT] crypt_strength | -40000 | -10000 | -
| [DEFAULT] default_log_levels | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN | -
| [DEFAULT] logging_exception_prefix | -%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s | -
| [DEFAULT] rpc_zmq_matchmaker | -local | -redis | -
| [DEFAULT] use_syslog_rfc_format | -False | -True | -
| [DEFAULT] verbose | -False | -True | -
| [auth] external | -keystone.auth.plugins.external.DefaultDomain | -None | -
| [auth] oauth1 | -keystone.auth.plugins.oauth1.OAuth | -None | -
| [auth] password | -keystone.auth.plugins.password.Password | -None | -
| [auth] token | -keystone.auth.plugins.token.Token | -None | -
| [catalog] driver | -keystone.catalog.backends.sql.Catalog | -sql | -
| [credential] driver | -keystone.credential.backends.sql.Credential | -sql | -
| [domain_config] driver | -keystone.resource.config_backends.sql.DomainConfig | -sql | -
| [endpoint_filter] driver | -keystone.contrib.endpoint_filter.backends.sql.EndpointFilter | -sql | -
| [endpoint_policy] driver | -keystone.contrib.endpoint_policy.backends.sql.EndpointPolicy | -sql | -
| [federation] driver | -keystone.contrib.federation.backends.sql.Federation | -sql | -
| [identity] driver | -keystone.identity.backends.sql.Identity | -sql | -
| [identity_mapping] driver | -keystone.identity.mapping_backends.sql.Mapping | -sql | -
| [identity_mapping] generator | -keystone.identity.id_generators.sha256.Generator | -sha256 | -
| [ldap] user_attribute_ignore | -default_project_id, tenants | -default_project_id | -
| [matchmaker_redis] password | -None | -- |
| [oauth1] driver | -keystone.contrib.oauth1.backends.sql.OAuth1 | -sql | -
| [oslo_messaging_rabbit] heartbeat_timeout_threshold | -0 | -60 | -
| [policy] driver | -keystone.policy.backends.sql.Policy | -sql | -
| [revoke] driver | -keystone.contrib.revoke.backends.sql.Revoke | -sql | -
| [token] driver | -keystone.token.persistence.backends.sql.Token | -sql | -
| [token] provider | -keystone.token.providers.uuid.Provider | -uuid | -
| [trust] driver | -keystone.trust.backends.sql.Trust | -sql | -
| Deprecated option | -New Option | -
| [DEFAULT] use_syslog | -None | -
| [DEFAULT] log_format | -None | -
| [DEFAULT] rpc_thread_pool_size | -[DEFAULT] executor_thread_pool_size | -
| Option = default value | -(Type) Help string | -
| [DEFAULT] client_socket_timeout = 900 | -(IntOpt) Timeout for client connections socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. | -
| [DEFAULT] emc_nas_root_dir = None | -(StrOpt) The root directory where shares will be located. | -
| [DEFAULT] enable_periodic_hooks = False | -(BoolOpt) Whether to enable periodic hooks or not. | -
| [DEFAULT] enable_post_hooks = False | -(BoolOpt) Whether to enable post hooks or not. | -
| [DEFAULT] enable_pre_hooks = False | -(BoolOpt) Whether to enable pre hooks or not. | -
| [DEFAULT] executor_thread_pool_size = 64 | -(IntOpt) Size of executor thread pool. | -
| [DEFAULT] glusterfs_share_layout = None | -(StrOpt) Specifies GlusterFS share layout, that is, the method of associating backing GlusterFS resources to shares. | -
| [DEFAULT] hds_hnas_cluster_admin_ip0 = None | -(StrOpt) The IP of the clusters admin node. Only set in HNAS multinode clusters. | -
| [DEFAULT] hds_hnas_evs_id = None | -(StrOpt) Specify which EVS this backend is assigned to. | -
| [DEFAULT] hds_hnas_evs_ip = None | -(StrOpt) Specify IP for mounting shares. | -
| [DEFAULT] hds_hnas_file_system_name = None | -(StrOpt) Specify file-system name for creating shares. | -
| [DEFAULT] hds_hnas_ip = None | -(StrOpt) HNAS management interface IP for communication between Manila controller and HNAS. | -
| [DEFAULT] hds_hnas_password = None | -(StrOpt) HNAS user password. Required only if private key is not provided. | -
| [DEFAULT] hds_hnas_ssh_private_key = None | -(StrOpt) RSA/DSA private key value used to connect into HNAS. Required only if password is not provided. | -
| [DEFAULT] hds_hnas_stalled_job_timeout = 30 | -(IntOpt) The time (in seconds) to wait for stalled HNAS jobs before aborting. | -
| [DEFAULT] hds_hnas_user = None | -(StrOpt) HNAS username Base64 String in order to perform tasks such as create file-systems and network interfaces. | -
| [DEFAULT] hook_drivers = | -(ListOpt) Driver(s) to perform some additional actions before and after share driver actions and on a periodic basis. Default is []. | -
| [DEFAULT] max_over_subscription_ratio = 20.0 | -(FloatOpt) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 is invalid. | -
| [DEFAULT] max_time_to_extend_volume = 180 | -(IntOpt) Maximum time to wait for extending cinder volume. | -
| [DEFAULT] migration_create_delete_share_timeout = 300 | -(IntOpt) Timeout for creating and deleting share instances when performing share migration (seconds). | -
| [DEFAULT] migration_data_copy_node_ip = None | -(StrOpt) The IP of the node responsible for copying data during migration, such as the data copy service node, reachable by the backend. | -
| [DEFAULT] migration_ignore_files = lost+found | -(ListOpt) List of files and folders to be ignored when migrating shares. Items should be names (not including any path). | -
| [DEFAULT] migration_mounting_backend_ip = None | -(StrOpt) Backend IP in admin network to use for mounting shares during migration. | -
| [DEFAULT] migration_protocol_mount_command = None | -(StrOpt) The command for mounting shares for this backend. Must specifythe executable and all necessary parameters for the protocol supported. It is advisable to separate protocols per backend. | -
| [DEFAULT] migration_readonly_support = True | -(BoolOpt) Specify whether read only access mode is supported in thisbackend. | -
| [DEFAULT] migration_tmp_location = /tmp/ | -(StrOpt) Temporary path to create and mount shares during migration. | -
| [DEFAULT] migration_wait_access_rules_timeout = 90 | -(IntOpt) Time to wait for access rules to be allowed/denied on backends when migrating shares using generic approach (seconds). | -
| [DEFAULT] nova_api_microversion = 2.10 | -(StrOpt) Version of Nova API to be used. | -
| [DEFAULT] osapi_share_workers = 1 | -(IntOpt) Number of workers for OpenStack Share API service. | -
| [DEFAULT] password = | -(StrOpt) Password for Redis server (optional). | -
| [DEFAULT] periodic_hooks_interval = 300.0 | -(FloatOpt) Interval in seconds between execution of periodic hooks. Used when option 'enable_periodic_hooks' is set to True. Default is 300. | -
| [DEFAULT] pool_weight_multiplier = 1.0 | -(FloatOpt) Multiplier used for weighing pools which have existing share servers. Negative numbers mean to spread vs stack. | -
| [DEFAULT] port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| [DEFAULT] rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| [DEFAULT] rpc_poll_timeout = 1 | -(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| [DEFAULT] rpc_zmq_all_req_rep = True | -(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| [DEFAULT] rpc_zmq_concurrency = eventlet | -(StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| [DEFAULT] suppress_post_hooks_errors = False | -(BoolOpt) Whether to suppress post hook errors (allow driver's results to pass through) or not. | -
| [DEFAULT] suppress_pre_hooks_errors = False | -(BoolOpt) Whether to suppress pre hook errors (allow driver perform actions) or not. | -
| [DEFAULT] watch_log_file = False | -(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| [DEFAULT] winrm_cert_key_pem_path = ~/.ssl/key.pem | -(StrOpt) Path to the x509 certificate key. | -
| [DEFAULT] winrm_cert_pem_path = ~/.ssl/cert.pem | -(StrOpt) Path to the x509 certificate used for accessing the serviceinstance. | -
| [DEFAULT] winrm_conn_timeout = 60 | -(IntOpt) WinRM connection timeout. | -
| [DEFAULT] winrm_operation_timeout = 60 | -(IntOpt) WinRM operation timeout. | -
| [DEFAULT] winrm_retry_count = 3 | -(IntOpt) WinRM retry count. | -
| [DEFAULT] winrm_retry_interval = 5 | -(IntOpt) WinRM retry interval in seconds | -
| [DEFAULT] winrm_use_cert_based_auth = False | -(BoolOpt) Use x509 certificates in order to authenticate to theservice instance. | -
| [DEFAULT] wsgi_keep_alive = True | -(BoolOpt) If False, closes the client socket connection explicitly. Setting it to True to maintain backward compatibility. Recommended setting is set it to False. | -
| [DEFAULT] zmq_use_broker = True | -(BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| [cors] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors.subdomain] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors.subdomain] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors.subdomain] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors.subdomain] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors.subdomain] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [keystone_authtoken] region_name = None | -(StrOpt) The region in which the identity server can be found. | -
| [oslo_messaging_amqp] password = | -(StrOpt) Password for message broker authentication | -
| [oslo_messaging_amqp] sasl_config_dir = | -(StrOpt) Path to directory that contains the SASL configuration | -
| [oslo_messaging_amqp] sasl_config_name = | -(StrOpt) Name of configuration file (without .conf suffix) | -
| [oslo_messaging_amqp] sasl_mechanisms = | -(StrOpt) Space separated list of acceptable SASL mechanisms | -
| [oslo_messaging_amqp] username = | -(StrOpt) User name for message broker authentication | -
| [oslo_messaging_qpid] send_single_reply = 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 the Mitaka release. | -
| [oslo_messaging_rabbit] kombu_reconnect_timeout = 60 | -(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. | -
| [oslo_messaging_rabbit] send_single_reply = 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 the Mitaka release. | -
| [oslo_middleware] max_request_body_size = 114688 | -(IntOpt) The maximum body size for each request, in bytes. | -
| [oslo_middleware] secure_proxy_ssl_header = 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] policy_default_rule = default | -(StrOpt) Default rule. Enforced when a requested rule is not found. | -
| [oslo_policy] policy_dirs = ['policy.d'] | -(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. | -
| [oslo_policy] policy_file = policy.json | -(StrOpt) The JSON file that defines policies. | -
| Option | -Previous default value | -New default value | -
| [DEFAULT] default_log_levels | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN | -
| [DEFAULT] enable_v1_api | -True | -False | -
| [DEFAULT] enable_v2_api | -True | -False | -
| [DEFAULT] logging_exception_prefix | -%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s | -
| [DEFAULT] osapi_share_listen | -0.0.0.0 | -:: | -
| [DEFAULT] rpc_zmq_matchmaker | -local | -redis | -
| [DEFAULT] scheduler_default_filters | -AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter | -AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter, ConsistencyGroupFilter | -
| [DEFAULT] use_syslog_rfc_format | -False | -True | -
| [DEFAULT] verbose | -False | -True | -
| [matchmaker_redis] password | -None | -- |
| [oslo_messaging_rabbit] heartbeat_timeout_threshold | -0 | -60 | -
| Deprecated option | -New Option | -
| [DEFAULT] glusterfs_native_server_password | -[DEFAULT] glusterfs_server_password | -
| [DEFAULT] sql_max_retries | -[database] max_retries | -
| [DEFAULT] sql_retry_interval | -[database] retry_interval | -
| [DEFAULT] use_syslog | -None | -
| [DEFAULT] osapi_max_request_body_size | -[oslo_middleware] max_request_body_size | -
| [DEFAULT] glusterfs_native_path_to_private_key | -[DEFAULT] glusterfs_path_to_private_key | -
| [DEFAULT] sql_idle_timeout | -[database] idle_timeout | -
| [DEFAULT] rpc_thread_pool_size | -[DEFAULT] executor_thread_pool_size | -
| [DEFAULT] db_backend | -[database] backend | -
| [DEFAULT] log_format | -None | -
| Option = default value | -(Type) Help string | -
| [DEFAULT] dns_domain = openstacklocal | -(StrOpt) Domain to use for building the hostnames | -
| [DEFAULT] dnsmasq_base_log_dir = None | -(StrOpt) Base log dir for dnsmasq logging. The log contains DHCP and DNS log information and is useful for debugging issues with either DHCP or DNS. If this section is null, disable dnsmasq log. | -
| [DEFAULT] enable_new_agents = True | -(BoolOpt) Agent starts with admin_state_up=False when enable_new_agents=False. In the case, user's resources will not be scheduled automatically to the agent until admin changes admin_state_up to True. | -
| [DEFAULT] enable_snat_by_default = True | -(BoolOpt) Define the default value of enable_snat if not provided in external_gateway_info. | -
| [DEFAULT] endpoint_url = None | -(StrOpt) Neutron endpoint URL, if not set will use endpoint from the keystone catalog along with endpoint_type | -
| [DEFAULT] executor_thread_pool_size = 64 | -(IntOpt) Size of executor thread pool. | -
| [DEFAULT] force_metadata = False | -(BoolOpt) Force to use DHCP to get Metadata on all networks. | -
| [DEFAULT] ipam_driver = None | -(StrOpt) IPAM driver to use. | -
| [DEFAULT] password = | -(StrOpt) Password for Redis server (optional). | -
| [DEFAULT] pd_confs = $state_path/pd | -(StrOpt) Location to store IPv6 PD files. | -
| [DEFAULT] pd_dhcp_driver = dibbler | -(StrOpt) Service to handle DHCPv6 Prefix delegation. | -
| [DEFAULT] port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| [DEFAULT] prefix_delegation_driver = dibbler | -(StrOpt) Driver used for ipv6 prefix delegation. This needs to be an entry point defined in the neutron.agent.linux.pd_drivers namespace. See setup.cfg for entry points included with the neutron source. | -
| [DEFAULT] rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| [DEFAULT] rpc_poll_timeout = 1 | -(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| [DEFAULT] rpc_zmq_all_req_rep = True | -(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| [DEFAULT] rpc_zmq_concurrency = eventlet | -(StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| [DEFAULT] vendor_pen = 8888 | -(StrOpt) A decimal value as Vendor's Registered Private Enterprise Number as required by RFC3315 DUID-EN. | -
| [DEFAULT] watch_log_file = False | -(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| [DEFAULT] zmq_use_broker = True | -(BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| [AGENT] agent_type = Open vSwitch agent | -(StrOpt) Selects the Agent Type reported | -
| [AGENT] drop_flows_on_start = False | -(BoolOpt) Reset flow table on start. Setting this to True will cause brief traffic interruption. | -
| [AGENT] log_agent_heartbeats = False | -(BoolOpt) Log agent heartbeats | -
| [AGENT] tunnel_csum = False | -(BoolOpt) Set or un-set the tunnel header checksum on outgoing IP packet carrying GRE/VXLAN tunnel. | -
| [LINUX_BRIDGE] bridge_mappings = | -(ListOpt) List of <physical_network>:<physical_bridge> | -
| [OVS] datapath_type = system | -(StrOpt) OVS datapath to use. | -
| [OVS] of_connect_timeout = 30 | -(IntOpt) Timeout in seconds to wait for the local switch connecting the controller. Used only for 'native' driver. | -
| [OVS] of_interface = ovs-ofctl | -(StrOpt) OpenFlow interface to use. | -
| [OVS] of_listen_address = 127.0.0.1 | -(IPOpt) Address to listen on for OpenFlow connections. Used only for 'native' driver. | -
| [OVS] of_listen_port = 6633 | -(IntOpt) Port to listen on for OpenFlow connections. Used only for 'native' driver. | -
| [OVS] of_request_timeout = 10 | -(IntOpt) Timeout in seconds to wait for a single OpenFlow request. Used only for 'native' driver. | -
| [QUOTAS] quota_rbac_entry = 10 | -(IntOpt) Default number of RBAC entries allowed per tenant. A negative value means unlimited. | -
| [QUOTAS] track_quota_usage = True | -(BoolOpt) Keep in track in the database of current resourcequota usage. Plugins which do not leverage the neutron database should set this flag to False | -
| [agent] extensions = | -(ListOpt) Extensions list to use | -
| [cors] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors.subdomain] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors.subdomain] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors.subdomain] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors.subdomain] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors.subdomain] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [keystone_authtoken] region_name = None | -(StrOpt) The region in which the identity server can be found. | -
| [ml2] external_network_type = None | -(StrOpt) Default network type for external networks when no provider attributes are specified. By default it is None, which means that if provider attributes are not specified while creating external networks then they will have the same type as tenant networks. Allowed values for external_network_type config option depend on the network type values configured in type_drivers config option. | -
| [ml2_type_geneve] max_header_size = 50 | -(IntOpt) Geneve encapsulation header size is dynamic, this value is used to calculate the maximum MTU for the driver.this is the sum of the sizes of the outer ETH + IP + UDP + GENEVE header sizes | -
| [ml2_type_geneve] vni_ranges = | -(ListOpt) Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of Geneve VNI IDs that are available for tenant network allocation | -
| [oslo_messaging_amqp] password = | -(StrOpt) Password for message broker authentication | -
| [oslo_messaging_amqp] sasl_config_dir = | -(StrOpt) Path to directory that contains the SASL configuration | -
| [oslo_messaging_amqp] sasl_config_name = | -(StrOpt) Name of configuration file (without .conf suffix) | -
| [oslo_messaging_amqp] sasl_mechanisms = | -(StrOpt) Space separated list of acceptable SASL mechanisms | -
| [oslo_messaging_amqp] username = | -(StrOpt) User name for message broker authentication | -
| [oslo_messaging_qpid] send_single_reply = 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 the Mitaka release. | -
| [oslo_messaging_rabbit] kombu_reconnect_timeout = 60 | -(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. | -
| [oslo_messaging_rabbit] send_single_reply = 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 the Mitaka release. | -
| [oslo_middleware] secure_proxy_ssl_header = 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] policy_default_rule = default | -(StrOpt) Default rule. Enforced when a requested rule is not found. | -
| [oslo_policy] policy_dirs = ['policy.d'] | -(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. | -
| [oslo_policy] policy_file = policy.json | -(StrOpt) The JSON file that defines policies. | -
| [oslo_versionedobjects] fatal_exception_format_errors = False | -(BoolOpt) Make exception message format errors fatal | -
| [qos] notification_drivers = message_queue | -(ListOpt) Drivers list to use to send the update notification | -
| Option | -Previous default value | -New default value | -
| [DEFAULT] api_workers | -0 | -None | -
| [DEFAULT] default_log_levels | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN | -
| [DEFAULT] dhcp_delete_namespaces | -False | -True | -
| [DEFAULT] endpoint_type | -publicURL | -adminURL | -
| [DEFAULT] logging_exception_prefix | -%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s | -
| [DEFAULT] network_scheduler_driver | -neutron.scheduler.dhcp_agent_scheduler.ChanceScheduler | -neutron.scheduler.dhcp_agent_scheduler.WeightScheduler | -
| [DEFAULT] router_delete_namespaces | -False | -True | -
| [DEFAULT] router_scheduler_driver | -neutron.scheduler.l3_agent_scheduler.ChanceScheduler | -neutron.scheduler.l3_agent_scheduler.LeastRoutersScheduler | -
| [DEFAULT] rpc_workers | -0 | -1 | -
| [DEFAULT] rpc_zmq_matchmaker | -local | -redis | -
| [DEFAULT] use_syslog_rfc_format | -False | -True | -
| [DEFAULT] verbose | -False | -True | -
| [AGENT] prevent_arp_spoofing | -False | -True | -
| [QUOTAS] quota_driver | -neutron.db.quota_db.DbQuotaDriver | -neutron.db.quota.driver.DbQuotaDriver | -
| [matchmaker_redis] password | -None | -- |
| [ml2] type_drivers | -local, flat, vlan, gre, vxlan | -local, flat, vlan, gre, vxlan, geneve | -
| [ml2_sriov] agent_required | -False | -True | -
| [oslo_messaging_rabbit] heartbeat_timeout_threshold | -0 | -60 | -
| Deprecated option | -New Option | -
| [DEFAULT] use_syslog | -None | -
| [DEFAULT] rpc_thread_pool_size | -[DEFAULT] executor_thread_pool_size | -
| [ml2_sriov] agent_required | -None | -
| [DEFAULT] log_format | -None | -
| Option = default value | -(Type) Help string | -
| [DEFAULT] console_allowed_origins = | -(ListOpt) Allowed Origin header hostnames for access to console proxy servers | -
| [DEFAULT] executor_thread_pool_size = 64 | -(IntOpt) Size of executor thread pool. | -
| [DEFAULT] max_concurrent_live_migrations = 1 | -(IntOpt) Maximum number of live migrations to run concurrently. This limit is enforced to avoid outbound live migrations overwhelming the host/network and causing failures. It is not recommended that you change this unless you are very sure that doing so is safe and stable in your environment. | -
| [DEFAULT] password = | -(StrOpt) Password for Redis server (optional). | -
| [DEFAULT] port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| [DEFAULT] rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| [DEFAULT] rpc_poll_timeout = 1 | -(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| [DEFAULT] rpc_zmq_all_req_rep = True | -(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| [DEFAULT] rpc_zmq_concurrency = eventlet | -(StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| [DEFAULT] secure_proxy_ssl_header = None | -(StrOpt) The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is "HTTP_X_FORWARDED_PROTO". | -
| [DEFAULT] update_resources_interval = 0 | -(IntOpt) Interval in seconds for updating compute resources. A number less than 0 means to disable the task completely. Leaving this at the default of 0 will cause this to run at the default periodic interval. Setting it to any positive value will cause it to run at approximately that number of seconds. | -
| [DEFAULT] use_rootwrap_daemon = False | -(BoolOpt) Start and use a daemon that can run the commands that need to be run with root privileges. This option is usually enabled on nodes that run nova compute processes | -
| [DEFAULT] watch_log_file = False | -(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| [DEFAULT] zmq_use_broker = True | -(BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| [cors] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors.subdomain] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors.subdomain] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors.subdomain] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors.subdomain] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors.subdomain] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [hyperv] power_state_check_timeframe = 60 | -(IntOpt) The timeframe to be checked for instance power state changes. | -
| [hyperv] power_state_event_polling_interval = 2 | -(IntOpt) Instance power state change event polling frequency. | -
| [keystone_authtoken] region_name = None | -(StrOpt) The region in which the identity server can be found. | -
| [libvirt] live_migration_completion_timeout = 800 | -(IntOpt) Time to wait, in seconds, for migration to successfully complete transferring data before aborting the operation. Value is per GiB of guest RAM + disk to be transferred, with lower bound of a minimum of 2 GiB. Should usually be larger than downtime delay * downtime steps. Set to 0 to disable timeouts. | -
| [libvirt] live_migration_downtime = 500 | -(IntOpt) Maximum permitted downtime, in milliseconds, for live migration switchover. Will be rounded up to a minimum of 100ms. Use a large value if guest liveness is unimportant. | -
| [libvirt] live_migration_downtime_delay = 75 | -(IntOpt) Time to wait, in seconds, between each step increase of the migration downtime. Minimum delay is 10 seconds. Value is per GiB of guest RAM + disk to be transferred, with lower bound of a minimum of 2 GiB per device | -
| [libvirt] live_migration_downtime_steps = 10 | -(IntOpt) Number of incremental steps to reach max downtime value. Will be rounded up to a minimum of 3 steps | -
| [libvirt] live_migration_progress_timeout = 150 | -(IntOpt) Time to wait, in seconds, for migration to make forward progress in transferring data before aborting the operation. Set to 0 to disable timeouts. | -
| [libvirt] remote_filesystem_transport = ssh | -(StrOpt) Use ssh or rsync transport for creating, copying, removing files on the remote host. | -
| [mks] enabled = False | -(BoolOpt) Enable MKS related features | -
| [mks] mksproxy_base_url = http://127.0.0.1:6090/ | -(StrOpt) Location of MKS web console proxy, in the form "http://127.0.0.1:6090/" | -
| [osapi_v21] enabled = True | -(BoolOpt) DEPRECATED: Whether the V2.1 API is enabled or not. This option will be removed in the near future. | -
| [osapi_v21] extensions_blacklist = | -(ListOpt) DEPRECATED: A list of v2.1 API extensions to never load. Specify the extension aliases here. This option will be removed in the near future. After that point you have to run all of the API. | -
| [osapi_v21] extensions_whitelist = | -(ListOpt) DEPRECATED: If the list is not empty then a v2.1 API extension will only be loaded if it exists in this list. Specify the extension aliases here. This option will be removed in the near future. After that point you have to run all of the API. | -
| [oslo_messaging_amqp] password = | -(StrOpt) Password for message broker authentication | -
| [oslo_messaging_amqp] sasl_config_dir = | -(StrOpt) Path to directory that contains the SASL configuration | -
| [oslo_messaging_amqp] sasl_config_name = | -(StrOpt) Name of configuration file (without .conf suffix) | -
| [oslo_messaging_amqp] sasl_mechanisms = | -(StrOpt) Space separated list of acceptable SASL mechanisms | -
| [oslo_messaging_amqp] username = | -(StrOpt) User name for message broker authentication | -
| [oslo_messaging_qpid] send_single_reply = 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 the Mitaka release. | -
| [oslo_messaging_rabbit] kombu_reconnect_timeout = 60 | -(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. | -
| [oslo_messaging_rabbit] send_single_reply = 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 the Mitaka release. | -
| [oslo_middleware] secure_proxy_ssl_header = 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_versionedobjects] fatal_exception_format_errors = False | -(BoolOpt) Make exception message format errors fatal | -
| [vmware] ca_file = None | -(StrOpt) Specify a CA bundle file to use in verifying the vCenter server certificate. | -
| [vmware] console_delay_seconds = None | -(IntOpt) Set this value if affected by an increased network latency causing repeated characters when typing in a remote console. | -
| [vmware] insecure = 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 "ca_file" is set. | -
| [vmware] serial_port_proxy_uri = None | -(StrOpt) Identifies a proxy service that provides network access to the serial_port_service_uri. This option is ignored if serial_port_service_uri is not specified. | -
| [vmware] serial_port_service_uri = None | -(StrOpt) Identifies the remote system that serial port traffic will be sent to. If this is not set, no serial ports will be added to the created VMs. | -
| [vnc] enabled = True | -(BoolOpt) Enable VNC related features | -
| [vnc] keymap = en-us | -(StrOpt) Keymap for VNC | -
| [vnc] novncproxy_base_url = http://127.0.0.1:6080/vnc_auto.html | -(StrOpt) Location of VNC console proxy, in the form "http://127.0.0.1:6080/vnc_auto.html" | -
| [vnc] vncserver_listen = 127.0.0.1 | -(StrOpt) IP address on which instance vncservers should listen | -
| [vnc] vncserver_proxyclient_address = 127.0.0.1 | -(StrOpt) The address to which proxy clients (like nova-xvpvncproxy) should connect | -
| [vnc] xvpvncproxy_base_url = http://127.0.0.1:6081/console | -(StrOpt) Location of nova xvp VNC console proxy, in the form "http://127.0.0.1:6081/console" | -
| [workarounds] handle_virt_lifecycle_events = True | -(BoolOpt) Whether or not to handle events raised from the compute driver's 'emit_event' method. These are lifecycle events raised from compute drivers that implement the method. An example of a lifecycle event is an instance starting or stopping. If the instance is going through task state changes due to an API operation, like resize, the events are ignored. However, this is an advanced feature which allows the hypervisor to signal to the compute service that an unexpected state change has occurred in an instance and the instance can be shutdown automatically - which can inherently race in reboot operations or when the compute service or host is rebooted, either planned or due to an unexpected outage. Care should be taken when using this and sync_power_state_interval is negative since then if any instances are out of sync between the hypervisor and the Nova database they will have to be synchronized manually. See https://bugs.launchpad.net/bugs/1444630 | -
| Option | -Previous default value | -New default value | -
| [DEFAULT] compute_available_monitors | -['nova.compute.monitors.all_monitors'] | -None | -
| [DEFAULT] cpu_allocation_ratio | -16.0 | -0.0 | -
| [DEFAULT] default_log_levels | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN | -
| [DEFAULT] logging_exception_prefix | -%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s | -
| [DEFAULT] osapi_compute_extension | -['nova.api.openstack.compute.contrib.standard_extensions'] | -['nova.api.openstack.compute.legacy_v2.contrib.standard_extensions'] | -
| [DEFAULT] ram_allocation_ratio | -1.5 | -0.0 | -
| [DEFAULT] rpc_zmq_matchmaker | -local | -redis | -
| [DEFAULT] scheduler_default_filters | -RetryFilter, AvailabilityZoneFilter, RamFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ServerGroupAntiAffinityFilter, ServerGroupAffinityFilter | -RetryFilter, AvailabilityZoneFilter, RamFilter, DiskFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ServerGroupAntiAffinityFilter, ServerGroupAffinityFilter | -
| [DEFAULT] use_syslog_rfc_format | -False | -True | -
| [DEFAULT] verbose | -False | -True | -
| [cells] mute_weight_multiplier | --10.0 | --10000.0 | -
| [libvirt] remove_unused_kernels | -False | -True | -
| [matchmaker_redis] password | -None | -- |
| [oslo_messaging_rabbit] heartbeat_timeout_threshold | -0 | -60 | -
| Deprecated option | -New Option | -
| [DEFAULT] network_device_mtu | -None | -
| [DEFAULT] vnc_keymap | -[vnc] keymap | -
| [osapi_v21] extensions_whitelist | -None | -
| [ironic] admin_auth_token | -None | -
| [DEFAULT] vnc_enabled | -[vnc] enabled | -
| [DEFAULT] use_syslog | -None | -
| [DEFAULT] xvpvncproxy_base_url | -[vnc] xvpvncproxy_base_url | -
| [ironic] client_log_level | -None | -
| [neutron] admin_username | -None | -
| [DEFAULT] ssl_ca_file | -[ssl] ca_file | -
| [neutron] auth_strategy | -None | -
| [osapi_v21] enabled | -None | -
| [DEFAULT] novncproxy_base_url | -[vnc] novncproxy_base_url | -
| [DEFAULT] compute_available_monitors | -None | -
| [neutron] admin_user_id | -None | -
| [neutron] admin_tenant_id | -None | -
| [DEFAULT] ssl_cert_file | -[ssl] cert_file | -
| [DEFAULT] log_format | -None | -
| [DEFAULT] vncserver_proxyclient_address | -[vnc] vncserver_proxyclient_address | -
| [osapi_v21] extensions_blacklist | -None | -
| [workarounds] destroy_after_evacuate | -None | -
| [neutron] admin_tenant_name | -None | -
| [DEFAULT] osapi_compute_ext_list | -None | -
| [DEFAULT] rpc_thread_pool_size | -[DEFAULT] executor_thread_pool_size | -
| [DEFAULT] vncserver_listen | -[vnc] vncserver_listen | -
| [neutron] admin_password | -None | -
| [DEFAULT] share_dhcp_address | -None | -
| [DEFAULT] ssl_key_file | -[ssl] key_file | -
| [libvirt] remove_unused_kernels | -None | -
| [neutron] admin_auth_url | -None | -
| Option = default value | -(Type) Help string | -
| [DEFAULT] cluster_operation_trust_expiration_hours = 24 | -(IntOpt) Defines the period of time (in hours) after which trusts created to allow sahara to create or scale a cluster will expire. Note that this value should be significantly larger than the value of the cleanup_time_for_incomplete_clusters configuration key if use of the cluster cleanup feature is desired (the trust must last at least as long as a cluster could validly take to stall in its creation, plus the timeout value set in that key, plus one hour for the period of the cleanup job). | -
| [DEFAULT] default_ntp_server = pool.ntp.org | -(StrOpt) Default ntp server for time sync | -
| [DEFAULT] executor_thread_pool_size = 64 | -(IntOpt) Size of executor thread pool. | -
| [DEFAULT] heat_stack_tags = data-processing-cluster | -(ListOpt) List of tags to be used during operating with stack. | -
| [DEFAULT] host = 127.0.0.1 | -(StrOpt) Host to locate redis. | -
| [DEFAULT] password = | -(StrOpt) Password for Redis server (optional). | -
| [DEFAULT] port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| [DEFAULT] rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| [DEFAULT] rpc_poll_timeout = 1 | -(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| [DEFAULT] rpc_zmq_all_req_rep = True | -(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| [DEFAULT] rpc_zmq_concurrency = eventlet | -(StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| [DEFAULT] watch_log_file = False | -(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| [DEFAULT] zmq_use_broker = True | -(BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| [cinder] endpoint_type = internalURL | -(StrOpt) Endpoint type for cinder client requests | -
| [cors] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [cors.subdomain] allow_credentials = True | -(BoolOpt) Indicate that the actual request can include user credentials | -
| [cors.subdomain] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which header field names may be used during the actual request. | -
| [cors.subdomain] allow_methods = GET, POST, PUT, DELETE, OPTIONS | -(ListOpt) Indicate which methods can be used during the actual request. | -
| [cors.subdomain] allowed_origin = None | -(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. | -
| [cors.subdomain] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | -(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. | -
| [cors.subdomain] max_age = 3600 | -(IntOpt) Maximum cache age of CORS preflight requests. | -
| [heat] endpoint_type = internalURL | -(StrOpt) Endpoint type for heat client requests | -
| [keystone] endpoint_type = internalURL | -(StrOpt) Endpoint type for keystone client requests | -
| [keystone_authtoken] region_name = None | -(StrOpt) The region in which the identity server can be found. | -
| [manila] api_insecure = True | -(BoolOpt) Allow to perform insecure SSL requests to manila. | -
| [manila] api_version = 1 | -(IntOpt) Version of the manila API to use. | -
| [manila] ca_file = None | -(StrOpt) Location of ca certificates file to use for manila client requests. | -
| [neutron] endpoint_type = internalURL | -(StrOpt) Endpoint type for neutron client requests | -
| [nova] endpoint_type = internalURL | -(StrOpt) Endpoint type for nova client requests | -
| [object_store_access] public_identity_ca_file = None | -(StrOpt) Location of ca certificate file to use for identity client requests via public endpoint | -
| [object_store_access] public_object_store_ca_file = None | -(StrOpt) Location of ca certificate file to use for object-store client requests via public endpoint | -
| [oslo_messaging_amqp] password = | -(StrOpt) Password for message broker authentication | -
| [oslo_messaging_amqp] sasl_config_dir = | -(StrOpt) Path to directory that contains the SASL configuration | -
| [oslo_messaging_amqp] sasl_config_name = | -(StrOpt) Name of configuration file (without .conf suffix) | -
| [oslo_messaging_amqp] sasl_mechanisms = | -(StrOpt) Space separated list of acceptable SASL mechanisms | -
| [oslo_messaging_amqp] username = | -(StrOpt) User name for message broker authentication | -
| [oslo_messaging_qpid] send_single_reply = 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 the Mitaka release. | -
| [oslo_messaging_rabbit] kombu_reconnect_timeout = 60 | -(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. | -
| [oslo_messaging_rabbit] send_single_reply = 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 the Mitaka release. | -
| [oslo_middleware] secure_proxy_ssl_header = 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. | -
| [retries] retries_number = 5 | -(IntOpt) Number of times to retry the request to client before failing | -
| [retries] retry_after = 10 | -(IntOpt) Time between the retries to client (in seconds). | -
| [swift] endpoint_type = internalURL | -(StrOpt) Endpoint type for swift client requests | -
| Option | -Previous default value | -New default value | -
| [DEFAULT] default_log_levels | -amqplib=WARN, qpid.messaging=INFO, stevedore=INFO, eventlet.wsgi.server=WARN, sqlalchemy=WARN, boto=WARN, suds=INFO, keystone=INFO, paramiko=WARN, requests=WARN, iso8601=WARN, oslo_messaging=INFO | -amqplib=WARN, qpid.messaging=INFO, stevedore=INFO, eventlet.wsgi.server=WARN, sqlalchemy=WARN, boto=WARN, suds=INFO, keystone=INFO, paramiko=WARN, requests=WARN, iso8601=WARN, oslo_messaging=INFO, neutronclient=INFO | -
| [DEFAULT] infrastructure_engine | -direct | -heat | -
| [DEFAULT] logging_exception_prefix | -%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s | -
| [DEFAULT] rpc_zmq_matchmaker | -local | -redis | -
| [DEFAULT] use_syslog_rfc_format | -False | -True | -
| [DEFAULT] verbose | -False | -True | -
| [matchmaker_redis] password | -None | -- |
| [oslo_messaging_rabbit] heartbeat_timeout_threshold | -0 | -60 | -
| Deprecated option | -New Option | -
| [DEFAULT] rpc_thread_pool_size | -[DEFAULT] executor_thread_pool_size | -
| [DEFAULT] log_format | -None | -
| [DEFAULT] use_syslog | -None | -
| Option = default value | -(Type) Help string | -
| [DEFAULT] executor_thread_pool_size = 64 | -(IntOpt) Size of executor thread pool. | -
| [DEFAULT] exists_notification_interval = 3600 | -(IntOpt) Seconds to wait between pushing events. | -
| [DEFAULT] nova_proxy_admin_tenant_id = | -(StrOpt) Admin tenant ID used to connect to Nova. | -
| [DEFAULT] password = | -(StrOpt) Password for Redis server (optional). | -
| [DEFAULT] port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| [DEFAULT] rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| [DEFAULT] rpc_poll_timeout = 1 | -(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. | -
| [DEFAULT] rpc_zmq_all_req_rep = True | -(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. | -
| [DEFAULT] rpc_zmq_concurrency = eventlet | -(StrOpt) Type of concurrency used. Either "native" or "eventlet" | -
| [DEFAULT] timeout_wait_for_service = 120 | -(IntOpt) Maximum time (in seconds) to wait for a service to become alive. | -
| [DEFAULT] watch_log_file = False | -(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. | -
| [DEFAULT] zmq_use_broker = True | -(BoolOpt) Shows whether zmq-messaging uses broker or not. | -
| [cassandra] root_controller = trove.extensions.common.service.DefaultRootController | -(StrOpt) Root controller implementation for cassandra. | -
| [couchbase] root_controller = trove.extensions.common.service.DefaultRootController | -(StrOpt) Root controller implementation for couchbase. | -
| [couchdb] root_controller = trove.extensions.common.service.DefaultRootController | -(StrOpt) Root controller implementation for couchdb. | -
| [db2] root_controller = trove.extensions.common.service.DefaultRootController | -(StrOpt) Root controller implementation for db2. | -
| [keystone_authtoken] region_name = None | -(StrOpt) The region in which the identity server can be found. | -
| [mariadb] backup_incremental_strategy = {'InnoBackupEx': 'InnoBackupExIncremental'} | -(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. | -
| [mariadb] backup_namespace = trove.guestagent.strategies.backup.mysql_impl | -(StrOpt) Namespace to load backup strategies from. | -
| [mariadb] backup_strategy = InnoBackupEx | -(StrOpt) Default strategy to perform backups. | -
| [mariadb] device_path = /dev/vdb | -(StrOpt) Device path for volume if volume support is enabled. | -
| [mariadb] mount_point = /var/lib/mysql | -(StrOpt) Filesystem path for mounting volumes if volume support is enabled. | -
| [mariadb] replication_namespace = trove.guestagent.strategies.replication.mysql_binlog | -(StrOpt) Namespace to load replication strategies from. | -
| [mariadb] replication_strategy = MysqlBinlogReplication | -(StrOpt) Default strategy for replication. | -
| [mariadb] restore_namespace = trove.guestagent.strategies.restore.mysql_impl | -(StrOpt) Namespace to load restore strategies from. | -
| [mariadb] root_controller = trove.extensions.common.service.DefaultRootController | -(StrOpt) Root controller implementation for mysql. | -
| [mariadb] root_on_create = False | -(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. | -
| [mariadb] tcp_ports = 3306 | -(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| [mariadb] udp_ports = | -(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| [mariadb] usage_timeout = 400 | -(IntOpt) Maximum time (in seconds) to wait for a Guest to become active. | -
| [mariadb] volume_support = True | -(BoolOpt) Whether to provision a Cinder volume for datadir. | -
| [mongodb] add_members_timeout = 300 | -(IntOpt) Maximum time to wait (in seconds) for a replica set initialization process to complete. | -
| [mongodb] configsvr_port = 27019 | -(IntOpt) Port for instances running as config servers. | -
| [mongodb] ignore_dbs = admin, local, config | -(ListOpt) Databases to exclude when listing databases. | -
| [mongodb] ignore_users = admin.os_admin, admin.root | -(ListOpt) Users to exclude when listing users. | -
| [mongodb] mongodb_port = 27017 | -(IntOpt) Port for mongod and mongos instances. | -
| [mongodb] root_controller = trove.extensions.common.service.DefaultRootController | -(StrOpt) Root controller implementation for mongodb. | -
| [mysql] root_controller = trove.extensions.common.service.DefaultRootController | -(StrOpt) Root controller implementation for mysql. | -
| [oslo_messaging_amqp] password = | -(StrOpt) Password for message broker authentication | -
| [oslo_messaging_amqp] sasl_config_dir = | -(StrOpt) Path to directory that contains the SASL configuration | -
| [oslo_messaging_amqp] sasl_config_name = | -(StrOpt) Name of configuration file (without .conf suffix) | -
| [oslo_messaging_amqp] sasl_mechanisms = | -(StrOpt) Space separated list of acceptable SASL mechanisms | -
| [oslo_messaging_amqp] username = | -(StrOpt) User name for message broker authentication | -
| [oslo_messaging_qpid] send_single_reply = 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 the Mitaka release. | -
| [oslo_messaging_rabbit] kombu_reconnect_timeout = 60 | -(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. | -
| [oslo_messaging_rabbit] send_single_reply = 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 the Mitaka release. | -
| [percona] root_controller = trove.extensions.common.service.DefaultRootController | -(StrOpt) Root controller implementation for percona. | -
| [postgresql] root_controller = trove.extensions.common.service.DefaultRootController | -(StrOpt) Root controller implementation for postgresql. | -
| [pxc] api_strategy = trove.common.strategies.cluster.experimental.pxc.api.PXCAPIStrategy | -(StrOpt) Class that implements datastore-specific API logic. | -
| [pxc] backup_incremental_strategy = {'InnoBackupEx': 'InnoBackupExIncremental'} | -(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. | -
| [pxc] backup_namespace = trove.guestagent.strategies.backup.mysql_impl | -(StrOpt) Namespace to load backup strategies from. | -
| [pxc] backup_strategy = InnoBackupEx | -(StrOpt) Default strategy to perform backups. | -
| [pxc] cluster_support = True | -(BoolOpt) Enable clusters to be created and managed. | -
| [pxc] device_path = /dev/vdb | -(StrOpt) Device path for volume if volume support is enabled. | -
| [pxc] guestagent_strategy = trove.common.strategies.cluster.experimental.pxc.guestagent.PXCGuestAgentStrategy | -(StrOpt) Class that implements datastore-specific Guest Agent API logic. | -
| [pxc] ignore_users = os_admin, root, clusterrepuser | -(ListOpt) Users to exclude when listing users. | -
| [pxc] min_cluster_member_count = 3 | -(IntOpt) Minimum number of members in PXC cluster. | -
| [pxc] mount_point = /var/lib/mysql | -(StrOpt) Filesystem path for mounting volumes if volume support is enabled. | -
| [pxc] replication_namespace = trove.guestagent.strategies.replication.mysql_gtid | -(StrOpt) Namespace to load replication strategies from. | -
| [pxc] replication_strategy = MysqlGTIDReplication | -(StrOpt) Default strategy for replication. | -
| [pxc] replication_user = slave_user | -(StrOpt) Userid for replication slave. | -
| [pxc] restore_namespace = trove.guestagent.strategies.restore.mysql_impl | -(StrOpt) Namespace to load restore strategies from. | -
| [pxc] root_controller = trove.extensions.common.service.DefaultRootController | -(StrOpt) Root controller implementation for pxc. | -
| [pxc] root_on_create = False | -(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. | -
| [pxc] taskmanager_strategy = trove.common.strategies.cluster.experimental.pxc.taskmanager.PXCTaskManagerStrategy | -(StrOpt) Class that implements datastore-specific task manager logic. | -
| [pxc] tcp_ports = 3306, 4444, 4567, 4568 | -(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| [pxc] udp_ports = | -(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | -
| [pxc] usage_timeout = 450 | -(IntOpt) Maximum time (in seconds) to wait for a Guest to become active. | -
| [pxc] volume_support = True | -(BoolOpt) Whether to provision a Cinder volume for datadir. | -
| [redis] api_strategy = trove.common.strategies.cluster.experimental.redis.api.RedisAPIStrategy | -(StrOpt) Class that implements datastore-specific API logic. | -
| [redis] cluster_support = True | -(BoolOpt) Enable clusters to be created and managed. | -
| [redis] guestagent_strategy = trove.common.strategies.cluster.experimental.redis.guestagent.RedisGuestAgentStrategy | -(StrOpt) Class that implements datastore-specific Guest Agent API logic. | -
| [redis] replication_namespace = trove.guestagent.strategies.replication.experimental.redis_sync | -(StrOpt) Namespace to load replication strategies from. | -
| [redis] root_controller = trove.extensions.common.service.DefaultRootController | -(StrOpt) Root controller implementation for redis. | -
| [redis] taskmanager_strategy = trove.common.strategies.cluster.experimental.redis.taskmanager.RedisTaskManagerStrategy | -(StrOpt) Class that implements datastore-specific task manager logic. | -
| [vertica] root_controller = trove.extensions.vertica.service.VerticaRootController | -(StrOpt) Root controller implementation for Vertica. | -
| Option | -Previous default value | -New default value | -
| [DEFAULT] cluster_usage_timeout | -675 | -36000 | -
| [DEFAULT] default_log_levels | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN | -amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN | -
| [DEFAULT] ignore_dbs | -lost+found, #mysql50#lost+found, mysql, information_schema | -mysql, information_schema, performance_schema | -
| [DEFAULT] logging_exception_prefix | -%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s | -
| [DEFAULT] notification_service_id | -{'vertica': 'a8d805ae-a3b2-c4fd-gb23-b62cee5201ae', 'db2': 'e040cd37-263d-4869-aaa6-c62aa97523b5', 'postgresql': 'ac277e0d-4f21-40aa-b347-1ea31e571720', 'mysql': '2f3ff068-2bfb-4f70-9a9d-a6bb65bc084b', 'couchbase': 'fa62fe68-74d9-4779-a24e-36f19602c415', 'mongodb': 'c8c907af-7375-456f-b929-b637ff9209ee', 'couchdb': 'f0a9ab7b-66f7-4352-93d7-071521d44c7c', 'redis': 'b216ffc5-1947-456c-a4cf-70f94c05f7d0', 'cassandra': '459a230d-4e97-4344-9067-2a54a310b0ed'} | -{'mongodb': 'c8c907af-7375-456f-b929-b637ff9209ee', 'percona': 'fd1723f5-68d2-409c-994f-a4a197892a17', 'mysql': '2f3ff068-2bfb-4f70-9a9d-a6bb65bc084b', 'pxc': '75a628c3-f81b-4ffb-b10a-4087c26bc854', 'db2': 'e040cd37-263d-4869-aaa6-c62aa97523b5', 'cassandra': '459a230d-4e97-4344-9067-2a54a310b0ed', 'mariadb': '7a4f82cc-10d2-4bc6-aadc-d9aacc2a3cb5', 'postgresql': 'ac277e0d-4f21-40aa-b347-1ea31e571720', 'couchbase': 'fa62fe68-74d9-4779-a24e-36f19602c415', 'couchdb': 'f0a9ab7b-66f7-4352-93d7-071521d44c7c', 'redis': 'b216ffc5-1947-456c-a4cf-70f94c05f7d0', 'vertica': 'a8d805ae-a3b2-c4fd-gb23-b62cee5201ae'} | -
| [DEFAULT] report_interval | -10 | -30 | -
| [DEFAULT] rpc_zmq_matchmaker | -local | -redis | -
| [DEFAULT] usage_timeout | -600 | -900 | -
| [DEFAULT] use_syslog_rfc_format | -False | -True | -
| [DEFAULT] verbose | -False | -True | -
| [matchmaker_redis] password | -None | -- |
| [mongodb] backup_namespace | -None | -trove.guestagent.strategies.backup.experimental.mongo_impl | -
| [mongodb] backup_strategy | -None | -MongoDump | -
| [mongodb] restore_namespace | -None | -trove.guestagent.strategies.restore.experimental.mongo_impl | -
| [oslo_messaging_rabbit] heartbeat_timeout_threshold | -0 | -60 | -
| [redis] backup_namespace | -None | -trove.guestagent.strategies.backup.experimental.redis_impl | -
| [redis] backup_strategy | -None | -RedisBackup | -
| [redis] replication_strategy | -None | -RedisSyncReplication | -
| [redis] restore_namespace | -None | -trove.guestagent.strategies.restore.experimental.redis_impl | -
| [redis] tcp_ports | -6379 | -6379, 16379 | -
| [redis] volume_support | -False | -True | -
| Deprecated option | -New Option | -
| [DEFAULT] use_syslog | -None | -
| [DEFAULT] rpc_thread_pool_size | -[DEFAULT] executor_thread_pool_size | -
| [DEFAULT] log_format | -None | -
| Log file | -Description | -
| Logs all attempts to access the web server. | -|
| Logs all unsuccessful attempts to access the web - server, along with the reason that each attempt - failed. | -
[DEFAULT] section. You can override the default values by setting values in the other sections."
-msgstr ""
-
-#: ./doc/config-reference/ch_objectstorageconfigure.xml:18(title)
-msgid "Object server configuration"
-msgstr ""
-
-#: ./doc/config-reference/ch_objectstorageconfigure.xml:19(para)
-msgid "Find an example object server configuration at wsdl_location=http://127.0.0.1:8080/vmware/SDK/wsdl/vim25/vimService.wsdl setting to the above configuration. For more information, see vSphere 5.0 and earlier additional set up."
-msgstr ""
-
-#: ./doc/config-reference/compute/section_hypervisor_vmware.xml:574(para)
-msgid "Clusters: The vCenter driver can support multiple clusters. To use more than one cluster, simply add multiple qemu-img utility."
-msgstr ""
-
-#: ./doc/config-reference/compute/section_hypervisor_vmware.xml:665(para)
-msgid "The following table shows the qemu-img utility, disk images in several formats (such as, qcow2) can be converted to the VMDK format."
-msgstr ""
-
-#: ./doc/config-reference/compute/section_hypervisor_vmware.xml:718(para)
-msgid "For example, the following command can be used to convert a qcow2 Ubuntu Trusty cloud image:"
-msgstr ""
-
-#: ./doc/config-reference/compute/section_hypervisor_vmware.xml:723(para)
-msgid "VMDK disks converted through qemu-img are qemu-img conversion, the command to upload the VMDK disk should be something like:"
-msgstr ""
-
-#: ./doc/config-reference/compute/section_hypervisor_vmware.xml:734(para)
-msgid "Note that the vmware_adaptertype is set to qemu-img utility, the vmware_disktype and vmware_adaptertype might be different. To determine the image adapter type from an image file, use the following command and look for the vmware-vdiskmanager is a utility that comes bundled with VMware Fusion and VMware Workstation. The following example converts a sparse disk to preallocated format:"
-msgstr ""
-
-#: ./doc/config-reference/compute/section_hypervisor_vmware.xml:831(para)
-msgid "In the previous cases, the converted vmdk is actually a pair of files:"
-msgstr ""
-
-#: ./doc/config-reference/compute/section_hypervisor_vmware.xml:833(para)
-msgid "The descriptor file vmware_linked_clone property in the OpenStack Image service to override the linked_clone mode on a per-image basis."
-msgstr ""
-
-#: ./doc/config-reference/compute/section_hypervisor_vmware.xml:864(para)
-msgid "If spawning a virtual machine image from ISO with a VMDK disk, the image is created and attached to the virtual machine as a blank disk. In that case vmware_linked_clone property for the image is just ignored."
-msgstr ""
-
-#: ./doc/config-reference/compute/section_hypervisor_vmware.xml:870(para)
-msgid "If multiple compute nodes are running on the same host, or have a shared file system, you can enable them to use the same cache folder on the back-end data store. To configure this action, set the wsdl_location option. For more information, see VMwareVCDriver configuration options above."
-msgstr ""
-
-#: ./doc/config-reference/compute/section_hypervisor_vmware.xml:972(title)
-msgid "To mirror WSDL from vCenter (or ESXi)"
-msgstr ""
-
-#: ./doc/config-reference/compute/section_hypervisor_vmware.xml:974(para)
-msgid "Set the VMWAREAPI_IP shell variable to the IP address for your vCenter or ESXi host from where you plan to mirror files. For example:"
-msgstr ""
-
-#: ./doc/config-reference/compute/section_hypervisor_vmware.xml:980(para)
-msgid "Create a local file system directory to hold the WSDL files:"
-msgstr ""
-
-#: ./doc/config-reference/compute/section_hypervisor_vmware.xml:985(para)
-msgid "Change into the new directory. storage_domain by looking up the given domain's CNAME record in DNS."
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:193(title)
-msgid "Temporary URL"
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:194(para)
-msgid "Allows the creation of URLs to provide temporary access to objects. For example, a website may wish to provide a link to download a large object in OpenStack Object Storage, but the Object Storage account has no public access. The website can generate a URL that provides GET access for a limited time to the resource. When the web browser user clicks on the link, the browser downloads the object directly from Object Storage, eliminating the need for the website to act as a proxy for the request. If the user shares the link with all his friends, or accidentally posts it on a forum, the direct access is limited to the expiration time set when the website created the link."
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:205(literal)
-msgid "temp_url_sig"
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:207(para)
-msgid "A cryptographic signature"
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:211(literal)
-msgid "temp_url_expires"
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:213(para)
-msgid "An expiration date, in Unix time"
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:202(para)
-msgid "A temporary URL is the typical URL associated with an object, with two additional query parameters:/v1/AUTH_account/container/object:"
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:266(para)
-msgid "Any alteration of the resource path or query arguments results in a container_quotas middleware implements simple quotas that can be imposed on Object Storage containers by a user with the ability to set container metadata, most likely the account administrator. This can be useful for limiting the scope of containers that are delegated to non-admin users, exposed to form uploads, or just as a self-imposed sanity check."
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:498(para)
-msgid "Any object operations that exceed these quotas return a Forbidden (403) status code."
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:500(para)
-msgid "Quotas are subject to several limitations: eventual consistency, the timeliness of the cached container_info (60 second TTL by default), and it is unable to reject chunked transfer uploads that exceed the quota (though once the quota is exceeded, new chunked transfers are refused)."
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:506(para)
-msgid "Set quotas by adding meta values to the container. These values are validated when you set them:"
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:510(para)
-msgid "X-Container-Meta-Quota-Bytes: Maximum size of the container, in bytes."
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:514(para)
-msgid "X-Container-Meta-Quota-Count: Maximum object count of the container."
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:523(title)
-msgid "Account quotas"
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:524(para)
-msgid "The bulk-delete to delete multiple files from an account with a single request. Responds to DELETE requests with a header 'X-Bulk-Delete: true_value'. The body of the DELETE request is a new line-separated list of files to delete. The files listed must be URL encoded and in the form:"
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:567(para)
-msgid "If all files are successfully deleted (or did not exist), the operation returns HTTPOk. If any files failed to delete, the operation returns HTTPBadGateway. In both cases, the response body is a JSON dictionary that shows the number of files that were successfully deleted or not found. The files that failed are listed."
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:580(title)
-msgid "Drive audit"
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:581(para)
-msgid "The 1440619048 is equivalent to Mon, Wed, 26 Aug 2015 19:57:28 GMT."
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:706(literal)
-msgid "name=\"signature\""
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:708(para)
-msgid "The HMAC-SHA1 signature of the form. This sample Python code shows how to compute the signature:"
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_object-storage-features.xml:724(para)
-msgid "The key is the value of the [filter:swift3] section, as shown below:"
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_configure_s3.xml:61(para)
-msgid "Next, configure the tool that you use to connect to the S3 API. For S3curl, for example, you must add your host IP information by adding your host IP to the @endpoints array (line 33 in s3curl.pl):"
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_configure_s3.xml:66(para)
-msgid "Now you can send commands to the endpoint, such as:"
-msgstr ""
-
-#: ./doc/config-reference/object-storage/section_configure_s3.xml:69(para)
-msgid "To set up your client, ensure you are using the ec2 credentials, which can be downloaded from the zfssa_target_interfaces."
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:96(para)
-msgid "Create and delete volumes"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:99(para)
-msgid "Extend volume"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:102(para)
-msgid "Create and delete snapshots"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:105(para)
-msgid "Create volume from snapshot"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:108(para)
-msgid "Delete volume snapshots"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:111(para) ./doc/config-reference/block-storage/drivers/zfssa-nfs-driver.xml:21(para)
-msgid "Attach and detach volumes"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:114(para)
-msgid "Get volume stats"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:117(para)
-msgid "Clone volumes"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:120(para) ./doc/config-reference/block-storage/drivers/zfssa-nfs-driver.xml:39(para)
-msgid "Volume migration"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:123(para) ./doc/config-reference/block-storage/drivers/zfssa-nfs-driver.xml:42(para)
-msgid "Local cache of a bootable volume"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:128(title)
-msgid "ZFSSA assisted volume migration"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:129(para)
-msgid "The ZFSSA iSCSI driver supports storage assisted volume migration starting in the Liberty release. This feature uses remote replication feature on the ZFSSA. Volumes can be migrated between two backends configured not only to the same ZFSSA but also between two separate ZFSSAs altogether."
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:134(para)
-msgid "The following conditions must be met in order to use ZFSSA assisted volume migration:"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:139(para)
-msgid "Both the source and target backends are configured to ZFSSAs."
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:142(para)
-msgid "Remote replication service on the source and target appliance is enabled."
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml:145(para)
-msgid "The ZFSSA to which the target backend is configured should be configured as a target in the remote replication service of the ZFSSA configured to the source backend. The remote replication target needs to be configured even when the source and the destination for volume migration are the same ZFSSA. Define san_ip = ScaleIO MDM IP "
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-scaleio-driver.xml:67(title)
-msgid "ScaleIO protection domain name"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-scaleio-driver.xml:68(para)
-msgid "ScaleIO allows multiple protection domains (groups of SDSs that provide backup for each other)."
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-scaleio-driver.xml:69(para)
-msgid "To retrieve the available protection domains, use the sio_protection_domain_name = ScaleIO Protection Domain "
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-scaleio-driver.xml:75(title)
-msgid "ScaleIO storage pool name"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-scaleio-driver.xml:76(para)
-msgid "A ScaleIO storage pool is a set of physical devices in a protection domain."
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-scaleio-driver.xml:77(para) ./doc/config-reference/block-storage/drivers/emc-scaleio-driver.xml:85(para)
-msgid "To retrieve the available storage pools, use the sio_storage_pool_name = ScaleIO Storage Pool "
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-scaleio-driver.xml:83(title)
-msgid "ScaleIO storage pools"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-scaleio-driver.xml:84(para)
-msgid "Multiple storage pools and protection domains can be listed for use by the virtual machines."
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-scaleio-driver.xml:87(para)
-msgid "Configure the available storage pools by adding the following parameter: sio_storage_pools = Comma separated list of protection domain:storage pool name "
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-scaleio-driver.xml:91(title)
-msgid "ScaleIO user credentials"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-scaleio-driver.xml:92(para)
-msgid "OpenStack Block Storage requires a ScaleIO user with administrative privileges. ScaleIO recommends creating a dedicated OpenStack user account that holds an administrative user role."
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-scaleio-driver.xml:94(para)
-msgid "Refer to the vmdk_type extra spec entry, the disk file type will default to lazyZeroedThick VMDK volume by using the appropriate vmdk_type:"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml:115(title) ./doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml:127(td)
-msgid "Clone type"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml:116(para)
-msgid "With the VMware VMDK drivers, you can create a volume from another source volume or a snapshot point. The VMware vCenter VMDK driver supports the vmware:clone_type extra spec key to specify the clone type. The following table captures the mapping for clone types:"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml:124(caption)
-msgid "Extra spec entry to clone type mapping"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml:134(td) ./doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml:136(td)
-msgid "full"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml:135(td) ./doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml:140(td)
-msgid "vmware:clone_type"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml:139(td)
-msgid "linked/fast"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml:141(td)
-msgid "linked"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml:145(para)
-msgid "If you do not specify the clone type, the default is volume_driver = cinder.volume.drivers.emc.xtremio.XtremIOIscsiDriver"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-xtremio-driver.xml:64(para)
-msgid "For Fibre Channel volume_driver = cinder.volume.drivers.emc.xtremio.XtremIOFibreChannelDriver"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-xtremio-driver.xml:69(title)
-msgid "XtremIO management server (XMS) IP"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-xtremio-driver.xml:70(para)
-msgid "To retrieve the management IP, use the san_ip = XMS Management IP "
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-xtremio-driver.xml:75(title)
-msgid "XtremIO cluster name"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-xtremio-driver.xml:76(para)
-msgid "In XtremIO version 4.0, a single XMS can manage multiple cluster back ends. In such setups, the administrator is required to specify the cluster name (in addition to the XMS IP). Each cluster must be defined as a separate back end."
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-xtremio-driver.xml:78(para)
-msgid "To retrieve the Cluster Name, run the xtremio_cluster_name = Cluster-Name"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-xtremio-driver.xml:80(para)
-msgid "When a single cluster is managed in XtremIO version 4.0, the cluster name is not required."
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-xtremio-driver.xml:83(title)
-msgid "XtremIO user credentials"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-xtremio-driver.xml:84(para)
-msgid "OpenStack Block Storage requires an XtremIO XMS user with administrative privileges. XtremIO recommends creating a dedicated OpenStack user account that holds an administrative user role."
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-xtremio-driver.xml:86(para)
-msgid "Refer to the max_over_subscription_ratio parameter."
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/emc-xtremio-driver.xml:107(para)
-msgid "The use_cow_images parameter in theuse_multipath_for_image_xfer parameter in theceph-mon daemons on separate servers."
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/ceph-rbd-volume-driver.xml:58(para)
-msgid "Ceph developers recommend XFS for production deployments, '+ssd +10.0.0.0 +6nines -production iops.reserve=1000 capacity.reserve=30%'. This query is satisfied by selecting SSD resources, accessible on the 10.0.0.0 network, with high resiliency, for non-production workloads, with guaranteed IOPS of 1000 and a storage reservation for 30% of the volume capacity specified at create time. Queries and parameters are completely administrator defined: they reflect the layout, resource, and organizational goals of a specific deployment."
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/blockbridge-eps-driver.xml:125(title)
-msgid "Supported protocols"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/blockbridge-eps-driver.xml:126(para)
-msgid "Blockbridge provides iSCSI access to storage. A unique iSCSI data fabric is programmatically assembled when a volume is attached to an instance. A fabric is disassembled when a volume is detached from an instance. Each volume is an isolated SCSI device that supports persistent reservations."
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/blockbridge-eps-driver.xml:134(title)
-msgid "Configuration steps"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/blockbridge-eps-driver.xml:136(title)
-msgid "Create an authentication token"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/blockbridge-eps-driver.xml:137(para)
-msgid "Whenever possible, avoid using password-based authentication. Even if you have created a role-restricted administrative user via Blockbridge, token-based authentication is preferred. You can generate persistent authentication tokens using the Blockbridge command-line tool as follows:"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/blockbridge-eps-driver.xml:167(title)
-msgid "Create volume type"
-msgstr ""
-
-#: ./doc/config-reference/block-storage/drivers/blockbridge-eps-driver.xml:168(para)
-msgid "Before configuring and enabling the Blockbridge volume driver, register an OpenStack volume type and associate it with a volume_backend_name. In this example, a volume type, 'Production', is associated with the volume_backend_name 'blockbridge_prod': volume_backend_name must match the value specified in the '+openstack'. Within Blockbridge, datastore resources that advertise the 'openstack' attribute will be selected to fulfill OpenStack provisioning requests. If you prefer a more specific query, define a custom pool configuration. volume_backend_name and pool configuration for each type. The | - Log file - | -- Service/interface - | -
|
- |
-
- |
-
|
- |
-
- |
-
|
- |
-
- |
-
|
- |
-
- |
-
|
- |
-
- |
-
|
- |
-
- |
-
|
- |
-
- |
-
|
- |
-
- |
-
[filter:swift3]
- section, as shown below:| Container Size | -Rate Limit | -
| 0-99 | -No limiting | -
| 100 | -100 | -
| 150 | -75 | -
| 500 | -20 | -
| 1000 | -20 | -
storage_domain by looking up the given domain's CNAME
- record in DNS./v1/AUTH_account/container/object:container_quotas middleware implements simple
- quotas that can be imposed on Object Storage containers by a user
- with the ability to set container metadata, most likely the
- account administrator. This can be useful for limiting the scope
- of containers that are delegated to non-admin users, exposed to
- form &POST; uploads, or just as a self-imposed sanity check.
- bulk-delete to delete multiple files
- from an account
- with a single request. Responds to DELETE requests with a
- header 'X-Bulk-Delete: true_value'. The body of the DELETE
- request is a new line-separated list of files to delete.
- The files listed must be URL encoded and in the
- form:HTTPOk. If any
- files failed to delete, the operation returns
- HTTPBadGateway. In both cases, the response body
- is a JSON dictionary that shows the number of files that were
- successfully deleted or not found. The files that failed are
- listed.1440619048 is equivalent to
- Mon, Wed, 26 Aug 2015 19:57:28 GMT.
- 1440619048 is equivalent to
- Mon, Wed, 26 Aug 2015 19:57:28 GMT.
- --- share_driver = manila.share.drivers.emc.driver.EMCShareDriver - emc_share_backend = isilon emc_nas_server = <IP address of - Isilon cluster> emc_nas_login = <username> - emc_nas_password = <password> isilon_share_root_dir = - <directory on Isilon where shares will be created> - -
--- server_cifs <mover_name> | head where: mover_name = - <name of the Data Mover> - -
--- uc_config -on -mover <mover_name> where: mover_name = - <name of the Data Mover> - -
--- server_setup <mover_name> -Protocol cifs -option start - [=<n>] where: <mover_name> = <name of the Data - Mover> [=<n>] = <number of threads for CIFS - users> - -
--- server_cifs <mover_name> | head where: <mover_name> - = <name of the Data Mover> - -
--- server_date <mover_name> where: mover_name = <name of - the Data Mover> - -
--- server_date <mover_name> timesvc start ntp <host> - [<host> ...] where: mover_name = <name of the Data - Mover> host = <IP address of the time server host> - -
--- server_usermapper <movername> where: <movername> = - <name of the Data Mover> - -
--- server_usermapper <movername> -enable where: - <movername> = <name of the Data Mover> - -
--- emc_share_backend = vnx emc_nas_server = <IP address> - emc_nas_password = <password> emc_nas_login = <user> - emc_nas_server_container = <Data Mover name> - emc_nas_pool_name = <pool name> share_driver = - manila.share.drivers.emc.driver.EMCShareDriver - -
--- -- -- ro and rw are not allowed (will be determined by the driver). - -- -- no_subtree_check and fsid are not allowed per HPE 3PAR CLI - support. - -- -- (in)secure and (no_)root_squash are not allowed because the - HPE 3PAR driver controls those settings. - -
--- As far as the Shared File Systems service requires share type for creation of shares, make - sure that used share type has extra spec driver_handles_share_servers set to False - otherwise Huawei back end will be filtered by manila-scheduler. If you do not provide - share type with share creation request then default share type and its extra specs will be - used.
--- snapshot_support will be reported as True for backends that support all snapshot - functionalities, including create_snapshot, delete_snapshot, and - create_share_from_snapshot. Huawei Driver does not support create_share_from_snapshot API - now, so make sure that used share type has extra spec snapshot_support set to False.
| - Log file - | -- Service/interface (for CentOS, Fedora, openSUSE, Red Hat - Enterprise Linux, and SUSE Linux Enterprise) - | -- Service/interface (for Ubuntu and Debian) - | -
|
- |
-
- |
-
- |
-
|
- |
-
- |
-
- |
-
|
- |
-
- |
-
- |
-
|
- |
-
- |
-
- |
-
| Service | -Default port | -Used by | -
|---|---|---|
| HTTP | -80 | -OpenStack dashboard ( |
-
| HTTP alternate | -8080 | -OpenStack Object Storage
- ( |
-
| HTTPS | -443 | -Any OpenStack service that is enabled for SSL, - especially secure-access dashboard. | -
| rsync | -873 | -OpenStack Object Storage. Required. | -
| iSCSI target | -3260 | -OpenStack Block Storage. Required. | -
| MySQL database service | -3306 | -Most OpenStack components. | -
| Message Broker (AMQP traffic) | -5672 | -OpenStack Block Storage, Networking, - Orchestration, and Compute. | -
| OpenStack service | -Default ports | -Port type | -
|---|---|---|
| Block Storage ( |
- 8776 | -publicurl and adminurl | -
| Compute ( |
- 8774 | -publicurl and adminurl | -
| Compute API ( |
- 8773, 8775 | -- |
| Compute ports for access to virtual machine - consoles | -5900-5999 | -- |
| Compute VNC proxy for browsers (
- |
- 6080 | -- |
| Compute VNC proxy for traditional VNC clients
- ( |
- 6081 | -- |
| Proxy port for HTML5 console used by Compute - service | -6082 | -- |
| Data processing service ( |
- 8386 | -publicurl and adminurl | -
| Identity service ( |
- 35357 | -adminurl | -
| Identity service public endpoint | -5000 | -publicurl | -
| Image service ( |
- 9292 | -publicurl and adminurl | -
| Image service registry | -9191 | -- |
| Networking ( |
- 9696 | -publicurl and adminurl | -
| Object Storage ( |
- 6000, 6001, 6002 | -- |
| Orchestration ( |
- 8004 | -publicurl and adminurl | -
| Orchestration AWS CloudFormation-compatible API
- ( |
- 8000 | -- |
| Orchestration AWS CloudWatch-compatible API
- ( |
- 8003 | -- |
| Telemetry ( |
- 8777 | -publicurl and adminurl | -
| Application Catalog ( |
- 8082 | -