Chapter 10. manila

admin_network_config_group = None

string value

If share driver requires to setup admin network for share, then define network plugin config options in some separate config group and set its name here. Used only with another option driver_handles_share_servers set to True.

admin_network_id = None

string value

ID of neutron network used to communicate with admin network, to create additional admin export locations on.

admin_subnet_id = None

string value

ID of neutron subnet used to communicate with admin network, to create additional admin export locations on. Related to admin_network_id.

api_paste_config = api-paste.ini

string value

File name for the paste.deploy config for api service

api_rate_limit = True

boolean value

Whether to rate limit the API.

as13000_nas_ip = None

host address value

IP address for the AS13000 storage.

as13000_nas_login = None

string value

Username for the AS13000 storage

as13000_nas_password = None

string value

Password for the AS13000 storage

as13000_nas_port = 8088

port value

Port number for the AS13000 storage.

as13000_share_pools = None

list value

The Storage Pools Manila should use, a comma separated list

as13000_token_available_time = 3600

integer value

The effective time of token validity in seconds.

auth_strategy = keystone

string value

The strategy to use for auth. Supports noauth, keystone, and noauthv2.

automatic_share_server_cleanup = True

boolean value

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.

backdoor_port = None

string value

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.

backdoor_socket = None

string value

Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with backdoor_port in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option. Inside the path {pid} will be replaced with the PID of the current process.

backend_availability_zone = None

string value

Availability zone for this share backend. If not set, the storage_availability_zone option from the [DEFAULT] section is used.

backend_url = file://$state_path

string value

The back end URL to use for distributed coordination.

capacity_weight_multiplier = 1.0

floating point value

Multiplier used for weighing share capacity. Negative numbers mean to stack vs spread.

cephfs_auth_id = manila

string value

The name of the ceph auth identity to use.

cephfs_cluster_name = None

string value

The name of the cluster in use, if it is not the default (ceph).

`cephfs_conf_path = `

string value

Fully qualified path to the ceph.conf file.

cephfs_filesystem_name = None

string value

The name of the filesystem to use, if there are multiple filesystems in the cluster.

`cephfs_ganesha_export_ips = `

list value

List of IPs to export shares. If not supplied, then the value of cephfs_ganesha_server_ip will be used to construct share export locations.

cephfs_ganesha_path_to_private_key = None

string value

The path of the driver host’s private SSH key file.

cephfs_ganesha_server_ip = None

host address value

The IP address of the NFS-Ganesha server.

cephfs_ganesha_server_is_remote = False

boolean value

Whether the NFS-Ganesha server is remote to the driver.

cephfs_ganesha_server_password = None

string value

The password to authenticate as the user in the remote Ganesha server host. This is not required if cephfs_ganesha_path_to_private_key is configured.

cephfs_ganesha_server_username = root

string value

The username to authenticate as in the remote NFS-Ganesha server host.

cephfs_protocol_helper_type = CEPHFS

string value

The type of protocol helper to use. Default is CEPHFS.

cephfs_volume_mode = 755

string value

The read/write/execute permissions mode for CephFS volumes, snapshots, and snapshot groups expressed in Octal as with linux chmod or umask commands.

cephfs_volume_path_prefix = /volumes

string value

The prefix of the cephfs volume path. Deprecated since: Wallaby

*Reason:*This option is not used starting with the Nautilus release of Ceph.

cinder_volume_type = None

string value

Name or id of cinder volume type which will be used for all volumes created by driver.

client_socket_timeout = 900

integer value

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.

compute_api_class = manila.compute.nova.API

string value

The full class name of the Compute API class to use.

conn_pool_min_size = 2

integer value

The pool size limit for connections expiration policy

conn_pool_ttl = 1200

integer value

The time-to-live in sec of idle connections in the pool

connect_share_server_to_tenant_network = False

boolean value

Attach share server directly to share network. Used only with Neutron and if driver_handles_share_servers=True.

container_cifs_guest_ok = True

boolean value

Determines whether to allow guest access to CIFS share or not.

container_helper = manila.share.drivers.container.container_helper.DockerExecHelper

string value

Container helper which provides container-related operations to the driver.

container_image_name = manila-docker-container

string value

Image to be used for a container-based share server.

container_linux_bridge_name = docker0

string value

Linux bridge used by container hypervisor to plug host-side veth to. It will be unplugged from here by the driver.

container_ovs_bridge_name = br-int

string value

OVS bridge to use to plug a container to.

container_protocol_helper = manila.share.drivers.container.protocol_helper.DockerCIFSHelper

string value

Helper which facilitates interaction with share server.

container_security_service_helper = manila.share.drivers.container.security_service_helper.SecurityServiceHelper

string value

Helper which facilitates interaction with security services.

container_storage_helper = manila.share.drivers.container.storage_helper.LVMHelper

string value

Helper which facilitates interaction with storage solution used to actually store data. By default LVM is used to provide storage for a share.

container_volume_group = manila_docker_volumes

string value

LVM volume group to use for volumes. This volume group must be created by the cloud administrator independently from manila operations.

container_volume_mount_path = /tmp/shares

string value

Folder name in host to which logical volume will be mounted prior to providing access to it from a container.

control_exchange = openstack

string value

The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.

data_access_wait_access_rules_timeout = 180

integer value

Time to wait for access rules to be allowed/denied on backends when migrating a share (seconds).

data_manager = manila.data.manager.DataManager

string value

Full class name for the data manager.

data_node_access_admin_user = None

string value

The admin user name registered in the security service in order to allow access to user authentication-based shares.

data_node_access_cert = None

string value

The certificate installed in the data node in order to allow access to certificate authentication-based shares.

data_node_access_ips = []

list value

A list of the IPs of the node interface connected to the admin network. Used for allowing access to the mounting shares. Default is [].

data_node_mount_options = {}

dict value

Mount options to be included in the mount command for share protocols. Use dictionary format, example: {nfs: -o nfsvers=3, cifs: -o user=foo,pass=bar}

data_topic = manila-data

string value

The topic data nodes listen on.

db_backend = sqlalchemy

string value

The backend to use for database.

db_driver = manila.db

string value

Driver to use for database access.

debug = False

boolean value

If set to true, the logging level will be set to DEBUG instead of the default INFO level.

default_log_levels = ['amqp=WARN', 'amqplib=WARN', 'boto=WARN', 'qpid=WARN', 'sqlalchemy=WARN', 'suds=INFO', 'oslo.messaging=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', 'keystoneauth=WARN', 'oslo.cache=INFO', 'oslo_policy=INFO', 'dogpile.core.dogpile=INFO']

list value

List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.

default_share_group_type = None

string value

Default share group type to use.

default_share_type = None

string value

Default share type to use.

delete_share_server_with_last_share = False

boolean value

Whether share servers will be deleted on deletion of the last share.

driver_handles_share_servers = None

boolean value

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.

drivers_private_storage_class = manila.share.drivers_private_data.SqlStorageDriver

string value

The full class name of the Private Data Driver class to use.

emc_nas_login = None

string value

User name for the EMC server.

emc_nas_password = None

string value

Password for the EMC server.

emc_nas_root_dir = None

string value

The root directory where shares will be located.

emc_nas_server = None

host address value

EMC server hostname or IP address.

emc_nas_server_port = 8080

port value

Port number for the EMC server.

emc_nas_server_secure = True

boolean value

Use secure connection to server.

emc_share_backend = None

string value

Share backend.

emc_ssl_cert_path = None

string value

Can be used to specify a non default path to a CA_BUNDLE file or directory with certificates of trusted CAs, which will be used to validate the backend.

emc_ssl_cert_verify = True

boolean value

If set to False the https client will not validate the SSL certificate of the backend endpoint.

enable_gathering_share_usage_size = False

boolean value

If set to True, share usage size will be polled for in the interval specified with "share_usage_size_update_interval". Usage data can be consumed by telemetry integration. If telemetry is not configured, this option must be set to False. If set to False - gathering share usage size will be disabled.

enable_new_services = True

boolean value

Services to be added to the available pool on create.

enable_periodic_hooks = False

boolean value

Whether to enable periodic hooks or not.

enable_post_hooks = False

boolean value

Whether to enable post hooks or not.

enable_pre_hooks = False

boolean value

Whether to enable pre hooks or not.

enabled_share_backends = None

list value

A list of share backend names to use. These backend names should be backed by a unique [CONFIG] group with its options.

enabled_share_protocols = ['NFS', 'CIFS']

list value

Specify list of protocols to be allowed for share creation. Available values are ['NFS, CIFS, GLUSTERFS, HDFS, CEPHFS, MAPRFS]'

executor_thread_pool_size = 64

integer value

Size of executor thread pool when executor is threading or eventlet.

fatal_deprecations = False

boolean value

Enables or disables fatal status of deprecations.

fatal_exception_format_errors = False

boolean value

Whether to make exception message format errors fatal.

filter_function = None

string value

String representation for an equation that will be used to filter hosts.

flashblade_api = None

string value

API token for an administrative user account

flashblade_data_vip = None

host address value

The name (or IP address) for the Pure Storage FlashBlade storage system data VIP.

flashblade_eradicate = True

boolean value

When enabled, all FlashBlade file systems and snapshots will be eradicated at the time of deletion in Manila. Data will NOT be recoverable after a delete with this set to True! When disabled, file systems and snapshots will go into pending eradication state and can be recovered.)

