Networking configuration options¶

The options and descriptions listed in this introduction are auto generated from the code in the Networking service project, which provides software-defined networking between VMs run in Compute. The list contains common options, while the subsections list the options for the various networking plug-ins.

Description of common configuration options
Configuration option = Default value	Description
[DEFAULT]
`agent_down_time` = `75`	(Integer) Seconds to regard the agent is down; should be at least twice report_interval, to be sure the agent is down for good.
`api_workers` = `None`	(Integer) Number of separate API worker processes for service. If not specified, the default is equal to the number of CPUs available for best performance.
`auth_ca_cert` = `None`	(String) Certificate Authority public key (CA cert) file for ssl
`auth_strategy` = `keystone`	(String) The type of authentication to use
`base_mac` = `fa:16:3e:00:00:00`	(String) The base MAC address Neutron will use for VIFs. The first 3 octets will remain unchanged. If the 4th octet is not 00, it will also be used. The others will be randomly generated.
`bgp_drscheduler_driver` = `neutron.services.bgp.scheduler.bgp_dragent_scheduler.ChanceScheduler`	(String) Driver used for scheduling BGP speakers to BGP DrAgent
`bind_host` = `0.0.0.0`	(String) The host IP to bind to
`bind_port` = `9696`	(Port number) The port to bind to
`core_plugin` = `None`	(String) The core plugin Neutron will use
`default_availability_zones` =	(List) Default value of availability zone hints. The availability zone aware schedulers use this when the resources availability_zone_hints is empty. Multiple availability zones can be specified by a comma separated string. This value can be empty. In this case, even if availability_zone_hints for a resource is empty, availability zone is considered for high availability while scheduling the resource.
`default_ipv4_subnet_pool` = `None`	(String) DEPRECATED: Default IPv4 subnet pool to be used for automatic subnet CIDR allocation. Specifies by UUID the pool to be used in case where creation of a subnet is being called without a subnet pool ID. If not set then no pool will be used unless passed explicitly to the subnet create. If no pool is used, then a CIDR must be passed to create a subnet and that subnet will not be allocated from any pool; it will be considered part of the tenant’s private address space. This option is deprecated for removal in the N release.
`default_ipv6_subnet_pool` = `None`	(String) DEPRECATED: Default IPv6 subnet pool to be used for automatic subnet CIDR allocation. Specifies by UUID the pool to be used in case where creation of a subnet is being called without a subnet pool ID. See the description for default_ipv4_subnet_pool for more information. This option is deprecated for removal in the N release.
`dhcp_agent_notification` = `True`	(Boolean) Allow sending resource operation notification to DHCP agent
`dhcp_agents_per_network` = `1`	(Integer) Number of DHCP agents scheduled to host a tenant network. If this number is greater than 1, the scheduler automatically assigns multiple DHCP agents for a given tenant network, providing high availability for DHCP service.
`dhcp_broadcast_reply` = `False`	(Boolean) Use broadcast in DHCP replies.
`dhcp_confs` = `$state_path/dhcp`	(String) Location to store DHCP server config files.
`dhcp_domain` = `openstacklocal`	(String) DEPRECATED: Domain to use for building the hostnames. This option is deprecated. It has been moved to neutron.conf as dns_domain. It will be removed in a future release.
`dhcp_lease_duration` = `86400`	(Integer) DHCP lease duration (in seconds). Use -1 to tell dnsmasq to use infinite lease times.
`dhcp_load_type` = `networks`	(String) Representing the resource type whose load is being reported by the agent. This can be “networks”, “subnets” or “ports”. When specified (Default is networks), the server will extract particular load sent as part of its agent configuration object from the agent report state, which is the number of resources being consumed, at every report_interval.dhcp_load_type can be used in combination with network_scheduler_driver = neutron.scheduler.dhcp_agent_scheduler.WeightScheduler When the network_scheduler_driver is WeightScheduler, dhcp_load_type can be configured to represent the choice for the resource being balanced. Example: dhcp_load_type=networks
`dns_domain` = `openstacklocal`	(String) Domain to use for building the hostnames
`enable_new_agents` = `True`	(Boolean) Agent starts with admin_state_up=False when enable_new_agents=False. In the case, user’s resources will not be scheduled automatically to the agent until admin changes admin_state_up to True.
`enable_services_on_agents_with_admin_state_down` = `False`	(Boolean) Enable services on an agent with admin_state_up False. If this option is False, when admin_state_up of an agent is turned False, services on it will be disabled. Agents with admin_state_up False are not selected for automatic scheduling regardless of this option. But manual scheduling to such agents is available if this option is True.
`executor_thread_pool_size` = `64`	(Integer) Size of executor thread pool.
`external_dns_driver` = `None`	(String) Driver for external DNS integration.
`global_physnet_mtu` = `1500`	(Integer) MTU of the underlying physical network. Neutron uses this value to calculate MTU for all virtual network components. For flat and VLAN networks, neutron uses this value without modification. For overlay networks such as VXLAN, neutron automatically subtracts the overlay protocol overhead from this value. Defaults to 1500, the standard value for Ethernet. If using the ML2 plug-in with overlay/tunnel networks, also configure the ml2 path_mtu option with the same value as the global_physnet_mtu option.
`ip_lib_force_root` = `False`	(Boolean) Force ip_lib calls to use the root helper
`ipam_driver` = `None`	(String) Neutron IPAM (IP address management) driver to use. If ipam_driver is not set (default behavior), no IPAM driver is used. In order to use the reference implementation of Neutron IPAM driver, use ‘internal’.
`mac_generation_retries` = `16`	(Integer) How many times Neutron will retry MAC generation
`max_allowed_address_pair` = `10`	(Integer) Maximum number of allowed address pairs
`max_dns_nameservers` = `5`	(Integer) Maximum number of DNS nameservers per subnet
`max_fixed_ips_per_port` = `5`	(Integer) DEPRECATED: Maximum number of fixed ips per port. This option is deprecated and will be removed in the N release.
`max_rtr_adv_interval` = `100`	(Integer) MaxRtrAdvInterval setting for radvd.conf
`max_subnet_host_routes` = `20`	(Integer) Maximum number of host routes per subnet
`memcached_servers` = `None`	(List) Memcached servers or None for in process cache.
`min_rtr_adv_interval` = `30`	(Integer) MinRtrAdvInterval setting for radvd.conf
`periodic_fuzzy_delay` = `5`	(Integer) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)
`periodic_interval` = `40`	(Integer) Seconds between running periodic tasks
`report_interval` = `300`	(Integer) Interval between two metering reports
`state_path` = `/var/lib/neutron`	(String) Where to store Neutron state files. This directory must be writable by the agent.
`vlan_transparent` = `False`	(Boolean) If True, then allow plugins that support it to create VLAN transparent networks.
`web_framework` = `legacy`	(String) This will choose the web framework in which to run the Neutron API server. ‘pecan’ is a new experiemental rewrite of the API server.
[AGENT]
`check_child_processes_action` = `respawn`	(String) Action to be executed when a child process dies
`check_child_processes_interval` = `60`	(Integer) Interval between checks of child process liveness (seconds), use 0 to disable
`log_agent_heartbeats` = `False`	(Boolean) Log agent heartbeats
`polling_interval` = `2`	(Integer) The number of seconds the agent will wait between polling for local device changes.
`root_helper` = `sudo`	(String) Root helper application. Use ‘sudo neutron-rootwrap /etc/neutron/rootwrap.conf’ to use the real root filter facility. Change to ‘sudo’ to skip the filtering and just run the command directly.
`root_helper_daemon` = `None`	(String) Root helper daemon application to use when possible.
[keystone_authtoken]
`memcached_servers` = `None`	(List) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
[qos]
`notification_drivers` = `message_queue`	(List) Drivers list to use to send the update notification
[service_providers]
`service_provider` = `[]`	(Multi-valued) Defines providers for advanced services using the format: <service_type>:<name>:<driver>[:default]

Networking plug-ins¶

OpenStack Networking introduces the concept of a plug-in, which is a back-end implementation of the OpenStack Networking API. A plug-in can use a variety of technologies to implement the logical API requests. Some OpenStack Networking plug-ins might use basic Linux VLANs and IP tables, while others might use more advanced technologies, such as L2-in-L3 tunneling or OpenFlow. These sections detail the configuration options for the various plug-ins.

Modular Layer 2 (ml2) plug-in configuration options¶

The Modular Layer 2 (ml2) plug-in has two components: network types and mechanisms. You can configure these components separately. The ml2 plugin also allows administrators to perform a partial specification, where some options are specified explicitly in the configuration, and the remainder is allowed to be chosen automatically by the Compute service.

This section describes the available configuration options.

Note

OpenFlow Agent (ofagent) Mechanism driver is deprecated in favor of OpenvSwitch mechanism driver with “native” of_interface in the Mitaka release and will be removed in the next release.

Description of ML2 configuration options
Configuration option = Default value	Description
[ml2]
`extension_drivers` =	(List) An ordered list of extension driver entrypoints to be loaded from the neutron.ml2.extension_drivers namespace. For example: extension_drivers = port_security,qos
`external_network_type` = `None`	(String) Default network type for external networks when no provider attributes are specified. By default it is None, which means that if provider attributes are not specified while creating external networks then they will have the same type as tenant networks. Allowed values for external_network_type config option depend on the network type values configured in type_drivers config option.
`mechanism_drivers` =	(List) An ordered list of networking mechanism driver entrypoints to be loaded from the neutron.ml2.mechanism_drivers namespace.
`path_mtu` = `1500`	(Integer) Maximum size of an IP packet (MTU) that can traverse the underlying physical network infrastructure without fragmentation for overlay/tunnel networks. In most cases, use the same value as the global_physnet_mtu option.
`physical_network_mtus` =	(List) A list of mappings of physical networks to MTU values. The format of the mapping is <physnet>:<mtu val>. This mapping allows specifying a physical network MTU value that differs from the default global_physnet_mtu value.
`tenant_network_types` = `local`	(List) Ordered list of network_types to allocate as tenant networks. The default value ‘local’ is useful for single-box testing but provides no connectivity between hosts.
`type_drivers` = `local, flat, vlan, gre, vxlan, geneve`	(List) List of network type driver entrypoints to be loaded from the neutron.ml2.type_drivers namespace.

Modular Layer 2 (ml2) Flat Type configuration options¶

Description of ML2 Flat mechanism driver configuration options
Configuration option = Default value	Description
[ml2_type_flat]
`flat_networks` = `*`	(List) List of physical_network names with which flat networks can be created. Use default ‘*’ to allow flat networks with arbitrary physical_network names. Use an empty list to disable flat networks.

Modular Layer 2 (ml2) Geneve Type configuration options¶

Description of ML2 Geneve type driver configuration options
Configuration option = Default value	Description
[ml2_type_geneve]
`max_header_size` = `50`	(Integer) Geneve encapsulation header size is dynamic, this value is used to calculate the maximum MTU for the driver. This is the sum of the sizes of the outer ETH + IP + UDP + GENEVE header sizes. The default size for this field is 50, which is the size of the Geneve header without any additional option headers.
`vni_ranges` =	(List) Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of Geneve VNI IDs that are available for tenant network allocation

Modular Layer 2 (ml2) GRE Type configuration options¶

Description of ML2 GRE configuration options
Configuration option = Default value	Description
[ml2_type_gre]
`tunnel_id_ranges` =	(List) Comma-separated list of <tun_min>:<tun_max> tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation

Modular Layer 2 (ml2) VLAN Type configuration options¶

Description of ML2 VLAN configuration options
Configuration option = Default value	Description
[ml2_type_vlan]
`network_vlan_ranges` =	(List) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks.

Modular Layer 2 (ml2) VXLAN Type configuration options¶

Description of ML2 VXLN configuration options
Configuration option = Default value	Description
[ml2_type_vxlan]
`vni_ranges` =	(List) Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation
`vxlan_group` = `None`	(String) Multicast group for VXLAN. When configured, will enable sending all broadcast traffic to this multicast group. When left unconfigured, will disable multicast VXLAN mode.

Modular Layer 2 (ml2) OpenFlow Agent (ofagent) Mechanism configuration options¶

ofagent is deprecated in the Mitaka release.

Description of ML2 ofagent mechanism driver configuration options
Configuration option = Default value	Description
[AGENT]
`dont_fragment` = `True`	(Boolean) Set or un-set the don’t fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel.

Modular Layer 2 (ml2) L2 Population Mechanism configuration options¶

Description of ML2 L2 population configuration options
Configuration option = Default value	Description
[l2pop]
`agent_boot_time` = `180`	(Integer) Delay within which agent is expected to update existing ports whent it restarts

Modular Layer 2 (ml2) MacVTap Mechanism configuration options¶

Description of ML2 MacVTap mechanism driver configuration options
Configuration option = Default value	Description
[AGENT]
`quitting_rpc_timeout` = `10`	(Integer) Set new timeout in seconds for new rpc calls after agent receives SIGTERM. If value is set to 0, rpc timeout won’t be changed
[macvtap]
`physical_interface_mappings` =	(List) Comma-separated list of <physical_network>:<physical_interface> tuples mapping physical network names to the agent’s node-specific physical network interfaces to be used for flat and VLAN networks. All physical networks listed in network_vlan_ranges on the server should have mappings to appropriate interfaces on each agent.

Modular Layer 2 (ml2) SR-IOV Mechanism configuration options¶

Description of ML2 ML2 SR-IOV driver configuration options
Configuration option = Default value	Description
[ml2_sriov]
`supported_pci_vendor_devs` = `15b3:1004, 8086:10ca`	(List) Comma-separated list of supported PCI vendor devices, as defined by vendor_id:product_id according to the PCI ID Repository. Default enables support for Intel and Mellanox SR-IOV capable NICs.

Configure the Oslo RPC messaging system¶

OpenStack projects use an open standard for messaging middleware known as AMQP. This messaging middleware enables the OpenStack services that run on multiple servers to talk to each other. OpenStack Oslo RPC supports two implementations of AMQP: RabbitMQ and ZeroMQ.

Configure RabbitMQ¶

OpenStack Oslo RPC uses RabbitMQ by default. Use these options to configure the RabbitMQ message system. The rpc_backend option is optional as long as RabbitMQ is the default messaging system. However, if it is included the configuration, you must set it to neutron.openstack.common.rpc.impl_kombu:

rpc_backend = neutron.openstack.common.rpc.impl_kombu

Use these options to configure the RabbitMQ messaging system. You can configure messaging communication for different installation scenarios, tune retries for RabbitMQ, and define the size of the RPC thread pool. To monitor notifications through RabbitMQ, you must set the notification_driver option to neutron.openstack.common.notifier.rpc_notifier in the neutron.conf file.