flashblade_mgmt_vip = None

host address value

The name (or IP address) for the Pure Storage FlashBlade storage system management VIP.

ganesha_config_dir = /etc/ganesha

string value

Directory where Ganesha config files are stored.

ganesha_config_path = $ganesha_config_dir/ganesha.conf

string value

Path to main Ganesha config file.

ganesha_db_path = $state_path/manila-ganesha.db

string value

Location of Ganesha database file. (Ganesha module only.)

ganesha_export_dir = $ganesha_config_dir/export.d

string value

Path to directory containing Ganesha export configuration. (Ganesha module only.)

ganesha_export_template_dir = /etc/manila/ganesha-export-templ.d

string value

Path to directory containing Ganesha export block templates. (Ganesha module only.)

ganesha_rados_export_counter = ganesha-export-counter

string value

Name of the Ceph RADOS object used as the Ganesha export counter.

ganesha_rados_export_index = ganesha-export-index

string value

Name of the Ceph RADOS object used to store a list of the export RADOS object URLS.

ganesha_rados_store_enable = False

boolean value

Persist Ganesha exports and export counter in Ceph RADOS objects, highly available storage.

ganesha_rados_store_pool_name = None

string value

Name of the Ceph RADOS pool to store Ganesha exports and export counter.

ganesha_service_name = ganesha.nfsd

string value

Name of the ganesha nfs service.

glusterfs_ganesha_server_ip = None

host address value

Remote Ganesha server node’s IP address.

glusterfs_ganesha_server_password = None

string value

Remote Ganesha server node’s login password. This is not required if glusterfs_path_to_private_key is configured.

glusterfs_ganesha_server_username = root

string value

Remote Ganesha server node’s username.

glusterfs_mount_point_base = $state_path/mnt

string value

Base directory containing mount points for Gluster volumes.

glusterfs_nfs_server_type = Gluster

string value

Type of NFS server that mediate access to the Gluster volumes (Gluster or Ganesha).

glusterfs_path_to_private_key = None

string value

Path of Manila host’s private SSH key file.

glusterfs_server_password = None

string value

Remote GlusterFS server node’s login password. This is not required if glusterfs_path_to_private_key is configured.

glusterfs_servers = []

list value

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.

glusterfs_share_layout = None

string value

Specifies GlusterFS share layout, that is, the method of associating backing GlusterFS resources to shares.

glusterfs_target = None

string value

Specifies the GlusterFS volume to be mounted on the Manila host. It is of the form [remoteuser@]<volserver>:<volid>.

glusterfs_volume_pattern = None

string value

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.

goodness_function = None

string value

String representation for an equation that will be used to determine the goodness of a host.

gpfs_mount_point_base = $state_path/mnt

string value

Base folder where exported shares are located.

gpfs_nfs_server_list = None

list value

A list of the fully qualified NFS server names that make up the OpenStack Manila configuration.

gpfs_nfs_server_type = CES

string value

NFS Server type. Valid choices are "CES" (Ganesha NFS) or "KNFS" (Kernel NFS).

gpfs_share_export_ip = None

host address value

IP to be added to GPFS export string.

gpfs_share_helpers = ['KNFS=manila.share.drivers.ibm.gpfs.KNFSHelper', 'CES=manila.share.drivers.ibm.gpfs.CESHelper']

list value

Specify list of share export helpers.

gpfs_ssh_login = None

string value

GPFS server SSH login name.

gpfs_ssh_password = None

string value

GPFS server SSH login password. The password is not needed, if gpfs_ssh_private_key is configured.

gpfs_ssh_port = 22

port value

GPFS server SSH port.

gpfs_ssh_private_key = None

string value

Path to GPFS server SSH private key for login.

graceful_shutdown_timeout = 60

integer value

Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait.

hdfs_namenode_ip = None

host address value

The IP of the HDFS namenode.

hdfs_namenode_port = 9000

port value

The port of HDFS namenode service.

hdfs_ssh_name = None

string value

HDFS namenode ssh login name.

hdfs_ssh_port = 22

port value

HDFS namenode SSH port.

hdfs_ssh_private_key = None

string value

Path to HDFS namenode SSH private key for login.

hdfs_ssh_pw = None

string value

HDFS namenode SSH login password, This parameter is not necessary, if hdfs_ssh_private_key is configured.

hitachi_hnas_admin_network_ip = None

host address value

Specify IP for mounting shares in the Admin network.

hitachi_hnas_allow_cifs_snapshot_while_mounted = False

boolean value

By default, CIFS snapshots are not allowed to be taken when the share has clients connected because consistent point-in-time replica cannot be guaranteed for all files. Enabling this might cause inconsistent snapshots on CIFS shares.

hitachi_hnas_cluster_admin_ip0 = None

host address value

The IP of the clusters admin node. Only set in HNAS multinode clusters.

hitachi_hnas_driver_helper = manila.share.drivers.hitachi.hnas.ssh.HNASSSHBackend

string value

Python class to be used for driver helper.

hitachi_hnas_evs_id = None

integer value

Specify which EVS this backend is assigned to.

hitachi_hnas_evs_ip = None

host address value

Specify IP for mounting shares.

hitachi_hnas_file_system_name = None

string value

Specify file-system name for creating shares.

hitachi_hnas_ip = None

host address value

HNAS management interface IP for communication between Manila controller and HNAS.

hitachi_hnas_password = None

string value

HNAS user password. Required only if private key is not provided.

hitachi_hnas_ssh_private_key = None

string value

RSA/DSA private key value used to connect into HNAS. Required only if password is not provided.

hitachi_hnas_stalled_job_timeout = 30

integer value

The time (in seconds) to wait for stalled HNAS jobs before aborting.

hitachi_hnas_user = None

string value

HNAS username Base64 String in order to perform tasks such as create file-systems and network interfaces.

hitachi_hsp_host = None

host address value

HSP management host for communication between Manila controller and HSP.

hitachi_hsp_password = None

string value

HSP password for the username provided.

hitachi_hsp_username = None

string value

HSP username to perform tasks such as create filesystems and shares.

hook_drivers = []

list value

Driver(s) to perform some additional actions before and after share driver actions and on a periodic basis. Default is [].

host = <based on operating system>

host address value

Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.

`hpe3par_api_url = `

string value

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

hpe3par_cifs_admin_access_domain = LOCAL_CLUSTER

string value

File system domain for the CIFS admin user.

`hpe3par_cifs_admin_access_password = `

string value

File system admin password for CIFS.

`hpe3par_cifs_admin_access_username = `

string value

File system admin user name for CIFS.

hpe3par_debug = False

boolean value

Enable HTTP debugging to 3PAR

hpe3par_fpg = None

FPG

The File Provisioning Group (FPG) to use

hpe3par_fstore_per_share = False

boolean value

Use one filestore per share

`hpe3par_password = `

string value

3PAR password for the user specified in hpe3par_username

hpe3par_require_cifs_ip = False

boolean value

Require IP access rules for CIFS (in addition to user)

hpe3par_san_ip = None

host address value

IP address of SAN controller

`hpe3par_san_login = `

string value

Username for SAN controller

`hpe3par_san_password = `

string value

Password for SAN controller

hpe3par_san_ssh_port = 22

port value

SSH port to use with SAN

hpe3par_share_mount_path = /mnt/

string value

The path where shares will be mounted when deleting nested file trees.

`hpe3par_username = `

string value

3PAR username with the edit role

image_api_class = manila.image.glance.API

string value

The full class name of the Glance API class to use.

infinibox_hostname = None

host address value

The name (or IP address) for the INFINIDAT Infinibox storage system.

infinibox_login = None

string value

Administrative user account name used to access the INFINIDAT Infinibox storage system.

infinibox_password = None

string value

Password for the administrative user account specified in the infinibox_login option.

infinidat_nas_network_space_name = None

string value

Name of the NAS network space on the INFINIDAT InfiniBox.

infinidat_pool_name = None

string value

Name of the pool from which volumes are allocated.

infinidat_suppress_ssl_warnings = False

boolean value

Suppress requests library SSL certificate warnings.

infinidat_thin_provision = True

boolean value

Use thin provisioning.

infinidat_use_ssl = False

boolean value

Use SSL to connect to the INFINIDAT Infinibox storage system.

infortrend_nas_ip = None

host address value

Infortrend NAS IP for management.

infortrend_nas_password = None

string value

Password for the Infortrend NAS server. This is not necessary if infortrend_nas_ssh_key is set.

infortrend_nas_ssh_key = None

string value

SSH key for the Infortrend NAS server. This is not necessary if infortrend_nas_password is set.