Description of RabbitMQ configuration options
Configuration option = Default value	Description
[oslo_messaging_rabbit]
`amqp_auto_delete` = `False`	(Boolean) Auto-delete queues in AMQP.
`amqp_durable_queues` = `False`	(Boolean) Use durable queues in AMQP.
`channel_max` = `None`	(Integer) Maximum number of channels to allow
`default_notification_exchange` = `${control_exchange}_notification`	(String) Exchange name for for sending notifications
`default_notification_retry_attempts` = `-1`	(Integer) Reconnecting retry count in case of connectivity problem during sending notification, -1 means infinite retry.
`default_rpc_exchange` = `${control_exchange}_rpc`	(String) Exchange name for sending RPC messages
`default_rpc_retry_attempts` = `-1`	(Integer) Reconnecting retry count in case of connectivity problem during sending RPC message, -1 means infinite retry. If actual retry attempts in not 0 the rpc request could be processed more then one time
`fake_rabbit` = `False`	(Boolean) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
`frame_max` = `None`	(Integer) The maximum byte size for an AMQP frame
`heartbeat_interval` = `1`	(Integer) How often to send heartbeats for consumer’s connections
`heartbeat_rate` = `2`	(Integer) How often times during the heartbeat_timeout_threshold we check the heartbeat.
`heartbeat_timeout_threshold` = `60`	(Integer) Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disable the heartbeat). EXPERIMENTAL
`host_connection_reconnect_delay` = `0.25`	(Floating point) Set delay for reconnection to some host which has connection error
`kombu_compression` = `None`	(String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions.
`kombu_failover_strategy` = `round-robin`	(String) 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) How long to wait a missing client beforce abandoning to send it its replies. This value should not be longer than rpc_response_timeout.
`kombu_reconnect_delay` = `1.0`	(Floating point) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
`kombu_ssl_ca_certs` =	(String) SSL certification authority file (valid only if SSL enabled).
`kombu_ssl_certfile` =	(String) SSL cert file (valid only if SSL enabled).
`kombu_ssl_keyfile` =	(String) SSL key file (valid only if SSL enabled).
`kombu_ssl_version` =	(String) 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.
`notification_listener_prefetch_count` = `100`	(Integer) Max number of not acknowledged message which RabbitMQ can send to notification listener.
`notification_persistence` = `False`	(Boolean) Persist notification messages.
`notification_retry_delay` = `0.25`	(Floating point) Reconnecting retry delay in case of connectivity problem during sending notification message
`pool_max_overflow` = `0`	(Integer) Maximum number of connections to create above pool_max_size.
`pool_max_size` = `10`	(Integer) Maximum number of connections to keep queued.
`pool_recycle` = `600`	(Integer) Lifetime of a connection (since creation) in seconds or None for no recycling. Expired connections are closed on acquire.
`pool_stale` = `60`	(Integer) Threshold at which inactive (since release) connections are considered stale in seconds or None for no staleness. Stale connections are closed on acquire.
`pool_timeout` = `30`	(Integer) Default number of seconds to wait for a connections to available
`rabbit_ha_queues` = `False`	(Boolean) 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_host` = `localhost`	(String) The RabbitMQ broker address where a single node is used.
`rabbit_hosts` = `$rabbit_host:$rabbit_port`	(List) RabbitMQ HA cluster host:port pairs.
`rabbit_interval_max` = `30`	(Integer) Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
`rabbit_login_method` = `AMQPLAIN`	(String) The RabbitMQ login method.
`rabbit_max_retries` = `0`	(Integer) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
`rabbit_password` = `guest`	(String) The RabbitMQ password.
`rabbit_port` = `5672`	(Port number) The RabbitMQ broker port where a single node is used.
`rabbit_qos_prefetch_count` = `0`	(Integer) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
`rabbit_retry_backoff` = `2`	(Integer) How long to backoff for between retries when connecting to RabbitMQ.
`rabbit_retry_interval` = `1`	(Integer) How frequently to retry connecting with RabbitMQ.
`rabbit_transient_queues_ttl` = `1800`	(Integer) 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.
`rabbit_use_ssl` = `False`	(Boolean) Connect over SSL for RabbitMQ.
`rabbit_userid` = `guest`	(String) The RabbitMQ userid.
`rabbit_virtual_host` = `/`	(String) The RabbitMQ virtual host.
`rpc_listener_prefetch_count` = `100`	(Integer) Max number of not acknowledged message which RabbitMQ can send to rpc listener.
`rpc_queue_expiration` = `60`	(Integer) Time to live for rpc queues without consumers in seconds.
`rpc_reply_exchange` = `${control_exchange}_rpc_reply`	(String) Exchange name for receiving RPC replies
`rpc_reply_listener_prefetch_count` = `100`	(Integer) Max number of not acknowledged message which RabbitMQ can send to rpc reply listener.
`rpc_reply_retry_attempts` = `-1`	(Integer) Reconnecting retry count in case of connectivity problem during sending reply. -1 means infinite retry during rpc_timeout
`rpc_reply_retry_delay` = `0.25`	(Floating point) Reconnecting retry delay in case of connectivity problem during sending reply.
`rpc_retry_delay` = `0.25`	(Floating point) Reconnecting retry delay in case of connectivity problem during sending RPC message
`socket_timeout` = `0.25`	(Floating point) Set socket timeout in seconds for connection’s socket
`ssl` = `None`	(Boolean) Enable SSL
`ssl_options` = `None`	(Dict) Arguments passed to ssl.wrap_socket
`tcp_user_timeout` = `0.25`	(Floating point) Set TCP_USER_TIMEOUT in seconds for connection’s socket

Configure ZeroMQ¶

Use these options to configure the ZeroMQ messaging system for OpenStack Oslo RPC. ZeroMQ is not the default messaging system, so you must enable it by setting the rpc_backend option in the neutron.conf file.

Description of ZeroMQ configuration options
Configuration option = Default value	Description
[DEFAULT]
`rpc_zmq_bind_address` = `*`	(String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The “host” option should point or resolve to this address.
`rpc_zmq_bind_port_retries` = `100`	(Integer) Number of retries to find free port number before fail with ZMQBindError.
`rpc_zmq_concurrency` = `eventlet`	(String) Type of concurrency used. Either “native” or “eventlet”
`rpc_zmq_contexts` = `1`	(Integer) Number of ZeroMQ contexts, defaults to 1.
`rpc_zmq_host` = `localhost`	(String) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match “host” option, if running Nova.
`rpc_zmq_ipc_dir` = `/var/run/openstack`	(String) Directory for holding IPC sockets.
`rpc_zmq_matchmaker` = `redis`	(String) MatchMaker driver.
`rpc_zmq_max_port` = `65536`	(Integer) Maximal port number for random ports range.
`rpc_zmq_min_port` = `49152`	(Port number) Minimal port number for random ports range.
`rpc_zmq_topic_backlog` = `None`	(Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
`use_pub_sub` = `True`	(Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
`zmq_target_expire` = `120`	(Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).

Configure messaging¶

Use these common options to configure the RabbitMQ and ZeroMq messaging drivers in the neutron.conf file.

Description of RPC configuration options
Configuration option = Default value	Description
[DEFAULT]
`rpc_backend` = `rabbit`	(String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq.
`rpc_cast_timeout` = `-1`	(Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq.
`rpc_conn_pool_size` = `30`	(Integer) Size of RPC connection pool.
`rpc_poll_timeout` = `1`	(Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.
`rpc_response_timeout` = `60`	(Integer) Seconds to wait for a response from a call.
`rpc_state_report_workers` = `1`	(Integer) Number of RPC worker processes dedicated to state reports queue
`rpc_workers` = `1`	(Integer) Number of RPC worker processes for service
[oslo_concurrency]
`disable_process_locking` = `False`	(Boolean) Enables or disables inter-process locks.
`lock_path` = `None`	(String) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set.
[oslo_messaging]
`event_stream_topic` = `neutron_lbaas_event`	(String) topic name for receiving events from a queue
[oslo_messaging_amqp]
`allow_insecure_clients` = `False`	(Boolean) Accept clients using either SSL or plain TCP
`broadcast_prefix` = `broadcast`	(String) address prefix used when broadcasting to all servers
`container_name` = `None`	(String) Name for the AMQP container
`group_request_prefix` = `unicast`	(String) address prefix when sending to any server in group
`idle_timeout` = `0`	(Integer) Timeout for inactive connections (in seconds)
`password` =	(String) Password for message broker authentication
`sasl_config_dir` =	(String) Path to directory that contains the SASL configuration
`sasl_config_name` =	(String) Name of configuration file (without .conf suffix)
`sasl_mechanisms` =	(String) Space separated list of acceptable SASL mechanisms
`server_request_prefix` = `exclusive`	(String) address prefix used when sending to a specific server
`ssl_ca_file` =	(String) CA certificate PEM file to verify server certificate
`ssl_cert_file` =	(String) Identifying certificate PEM file to present to clients
`ssl_key_file` =	(String) Private key PEM file used to sign cert_file certificate
`ssl_key_password` = `None`	(String) Password for decrypting ssl_key_file (if encrypted)
`trace` = `False`	(Boolean) Debug: dump AMQP frames to stdout
`username` =	(String) User name for message broker authentication
[oslo_messaging_notifications]
`driver` = `[]`	(Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
`topics` = `notifications`	(List) AMQP topic used for OpenStack notifications.
`transport_url` = `None`	(String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.

Description of Redis configuration options
Configuration option = Default value	Description
[matchmaker_redis]
`check_timeout` = `20000`	(Integer) Time in ms to wait before the transaction is killed.
`host` = `127.0.0.1`	(String) Host to locate redis.
`password` =	(String) Password for Redis server (optional).
`port` = `6379`	(Port number) Use this port to connect to redis host.
`sentinel_group_name` = `oslo-messaging-zeromq`	(String) Redis replica set name.
`sentinel_hosts` =	(List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ]
`socket_timeout` = `1000`	(Integer) Timeout in ms on blocking socket operations
`wait_timeout` = `500`	(Integer) Time in ms to wait between connection attempts.

Description of AMQP configuration options
Configuration option = Default value	Description
[DEFAULT]
`control_exchange` = `neutron`	(String) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
`transport_url` = `None`	(String) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.

Agent¶

Use the following options to alter agent-related settings.

Description of agent configuration options
Configuration option = Default value	Description
[DEFAULT]
`external_pids` = `$state_path/external/pids`	(String) Location to store child pid files
`network_device_mtu` = `None`	(Integer) DEPRECATED: MTU setting for device. This option will be removed in Newton. Please use the system-wide segment_mtu setting which the agents will take into account when wiring VIFs.
`prefix_delegation_driver` = `dibbler`	(String) Driver used for ipv6 prefix delegation. This needs to be an entry point defined in the neutron.agent.linux.pd_drivers namespace. See setup.cfg for entry points included with the neutron source.
[AGENT]
`agent_type` = `Open vSwitch agent`	(String) DEPRECATED: Selects the Agent Type reported
`availability_zone` = `nova`	(String) Availability zone of this node

Layer 2 agent configuration options¶

Description of L2 agent extension configuration options
Configuration option = Default value	Description
[agent]
`extensions` =	(List) Extensions list to use

Linux Bridge agent configuration options¶

Description of Linux Bridge agent configuration options
Configuration option = Default value	Description
[AGENT]
`quitting_rpc_timeout` = `10`	(Integer) Set new timeout in seconds for new rpc calls after agent receives SIGTERM. If value is set to 0, rpc timeout won’t be changed
[LINUX_BRIDGE]
`bridge_mappings` =	(List) List of <physical_network>:<physical_bridge>
`physical_interface_mappings` =	(List) Comma-separated list of <physical_network>:<physical_interface> tuples mapping physical network names to the agent’s node-specific physical network interfaces to be used for flat and VLAN networks. All physical networks listed in network_vlan_ranges on the server should have mappings to appropriate interfaces on each agent.
[VXLAN]
`arp_responder` = `False`	(Boolean) Enable local ARP responder which provides local responses instead of performing ARP broadcast into the overlay. Enabling local ARP responder is not fully compatible with the allowed-address-pairs extension.
`enable_vxlan` = `True`	(Boolean) Enable VXLAN on the agent. Can be enabled when agent is managed by ml2 plugin using linuxbridge mechanism driver
`l2_population` = `False`	(Boolean) Extension to use alongside ml2 plugin’s l2population mechanism driver. It enables the plugin to populate VXLAN forwarding table.
`local_ip` = `None`	(Unknown) Local IP address of the VXLAN endpoints.
`tos` = `None`	(Integer) TOS for vxlan interface protocol packets.
`ttl` = `None`	(Integer) TTL for vxlan interface protocol packets.
`vxlan_group` = `224.0.0.1`	(String) Multicast group(s) for vxlan interface. A range of group addresses may be specified by using CIDR notation. Specifying a range allows different VNIs to use different group addresses, reducing or eliminating spurious broadcast traffic to the tunnel endpoints. To reserve a unique group for each possible (24-bit) VNI, use a /8 such as 239.0.0.0/8. This setting must be the same on all the agents.

Open vSwitch agent configuration options¶

Description of Open vSwitch agent configuration options
Configuration option = Default value	Description
[DEFAULT]
`ovs_integration_bridge` = `br-int`	(String) Name of Open vSwitch bridge to use
`ovs_use_veth` = `False`	(Boolean) Uses veth for an OVS interface or not. Support kernels with limited namespace support (e.g. RHEL 6.5) so long as ovs_use_veth is set to True.
`ovs_vsctl_timeout` = `10`	(Integer) Timeout in seconds for ovs-vsctl commands. If the timeout expires, ovs commands will fail with ALARMCLOCK error.
[AGENT]
`arp_responder` = `False`	(Boolean) Enable local ARP responder if it is supported. Requires OVS 2.1 and ML2 l2population driver. Allows the switch (when supporting an overlay) to respond to an ARP request locally without performing a costly ARP broadcast into the overlay.
`dont_fragment` = `True`	(Boolean) Set or un-set the don’t fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel.
`drop_flows_on_start` = `False`	(Boolean) Reset flow table on start. Setting this to True will cause brief traffic interruption.
`enable_distributed_routing` = `False`	(Boolean) Make the l2 agent run in DVR mode.
`l2_population` = `False`	(Boolean) Use ML2 l2population mechanism driver to learn remote MAC and IPs and improve tunnel scalability.
`minimize_polling` = `True`	(Boolean) Minimize polling by monitoring ovsdb for interface changes.
`ovsdb_monitor_respawn_interval` = `30`	(Integer) The number of seconds to wait before respawning the ovsdb monitor after losing communication with it.
`prevent_arp_spoofing` = `True`	(Boolean) DEPRECATED: Enable suppression of ARP responses that don’t match an IP address that belongs to the port from which they originate. Note: This prevents the VMs attached to this agent from spoofing, it doesn’t protect them from other devices which have the capability to spoof (e.g. bare metal or VMs attached to agents without this flag set to True). Spoofing rules will not be added to any ports that have port security disabled. For LinuxBridge, this requires ebtables. For OVS, it requires a version that supports matching ARP headers. This option will be removed in Newton so the only way to disable protection will be via the port security extension.
`quitting_rpc_timeout` = `10`	(Integer) Set new timeout in seconds for new rpc calls after agent receives SIGTERM. If value is set to 0, rpc timeout won’t be changed
`tunnel_csum` = `False`	(Boolean) Set or un-set the tunnel header checksum on outgoing IP packet carrying GRE/VXLAN tunnel.
`tunnel_types` =	(List) Network types supported by the agent (gre and/or vxlan).
`veth_mtu` = `9000`	(Integer) MTU size of veth interfaces
`vxlan_udp_port` = `4789`	(Port number) The UDP port to use for VXLAN tunnels.
[OVS]
`bridge_mappings` =	(List) Comma-separated list of <physical_network>:<bridge> tuples mapping physical network names to the agent’s node-specific Open vSwitch bridge names to be used for flat and VLAN networks. The length of bridge names should be no more than 11. Each bridge must exist, and should have a physical network interface configured as a port. All physical networks configured on the server should have mappings to appropriate bridges on each agent. Note: If you remove a bridge from this mapping, make sure to disconnect it from the integration bridge as it won’t be managed by the agent anymore. Deprecated for ofagent.
`datapath_type` = `system`	(String) OVS datapath to use. ‘system’ is the default value and corresponds to the kernel datapath. To enable the userspace datapath set this value to ‘netdev’.
`int_peer_patch_port` = `patch-tun`	(String) Peer patch port in integration bridge for tunnel bridge.
`integration_bridge` = `br-int`	(String) Integration bridge to use. Do not change this parameter unless you have a good reason to. This is the name of the OVS integration bridge. There is one per hypervisor. The integration bridge acts as a virtual ‘patch bay’. All VM VIFs are attached to this bridge and then ‘patched’ according to their network connectivity.
`local_ip` = `None`	(Unknown) Local IP address of tunnel endpoint.
`of_connect_timeout` = `30`	(Integer) Timeout in seconds to wait for the local switch connecting the controller. Used only for ‘native’ driver.
`of_interface` = `ovs-ofctl`	(String) OpenFlow interface to use.
`of_listen_address` = `127.0.0.1`	(Unknown) Address to listen on for OpenFlow connections. Used only for ‘native’ driver.
`of_listen_port` = `6633`	(Port number) Port to listen on for OpenFlow connections. Used only for ‘native’ driver.
`of_request_timeout` = `10`	(Integer) Timeout in seconds to wait for a single OpenFlow request. Used only for ‘native’ driver.
`ovsdb_connection` = `tcp:127.0.0.1:6640`	(String) The connection string for the native OVSDB backend. Requires the native ovsdb_interface to be enabled.
`ovsdb_interface` = `vsctl`	(String) The interface for interacting with the OVSDB
`tun_peer_patch_port` = `patch-int`	(String) Peer patch port in tunnel bridge for integration bridge.
`tunnel_bridge` = `br-tun`	(String) Tunnel bridge to use.
`use_veth_interconnection` = `False`	(Boolean) Use veths instead of patch ports to interconnect the integration bridge to physical networks. Support kernel without Open vSwitch patch port support so long as it is set to True.
`vhostuser_socket_dir` = `/var/run/openvswitch`	(String) OVS vhost-user socket directory.

IPv6 Prefix Delegation configuration options¶

Description of IPv6 Prefix Delegation driver configuration options
Configuration option = Default value	Description
[DEFAULT]
`pd_confs` = `$state_path/pd`	(String) Location to store IPv6 PD files.
`pd_dhcp_driver` = `dibbler`	(String) Service to handle DHCPv6 Prefix delegation.
`vendor_pen` = `8888`	(String) A decimal value as Vendor’s Registered Private Enterprise Number as required by RFC3315 DUID-EN.

API¶

Use the following options to alter API-related settings.

Description of API configuration options
Configuration option = Default value	Description
[DEFAULT]
`allow_bulk` = `True`	(Boolean) Allow the usage of the bulk API
`allow_pagination` = `False`	(Boolean) Allow the usage of the pagination
`allow_sorting` = `False`	(Boolean) Allow the usage of the sorting
`api_extensions_path` =	(String) The path for API extensions. Note that this can be a colon-separated list of paths. For example: api_extensions_path = extensions:/path/to/more/exts:/even/more/exts. The __path__ of neutron.extensions is appended to this, so if your extensions are in there you don’t need to specify them here.
`api_paste_config` = `api-paste.ini`	(String) File name for the paste.deploy config for api service
`backlog` = `4096`	(Integer) Number of backlog requests to configure the socket with
`client_socket_timeout` = `900`	(Integer) 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.
`max_header_line` = `16384`	(Integer) 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).
`pagination_max_limit` = `-1`	(String) The maximum number of items returned in a single response, value was ‘infinite’ or negative integer means no limit
`retry_until_window` = `30`	(Integer) Number of seconds to keep retrying to listen
`service_plugins` =	(List) The service plugins Neutron will use
`tcp_keepidle` = `600`	(Integer) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.
`wsgi_default_pool_size` = `100`	(Integer) Size of the pool of greenthreads used by wsgi
`wsgi_keep_alive` = `True`	(Boolean) If False, closes the client socket connection explicitly.
[oslo_middleware]
`max_request_body_size` = `114688`	(Integer) The maximum body size for each request, in bytes.
`secure_proxy_ssl_header` = `X-Forwarded-Proto`	(String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.
[oslo_policy]
`policy_default_rule` = `default`	(String) 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.json`	(String) The JSON file that defines policies.