infortrend_nas_user = manila

string value

User for the Infortrend NAS server.

infortrend_share_channels = None

list value

Comma separated list of Infortrend channels.

infortrend_share_pools = None

list value

Comma separated list of Infortrend NAS pools.

infortrend_ssh_timeout = 30

integer value

SSH timeout in seconds.

`instance_format = [instance: %(uuid)s] `

string value

The format for an instance that is passed with the log message.

`instance_uuid_format = [instance: %(uuid)s] `

string value

The format for an instance UUID that is passed with the log message.

instorage_nas_ip = None

host address value

IP address for the InStorage.

instorage_nas_login = None

string value

Username for the InStorage.

instorage_nas_password = None

string value

Password for the InStorage.

instorage_nas_pools = None

list value

The Storage Pools Manila should use, a comma separated list.

instorage_nas_port = 22

port value

Port number for the InStorage.

interface_driver = manila.network.linux.interface.OVSInterfaceDriver

string value

Module path to the Virtual Interface (VIF) driver class. This option is used only by drivers operating in driver_handles_share_servers=True mode that provision OpenStack compute instances as share servers. This option is only supported with Neutron networking. Drivers provided in tree work with Linux Bridge (manila.network.linux.interface.BridgeInterfaceDriver) and OVS (manila.network.linux.interface.OVSInterfaceDriver). If the manila-share service is running on a host that is connected to the administrator network, a no-op driver (manila.network.linux.interface.NoopInterfaceDriver) may be used.

is_gpfs_node = False

boolean value

True:when Manila services are running on one of the Spectrum Scale node. False:when Manila services are not running on any of the Spectrum Scale node.

knfs_export_options = rw,sync,no_root_squash,insecure,no_wdelay,no_subtree_check

string value

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.

limit_ssh_access = False

boolean value

Block SSH connection to the service instance from other networks than service network.

log-config-append = None

string value

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-date-format).

log-date-format = %Y-%m-%d %H:%M:%S

string value

Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.

log-dir = None

string value

(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.

log-file = None

string value

(Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.

log_options = True

boolean value

Enables or disables logging values of all registered options when starting a service (at DEBUG level).

log_rotate_interval = 1

integer value

The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval".

log_rotate_interval_type = days

string value

Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation.

log_rotation_type = none

string value

Log rotation type.

logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s

string value

Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter

logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d

string value

Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter

logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s

string value

Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter

logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s

string value

Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter

logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s

string value

Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter

lvm_share_export_ips = None

list value

List of IPs to export shares belonging to the LVM storage driver.

lvm_share_export_root = $state_path/mnt

string value

Base folder where exported shares are located.

lvm_share_helpers = ['CIFS=manila.share.drivers.helpers.CIFSHelperUserAccess', 'NFS=manila.share.drivers.helpers.NFSHelper']

list value

Specify list of share export helpers.

lvm_share_mirrors = 0

integer value

If set, create LVMs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space.

lvm_share_volume_group = lvm-shares

string value

Name for the VG that will contain exported shares.

manila_huawei_conf_file = /etc/manila/manila_huawei_conf.xml

string value

The configuration file for the Manila Huawei driver.

manila_service_keypair_name = manila-service

string value

Keypair name that will be created and used for service instances. Only used if driver_handles_share_servers=True.

maprfs_base_volume_dir = /

string value

Path in MapRFS where share volumes must be created.

maprfs_cldb_ip = None

list value

The list of IPs or hostnames of CLDB nodes.

maprfs_clinode_ip = None

list value

The list of IPs or hostnames of nodes where mapr-core is installed.

maprfs_rename_managed_volume = True

boolean value

Specify whether existing volume should be renamed when start managing.

maprfs_ssh_name = mapr

string value

Cluster admin user ssh login name.

maprfs_ssh_port = 22

port value

CLDB node SSH port.

maprfs_ssh_private_key = None

string value

Path to SSH private key for login.

maprfs_ssh_pw = None

string value

Cluster node SSH login password, This parameter is not necessary, if maprfs_ssh_private_key is configured.

maprfs_zookeeper_ip = None

list value

The list of IPs or hostnames of ZooKeeper nodes.

max_age = 0

integer value

Number of seconds between subsequent usage refreshes.

max_gigabytes = 10000

integer value

Maximum number of volume gigabytes to allow per host.

max_header_line = 16384

integer value

Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs).

max_logfile_count = 30

integer value

Maximum number of rotated log files.

max_logfile_size_mb = 200

integer value

Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size".

max_over_subscription_ratio = 20.0

floating point value

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.

max_share_server_size = -1

integer value

Maximum sum of gigabytes a share server can have considering all its share instances and snapshots.

max_shares_per_share_server = -1

integer value

Maximum number of share instances created in a share server.

max_time_to_attach = 120

integer value

Maximum time to wait for attaching cinder volume.

max_time_to_build_instance = 300

integer value

Maximum time in seconds to wait for creating service instance.

max_time_to_create_volume = 180

integer value

Maximum time to wait for creating cinder volume.

max_time_to_extend_volume = 180

integer value

Maximum time to wait for extending cinder volume.

memcached_servers = None

list value

Memcached servers or None for in process cache.

message_reap_interval = 86400

integer value

Interval between periodic task runs to clean expired messages in seconds.

message_ttl = 2592000

integer value

Message minimum life in seconds.

migration_driver_continue_update_interval = 60

integer value

This value, specified in seconds, determines how often the share manager will poll the driver to perform the next step of migration in the storage backend, for a migrating share.

migration_ignore_files = ['lost+found']

list value

List of files and folders to be ignored when migrating shares. Items should be names (not including any path).

migration_readonly_rules_support = True

boolean value

Specify whether read only access rule mode is supported in this backend. Obsolete.

monkey_patch = False

boolean value

Whether to log monkey patching.

monkey_patch_modules = []

list value

List of modules or decorators to monkey patch.

my_ip = <based on operating system>

host address value

IP address of this host.

netapp_aggregate_name_search_pattern = (.*)

string value

Pattern for searching available aggregates for provisioning.

netapp_cached_aggregates_status_lifetime = 60

integer value

The maximum time in seconds that the cached aggregates status will be considered valid. Trying to read the expired cache leads to refreshing it.

netapp_enabled_share_protocols = ['nfs3', 'nfs4.0']

list value

The NFS protocol versions that will be enabled. Supported values include nfs3, nfs4.0, nfs4.1. This option only applies when the option driver_handles_share_servers is set to True.

netapp_fpolicy_default_file_operations = ['create', 'write', 'rename']

list value

NetApp FPolicy file operations to apply to a FPolicy event, when not provided by the user using "netapp:fpolicy_file_operations" extra-spec.

netapp_fpolicy_event_name_template = fpolicy_event_%(protocol)s_%(share_id)s

string value

NetApp FPolicy policy name template.

netapp_fpolicy_policy_name_template = fpolicy_policy_%(share_id)s

string value

NetApp FPolicy policy name template.

netapp_lif_name_template = os_%(net_allocation_id)s

string value

Logical interface (LIF) name template

netapp_login = None

string value

Administrative user account name used to access the storage system.

netapp_migration_cancel_timeout = 3600

integer value

The maximum time in seconds that migration cancel waits for all migration operations be completely aborted.

netapp_password = None

string value

Password for the administrative user account specified in the netapp_login option.

netapp_port_name_search_pattern = (.*)

string value

Pattern for overriding the selection of network ports on which to create Vserver LIFs.

netapp_qos_policy_group_name_template = qos_share_%(share_id)s

string value

NetApp QoS policy group name template.

netapp_reset_snapdir_visibility = default

string value

This option forces all existing shares to have their snapshot directory visibility set to either visible or hidden during driver startup. If set to default, nothing will be changed during startup. This will not affect new shares, which will have their snapshot directory always visible, unless toggled by the share type extra spec netapp:hide_snapdir.

netapp_root_volume = root

string value

Root volume name.

netapp_root_volume_aggregate = None

string value

Name of aggregate to create Vserver root volumes on. This option only applies when the option driver_handles_share_servers is set to True.

netapp_server_hostname = None

host address value

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

netapp_server_migration_check_capacity = True

boolean value

Specify if the capacity check must be made by the driver while performing a share server migration. If enabled, the driver will validate if the destination backend can hold all shares and snapshots capacities from the source share server.

netapp_server_migration_state_change_timeout = 3600

integer value

The maximum time in seconds that a share server migration waits for a vserver to change its internal states.

netapp_server_port = None

port value

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.

netapp_snapmirror_policy_name_svm_template = snapmirror_policy_%(share_server_id)s

string value

NetApp SnapMirror policy name template for Storage Virtual Machines (Vservers).

netapp_snapmirror_quiesce_timeout = 3600

integer value

The maximum time in seconds to wait for existing snapmirror transfers to complete before aborting when promoting a replica.

netapp_snapmirror_release_timeout = 3600

integer value

The maximum time in seconds to wait for a snapmirror release when breaking snapmirror relationships.

netapp_ssl_cert_path = None

string value

The path to a CA_BUNDLE file or directory with certificates of trusted CA. If set to a directory, it must have been processed using the c_rehash utility supplied with OpenSSL. If not informed, it will use the Mozilla’s carefully curated collection of Root Certificates for validating the trustworthiness of SSL certificates.

netapp_start_volume_move_timeout = 3600

integer value

The maximum time in seconds to wait for the completion of a volume clone split operation in order to start a volume move.

netapp_storage_family = ontap_cluster

string value

The storage family type used on the storage system; valid values include ontap_cluster for using clustered Data ONTAP.

netapp_transport_type = http

string value

The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.

netapp_volume_move_cutover_timeout = 3600

integer value

The maximum time in seconds to wait for the completion of a volume move operation after the cutover was triggered.

netapp_volume_name_template = share_%(share_id)s

string value

NetApp volume name template.

netapp_volume_snapshot_reserve_percent = 5

integer value

The percentage of share space set aside as reserve for snapshot usage; valid values range from 0 to 90.

netapp_vserver_name_template = os_%s

string value

Name template to use for new Vserver. When using CIFS protocol make sure to not configure characters illegal in DNS hostnames.

network_api_class = manila.network.neutron.neutron_network_plugin.NeutronNetworkPlugin

string value

The full class name of the Networking API class to use.

network_config_group = None

string value

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.

network_plugin_ipv4_enabled = True

boolean value

Whether to support IPv4 network resource, Default=True.

network_plugin_ipv6_enabled = False

boolean value

Whether to support IPv6 network resource, Default=False. If this option is True, the value of network_plugin_ipv4_enabled will be ignored.

neutron_binding_profiles = None

list value

A list of binding profiles to be used during port binding. This option can be used with the NeutronBindNetworkPlugin. The value for this option has to be a comma separated list of names that correspond to each binding profile. Each binding profile needs to be specified as an individual configuration section using the binding profile name as the section name.

neutron_host_id = 89b9d54ec6dd

string value

Host ID to be used when creating neutron port. If not set host is set to manila-share host by default.

neutron_net_id = None

string value

Default Neutron network that will be used for share server creation. This opt is used only with class NeutronSingleNetworkPlugin.

neutron_physical_net_name = None

string value

The name of the physical network to determine which net segment is used. This opt is optional and will only be used for networks configured with multiple segments.

neutron_port_id = None

string value

Port ID on the given switch.

neutron_subnet_id = None

string value

Default Neutron subnet that will be used for share server creation. Should be assigned to network defined in opt neutron_net_id. This opt is used only with class NeutronSingleNetworkPlugin.

neutron_switch_id = None

string value

Switch ID for binding profile.

neutron_switch_info = None

dict value

Switch label. For example: switch_ip: 10.4.30.5. Multiple key-value pairs separated by commas are accepted.

neutron_vnic_type = baremetal

string value

vNIC type used for binding.

nexenta_dataset_compression = on

string value

Compression value for new ZFS folders.

nexenta_dataset_dedupe = off

string value

Deduplication value for new ZFS folders. Only used by NexentaStor4 driver.

nexenta_dataset_record_size = 131072

integer value

Specifies a suggested block size in for files in a file system. (bytes)

nexenta_folder = folder

string value

Parent folder on NexentaStor.

nexenta_mount_point_base = $state_path/mnt

string value

Base directory that contains NFS share mount points.

nexenta_nas_host = None

host address value

Data IP address of Nexenta storage appliance.

nexenta_nfs = True

boolean value

Defines whether share over NFS is enabled.

nexenta_nfs_share = nfs_share

string value

Parent filesystem where all the shares will be created. This parameter is only used by NexentaStor4 driver.

nexenta_password = None

string value

Password to connect to Nexenta SA.

nexenta_pool = pool1

string value

Pool name on NexentaStor.

nexenta_rest_addresses = None

list value

One or more comma delimited IP addresses for management communication with NexentaStor appliance.

nexenta_rest_backoff_factor = 1

floating point value

Specifies the backoff factor to apply between connection attempts to NexentaStor management REST API server

nexenta_rest_connect_timeout = 30

floating point value

Specifies the time limit (in seconds), within which the connection to NexentaStor management REST API server must be established

nexenta_rest_port = 8443

integer value

Port to connect to Nexenta REST API server.

nexenta_rest_protocol = auto

string value

Use http or https for REST connection (default auto).

nexenta_rest_read_timeout = 300

floating point value

Specifies the time limit (in seconds), within which NexentaStor management REST API server must send a response

nexenta_rest_retry_count = 5

integer value

Specifies the number of times to repeat NexentaStor management REST API call in case of connection errors and NexentaStor appliance EBUSY or ENOENT errors

nexenta_share_name_prefix = share-

string value

Nexenta share name prefix.

nexenta_ssl_cert_verify = False

boolean value

Defines whether the driver should check ssl cert.

nexenta_thin_provisioning = True

boolean value

If True shares will not be space guaranteed and overprovisioning will be enabled.

nexenta_use_https = True

boolean value

Use HTTP secure protocol for NexentaStor management REST API connections

nexenta_user = admin

string value

User name to connect to Nexenta SA.

nexenta_volume = volume1

string value

Volume name on NexentaStor.

num_shell_tries = 3

integer value

Number of times to attempt to run flakey shell commands.

osapi_max_limit = 1000

integer value

The maximum number of items returned in a single response from a collection resource.

osapi_share_base_URL = None

string value

Base URL to be presented to users in links to the Share API

osapi_share_ext_list = []

list value

Specify list of extensions to load when using osapi_share_extension option with manila.api.contrib.select_extensions.

osapi_share_extension = ['manila.api.contrib.standard_extensions']

list value

The osapi share extensions to load.

osapi_share_listen = ::

host address value

IP address for OpenStack Share API to listen on.

osapi_share_listen_port = 8786

port value

Port for OpenStack Share API to listen on.

osapi_share_use_ssl = False

boolean value

Wraps the socket in a SSL context if True is set. A certificate file and key file must be specified.

osapi_share_workers = 1

integer value

Number of workers for OpenStack Share API service.

ovs_integration_bridge = br-int

string value

Name of Open vSwitch bridge to use.

path_to_private_key = None

string value

Path to host’s private key.

path_to_public_key = ~/.ssh/id_rsa.pub

string value

Path to hosts public key. Only used if driver_handles_share_servers=True.

periodic_fuzzy_delay = 60

integer value

Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)