Token authentication¶

Use the following options to alter token authentication settings.

Description of authorization token configuration options
Configuration option = Default value	Description
[keystone_authtoken]
`admin_password` = `None`	(String) Service user password.
`admin_tenant_name` = `admin`	(String) Service tenant name.
`admin_token` = `None`	(String) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use admin_user and admin_password instead.
`admin_user` = `None`	(String) Service username.
`auth_admin_prefix` =	(String) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
`auth_host` = `127.0.0.1`	(String) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
`auth_port` = `35357`	(Integer) Port of the admin Identity API endpoint. Deprecated, use identity_uri.
`auth_protocol` = `https`	(String) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri.
`auth_section` = `None`	(Unknown) Config Section from which to load plugin specific options
`auth_type` = `None`	(Unknown) Authentication type to load
`auth_uri` = `None`	(String) Complete public Identity API endpoint.
`auth_version` = `None`	(String) API version of the admin Identity API endpoint.
`cache` = `None`	(String) Env key for the swift cache.
`cafile` = `None`	(String) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
`certfile` = `None`	(String) Required if identity server requires client certificate
`check_revocations_for_cached` = `False`	(Boolean) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
`delay_auth_decision` = `False`	(Boolean) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
`enforce_token_bind` = `permissive`	(String) 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.
`hash_algorithms` = `md5`	(List) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
`http_connect_timeout` = `None`	(Integer) Request timeout value for communicating with Identity API server.
`http_request_max_retries` = `3`	(Integer) How many times are we trying to reconnect when communicating with Identity API Server.
`identity_uri` = `None`	(String) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/
`include_service_catalog` = `True`	(Boolean) (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) Verify HTTPS connections.
`keyfile` = `None`	(String) Required if identity server requires client certificate
`memcache_pool_conn_get_timeout` = `10`	(Integer) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
`memcache_pool_dead_retry` = `300`	(Integer) (Optional) Number of seconds memcached server is considered dead before it is tried again.
`memcache_pool_maxsize` = `10`	(Integer) (Optional) Maximum total number of open connections to every memcached server.
`memcache_pool_socket_timeout` = `3`	(Integer) (Optional) Socket timeout in seconds for communicating with a memcached server.
`memcache_pool_unused_timeout` = `60`	(Integer) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
`memcache_secret_key` = `None`	(String) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
`memcache_security_strategy` = `None`	(String) (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) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.
`region_name` = `None`	(String) The region in which the identity server can be found.
`revocation_cache_time` = `10`	(Integer) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
`signing_dir` = `None`	(String) Directory used to cache files related to PKI tokens.
`token_cache_time` = `300`	(Integer) 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.