periodic_hooks_interval = 300.0

floating point value

Interval in seconds between execution of periodic hooks. Used when option enable_periodic_hooks is set to True. Default is 300.

periodic_interval = 60

integer value

Seconds between running periodic tasks.

pool_weight_multiplier = 1.0

floating point value

Multiplier used for weighing pools which have existing share servers. Negative numbers mean to spread vs stack.

powermax_ethernet_ports = None

list value

Comma separated list of ports that can be used for share server interfaces. Members of the list can be Unix-style glob expressions.

powermax_server_container = None

string value

Data mover to host the NAS server.

powermax_share_data_pools = None

list value

Comma separated list of pools that can be used to persist share data.

protocol_access_mapping = {'ip': ['nfs'], 'user': ['cifs']}

dict value

Protocol access mapping for this backend. Should be a dictionary comprised of {access_type1: [share_proto1, share_proto2], access_type2: [share_proto2, share_proto3]}.

publish_errors = False

boolean value

Enables or disables publication of error events.

qnap_management_url = None

string value

The URL to manage QNAP Storage.

qnap_nas_login = None

string value

Username for QNAP storage.

qnap_nas_password = None

string value

Password for QNAP storage.

qnap_poolname = None

string value

Pool within which QNAP shares must be created.

qnap_share_ip = None

host address value

NAS share IP for mounting shares.

quobyte_api_ca = None

string value

The X.509 CA file to verify the server cert.

quobyte_api_password = quobyte

string value

Password for Quobyte API server

quobyte_api_url = None

string value

URL of the Quobyte API server (http or https)

quobyte_api_username = admin

string value

Username for Quobyte API server.

quobyte_default_volume_group = root

string value

Default owning group for new volumes.

quobyte_default_volume_user = root

string value

Default owning user for new volumes.

quobyte_delete_shares = False

boolean value

Actually deletes shares (vs. unexport)

quobyte_export_path = /quobyte

string value

Export path for shares of this bacckend. This needs to match the quobyte-nfs services "Pseudo" option.

quobyte_volume_configuration = BASE

string value

Name of volume configuration used for new shares.

quota_driver = manila.quota.DbQuotaDriver

string value

Default driver to use for quota checks.

quota_gigabytes = 1000

integer value

Number of share gigabytes allowed per project.

quota_per_share_gigabytes = -1

integer value

Max size allowed per share, in gigabytes.

quota_replica_gigabytes = 1000

integer value

Number of replica gigabytes allowed per project.

quota_share_group_snapshots = 50

integer value

Number of share group snapshots allowed.

quota_share_groups = 50