Compute¶

Use the following options to alter Compute-related settings.

Description of Compute configuration options
Configuration option = Default value	Description
[DEFAULT]
`notify_nova_on_port_data_changes` = `True`	(Boolean) Send notification to nova when port data (fixed_ips/floatingip) changes so nova can update its cache.
`notify_nova_on_port_status_changes` = `True`	(Boolean) Send notification to nova when port status changes
`nova_client_cert` =	(String) Client certificate for nova metadata api server.
`nova_client_priv_key` =	(String) Private key of client certificate.
`send_events_interval` = `2`	(Integer) Number of seconds between sending events to nova if there are any events to send.

CORS¶

Use the following options to alter CORS-related settings.

Description of CORS configuration options
Configuration option = Default value	Description
[cors]
`allow_credentials` = `True`	(Boolean) Indicate that the actual request can include user credentials
`allow_headers` = `Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`	(List) Indicate which header field names may be used during the actual request.
`allow_methods` = `GET, POST, PUT, DELETE, OPTIONS`	(List) Indicate which methods can be used during the actual request.
`allowed_origin` = `None`	(List) Indicate whether this resource may be shared with the domain received in the requests “origin” header.
`expose_headers` = `Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`	(List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
`max_age` = `3600`	(Integer) Maximum cache age of CORS preflight requests.
[cors.subdomain]
`allow_credentials` = `True`	(Boolean) Indicate that the actual request can include user credentials
`allow_headers` = `Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`	(List) Indicate which header field names may be used during the actual request.
`allow_methods` = `GET, POST, PUT, DELETE, OPTIONS`	(List) Indicate which methods can be used during the actual request.
`allowed_origin` = `None`	(List) Indicate whether this resource may be shared with the domain received in the requests “origin” header.
`expose_headers` = `Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`	(List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
`max_age` = `3600`	(Integer) Maximum cache age of CORS preflight requests.

Database¶

Use the following options to alter Database-related settings.

Description of database configuration options
Configuration option = Default value	Description
[database]
`backend` = `sqlalchemy`	(String) The back end to use for the database.
`connection` = `None`	(String) The SQLAlchemy connection string to use to connect to the database.
`connection_debug` = `0`	(Integer) Verbosity of SQL debugging information: 0=None, 100=Everything.
`connection_trace` = `False`	(Boolean) Add Python stack traces to SQL as comment strings.
`db_inc_retry_interval` = `True`	(Boolean) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
`db_max_retries` = `20`	(Integer) 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) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
`db_retry_interval` = `1`	(Integer) Seconds between retries of a database transaction.
`idle_timeout` = `3600`	(Integer) Timeout before idle SQL connections are reaped.
`max_overflow` = `50`	(Integer) If set, use this value for max_overflow with SQLAlchemy.
`max_pool_size` = `None`	(Integer) Maximum number of SQL connections to keep open in a pool.
`max_retries` = `10`	(Integer) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
`min_pool_size` = `1`	(Integer) Minimum number of SQL connections to keep open in a pool.
`mysql_sql_mode` = `TRADITIONAL`	(String) 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) If set, use this value for pool_timeout with SQLAlchemy.
`retry_interval` = `10`	(Integer) Interval between retries of opening a SQL connection.
`slave_connection` = `None`	(String) The SQLAlchemy connection string to use to connect to the slave database.
`sqlite_db` = `oslo.sqlite`	(String) The file name to use with SQLite.
`sqlite_synchronous` = `True`	(Boolean) If True, SQLite uses synchronous mode.
`use_db_reconnect` = `False`	(Boolean) Enable the experimental use of database reconnect on connection lost.

DHCP agent¶

Use the following options to alter Database-related settings.

Description of DHCP agent configuration options
Configuration option = Default value	Description
[DEFAULT]
`advertise_mtu` = `True`	(Boolean) If True, advertise network MTU values if core plugin calculates them. MTU is advertised to running instances via DHCP and RA MTU options.
`dhcp_driver` = `neutron.agent.linux.dhcp.Dnsmasq`	(String) The driver used to manage the DHCP server.
`dnsmasq_base_log_dir` = `None`	(String) Base log dir for dnsmasq logging. The log contains DHCP and DNS log information and is useful for debugging issues with either DHCP or DNS. If this section is null, disable dnsmasq log.
`dnsmasq_config_file` =	(String) Override the default dnsmasq settings with this file.
`dnsmasq_dns_servers` = `None`	(List) Comma-separated list of the DNS servers which will be used as forwarders.
`dnsmasq_lease_max` = `16777216`	(Integer) Limit number of leases to prevent a denial-of-service.
`dnsmasq_local_resolv` = `False`	(Boolean) Enables the dnsmasq service to provide name resolution for instances via DNS resolvers on the host running the DHCP agent. Effectively removes the ‘–no-resolv’ option from the dnsmasq process arguments. Adding custom DNS resolvers to the ‘dnsmasq_dns_servers’ option disables this feature.
`enable_isolated_metadata` = `False`	(Boolean) The DHCP server can assist with providing metadata support on isolated networks. Setting this value to True will cause the DHCP server to append specific host routes to the DHCP request. The metadata service will only be activated when the subnet does not contain any router port. The guest instance must be configured to request host routes via DHCP (Option 121). This option doesn’t have any effect when force_metadata is set to True.
`enable_metadata_network` = `False`	(Boolean) Allows for serving metadata requests coming from a dedicated metadata access network whose CIDR is 169.254.169.254/16 (or larger prefix), and is connected to a Neutron router from which the VMs send metadata:1 request. In this case DHCP Option 121 will not be injected in VMs, as they will be able to reach 169.254.169.254 through a router. This option requires enable_isolated_metadata = True.
`force_metadata` = `False`	(Boolean) In some cases the Neutron router is not present to provide the metadata IP but the DHCP server can be used to provide this info. Setting this value will force the DHCP server to append specific host routes to the DHCP request. If this option is set, then the metadata service will be activated for all the networks.
`host` = `example.domain`	(String) Hostname to be used by the Neutron server, agents and services running on this machine. All the agents and services running on this machine must use the same host value.
`interface_driver` = `None`	(String) The driver used to manage the virtual interface.
`num_sync_threads` = `4`	(Integer) Number of threads to use during sync process. Should not exceed connection pool size configured on server.
`resync_interval` = `5`	(Integer) The DHCP agent will resync its state with Neutron to recover from any transient notification or RPC errors. The interval is number of seconds between attempts.

Distributed virtual router¶

Use the following options to alter DVR-related settings.

Description of DVR configuration options
Configuration option = Default value	Description
[DEFAULT]
`dvr_base_mac` = `fa:16:3f:00:00:00`	(String) The base mac address used for unique DVR instances by Neutron. The first 3 octets will remain unchanged. If the 4th octet is not 00, it will also be used. The others will be randomly generated. The ‘dvr_base_mac’ must be different from ‘base_mac’ to avoid mixing them up with MAC’s allocated for tenant ports. A 4 octet example would be dvr_base_mac = fa:16:3f:4f:00:00. The default is 3 octet
`router_distributed` = `False`	(Boolean) System-wide flag to determine the type of router that tenants can create. Only admin can override.

IPv6 router advertisement¶

Use the following options to alter IPv6 RA settings.

Description of IPv6 router advertisement configuration options
Configuration option = Default value	Description
[DEFAULT]
`ra_confs` = `$state_path/ra`	(String) Location to store IPv6 RA config files

L3 agent¶

Use the following options in the l3_agent.ini file for the L3 agent.