integer value

Number of share groups allowed.

quota_share_networks = 10

integer value

Number of share-networks allowed per project.

quota_share_replicas = 100

integer value

Number of share-replicas allowed per project.

quota_shares = 50

integer value

Number of shares allowed per project.

quota_snapshot_gigabytes = 1000

integer value

Number of snapshot gigabytes allowed per project.

quota_snapshots = 50

integer value

Number of share snapshots allowed per project.

rate_limit_burst = 0

integer value

Maximum number of logged messages per rate_limit_interval.

rate_limit_except_level = CRITICAL

string value

Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.

rate_limit_interval = 0

integer value

Interval, number of seconds, of log rate limiting.

replica_state_update_interval = 300

integer value

This value, specified in seconds, determines how often the share manager will poll for the health (replica_state) of each replica instance.

replication_domain = None

string value

A string specifying the replication domain that the backend belongs to. This option needs to be specified the same in the configuration sections of all backends that support replication between each other. If this option is not specified in the group, it means that replication is not enabled on the backend.

report_interval = 10

integer value

Seconds between nodes reporting state to datastore.

reservation_expire = 86400

integer value

Number of seconds until a reservation expires.

reserved_share_percentage = 0

integer value

The percentage of backend capacity reserved.

rootwrap_config = None

string value

Path to the rootwrap configuration file to use for running commands as root.

rpc_conn_pool_size = 30

integer value

Size of RPC connection pool.

rpc_ping_enabled = False

boolean value

Add an endpoint to answer to ping calls. Endpoint is named oslo_rpc_server_ping

rpc_response_timeout = 60

integer value

Seconds to wait for a response from a call.

run_external_periodic_tasks = True

boolean value

Some periodic tasks can be run in a separate process. Should we run them here?

scheduler_default_filters = ['AvailabilityZoneFilter', 'CapacityFilter', 'CapabilitiesFilter', 'DriverFilter', 'ShareReplicationFilter', 'CreateFromSnapshotFilter']

list value

Which filter class names to use for filtering hosts when not specified in the request.

scheduler_default_share_group_filters = ['AvailabilityZoneFilter', 'ConsistentSnapshotFilter']

list value

Which filter class names to use for filtering hosts creating share group when not specified in the request.

scheduler_default_weighers = ['CapacityWeigher', 'GoodnessWeigher', 'HostAffinityWeigher']

list value

Which weigher class names to use for weighing hosts.

scheduler_driver = manila.scheduler.drivers.filter.FilterScheduler

string value

Default scheduler driver to use.

scheduler_host_manager = manila.scheduler.host_manager.HostManager

string value

The scheduler host manager class to use.

`scheduler_json_config_location = `

string value

Absolute path to scheduler configuration JSON file.

scheduler_manager = manila.scheduler.manager.SchedulerManager

string value

Full class name for the scheduler manager.

scheduler_max_attempts = 3

integer value

Maximum number of attempts to schedule a share.

scheduler_topic = manila-scheduler

string value

The topic scheduler nodes listen on.

server_migration_driver_continue_update_interval = 900

integer value

This value, specified in seconds, determines how often the share manager will poll the driver to perform the next step of migration in the storage backend, for a migrating share server.

service_down_time = 60

integer value

Maximum time since last check-in for up service.

service_image_name = manila-service-image

string value

Name of image in Glance, that will be used for service instance creation. Only used if driver_handles_share_servers=True.

service_instance_flavor_id = 100

string value

ID of flavor, that will be used for service instance creation. Only used if driver_handles_share_servers=True.

service_instance_name_or_id = None

string value

Name or ID of service instance in Nova to use for share exports. Used only when share servers handling is disabled.

service_instance_name_template = manila_service_instance_%s

string value

Name of service instance. Only used if driver_handles_share_servers=True.

service_instance_password = None

string value

Password for service instance user.

service_instance_security_group = manila-service

string value

Security group name, that will be used for service instance creation. Only used if driver_handles_share_servers=True.

service_instance_smb_config_path = $share_mount_path/smb.conf

string value

Path to SMB config in service instance.

service_instance_user = None

string value

User in service instance that will be used for authentication.

service_net_name_or_ip = None

host address value

Can be either name of network that is used by service instance within Nova to get IP address or IP address itself (either IPv4 or IPv6) for managing shares there. Used only when share servers handling is disabled.

service_network_cidr = 10.254.0.0/16

string value

CIDR of manila service network. Used only with Neutron and if driver_handles_share_servers=True.

service_network_division_mask = 28

integer value

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 and if driver_handles_share_servers=True.

service_network_name = manila_service_network

string value

Name of manila service network. Used only with Neutron. Only used if driver_handles_share_servers=True.

share_api_class = manila.share.api.API

string value

The full class name of the share API class to use.

share_backend_name = None

string value

The backend name for a given driver implementation.

share_driver = manila.share.drivers.generic.GenericShareDriver

string value

Driver to use for share creation.

share_helpers = ['CIFS=manila.share.drivers.helpers.CIFSHelperIPAccess', 'NFS=manila.share.drivers.helpers.NFSHelper']

list value

Specify list of share export helpers.

share_manager = manila.share.manager.ShareManager

string value

Full class name for the share manager.

share_mount_path = /shares

string value

Parent path in service instance where shares will be mounted.

share_mount_template = mount -vt %(proto)s %(options)s %(export)s %(path)s

string value

The template for mounting shares for this backend. Must specify the executable with all necessary parameters for the protocol supported. proto template element may not be required if included in the command. export and path template elements are required. It is advisable to separate different commands per backend.

share_name_template = share-%s

string value

Template string to be used to generate share names.

share_service_inithost_offload = False

boolean value

Offload pending share ensure during share service startup

share_snapshot_name_template = share-snapshot-%s

string value

Template string to be used to generate share snapshot names.

share_topic = manila-share

string value

The topic share nodes listen on.

share_unmount_template = umount -v %(path)s

string value

The template for unmounting shares for this backend. Must specify the executable with all necessary parameters for the protocol supported. path template element is required. It is advisable to separate different commands per backend.

share_usage_audit_period = month

string value

Time period to generate share usages for. Time period must be hour, day, month or year.

share_usage_size_update_interval = 300

integer value

This value, specified in seconds, determines how often the share manager will poll the driver to update the share usage size in the storage backend, for shares in that backend.

share_volume_fstype = ext4

string value

Filesystem type of the share volume.

smb_template_config_path = $state_path/smb.conf

string value

Path to smb config.

ssh_conn_timeout = 60

integer value

Backend server SSH connection timeout.

ssh_max_pool_conn = 10

integer value

Maximum number of connections in the SSH pool.

ssh_min_pool_conn = 1

integer value

Minimum number of connections in the SSH pool.

standalone_network_plugin_allowed_ip_ranges = None

list value

Can be IP address, range of IP addresses or list of addresses or ranges. Contains addresses from IP network that are allowed to be used. If empty, then will be assumed that all host addresses from network can be used. Optional. Examples: 10.0.0.10 or 10.0.0.10-10.0.0.20 or 10.0.0.10-10.0.0.20,10.0.0.30-10.0.0.40,10.0.0.50

standalone_network_plugin_gateway = None

string value

Gateway address that should be used. Required.

standalone_network_plugin_mask = None

string value

Network mask that will be used. Can be either decimal like 24 or binary like 255.255.255.0. Required.

standalone_network_plugin_mtu = 1500

integer value

Maximum Transmission Unit (MTU) value of the network. Default value is 1500.

standalone_network_plugin_network_type = None

string value

Network type, such as flat, vlan, vxlan or gre. Empty value is alias for flat. It will be assigned to share-network and share drivers will be able to use this for network interfaces within provisioned share servers. Optional.

standalone_network_plugin_segmentation_id = None

integer value

Set it if network has segmentation (VLAN, VXLAN, etc…​). It will be assigned to share-network and share drivers will be able to use this for network interfaces within provisioned share servers. Optional. Example: 1001

state_path = /var/lib/manila

string value

Top-level directory for maintaining manila’s state.

storage_availability_zone = nova

string value

Availability zone of this node.

suppress_post_hooks_errors = False

boolean value

Whether to suppress post hook errors (allow driver’s results to pass through) or not.

suppress_pre_hooks_errors = False

boolean value

Whether to suppress pre hook errors (allow driver perform actions) or not.

syslog-log-facility = LOG_USER

string value

Syslog facility to receive log lines. This option is ignored if log_config_append is set.

tcp_keepalive = True

boolean value

Sets the value of TCP_KEEPALIVE (True/False) for each server socket.

tcp_keepalive_count = None

integer value

Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X.

tcp_keepalive_interval = None

integer value

Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X.

tcp_keepidle = 600

integer value

Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.

tegile_default_project = None

string value

Create shares in this project

tegile_nas_login = None

string value

User name for the Tegile NAS server.

tegile_nas_password = None

string value

Password for the Tegile NAS server.

tegile_nas_server = None

host address value

Tegile NAS server hostname or IP address.