Description of L3 agent configuration options
Configuration option = Default value	Description
[DEFAULT]
`agent_mode` = `legacy`	(String) The working mode for the agent. Allowed modes are: ‘legacy’ - this preserves the existing behavior where the L3 agent is deployed on a centralized networking node to provide L3 services like DNAT, and SNAT. Use this mode if you do not want to adopt DVR. ‘dvr’ - this mode enables DVR functionality and must be used for an L3 agent that runs on a compute host. ‘dvr_snat’ - this enables centralized SNAT support in conjunction with DVR. This mode must be used for an L3 agent running on a centralized node (or in single-host deployments, e.g. devstack)
`allow_automatic_dhcp_failover` = `True`	(Boolean) Automatically remove networks from offline DHCP agents.
`allow_automatic_l3agent_failover` = `False`	(Boolean) Automatically reschedule routers from offline L3 agents to online L3 agents.
`enable_metadata_proxy` = `True`	(Boolean) Allow running metadata proxy.
`enable_snat_by_default` = `True`	(Boolean) Define the default value of enable_snat if not provided in external_gateway_info.
`external_ingress_mark` = `0x2`	(String) Iptables mangle mark used to mark ingress from external network. This mark will be masked with 0xffff so that only the lower 16 bits will be used.
`external_network_bridge` = `br-ex`	(String) DEPRECATED: Name of bridge used for external network traffic. This should be set to an empty value for the Linux Bridge. When this parameter is set, each L3 agent can be associated with no more than one external network. This option is deprecated and will be removed in the M release.
`gateway_external_network_id` =	(String) When external_network_bridge is set, each L3 agent can be associated with no more than one external network. This value should be set to the UUID of that external network. To allow L3 agent support multiple external networks, both the external_network_bridge and gateway_external_network_id must be left empty.
`ha_confs_path` = `$state_path/ha_confs`	(String) Location to store keepalived/conntrackd config files
`ha_vrrp_advert_int` = `2`	(Integer) The advertisement interval in seconds
`ha_vrrp_auth_password` = `None`	(String) VRRP authentication password
`ha_vrrp_auth_type` = `PASS`	(String) VRRP authentication type
`handle_internal_only_routers` = `True`	(Boolean) Indicates that this L3 agent should also handle routers that do not have an external network gateway configured. This option should be True only for a single agent in a Neutron deployment, and may be False for all agents if all routers must have an external network gateway.
`host` = `example.domain`	(String) Hostname to be used by the Neutron server, agents and services running on this machine. All the agents and services running on this machine must use the same host value.
`interface_driver` = `None`	(String) The driver used to manage the virtual interface.
`ipv6_gateway` =	(String) With IPv6, the network used for the external gateway does not need to have an associated subnet, since the automatically assigned link-local address (LLA) can be used. However, an IPv6 gateway address is needed for use as the next-hop for the default route. If no IPv6 gateway address is configured here, (and only then) the neutron router will be configured to get its default route from router advertisements (RAs) from the upstream router; in which case the upstream router must also be configured to send these RAs. The ipv6_gateway, when configured, should be the LLA of the interface on the upstream router. If a next-hop using a global unique address (GUA) is desired, it needs to be done via a subnet allocated to the network and not through this parameter.
`ipv6_pd_enabled` = `False`	(Boolean) Enables IPv6 Prefix Delegation for automatic subnet CIDR allocation. Set to True to enable IPv6 Prefix Delegation for subnet allocation in a PD-capable environment. Users making subnet creation requests for IPv6 subnets without providing a CIDR or subnetpool ID will be given a CIDR via the Prefix Delegation mechanism. Note that enabling PD will override the behavior of the default IPv6 subnetpool.
`l3_ha` = `False`	(Boolean) Enable HA mode for virtual routers.
`l3_ha_net_cidr` = `169.254.192.0/18`	(String) Subnet used for the l3 HA admin network.
`l3_ha_network_physical_name` =	(String) The physical network name with which the HA network can be created.
`l3_ha_network_type` =	(String) The network type to use when creating the HA network for an HA router. By default or if empty, the first ‘tenant_network_types’ is used. This is helpful when the VRRP traffic should use a specific network which is not the default one.
`max_l3_agents_per_router` = `3`	(Integer) Maximum number of L3 agents which a HA router will be scheduled on. If it is set to 0 then the router will be scheduled on every agent.
`min_l3_agents_per_router` = `2`	(Integer) Minimum number of L3 agents which a HA router will be scheduled on. If it is set to 0 then the router will be scheduled on every agent.
`router_id` =	(String) DEPRECATED: If non-empty, the l3 agent can only configure a router that has the matching router ID.
`send_arp_for_ha` = `3`	(Integer) Send this many gratuitous ARPs for HA setup, if less than or equal to 0, the feature is disabled
[AGENT]
`comment_iptables_rules` = `True`	(Boolean) Add comments to iptables rules. Set to false to disallow the addition of comments to generated iptables rules that describe each rule’s purpose. System must support the iptables comments module for addition of comments.
`use_helper_for_ns_read` = `True`	(Boolean) Use the root helper when listing the namespaces on a system. This may not be required depending on the security configuration. If the root helper is not required, set this to False for a performance improvement.

Logging¶

Use the following options to alter logging settings.

Description of logging configuration options
Configuration option = Default value	Description
[DEFAULT]
`debug` = `False`	(Boolean) 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, 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, dogpile.core.dogpile=INFO`	(List) List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
`fatal_deprecations` = `False`	(Boolean) Enables or disables fatal status of deprecations.
`instance_format` = `"[instance: %(uuid)s] "`	(String) The format for an instance that is passed with the log message.
`instance_uuid_format` = `"[instance: %(uuid)s] "`	(String) The format for an instance UUID that is passed with the log message.
`log_config_append` = `None`	(String) 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, logging_context_format_string).
`log_date_format` = `%Y-%m-%d %H:%M:%S`	(String) 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) (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
`log_file` = `None`	(String) (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.
`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) Format string to use for log messages with context.
`logging_debug_format_suffix` = `%(funcName)s %(pathname)s:%(lineno)d`	(String) Additional data to append to log message when logging level for the message is DEBUG.
`logging_default_format_string` = `%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s`	(String) Format string to use for log messages when context is undefined.
`logging_exception_prefix` = `%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s`	(String) Prefix each line of exception output with this format.
`logging_user_identity_format` = `%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s`	(String) Defines the format string for %(user_identity)s that is used in logging_context_format_string.
`publish_errors` = `False`	(Boolean) Enables or disables publication of error events.
`syslog_log_facility` = `LOG_USER`	(String) Syslog facility to receive log lines. This option is ignored if log_config_append is set.
`use_ssl` = `False`	(Boolean) Enable SSL on the API server
`use_stderr` = `True`	(Boolean) Log output to standard error. This option is ignored if log_config_append is set.
`use_syslog` = `False`	(Boolean) 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.
`verbose` = `True`	(Boolean) DEPRECATED: If set to false, the logging level will be set to WARNING instead of the default INFO level.
`watch_log_file` = `False`	(Boolean) 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.
`wsgi_log_format` = `%(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f`	(String) 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.
[oslo_versionedobjects]
`fatal_exception_format_errors` = `False`	(Boolean) Make exception message format errors fatal

Metadata Agent¶

Use the following options in the metadata_agent.ini file for the Metadata agent.

Description of metadata configuration options
Configuration option = Default value	Description
[DEFAULT]
`metadata_access_mark` = `0x1`	(String) Iptables mangle mark used to mark metadata valid requests. This mark will be masked with 0xffff so that only the lower 16 bits will be used.
`metadata_backlog` = `4096`	(Integer) Number of backlog requests to configure the metadata server socket with
`metadata_port` = `9697`	(Port number) TCP Port used by Neutron metadata namespace proxy.
`metadata_proxy_group` =	(String) Group (gid or name) running metadata proxy after its initialization (if empty: agent effective group).
`metadata_proxy_shared_secret` =	(String) When proxying metadata requests, Neutron signs the Instance-ID header with a shared secret to prevent spoofing. You may select any string for a secret, but it must match here and in the configuration used by the Nova Metadata Server. NOTE: Nova uses the same config key, but in [neutron] section.
`metadata_proxy_socket` = `$state_path/metadata_proxy`	(String) Location for Metadata Proxy UNIX domain socket.
`metadata_proxy_socket_mode` = `deduce`	(String) Metadata Proxy UNIX domain socket mode, 4 values allowed: ‘deduce’: deduce mode from metadata_proxy_user/group values, ‘user’: set metadata proxy socket mode to 0o644, to use when metadata_proxy_user is agent effective user or root, ‘group’: set metadata proxy socket mode to 0o664, to use when metadata_proxy_group is agent effective group or root, ‘all’: set metadata proxy socket mode to 0o666, to use otherwise.
`metadata_proxy_user` =	(String) User (uid or name) running metadata proxy after its initialization (if empty: agent effective user).
`metadata_proxy_watch_log` = `None`	(Boolean) Enable/Disable log watch by metadata proxy. It should be disabled when metadata_proxy_user/group is not allowed to read/write its log file and copytruncate logrotate option must be used if logrotate is enabled on metadata proxy log files. Option default value is deduced from metadata_proxy_user: watch log is enabled if metadata_proxy_user is agent effective user id/name.
`metadata_workers` = `2`	(Integer) Number of separate worker processes for metadata server (defaults to half of the number of CPUs)
`nova_metadata_insecure` = `False`	(Boolean) Allow to perform insecure SSL (https) requests to nova metadata
`nova_metadata_ip` = `127.0.0.1`	(String) IP address used by Nova metadata server.
`nova_metadata_port` = `8775`	(Port number) TCP Port used by Nova metadata server.
`nova_metadata_protocol` = `http`	(String) Protocol to access nova metadata, http or https

Note

Previously, the neutron metadata agent connected to a neutron server via REST API using a neutron client. This is ineffective because keystone is then fully involved into the authentication process and gets overloaded.

The neutron metadata agent has been reworked to use RPC by default to connect to a server since Kilo release. This is a typical way of interacting between neutron server and its agents. If neutron server does not support metadata RPC then neutron client will be used.

Warning

Do not run the neutron-ns-metadata-proxy proxy namespace as root on a node with the L3 agent running. In OpenStack Kilo and newer, you can change the permissions of neutron-ns-metadata-proxy after the proxy installation using the metadata_proxy_user and metadata_proxy_group options.

Metering Agent¶

Use the following options in the metering_agent.ini file for the Metering agent.

Description of metering agent configuration options
Configuration option = Default value	Description
[DEFAULT]
`driver` = `neutron.services.metering.drivers.noop.noop_driver.NoopMeteringDriver`	(String) Metering driver
`measure_interval` = `30`	(Integer) Interval between two metering measures
[AGENT]
`report_interval` = `30`	(Floating point) Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time.

Nova¶

Use the following options in the neutron.conf file to change nova-related settings.

Description of nova configuration options
Configuration option = Default value	Description
[nova]
`auth_section` = `None`	(Unknown) Config Section from which to load plugin specific options
`auth_type` = `None`	(Unknown) Authentication type to load
`cafile` = `None`	(String) PEM encoded Certificate Authority to use when verifying HTTPs connections.
`certfile` = `None`	(String) PEM encoded client certificate cert file
`endpoint_type` = `public`	(String) Type of the nova endpoint to use. This endpoint will be looked up in the keystone catalog and should be one of public, internal or admin.
`insecure` = `False`	(Boolean) Verify HTTPS connections.
`keyfile` = `None`	(String) PEM encoded client certificate key file
`region_name` = `None`	(String) Name of nova region to use. Useful if keystone manages more than one region.
`timeout` = `None`	(Integer) Timeout value for http requests

Policy¶

Use the following options in the neutron.conf file to change policy settings.

Description of policy configuration options
Configuration option = Default value	Description
[DEFAULT]
`allow_overlapping_ips` = `False`	(Boolean) Allow overlapping IP support in Neutron. Attention: the following parameter MUST be set to False if Neutron is being used in conjunction with Nova security groups.

Quotas¶

Use the following options in the neutron.conf file for the quota system.

Description of quotas configuration options
Configuration option = Default value	Description
[DEFAULT]
`max_routes` = `30`	(Integer) Maximum number of routes per router
[QUOTAS]
`default_quota` = `-1`	(Integer) Default number of resource allowed per tenant. A negative value means unlimited.
`quota_driver` = `neutron.db.quota.driver.DbQuotaDriver`	(String) Default driver to use for quota checks
`quota_firewall` = `10`	(Integer) Number of firewalls allowed per tenant. A negative value means unlimited.
`quota_firewall_policy` = `10`	(Integer) Number of firewall policies allowed per tenant. A negative value means unlimited.
`quota_firewall_rule` = `100`	(Integer) Number of firewall rules allowed per tenant. A negative value means unlimited.
`quota_floatingip` = `50`	(Integer) Number of floating IPs allowed per tenant. A negative value means unlimited.
`quota_health_monitor` = `-1`	(Integer) Number of health monitors allowed per tenant. A negative value means unlimited.
`quota_healthmonitor` = `-1`	(Integer) Number of health monitors allowed per tenant. A negative value means unlimited.
`quota_items` = `network, subnet, port`	(List) DEPRECATED: Resource name(s) that are supported in quota features. This option is now deprecated for removal.
`quota_listener` = `-1`	(Integer) Number of Loadbalancer Listeners allowed per tenant. A negative value means unlimited.
`quota_loadbalancer` = `10`	(Integer) Number of LoadBalancers allowed per tenant. A negative value means unlimited.
`quota_member` = `-1`	(Integer) Number of pool members allowed per tenant. A negative value means unlimited.
`quota_network` = `10`	(Integer) Number of networks allowed per tenant. A negative value means unlimited.
`quota_pool` = `10`	(Integer) Number of pools allowed per tenant. A negative value means unlimited.
`quota_port` = `50`	(Integer) Number of ports allowed per tenant. A negative value means unlimited.
`quota_rbac_policy` = `10`	(Integer) Default number of RBAC entries allowed per tenant. A negative value means unlimited.
`quota_router` = `10`	(Integer) Number of routers allowed per tenant. A negative value means unlimited.
`quota_security_group` = `10`	(Integer) Number of security groups allowed per tenant. A negative value means unlimited.
`quota_security_group_rule` = `100`	(Integer) Number of security rules allowed per tenant. A negative value means unlimited.
`quota_subnet` = `10`	(Integer) Number of subnets allowed per tenant, A negative value means unlimited.
`quota_vip` = `10`	(Integer) Number of vips allowed per tenant. A negative value means unlimited.
`track_quota_usage` = `True`	(Boolean) Keep in track in the database of current resourcequota usage. Plugins which do not leverage the neutron database should set this flag to False

Scheduler¶

Use the following options in the neutron.conf file to change scheduler settings.

Description of scheduler configuration options
Configuration option = Default value	Description
[DEFAULT]
`network_auto_schedule` = `True`	(Boolean) Allow auto scheduling networks to DHCP agent.
`network_scheduler_driver` = `neutron.scheduler.dhcp_agent_scheduler.WeightScheduler`	(String) Driver to use for scheduling network to DHCP agent
`router_auto_schedule` = `True`	(Boolean) Allow auto scheduling of routers to L3 agent.
`router_scheduler_driver` = `neutron.scheduler.l3_agent_scheduler.LeastRoutersScheduler`	(String) Driver to use for scheduling router to a default L3 agent

Security Groups¶

Use the following options in the configuration file for your driver to change security group settings.

Description of security groups configuration options
Configuration option = Default value	Description
[SECURITYGROUP]
`enable_ipset` = `True`	(Boolean) Use ipset to speed-up the iptables based security groups. Enabling ipset support requires that ipset is installed on L2 agent node.
`enable_security_group` = `True`	(Boolean) Controls whether the neutron security group API is enabled in the server. It should be false when using no security groups or using the nova security group API.
`firewall_driver` = `None`	(String) Driver for security groups firewall in the L2 agent

Note

Now Networking uses iptables to achieve security group functions. In L2 agent with enable_ipset option enabled, it makes use of IPset to improve security group’s performance, as it represents a hash set which is insensitive to the number of elements.

When a port is created, L2 agent will add an additional IPset chain to it’s iptables chain, if the security group that this port belongs to has rules between other security group, the member of that security group will be added to the ipset chain.

If a member of a security group is changed, it used to reload iptables rules which is expensive. However, when IPset option is enabled on L2 agent, it does not need to reload iptables if only members of security group were changed, it should just update an IPset.

Note

A single default security group has been introduced in order to avoid race conditions when creating a tenant’s default security group. The race conditions are caused by the uniqueness check of a new security group name. A table default_security_group implements such a group. It has tenant_id field as a primary key and security_group_id, which is an identifier of a default security group. The migration that introduces this table has a sanity check that verifies if a default security group is not duplicated in any tenant.

Misc¶

Description of BGP configuration options
Configuration option = Default value	Description
[BGP]
`bgp_router_id` = `None`	(String) 32-bit BGP identifier, typically an IPv4 address owned by the system running the BGP DrAgent.
`bgp_speaker_driver` = `None`	(String) BGP speaker driver class to be instantiated.

Description of QoS configuration options
Configuration option = Default value	Description
[QOS]
`kernel_hz` = `250`	(Integer) Value of host kernel tick rate (hz) for calculating minimum burst value in bandwidth limit rules for a port with QoS. See kernel configuration file for HZ value and tc-tbf manual for more information.
`tbf_latency` = `50`	(Integer) Value of latency (ms) for calculating size of queue for a port with QoS. See tc-tbf manual for more information.