tenant_net_name_or_ip = None

host address value

Can be either name of network that is used by service instance within Nova to get IP address or IP address itself (either IPv4 or IPv6) for exporting shares. Used only when share servers handling is disabled.

transport_url = rabbit://

string value

The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is:

driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query

Example: rabbit://rabbitmq:password@127.0.0.1:5672//

For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html

unmanage_remove_access_rules = False

boolean value

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.

until_refresh = 0

integer value

Count of reservations until usage is refreshed.

unused_share_server_cleanup_interval = 10

integer value

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.

use-journal = False

boolean value

Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set.

use-json = False

boolean value

Use JSON formatting for logging. This option is ignored if log_config_append is set.

use-syslog = False

boolean value

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.

use_eventlog = False

boolean value

Log output to Windows Event Log.

use_forwarded_for = False

boolean value

Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.

use_scheduler_creating_share_from_snapshot = False

boolean value

If set to False, then share creation from snapshot will be performed on the same host. If set to True, then scheduler will be used.When enabling this option make sure that filter CreateFromSnapshotFilter is enabled and to have hosts reporting replication_domain option.

use_stderr = False

boolean value

Log output to standard error. This option is ignored if log_config_append is set.

vast_mgmt_host = None

host address value

Hostname or IP address VAST storage system management VIP.

vast_mgmt_password = None

string value

Password for VAST management

vast_mgmt_port = 443

port value

Port for VAST management

vast_mgmt_user = None

string value

Username for VAST management

vast_root_export = manila

string value

Base path for shares

vast_vippool_name = None

string value

Name of Virtual IP pool

volume_api_class = manila.volume.cinder.API

string value

The full class name of the Volume API class to use.

volume_name_template = manila-share-%s

string value

Volume name template.

volume_snapshot_name_template = manila-snapshot-%s

string value

Volume snapshot name template.

watch-log-file = False

boolean value

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.

winrm_cert_key_pem_path = ~/.ssl/key.pem

string value

Path to the x509 certificate key.

winrm_cert_pem_path = ~/.ssl/cert.pem

string value

Path to the x509 certificate used for accessing the service instance.

winrm_conn_timeout = 60

integer value

WinRM connection timeout.

winrm_operation_timeout = 60

integer value

WinRM operation timeout.

winrm_retry_count = 3

integer value

WinRM retry count.

winrm_retry_interval = 5

integer value

WinRM retry interval in seconds

winrm_use_cert_based_auth = False

boolean value

Use x509 certificates in order to authenticate to the service instance.

wsgi_default_pool_size = 100

integer value

Size of the pool of greenthreads used by wsgi

wsgi_keep_alive = True

boolean value

If False, closes the client socket connection explicitly.

wsgi_log_format = %(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f

string value

A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.

wsgi_server_debug = False

boolean value

True if the server should send exception tracebacks to the clients on 500 errors. If False, the server will respond with empty bodies.

zfs_dataset_creation_options = None

list value

Define here list of options that should be applied for each dataset creation if needed. Example: compression=gzip,dedup=off. Note that, for secondary replicas option readonly will be set to on and for active replicas to off in any way. Also, quota will be equal to share size. Optional.

zfs_dataset_name_prefix = manila_share_

string value

Prefix to be used in each dataset name. Optional.

zfs_dataset_snapshot_name_prefix = manila_share_snapshot_

string value

Prefix to be used in each dataset snapshot name. Optional.

zfs_migration_snapshot_prefix = tmp_snapshot_for_share_migration_

string value

Set snapshot prefix for usage in ZFS migration. Required.

zfs_replica_snapshot_prefix = tmp_snapshot_for_replication_

string value

Set snapshot prefix for usage in ZFS replication. Required.

zfs_service_ip = None

host address value

IP to be added to admin-facing export location. Required.

zfs_share_export_ip = None

host address value

IP to be added to user-facing export location. Required.

zfs_share_helpers = ['NFS=manila.share.drivers.zfsonlinux.utils.NFSviaZFSHelper']

list value

Specify list of share export helpers for ZFS storage. It should look like following: FOO_protocol=foo.FooClass,BAR_protocol=bar.BarClass. Required.

zfs_ssh_private_key_path = None

string value

Path to SSH private key that should be used for SSH’ing ZFS storage host. Not used for replication operations. Optional.

zfs_ssh_user_password = None

string value

Password for user that is used for SSH’ing ZFS storage host. Not used for replication operations. They require passwordless SSH access. Optional.

zfs_ssh_username = None

string value

SSH user that will be used in 2 cases: 1) By manila-share service in case it is located on different host than its ZFS storage. 2) By manila-share services with other ZFS backends that perform replication. It is expected that SSH’ing will be key-based, passwordless. This user should be passwordless sudoer. Optional.

zfs_use_ssh = False

boolean value

Remote ZFS storage hostname that should be used for SSH’ing. Optional.

zfs_zpool_list = None

list value

Specify list of zpools that are allowed to be used by backend. Can contain nested datasets. Examples: Without nested dataset: zpool_name. With nested dataset: zpool_name/nested_dataset_name. Required.

zfssa_auth_password = None

string value

ZFSSA management authorized user’s password.

zfssa_auth_user = None

string value

ZFSSA management authorized username.

zfssa_data_ip = None

host address value

IP address for data.

zfssa_host = None

host address value

ZFSSA management IP address.

zfssa_manage_policy = loose

string value

Driver policy for share manage. A strict policy checks for a schema named manila_managed, and makes sure its value is true. A loose policy does not check for the schema.

zfssa_nas_checksum = fletcher4

string value

Controls checksum used for data blocks.

zfssa_nas_compression = off

string value

Data compression-off, lzjb, gzip-2, gzip, gzip-9.

zfssa_nas_logbias = latency

string value

Controls behavior when servicing synchronous writes.

`zfssa_nas_mountpoint = `

string value

Location of project in ZFS/SA.

zfssa_nas_quota_snap = true

string value

Controls whether a share quota includes snapshot.

zfssa_nas_rstchown = true

string value

Controls whether file ownership can be changed.

zfssa_nas_vscan = false

string value

Controls whether the share is scanned for viruses.

zfssa_pool = None

string value

ZFSSA storage pool name.

zfssa_project = None

string value

ZFSSA project name.

zfssa_rest_timeout = None

string value

REST connection timeout (in seconds).

auth-url = None

string value

Authentication URL

auth_type = None

string value

Authentication type to load

cafile = None

string value

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile = None

string value

PEM encoded client certificate cert file

collect-timing = False

boolean value

Collect per-API call timing information.

cross_az_attach = True

boolean value

Allow attaching between instances and volumes in different availability zones.

default-domain-id = None

string value

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

default-domain-name = None

string value

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

domain-id = None

string value

Domain ID to scope to

domain-name = None

string value

Domain name to scope to

endpoint_type = publicURL

string value

Endpoint type to be used with cinder client calls.

http_retries = 3

integer value

Number of cinderclient retries on failed HTTP calls.

insecure = False

boolean value

Verify HTTPS connections.

keyfile = None

string value

PEM encoded client certificate key file

password = None

string value

User’s password

project-domain-id = None

string value

Domain ID containing project

project-domain-name = None

string value

Domain name containing project

project-id = None

string value

Project ID to scope to

project-name = None

string value

Project name to scope to

region_name = None

string value

Region name for connecting to cinder.

split-loggers = False

boolean value

Log requests to multiple loggers.

system-scope = None

string value

Scope for system operations

timeout = None

integer value

Timeout value for http requests

trust-id = None

string value

Trust ID

user-domain-id = None

string value

User’s domain id

user-domain-name = None

string value

User’s domain name

user-id = None

string value

User id

username = None

string value

Username

allow_credentials = True

boolean value

Indicate that the actual request can include user credentials

allow_headers = ['X-Auth-Token', 'X-OpenStack-Request-ID', 'X-Openstack-Manila-Api-Version', 'X-OpenStack-Manila-API-Experimental', 'X-Identity-Status', 'X-Roles', 'X-Service-Catalog', 'X-User-Id', 'X-Tenant-Id']

list value

Indicate which header field names may be used during the actual request.

allow_methods = ['GET', 'PUT', 'POST', 'DELETE', 'PATCH']

list value

Indicate which methods can be used during the actual request.

allowed_origin = None

list value

Indicate whether this resource may be shared with the domain received in the requests "origin" header. Format: "<protocol>://<host>[:<port>]", no trailing slash. Example: https://horizon.example.com

expose_headers = ['X-Auth-Token', 'X-OpenStack-Request-ID', 'X-Openstack-Manila-Api-Version', 'X-OpenStack-Manila-API-Experimental', 'X-Subject-Token', 'X-Service-Token']

list value

Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.

max_age = 3600

integer value

Maximum cache age of CORS preflight requests.

backend = sqlalchemy

string value

The back end to use for the database.

connection = None

string value

The SQLAlchemy connection string to use to connect to the database.

connection_debug = 0

integer value

Verbosity of SQL debugging information: 0=None, 100=Everything.

`connection_parameters = `

string value

Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1&param2=value2&…​

connection_recycle_time = 3600

integer value

Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool.

connection_trace = False

boolean value

Add Python stack traces to SQL as comment strings.

db_inc_retry_interval = True

boolean value

If True, increases the interval between retries of a database operation up to db_max_retry_interval.

db_max_retries = 20

integer value

Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.

db_max_retry_interval = 10

integer value

If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.

db_retry_interval = 1

integer value

Seconds between retries of a database transaction.

max_overflow = 50

integer value

If set, use this value for max_overflow with SQLAlchemy.

max_pool_size = 5

integer value

Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit.

max_retries = 10

integer value

Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.

mysql_enable_ndb = False

boolean value

If True, transparently enables support for handling MySQL Cluster (NDB).

mysql_sql_mode = TRADITIONAL

string value

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=

pool_timeout = None

integer value

If set, use this value for pool_timeout with SQLAlchemy.

retry_interval = 10

integer value

Interval between retries of opening a SQL connection.

slave_connection = None

string value

The SQLAlchemy connection string to use to connect to the slave database.

sqlite_synchronous = True

boolean value

If True, SQLite uses synchronous mode.

use_db_reconnect = False

boolean value

Enable the experimental use of database reconnect on connection lost.

use_tpool = False

boolean value

Enable the experimental use of thread pooling for all DB API calls

api_microversion = 2

string value

Version of Glance API to be used.

auth-url = None

string value

Authentication URL

auth_type = None

string value

Authentication type to load

cafile = None

string value

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile = None

string value

PEM encoded client certificate cert file

collect-timing = False

boolean value

Collect per-API call timing information.

default-domain-id = None

string value

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

default-domain-name = None

string value

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

domain-id = None

string value

Domain ID to scope to

domain-name = None

string value

Domain name to scope to

endpoint_type = publicURL

string value

Endpoint type to be used with glance client calls.

insecure = False

boolean value

Verify HTTPS connections.

keyfile = None

string value

PEM encoded client certificate key file

password = None

string value

User’s password

project-domain-id = None

string value

Domain ID containing project

project-domain-name = None

string value

Domain name containing project

project-id = None

string value

Project ID to scope to

project-name = None

string value

Project name to scope to

region_name = RegionOne

string value

Region name for connecting to glance.

split-loggers = False

boolean value

Log requests to multiple loggers.

system-scope = None

string value

Scope for system operations

timeout = None

integer value

Timeout value for http requests

trust-id = None

string value

Trust ID

user-domain-id = None

string value

User’s domain id

user-domain-name = None

string value

User’s domain name

user-id = None

string value

User id

username = None

string value

Username

backends = []

list value

Additional backends that can perform health checks and report that information back as part of a request.

detailed = False

boolean value

Show more detailed information as part of the response. Security note: Enabling this option may expose sensitive details about the service being monitored. Be sure to verify that it will not violate your security policies.

disable_by_file_path = None

string value

Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin.

disable_by_file_paths = []

list value

Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin.

path = /healthcheck

string value

The path to respond to healtcheck requests on.

auth_section = None

string value

Config Section from which to load plugin specific options

auth_type = None

string value

Authentication type to load

auth_uri = None

string value

Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release. Deprecated since: Queens

*Reason:*The auth_uri option is deprecated in favor of www_authenticate_uri and will be removed in the S release.

auth_version = None

string value

API version of the Identity API endpoint.

cache = None

string value

Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the memcached_servers option instead.

cafile = None

string value

A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.

certfile = None

string value

Required if identity server requires client certificate

delay_auth_decision = False

boolean value

Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.

enforce_token_bind = permissive

string value

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.

http_connect_timeout = None

integer value

Request timeout value for communicating with Identity API server.

http_request_max_retries = 3

integer value

How many times are we trying to reconnect when communicating with Identity API Server.

include_service_catalog = True

boolean value

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

insecure = False

boolean value

Verify HTTPS connections.

interface = internal

string value

Interface to use for the Identity API endpoint. Valid values are "public", "internal" (default) or "admin".

keyfile = None

string value

Required if identity server requires client certificate

memcache_pool_conn_get_timeout = 10

integer value

(Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.

memcache_pool_dead_retry = 300

integer value

(Optional) Number of seconds memcached server is considered dead before it is tried again.

memcache_pool_maxsize = 10

integer value

(Optional) Maximum total number of open connections to every memcached server.

memcache_pool_socket_timeout = 3

integer value

(Optional) Socket timeout in seconds for communicating with a memcached server.

memcache_pool_unused_timeout = 60

integer value

(Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.

memcache_secret_key = None

string value

(Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.

memcache_security_strategy = None

string value

(Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. 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.

memcache_use_advanced_pool = False

boolean value

(Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.

memcached_servers = None

list value

Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.

region_name = None

string value

The region in which the identity server can be found.

service_token_roles = ['service']

list value

A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check.

service_token_roles_required = False

boolean value

For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible.

service_type = None

string value

The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules.

token_cache_time = 300

integer value

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.

www_authenticate_uri = None

string value

Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint.

auth-url = None

string value

Authentication URL

auth_strategy = keystone

string value

Auth strategy for connecting to neutron in admin context.

auth_type = None

string value

Authentication type to load

cafile = None

string value

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile = None

string value

PEM encoded client certificate cert file

collect-timing = False

boolean value

Collect per-API call timing information.

default-domain-id = None

string value

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

default-domain-name = None

string value

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

domain-id = None

string value

Domain ID to scope to

domain-name = None

string value

Domain name to scope to

endpoint_type = publicURL

string value

Endpoint type to be used with neutron client calls.

insecure = False

boolean value

Verify HTTPS connections.

keyfile = None

string value

PEM encoded client certificate key file

password = None

string value

User’s password

project-domain-id = None

string value

Domain ID containing project

project-domain-name = None

string value

Domain name containing project

project-id = None

string value

Project ID to scope to

project-name = None

string value

Project name to scope to

region_name = None

string value

Region name for connecting to neutron in admin context.

split-loggers = False

boolean value

Log requests to multiple loggers.

system-scope = None

string value

Scope for system operations

timeout = None

integer value

Timeout value for http requests

trust-id = None

string value

Trust ID

url = http://127.0.0.1:9696

string value

URL for connecting to neutron.

url_timeout = 30

integer value

Timeout value for connecting to neutron in seconds.

user-domain-id = None

string value

User’s domain id

user-domain-name = None

string value

User’s domain name

user-id = None

string value

User id

username = None

string value

Username

api_microversion = 2.10

string value

Version of Nova API to be used.

auth-url = None

string value

Authentication URL

auth_type = None

string value

Authentication type to load

cafile = None

string value

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile = None

string value

PEM encoded client certificate cert file

collect-timing = False

boolean value

Collect per-API call timing information.

default-domain-id = None

string value

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

default-domain-name = None

string value

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

domain-id = None

string value

Domain ID to scope to

domain-name = None

string value

Domain name to scope to

endpoint_type = publicURL

string value

Endpoint type to be used with nova client calls.

insecure = False

boolean value

Verify HTTPS connections.

keyfile = None

string value

PEM encoded client certificate key file

password = None

string value

User’s password

project-domain-id = None

string value

Domain ID containing project

project-domain-name = None

string value

Domain name containing project

project-id = None

string value

Project ID to scope to

project-name = None

string value

Project name to scope to

region_name = None

string value

Region name for connecting to nova.

split-loggers = False

boolean value

Log requests to multiple loggers.

system-scope = None

string value

Scope for system operations

timeout = None

integer value

Timeout value for http requests

trust-id = None

string value

Trust ID

user-domain-id = None

string value

User’s domain id

user-domain-name = None

string value

User’s domain name

user-id = None

string value

User id

username = None

string value

Username

disable_process_locking = False

boolean value

Enables or disables inter-process locks.

lock_path = None

string value

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.

addressing_mode = dynamic

string value

Indicates the addressing mode used by the driver. Permitted values: legacy - use legacy non-routable addressing routable - use routable addresses dynamic - use legacy addresses if the message bus does not support routing otherwise use routable addressing

anycast_address = anycast

string value

Appended to the address prefix when sending to a group of consumers. Used by the message bus to identify messages that should be delivered in a round-robin fashion across consumers.

broadcast_prefix = broadcast

string value

address prefix used when broadcasting to all servers

connection_retry_backoff = 2

integer value

Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt.

connection_retry_interval = 1

integer value

Seconds to pause before attempting to re-connect.

connection_retry_interval_max = 30

integer value

Maximum limit for connection_retry_interval + connection_retry_backoff

container_name = None

string value

Name for the AMQP container. must be globally unique. Defaults to a generated UUID

default_notification_exchange = None

string value

Exchange name used in notification addresses. Exchange name resolution precedence: Target.exchange if set else default_notification_exchange if set else control_exchange if set else notify

default_notify_timeout = 30

integer value

The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry.

default_reply_retry = 0

integer value

The maximum number of attempts to re-send a reply message which failed due to a recoverable error.

default_reply_timeout = 30

integer value

The deadline for an rpc reply message delivery.

default_rpc_exchange = None

string value

Exchange name used in RPC addresses. Exchange name resolution precedence: Target.exchange if set else default_rpc_exchange if set else control_exchange if set else rpc

default_send_timeout = 30

integer value

The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry.

default_sender_link_timeout = 600

integer value

The duration to schedule a purge of idle sender links. Detach link after expiry.

group_request_prefix = unicast

string value

address prefix when sending to any server in group

idle_timeout = 0

integer value

Timeout for inactive connections (in seconds)

link_retry_delay = 10

integer value

Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error.

multicast_address = multicast

string value

Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages.

notify_address_prefix = openstack.org/om/notify

string value

Address prefix for all generated Notification addresses

notify_server_credit = 100

integer value

Window size for incoming Notification messages

pre_settled = ['rpc-cast', 'rpc-reply']

multi valued

Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: rpc-call - send RPC Calls pre-settled rpc-reply- send RPC Replies pre-settled rpc-cast - Send RPC Casts pre-settled notify - Send Notifications pre-settled

pseudo_vhost = True

boolean value

Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private subnet per virtual host. Set to False if the message bus supports virtual hosting using the hostname field in the AMQP 1.0 Open performative as the name of the virtual host.

reply_link_credit = 200

integer value

Window size for incoming RPC Reply messages.

rpc_address_prefix = openstack.org/om/rpc

string value

Address prefix for all generated RPC addresses

rpc_server_credit = 100

integer value

Window size for incoming RPC Request messages

`sasl_config_dir = `

string value

Path to directory that contains the SASL configuration

`sasl_config_name = `

string value

Name of configuration file (without .conf suffix)

`sasl_default_realm = `

string value

SASL realm to use if no realm present in username

`sasl_mechanisms = `

string value

Space separated list of acceptable SASL mechanisms

server_request_prefix = exclusive

string value

address prefix used when sending to a specific server

ssl = False

boolean value

Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate.

`ssl_ca_file = `

string value

CA certificate PEM file used to verify the server’s certificate

`ssl_cert_file = `

string value

Self-identifying certificate PEM file for client authentication

`ssl_key_file = `

string value

Private key PEM file used to sign ssl_cert_file certificate (optional)

ssl_key_password = None

string value

Password for decrypting ssl_key_file (if encrypted)

ssl_verify_vhost = False

boolean value

By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name.

trace = False

boolean value

Debug: dump AMQP frames to stdout

unicast_address = unicast

string value

Appended to the address prefix when sending to a particular RPC/Notification server. Used by the message bus to identify messages sent to a single destination.

compression_codec = none

string value

The compression codec for all data generated by the producer. If not set, compression will not be used. Note that the allowed values of this depend on the kafka version

conn_pool_min_size = 2

integer value

The pool size limit for connections expiration policy

conn_pool_ttl = 1200

integer value

The time-to-live in sec of idle connections in the pool

consumer_group = oslo_messaging_consumer

string value

Group id for Kafka consumer. Consumers in one group will coordinate message consumption

enable_auto_commit = False

boolean value

Enable asynchronous consumer commits

kafka_consumer_timeout = 1.0

floating point value

Default timeout(s) for Kafka consumers

kafka_max_fetch_bytes = 1048576

integer value

Max fetch bytes of Kafka consumer

max_poll_records = 500

integer value

The maximum number of records returned in a poll call

pool_size = 10

integer value

Pool Size for Kafka Consumers

producer_batch_size = 16384

integer value

Size of batch for the producer async send

producer_batch_timeout = 0.0

floating point value

Upper bound on the delay for KafkaProducer batching in seconds

sasl_mechanism = PLAIN

string value

Mechanism when security protocol is SASL

security_protocol = PLAINTEXT

string value

Protocol used to communicate with brokers

`ssl_cafile = `

string value

CA certificate PEM file used to verify the server certificate

`ssl_client_cert_file = `

string value

Client certificate PEM file used for authentication.

`ssl_client_key_file = `

string value

Client key PEM file used for authentication.

`ssl_client_key_password = `

string value

Client key password file used for authentication.

driver = []

multi valued

The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop

retry = -1

integer value

The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite

topics = ['notifications']

list value

AMQP topic used for OpenStack notifications.

transport_url = None

string value

A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.

amqp_auto_delete = False

boolean value

Auto-delete queues in AMQP.

amqp_durable_queues = False

boolean value

Use durable queues in AMQP.

direct_mandatory_flag = True

boolean value

(DEPRECATED) Enable/Disable the RabbitMQ mandatory flag for direct send. The direct send is used as reply, so the MessageUndeliverable exception is raised in case the client queue does not exist.MessageUndeliverable exception will be used to loop for a timeout to lets a chance to sender to recover.This flag is deprecated and it will not be possible to deactivate this functionality anymore

enable_cancel_on_failover = False

boolean value

Enable x-cancel-on-ha-failover flag so that rabbitmq server will cancel and notify consumerswhen queue is down

heartbeat_in_pthread = False

boolean value

Run the health check heartbeat thread through a native python thread by default. If this option is equal to False then the health check heartbeat will inherit the execution model from the parent process. For example if the parent process has monkey patched the stdlib by using eventlet/greenlet then the heartbeat will be run through a green thread. This option should be set to True only for the wsgi services.

heartbeat_rate = 2

integer value

How often times during the heartbeat_timeout_threshold we check the heartbeat.

heartbeat_timeout_threshold = 60

integer value

Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat).

kombu_compression = None

string value

EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions.

kombu_failover_strategy = round-robin

string value

Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config.

kombu_missing_consumer_retry_timeout = 60

integer value

How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout.

kombu_reconnect_delay = 1.0

floating point value

How long to wait before reconnecting in response to an AMQP consumer cancel notification.

rabbit_ha_queues = False

boolean value

Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: "rabbitmqctl set_policy HA ^(?!amq\.).* {"ha-mode": "all"} "

rabbit_interval_max = 30

integer value

Maximum interval of RabbitMQ connection retries. Default is 30 seconds.

rabbit_login_method = AMQPLAIN

string value

The RabbitMQ login method.

rabbit_qos_prefetch_count = 0

integer value

Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.

rabbit_retry_backoff = 2

integer value

How long to backoff for between retries when connecting to RabbitMQ.

rabbit_retry_interval = 1

integer value

How frequently to retry connecting with RabbitMQ.

rabbit_transient_queues_ttl = 1800

integer value

Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues.

ssl = False

boolean value

Connect over SSL.

`ssl_ca_file = `

string value

SSL certification authority file (valid only if SSL enabled).

`ssl_cert_file = `

string value

SSL cert file (valid only if SSL enabled).

`ssl_key_file = `

string value

SSL key file (valid only if SSL enabled).

`ssl_version = `

string value

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.

enable_proxy_headers_parsing = False

boolean value

Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.

max_request_body_size = 114688

integer value

The maximum body size for each request, in bytes.

secure_proxy_ssl_header = X-Forwarded-Proto

string value

The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.

enforce_new_defaults = False

boolean value

This option controls whether or not to use old deprecated defaults when evaluating policies. If True, the old deprecated defaults are not going to be evaluated. This means if any existing token is allowed for old defaults but is disallowed for new defaults, it will be disallowed. It is encouraged to enable this flag along with the enforce_scope flag so that you can get the benefits of new defaults and scope_type together

enforce_scope = False

boolean value

This option controls whether or not to enforce scope when evaluating policies. If True, the scope of the token used in the request is compared to the scope_types of the policy being enforced. If the scopes do not match, an InvalidScope exception will be raised. If False, a message will be logged informing operators that policies are being invoked with mismatching scope.

policy_default_rule = default

string value

Default rule. Enforced when a requested rule is not found.

policy_dirs = ['policy.d']

multi valued

Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.

policy_file = policy.yaml

string value

The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option.

remote_content_type = application/x-www-form-urlencoded

string value

Content Type to send and receive data for REST based policy check

remote_ssl_ca_crt_file = None

string value

Absolute path to ca cert file for REST based policy check

remote_ssl_client_crt_file = None

string value

Absolute path to client cert for REST based policy check

remote_ssl_client_key_file = None

string value

Absolute path client key file REST based policy check

remote_ssl_verify_server_crt = False

boolean value

server identity verification for REST based policy check

file_event_handler = None

string value

The path to a file to watch for changes to trigger the reports, instead of signals. Setting this option disables the signal trigger for the reports. If application is running as a WSGI application it is recommended to use this instead of signals.

file_event_handler_interval = 1

integer value

How many seconds to wait between polls when file_event_handler is set

log_dir = None

string value

Path to a log directory where to create a file

ca_file = None

string value

CA certificate file to use to verify connecting clients.

cert_file = None

string value

Certificate file to use when starting the server securely.

ciphers = None

string value

Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format.

key_file = None

string value

Private key file to use when starting the server securely.

version = None

string value

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.