Este conteúdo não está disponível no idioma selecionado.
Chapter 8. neutron
The following chapter contains information about the configuration options in the neutron service.
8.1. dhcp_agent.ini
This section contains options for the /etc/neutron/dhcp_agent.ini file.
8.1.1. DEFAULT
The following table outlines the options available under the [DEFAULT] group in the /etc/neutron/dhcp_agent.ini file.
.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| integer value | Time to sleep between reloading the DHCP allocations. This will only be invoked if the value is not 0. If a network has N updates in X seconds then we will reload once with the port changes in the X seconds and not N times. |
|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
|
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
|
| boolean value | Use broadcast in DHCP replies. |
|
| string value | Location to store DHCP server config files. |
|
| string value | The driver used to manage the DHCP server. |
|
| string value | 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 value | Override the default dnsmasq settings with this file. |
|
| list value | Comma-separated list of the DNS servers which will be used as forwarders. |
|
| boolean value | Enable dhcp-host entry with list of addresses when port has multiple IPv6 addresses in the same subnet. |
|
| integer value | Limit number of leases to prevent a denial-of-service. |
|
| boolean value | 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. |
|
| boolean value | 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. |
|
| boolean value | 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. |
|
| boolean value | Enables or disables fatal status of deprecations. |
|
| boolean value | 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. |
| `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. |
|
| string value | The driver used to manage the virtual interface. |
|
| 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). |
|
| 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. |
|
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
|
| 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. |
|
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to "interval". |
|
| 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. |
|
| string value | Log rotation type. |
|
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
|
| integer value | Maximum number of rotated log files. |
|
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
|
| integer value | Number of threads to use during sync process. Should not exceed connection pool size configured on server. |
|
| string value | Name of Open vSwitch bridge to use |
|
| boolean value | Uses veth for an OVS interface or not. Support kernels with limited namespace support (e.g. RHEL 6.5) and rate limiting on router’s gateway port so long as ovs_use_veth is set to True. |
|
| boolean value | Enables or disables publication of error events. |
|
| integer value | Maximum number of logged messages per rate_limit_interval. |
|
| 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. |
|
| integer value | Interval, number of seconds, of log rate limiting. |
|
| integer value | The DHCP agent will resync its state with Neutron to recover from any transient notification or RPC errors. The interval is maximum number of seconds between attempts. The resync can be done more often based on the events triggered. |
|
| integer value | Throttle the number of resync state events between the local DHCP state and Neutron to only once per resync_throttle seconds. The value of throttle introduces a minimum interval between resync state events. Otherwise the resync may end up in a busy-loop. The value must be less than resync_interval. |
|
| integer value | Maximum seconds to wait for a response from an RPC call. |
|
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Log output to Windows Event Log. |
|
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
|
| 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. |
8.1.2. agent
The following table outlines the options available under the [agent] group in the /etc/neutron/dhcp_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Availability zone of this node |
|
| boolean value | Log agent heartbeats |
|
| floating point value | 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. |
8.1.3. ovs
The following table outlines the options available under the [ovs] group in the /etc/neutron/dhcp_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| integer value | The maximum number of MAC addresses to learn on a bridge managed by the Neutron OVS agent. Values outside a reasonable range (10 to 1,000,000) might be overridden by Open vSwitch according to the documentation. |
|
| boolean value | Enable IGMP snooping for integration bridge. If this option is set to True, support for Internet Group Management Protocol (IGMP) is enabled in integration bridge. Setting this option to True will also enable Open vSwitch mcast-snooping-disable-flood-unregistered flag. This option will disable flooding of unregistered multicast packets to all ports. The switch will send unregistered multicast packets only to ports connected to multicast routers. |
|
| string value | The connection string for the OVSDB backend. Will be used for all ovsdb commands and by ovsdb-client when monitoring |
|
| boolean value | Enable OVSDB debug logs |
|
| integer value | Timeout in seconds for ovsdb commands. If the timeout expires, ovsdb commands will fail with ALARMCLOCK error. |
|
| string value | The Certificate Authority (CA) certificate to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
|
| string value | The SSL certificate file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
|
| string value | The SSL private key file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
8.2. l3_agent.ini
This section contains options for the /etc/neutron/l3_agent.ini file.
8.2.1. DEFAULT
The following table outlines the options available under the [DEFAULT] group in the /etc/neutron/l3_agent.ini file.
.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | 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). dvr_snat mode is not supported on a compute host. dvr_no_external - this mode enables only East/West DVR routing functionality for a L3 agent that runs on a compute host, the North/South functionality such as DNAT and SNAT will be provided by the centralized network node that is running in dvr_snat mode. This mode should be used when there is no external network connectivity on the compute host. |
|
| integer value | Number of separate API worker processes for service. If not specified, the default is equal to the number of CPUs available for best performance, capped by potential RAM usage. |
|
| boolean value | Delete all routers on L3 agent shutdown. For L3 HA routers it includes a shutdown of keepalived and the state change monitor. NOTE: Setting to True could affect the data plane when stopping or restarting the L3 agent. |
|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
|
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
|
| boolean value | Allow running metadata proxy. |
|
| string value | 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. |
|
| boolean value | Enables or disables fatal status of deprecations. |
|
| string value | Location to store keepalived config files |
|
| integer value | Number of concurrent threads for keepalived server connection requests. More threads create a higher CPU load on the agent node. |
|
| integer value | The advertisement interval in seconds |
|
| string value | VRRP authentication password |
|
| string value | VRRP authentication type |
|
| integer value | The VRRP health check interval in seconds. Values > 0 enable VRRP health checks. Setting it to 0 disables VRRP health checks. Recommended value is 5. This will cause pings to be sent to the gateway IP address(es) - requires ICMP_ECHO_REQUEST to be enabled on the gateway(s). If a gateway fails, all routers will be reported as primary, and a primary election will be repeated in a round-robin fashion, until one of the routers restores the gateway connection. |
|
| boolean value | 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. |
| `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. |
|
| string value | The driver used to manage the virtual interface. |
| `ipv6_gateway = ` | string value | 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. |
|
| 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). |
|
| 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. |
|
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
|
| 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. |
|
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to "interval". |
|
| 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. |
|
| string value | Log rotation type. |
|
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
|
| integer value | Maximum number of rotated log files. |
|
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
|
| integer value | MaxRtrAdvInterval setting for radvd.conf |
|
| string value | 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. |
|
| port value | TCP Port used by Neutron metadata namespace proxy. |
|
| integer value | MinRtrAdvInterval setting for radvd.conf |
|
| string value | Name of Open vSwitch bridge to use |
|
| boolean value | Uses veth for an OVS interface or not. Support kernels with limited namespace support (e.g. RHEL 6.5) and rate limiting on router’s gateway port so long as ovs_use_veth is set to True. |
|
| string value | Location to store IPv6 PD files. |
|
| integer value | Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) |
|
| integer value | Seconds between running periodic tasks. |
|
| string value | 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. |
|
| boolean value | Enables or disables publication of error events. |
|
| string value | Location to store IPv6 RA config files |
| `radvd_user = ` | string value | The username passed to radvd, used to drop root privileges and change user ID to username and group ID to the primary group of username. If no user specified (by default), the user executing the L3 agent will be passed. If "root" specified, because radvd is spawned as root, no "username" parameter will be passed. |
|
| integer value | Maximum number of logged messages per rate_limit_interval. |
|
| 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. |
|
| integer value | Interval, number of seconds, of log rate limiting. |
|
| integer value | Maximum seconds to wait for a response from an RPC call. |
|
| integer value | Number of RPC worker processes dedicated to state reports queue. |
|
| integer value | Number of RPC worker processes for service. If not specified, the default is equal to half the number of API workers. |
|
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Log output to Windows Event Log. |
|
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
|
| string value | A decimal value as Vendor’s Registered Private Enterprise Number as required by RFC3315 DUID-EN. |
|
| 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. |
8.2.2. agent
The following table outlines the options available under the [agent] group in the /etc/neutron/l3_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Availability zone of this node |
|
| list value | Extensions list to use |
|
| boolean value | Log agent heartbeats |
|
| floating point value | 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. |
8.2.3. network_log
The following table outlines the options available under the [network_log] group in the /etc/neutron/l3_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| integer value | Maximum number of packets per rate_limit. |
|
| string value | Output logfile path on agent side, default syslog file. |
|
| integer value | Maximum packets logging per second. |
8.2.4. ovs
The following table outlines the options available under the [ovs] group in the /etc/neutron/l3_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| integer value | The maximum number of MAC addresses to learn on a bridge managed by the Neutron OVS agent. Values outside a reasonable range (10 to 1,000,000) might be overridden by Open vSwitch according to the documentation. |
|
| boolean value | Enable IGMP snooping for integration bridge. If this option is set to True, support for Internet Group Management Protocol (IGMP) is enabled in integration bridge. Setting this option to True will also enable Open vSwitch mcast-snooping-disable-flood-unregistered flag. This option will disable flooding of unregistered multicast packets to all ports. The switch will send unregistered multicast packets only to ports connected to multicast routers. |
|
| string value | The connection string for the OVSDB backend. Will be used for all ovsdb commands and by ovsdb-client when monitoring |
|
| boolean value | Enable OVSDB debug logs |
|
| integer value | Timeout in seconds for ovsdb commands. If the timeout expires, ovsdb commands will fail with ALARMCLOCK error. |
|
| string value | The Certificate Authority (CA) certificate to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
|
| string value | The SSL certificate file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
|
| string value | The SSL private key file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
8.3. linuxbridge_agent.ini
This section contains options for the /etc/neutron/plugins/ml2/linuxbridge_agent.ini file.
8.3.1. DEFAULT
The following table outlines the options available under the [DEFAULT] group in the /etc/neutron/plugins/ml2/linuxbridge_agent.ini file.
.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
|
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
|
| boolean value | Enables or disables fatal status of deprecations. |
| `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. |
|
| 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). |
|
| 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. |
|
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
|
| 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. |
|
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to "interval". |
|
| 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. |
|
| string value | Log rotation type. |
|
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
|
| integer value | Maximum number of rotated log files. |
|
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
|
| boolean value | Enables or disables publication of error events. |
|
| integer value | Maximum number of logged messages per rate_limit_interval. |
|
| 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. |
|
| integer value | Interval, number of seconds, of log rate limiting. |
|
| integer value | Maximum seconds to wait for a response from an RPC call. |
|
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Log output to Windows Event Log. |
|
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
|
| 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. |
8.3.2. agent
The following table outlines the options available under the [agent] group in the /etc/neutron/plugins/ml2/linuxbridge_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| integer value | The DSCP value to use for outer headers during tunnel encapsulation. |
|
| boolean value | If set to True, the DSCP value of tunnel interfaces is overwritten and set to inherit. The DSCP value of the inner header is then copied to the outer header. |
|
| list value | Extensions list to use |
|
| integer value | The number of seconds the agent will wait between polling for local device changes. |
|
| integer value | 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 |
8.3.3. linux_bridge
The following table outlines the options available under the [linux_bridge] group in the /etc/neutron/plugins/ml2/linuxbridge_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| list value | List of <physical_network>:<physical_bridge> |
|
| list value | 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. |
8.3.4. network_log
The following table outlines the options available under the [network_log] group in the /etc/neutron/plugins/ml2/linuxbridge_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| integer value | Maximum number of packets per rate_limit. |
|
| string value | Output logfile path on agent side, default syslog file. |
|
| integer value | Maximum packets logging per second. |
8.3.5. securitygroup
The following table outlines the options available under the [securitygroup] group in the /etc/neutron/plugins/ml2/linuxbridge_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | Use ipset to speed-up the iptables based security groups. Enabling ipset support requires that ipset is installed on L2 agent node. |
|
| boolean value | 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. |
|
| string value | Driver for security groups firewall in the L2 agent |
|
| list value | Comma-separated list of ethertypes to be permitted, in hexadecimal (starting with "0x"). For example, "0x4008" to permit InfiniBand. |
8.3.6. vxlan
The following table outlines the options available under the [vxlan] group in the /etc/neutron/plugins/ml2/linuxbridge_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | 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. |
|
| boolean value | Enable VXLAN on the agent. Can be enabled when agent is managed by ml2 plugin using linuxbridge mechanism driver |
|
| boolean value | Extension to use alongside ml2 plugin’s l2population mechanism driver. It enables the plugin to populate VXLAN forwarding table. |
|
| IP address value | IP address of local overlay (tunnel) network endpoint. Use either an IPv4 or IPv6 address that resides on one of the host network interfaces. The IP version of this value must match the value of the overlay_ip_version option in the ML2 plug-in configuration file on the neutron server node(s). |
|
| list value | Optional comma-separated list of <multicast address>:<vni_min>:<vni_max> triples describing how to assign a multicast address to VXLAN according to its VNI ID. |
|
| integer value | TOS for vxlan interface protocol packets. This option is deprecated in favor of the dscp option in the AGENT section and will be removed in a future release. To convert the TOS value to DSCP, divide by 4. |
|
| integer value | TTL for vxlan interface protocol packets. |
|
| port value | The UDP port used for VXLAN communication. By default, the Linux kernel doesn’t use the IANA assigned standard value, so if you want to use it, this option must be set to 4789. It is not set by default because of backward compatibility. |
|
| port value | The maximum of the UDP source port range used for VXLAN communication. |
|
| port value | The minimum of the UDP source port range used for VXLAN communication. |
|
| string value | 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. |
8.4. metadata_agent.ini
This section contains options for the /etc/neutron/metadata_agent.ini file.
8.4.1. DEFAULT
The following table outlines the options available under the [DEFAULT] group in the /etc/neutron/metadata_agent.ini file.
.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Certificate Authority public key (CA cert) file for ssl |
|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
|
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
|
| boolean value | Enables or disables fatal status of deprecations. |
| `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. |
|
| 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). |
|
| 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. |
|
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
|
| 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. |
|
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to "interval". |
|
| 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. |
|
| string value | Log rotation type. |
|
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
|
| integer value | Maximum number of rotated log files. |
|
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
|
| integer value | Number of backlog requests to configure the metadata server socket with |
| `metadata_proxy_group = ` | string value | Group (gid or name) running metadata proxy after its initialization (if empty: agent effective group). |
| `metadata_proxy_shared_secret = ` | string value | 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. |
|
| string value | Location for Metadata Proxy UNIX domain socket. |
|
| string value | 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 value | User (uid or name) running metadata proxy after its initialization (if empty: agent effective user). |
|
| integer value | Number of separate worker processes for metadata server (defaults to 0 when used with ML2/OVN and half of the number of CPUs with other backend drivers) |
| `nova_client_cert = ` | string value | Client certificate for nova metadata api server. |
| `nova_client_priv_key = ` | string value | Private key of client certificate. |
|
| host address value | IP address or DNS name of Nova metadata server. |
|
| boolean value | Allow to perform insecure SSL (https) requests to nova metadata |
|
| port value | TCP Port used by Nova metadata server. |
|
| string value | Protocol to access nova metadata, http or https |
|
| boolean value | Enables or disables publication of error events. |
|
| integer value | Maximum number of logged messages per rate_limit_interval. |
|
| 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. |
|
| integer value | Interval, number of seconds, of log rate limiting. |
|
| integer value | Maximum seconds to wait for a response from an RPC call. |
|
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Log output to Windows Event Log. |
|
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
|
| 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. |
8.4.2. agent
The following table outlines the options available under the [agent] group in the /etc/neutron/metadata_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | Log agent heartbeats |
|
| floating point value | 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. |
8.4.3. cache
The following table outlines the options available under the [cache] group in the /etc/neutron/metadata_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Cache backend module. For eventlet-based or environments with hundreds of threaded servers, Memcache with pooling (oslo_cache.memcache_pool) is recommended. For environments with less than 100 threaded servers, Memcached (dogpile.cache.memcached) or Redis (dogpile.cache.redis) is recommended. Test environments with a single instance of the server can use the dogpile.cache.memory backend. |
|
| multi valued | Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: "<argname>:<value>". |
|
| string value | Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. |
|
| floating point value | Time in seconds before attempting to add a node back in the pool in the HashClient’s internal mechanisms. |
|
| boolean value | Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. |
|
| boolean value | Enable retry client mechanisms to handle failure. Those mechanisms can be used to wrap all kind of pymemcache clients. The wrapper allows you to define how many attempts to make and how long to wait between attemots. |
|
| boolean value | Global toggle for the socket keepalive of dogpile’s pymemcache backend |
|
| boolean value | Global toggle for caching. |
|
| integer value | Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn’t have an explicit cache expiration time defined for it. |
|
| integer value | Amount of times a client should be tried before it is marked dead and removed from the pool in the HashClient’s internal mechanisms. |
|
| floating point value | Time in seconds that should pass between retry attempts in the HashClient’s internal mechanisms. |
|
| integer value | Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). |
| `memcache_password = ` | string value | the password for the memcached which SASL enabled |
|
| integer value | Number of seconds that an operation will wait to get a memcache client connection. |
|
| boolean value | Global toggle if memcache will be flushed on reconnect. (oslo_cache.memcache_pool backend only). |
|
| integer value | Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). |
|
| integer value | Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). |
|
| boolean value | Enable the SASL(Simple Authentication and SecurityLayer) if the SASL_enable is true, else disable. |
|
| list value |
Memcache servers in the format of "host:port". This is used by backends dependent on Memcached.If |
|
| floating point value | Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). |
| `memcache_username = ` | string value | the user name for the memcached which SASL enabled |
|
| list value | Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. |
|
| integer value | Number of times to attempt an action before failing. |
|
| floating point value | Number of seconds to sleep between each attempt. |
|
| integer value | The maximum number of keepalive probes TCP should send before dropping the connection. Should be a positive integer greater than zero. |
|
| integer value | The time (in seconds) the connection needs to remain idle before TCP starts sending keepalive probes. Should be a positive integer most greater than zero. |
|
| integer value | The time (in seconds) between individual keepalive probes. Should be a positive integer greater than zero. |
|
| string value | Set the available ciphers for sockets created with the TLS context. It should be a string in the OpenSSL cipher list format. If not specified, all OpenSSL enabled ciphers will be available. |
|
| string value | Path to a file of concatenated CA certificates in PEM format necessary to establish the caching servers' authenticity. If tls_enabled is False, this option is ignored. |
|
| string value | Path to a single file in PEM format containing the client’s certificate as well as any number of CA certificates needed to establish the certificate’s authenticity. This file is only required when client side authentication is necessary. If tls_enabled is False, this option is ignored. |
|
| boolean value | Global toggle for TLS usage when comunicating with the caching servers. |
|
| string value | Path to a single file containing the client’s private key in. Otherwise the private key will be taken from the file specified in tls_certfile. If tls_enabled is False, this option is ignored. |
8.5. metering_agent.ini
This section contains options for the /etc/neutron/metering_agent.ini file.
8.5.1. DEFAULT
The following table outlines the options available under the [DEFAULT] group in the /etc/neutron/metering_agent.ini file.
.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
|
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
|
| string value | Metering driver |
|
| boolean value | Enables or disables fatal status of deprecations. |
|
| boolean value |
Defines if the metering agent driver should present traffic data in a granular fashion, instead of grouping all of the traffic data for all projects and routers where the labels were assigned to. The default value is |
| `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. |
|
| string value | The driver used to manage the virtual interface. |
|
| 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). |
|
| 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. |
|
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
|
| 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. |
|
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to "interval". |
|
| 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. |
|
| string value | Log rotation type. |
|
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
|
| integer value | Maximum number of rotated log files. |
|
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
|
| integer value | Interval between two metering measures |
|
| string value | Name of Open vSwitch bridge to use |
|
| boolean value | Uses veth for an OVS interface or not. Support kernels with limited namespace support (e.g. RHEL 6.5) and rate limiting on router’s gateway port so long as ovs_use_veth is set to True. |
|
| boolean value | Enables or disables publication of error events. |
|
| integer value | Maximum number of logged messages per rate_limit_interval. |
|
| 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. |
|
| integer value | Interval, number of seconds, of log rate limiting. |
|
| integer value | Interval between two metering reports |
|
| integer value | Maximum seconds to wait for a response from an RPC call. |
|
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Log output to Windows Event Log. |
|
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
|
| 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. |
8.5.2. agent
The following table outlines the options available under the [agent] group in the /etc/neutron/metering_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | Log agent heartbeats |
|
| floating point value | 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. |
8.5.3. ovs
The following table outlines the options available under the [ovs] group in the /etc/neutron/metering_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| integer value | The maximum number of MAC addresses to learn on a bridge managed by the Neutron OVS agent. Values outside a reasonable range (10 to 1,000,000) might be overridden by Open vSwitch according to the documentation. |
|
| boolean value | Enable IGMP snooping for integration bridge. If this option is set to True, support for Internet Group Management Protocol (IGMP) is enabled in integration bridge. Setting this option to True will also enable Open vSwitch mcast-snooping-disable-flood-unregistered flag. This option will disable flooding of unregistered multicast packets to all ports. The switch will send unregistered multicast packets only to ports connected to multicast routers. |
|
| string value | The connection string for the OVSDB backend. Will be used for all ovsdb commands and by ovsdb-client when monitoring |
|
| boolean value | Enable OVSDB debug logs |
|
| integer value | Timeout in seconds for ovsdb commands. If the timeout expires, ovsdb commands will fail with ALARMCLOCK error. |
|
| string value | The Certificate Authority (CA) certificate to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
|
| string value | The SSL certificate file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
|
| string value | The SSL private key file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
8.6. ml2_conf.ini
This section contains options for the /etc/neutron/plugins/ml2/ml2_conf.ini file.
8.6.1. DEFAULT
The following table outlines the options available under the [DEFAULT] group in the /etc/neutron/plugins/ml2/ml2_conf.ini file.
.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
|
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
|
| boolean value | Enables or disables fatal status of deprecations. |
| `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. |
|
| 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). |
|
| 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. |
|
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
|
| 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. |
|
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to "interval". |
|
| 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. |
|
| string value | Log rotation type. |
|
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
|
| integer value | Maximum number of rotated log files. |
|
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
|
| boolean value | Enables or disables publication of error events. |
|
| integer value | Maximum number of logged messages per rate_limit_interval. |
|
| 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. |
|
| integer value | Interval, number of seconds, of log rate limiting. |
|
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Log output to Windows Event Log. |
|
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
|
| 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. |
8.6.2. ml2
The following table outlines the options available under the [ml2] group in the /etc/neutron/plugins/ml2/ml2_conf.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| list value | An ordered list of extension driver entrypoints to be loaded from the neutron.ml2.extension_drivers namespace. For example: extension_drivers = port_security,qos |
|
| string value | 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. |
|
| list value | An ordered list of networking mechanism driver entrypoints to be loaded from the neutron.ml2.mechanism_drivers namespace. |
|
| integer value | IP version of all overlay (tunnel) network endpoints. Use a value of 4 for IPv4 or 6 for IPv6. |
|
| integer value | Maximum size of an IP packet (MTU) that can traverse the underlying physical network infrastructure without fragmentation when using an overlay/tunnel protocol. This option allows specifying a physical network MTU value that differs from the default global_physnet_mtu value. |
|
| list value | 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. |
|
| list value | 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. |
|
| string value | Resource provider name for the host with tunnelled networks. This resource provider represents the available bandwidth for all tunnelled networks in a compute node. NOTE: this parameter is used both by the Neutron server and the mechanism driver agents; it is recommended not to change it once any resource provider register has been created. |
|
| list value | List of network type driver entrypoints to be loaded from the neutron.ml2.type_drivers namespace. |
8.6.3. ml2_type_flat
The following table outlines the options available under the [ml2_type_flat] group in the /etc/neutron/plugins/ml2/ml2_conf.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| list value | 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. |
8.6.4. ml2_type_geneve
The following table outlines the options available under the [ml2_type_geneve] group in the /etc/neutron/plugins/ml2/ml2_conf.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| integer value | The maximum allowed Geneve encapsulation header size (in bytes). Geneve header is extensible, this value is used to calculate the maximum MTU for Geneve-based networks. The default is 30, which is the size of the Geneve header without any additional option headers. Note the default is not enough for OVN which requires at least 38. |
|
| list value | Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of Geneve VNI IDs that are available for tenant network allocation. Note OVN does not use the actual values. |
8.6.5. ml2_type_gre
The following table outlines the options available under the [ml2_type_gre] group in the /etc/neutron/plugins/ml2/ml2_conf.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| list value | Comma-separated list of <tun_min>:<tun_max> tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation |
8.6.6. ml2_type_vlan
The following table outlines the options available under the [ml2_type_vlan] group in the /etc/neutron/plugins/ml2/ml2_conf.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| list value | 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. If no range is defined, the whole valid VLAN ID set [1, 4094] will be assigned. |
8.6.7. ml2_type_vxlan
The following table outlines the options available under the [ml2_type_vxlan] group in the /etc/neutron/plugins/ml2/ml2_conf.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| list value | Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation |
|
| string value | Multicast group for VXLAN. When configured, will enable sending all broadcast traffic to this multicast group. When left unconfigured, will disable multicast VXLAN mode. |
8.6.8. ovs_driver
The following table outlines the options available under the [ovs_driver] group in the /etc/neutron/plugins/ml2/ml2_conf.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| list value | Comma-separated list of VNIC types for which support is administratively prohibited by the mechanism driver. Please note that the supported vnic_types depend on your network interface card, on the kernel version of your operating system, and on other factors, like OVS version. In case of ovs mechanism driver the valid vnic types are normal and direct. Note that direct is supported only from kernel 4.8, and from ovs 2.8.0. Bind DIRECT (SR-IOV) port allows to offload the OVS flows using tc to the SR-IOV NIC. This allows to support hardware offload via tc and that allows us to manage the VF by OpenFlow control plane using representor net-device. |
8.6.9. securitygroup
The following table outlines the options available under the [securitygroup] group in the /etc/neutron/plugins/ml2/ml2_conf.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | Use ipset to speed-up the iptables based security groups. Enabling ipset support requires that ipset is installed on L2 agent node. |
|
| boolean value | 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. |
|
| string value | Driver for security groups firewall in the L2 agent |
|
| list value | Comma-separated list of ethertypes to be permitted, in hexadecimal (starting with "0x"). For example, "0x4008" to permit InfiniBand. |
8.6.10. sriov_driver
The following table outlines the options available under the [sriov_driver] group in the /etc/neutron/plugins/ml2/ml2_conf.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| list value | Comma-separated list of VNIC types for which support is administratively prohibited by the mechanism driver. Please note that the supported vnic_types depend on your network interface card, on the kernel version of your operating system, and on other factors. In case of sriov mechanism driver the valid VNIC types are direct, macvtap and direct-physical. |
8.7. neutron.conf
This section contains options for the /etc/neutron/neutron.conf file.
8.7.1. DEFAULT
The following table outlines the options available under the [DEFAULT] group in the /etc/neutron/neutron.conf file.
.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| integer value | Seconds to regard the agent is down; should be at least twice report_interval, to be sure the agent is down for good. |
|
| boolean value | Automatically remove networks from offline DHCP agents. |
|
| boolean value | Automatically reschedule routers from offline L3 agents to online L3 agents. |
|
| boolean value | Allow the usage of the bulk API |
|
| list value | Defines the allowed conntrack helpers, and conntack helper module protocol constraints. |
| `api_extensions_path = ` | string value | 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. |
|
| string value | File name for the paste.deploy config for api service |
|
| integer value | Number of separate API worker processes for service. If not specified, the default is equal to the number of CPUs available for best performance, capped by potential RAM usage. |
|
| string value | The type of authentication to use |
|
| 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. |
|
| 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. |
|
| integer value | Number of backlog requests to configure the socket with |
|
| string value | 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. |
|
| host address value | The host IP to bind to. |
|
| port value | The port to bind to |
|
| 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. |
|
| integer value | The pool size limit for connections expiration policy |
|
| integer value | The time-to-live in sec of idle connections in the pool |
|
| string value | The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. |
|
| string value | The core plugin Neutron will use |
|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
|
| list value | 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. |
|
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
|
| boolean value | Allow sending resource operation notification to DHCP agent |
|
| integer value | 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 the DHCP service. However this does not provide high availability for the IPv6 metadata service in isolated networks. |
|
| integer value | DHCP lease duration (in seconds). Use -1 to tell dnsmasq to use infinite lease times. |
|
| string value | 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 |
|
| string value | Domain to use for building the hostnames |
|
| string value | 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 |
|
| boolean value | Determine if setup is configured for DVR. If False, DVR API extension will be disabled. |
|
| boolean value | 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. |
|
| boolean value | 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. |
|
| boolean value | Define the default value of enable_snat if not provided in external_gateway_info. |
|
| boolean value | If False, neutron-server will disable the following DHCP-agent related functions:1. DHCP provisioning block 2. DHCP scheduler API extension 3. Network scheduling mechanism 4. DHCP RPC/notification |
|
| integer value | Size of executor thread pool when executor is threading or eventlet. |
|
| string value | Driver for external DNS integration. |
|
| boolean value | Enables or disables fatal status of deprecations. |
|
| boolean value | If True, then allow plugins to decide whether to perform validations on filter parameters. Filter validation is enabled if this config is turned on and it is supported by all plugins |
|
| integer value | 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. |
|
| integer value | Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait. |
|
| host address value | 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. |
|
| boolean value | Flag to determine if hosting a DVR local router to the DHCP agent is desired. If False, any L3 function supported by the DHCP agent instance will not be possible, for instance: DNS. |
|
| integer value | Number of times client connections (nova, ironic) should be retried on a failed HTTP call. 0 (zero) means connection is attempted only once (not retried). Setting to any positive integer means that on failure the connection is retried that many times. For example, setting to 3 means total attempts to connect will be 4. |
| `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. |
|
| string value | The driver used to manage the virtual interface. |
|
| string value | Neutron IPAM (IP address management) driver to use. By default, the reference implementation of the Neutron IPAM driver is used. |
|
| boolean value | Warning: This feature is experimental with low test coverage, and the Dibbler client which is used for this feature is no longer maintained! 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. |
|
| boolean value | Enable HA mode for virtual routers. |
|
| string value | Subnet used for the l3 HA admin network. |
| `l3_ha_network_physical_name = ` | string value | The physical network name with which the HA network can be created. |
| `l3_ha_network_type = ` | string value | 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. |
|
| 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). |
|
| 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. |
|
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Enables or disables logging values of all registered options when starting a service (at DEBUG level). |
|
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to "interval". |
|
| 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. |
|
| string value | Log rotation type. |
|
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
|
| integer value | Maximum number of allowed address pairs |
|
| integer value | Maximum number of DNS nameservers per subnet |
|
| 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). |
|
| integer value | 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. |
|
| integer value | Maximum number of rotated log files. |
|
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
|
| integer value | Maximum number of routes per router |
|
| integer value | Maximum number of host routes per subnet |
| `metadata_proxy_group = ` | string value | Group (gid or name) running metadata proxy after its initialization (if empty: agent effective group). |
|
| string value | Location for Metadata Proxy UNIX domain socket. |
| `metadata_proxy_user = ` | string value | User (uid or name) running metadata proxy after its initialization (if empty: agent effective user). |
|
| boolean value | Allow auto scheduling networks to DHCP agent. |
|
| string value | This string is prepended to the normal URL that is returned in links to the OpenStack Network API. If it is empty (the default), the URLs are returned unchanged. |
|
| string value | Driver to use for scheduling network to DHCP agent |
|
| boolean value | Send notification to nova when port data (fixed_ips/floatingip) changes so nova can update its cache. |
|
| boolean value | Send notification to nova when port status changes |
|
| string value | The maximum number of items returned in a single response, value was infinite or negative integer means no limit |
|
| integer value | Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) |
|
| integer value | Seconds between running periodic tasks. |
|
| boolean value | Enables or disables publication of error events. |
|
| integer value | Maximum number of logged messages per rate_limit_interval. |
|
| 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. |
|
| integer value | Interval, number of seconds, of log rate limiting. |
|
| integer value | Number of seconds to keep retrying to listen |
|
| boolean value | Allow auto scheduling of routers to L3 agent. |
|
| boolean value | System-wide flag to determine the type of router that tenants can create. Only admin can override. |
|
| string value | Driver to use for scheduling router to a default L3 agent |
|
| integer value | Size of RPC connection pool. |
|
| boolean value | Add an endpoint to answer to ping calls. Endpoint is named oslo_rpc_server_ping |
|
| integer value | Number of resources for neutron to divide the large RPC call data sets. It can be reduced if RPC timeout occurred. The best value can be determined empirically in your environment. |
|
| integer value | Maximum seconds to wait for a response from an RPC call. |
|
| integer value | Seconds to wait for a response from a call. |
|
| integer value | Number of RPC worker processes dedicated to state reports queue. |
|
| integer value | Number of RPC worker processes for service. If not specified, the default is equal to half the number of API workers. |
|
| boolean value | Some periodic tasks can be run in a separate process. Should we run them here? |
|
| integer value | Number of seconds between sending events to nova if there are any events to send. |
|
| list value | The service plugins Neutron will use |
|
| string value | Set process name to match child worker role. Available options are: off - retains the previous behavior; on - renames processes to neutron-server: role (original string); brief - renames the same as on, but without the original string, such as neutron-server: role. |
|
| string value | Where to store Neutron state files. This directory must be writable by the agent. |
|
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
|
| integer value | Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. |
|
| 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 |
|
| 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. |
|
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Log output to Windows Event Log. |
|
| boolean value | Enable SSL on the API server |
|
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
|
| boolean value | If True, then allow plugins that support it to create VLAN transparent networks. |
|
| 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. |
|
| integer value | Size of the pool of greenthreads used by wsgi |
|
| boolean value | If False, closes the client socket connection explicitly. |
|
| 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. |
|
| 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. |
8.7.2. agent
The following table outlines the options available under the [agent] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Availability zone of this node |
|
| string value | Action to be executed when a child process dies |
|
| integer value | Interval between checks of child process liveness (seconds), use 0 to disable |
|
| boolean value | 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. |
|
| boolean value | Duplicate every iptables difference calculation to ensure the format being generated matches the format of iptables-save. This option should not be turned on for production systems because it imposes a performance penalty. |
|
| string value | Location of scripts used to kill external processes. Names of scripts here must follow the pattern: "<process-name>-kill" where <process-name> is name of the process which should be killed using this script. For example, kill script for dnsmasq process should be named "dnsmasq-kill". If path is set to None, then default "kill" command will be used to stop processes. |
|
| boolean value | Log agent heartbeats |
|
| floating point value | 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. |
|
| string value | 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. |
|
| string value | Root helper daemon application to use when possible. Use sudo neutron-rootwrap-daemon /etc/neutron/rootwrap.conf to run rootwrap in "daemon mode" which has been reported to improve performance at scale. For more information on running rootwrap in "daemon mode", see: https://docs.openstack.org/oslo.rootwrap/latest/user/usage.html#daemon-mode |
|
| boolean value | 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. |
|
| boolean value | Use random-fully in SNAT masquerade rules. |
8.7.3. cors
The following table outlines the options available under the [cors] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | Indicate that the actual request can include user credentials |
|
| list value | Indicate which header field names may be used during the actual request. |
|
| list value | Indicate which methods can be used during the actual request. |
|
| 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 |
|
| list value | Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
|
| integer value | Maximum cache age of CORS preflight requests. |
8.7.4. database
The following table outlines the options available under the [database] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | The back end to use for the database. |
|
| string value | The SQLAlchemy connection string to use to connect to the database. |
|
| 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¶m2=value2&… |
|
| 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. |
|
| boolean value | Add Python stack traces to SQL as comment strings. |
|
| boolean value | If True, increases the interval between retries of a database operation up to db_max_retry_interval. |
|
| 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. |
|
| integer value | If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. |
|
| integer value | Seconds between retries of a database transaction. |
| `engine = ` | string value | Database engine for which script will be generated when using offline migration. |
|
| integer value | If set, use this value for max_overflow with SQLAlchemy. |
|
| integer value | Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. |
|
| integer value | Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
|
| boolean value | If True, transparently enables support for handling MySQL Cluster (NDB). Deprecated since: 12.1.0 *Reason:*Support for the MySQL NDB Cluster storage engine has been deprecated and will be removed in a future release. |
|
| 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= |
|
| integer value | For Galera only, configure wsrep_sync_wait causality checks on new connections. Default is None, meaning don’t configure any setting. |
|
| integer value | If set, use this value for pool_timeout with SQLAlchemy. |
|
| integer value | Interval between retries of opening a SQL connection. |
|
| string value | The SQLAlchemy connection string to use to connect to the slave database. |
|
| boolean value | If True, SQLite uses synchronous mode. |
|
| boolean value | Enable the experimental use of database reconnect on connection lost. |
8.7.5. designate
The following table outlines the options available under the [designate] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Authorization URL for connecting to designate in admin context Deprecated since: Xena *Reason:*This option will be completely replaced by keystoneauth parameters. |
|
| string value | Password for connecting to designate in admin context Deprecated since: Xena *Reason:*This option will be completely replaced by keystoneauth parameters. |
|
| string value | Tenant id for connecting to designate in admin context Deprecated since: Xena *Reason:*This option will be completely replaced by keystoneauth parameters. |
|
| string value | Tenant name for connecting to designate in admin context Deprecated since: Xena *Reason:*This option will be completely replaced by keystoneauth parameters. |
|
| string value | Username for connecting to designate in admin context Deprecated since: Xena *Reason:*This option will be completely replaced by keystoneauth parameters. |
|
| boolean value | Allow the creation of PTR records |
|
| integer value | Number of bits in an ipv4 PTR zone that will be considered network prefix. It has to align to byte boundary. Minimum value is 8. Maximum value is 24. As a consequence, range of values is 8, 16 and 24 |
|
| integer value | Number of bits in an ipv6 PTR zone that will be considered network prefix. It has to align to nyble boundary. Minimum value is 4. Maximum value is 124. As a consequence, range of values is 4, 8, 12, 16,…, 124 |
| `ptr_zone_email = ` | string value | The email address to be used when creating PTR zones. If not specified, the email address will be admin@<dns_domain> |
|
| string value | URL for connecting to designate |
8.7.6. healthcheck
The following table outlines the options available under the [healthcheck] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| list value | Additional backends that can perform health checks and report that information back as part of a request. |
|
| 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. |
|
| string value | Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin. |
|
| 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. |
|
| string value | The path to respond to healtcheck requests on. |
8.7.7. ironic
The following table outlines the options available under the [ironic] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Authentication URL |
|
| string value | Authentication type to load |
|
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
|
| string value | PEM encoded client certificate cert file |
|
| boolean value | Collect per-API call timing information. |
|
| 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. |
|
| 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. |
|
| string value | Domain ID to scope to |
|
| string value | Domain name to scope to |
|
| boolean value | Send notification events to ironic. (For example on relevant port status changes.) |
|
| boolean value | Verify HTTPS connections. |
|
| string value | PEM encoded client certificate key file |
|
| string value | User’s password |
|
| string value | Domain ID containing project |
|
| string value | Domain name containing project |
|
| string value | Project ID to scope to |
|
| string value | Project name to scope to |
|
| boolean value | Log requests to multiple loggers. |
|
| string value | Scope for system operations |
|
| string value | Tenant ID |
|
| string value | Tenant Name |
|
| integer value | Timeout value for http requests |
|
| string value | ID of the trust to use as a trustee use |
|
| string value | User’s domain id |
|
| string value | User’s domain name |
|
| string value | User id |
|
| string value | Username |
8.7.8. keystone_authtoken
The following table outlines the options available under the [keystone_authtoken] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Config Section from which to load plugin specific options |
|
| string value | Authentication type to load |
|
| 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. |
|
| string value | API version of the Identity API endpoint. |
|
| 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 |
|
| string value | A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. |
|
| string value | Required if identity server requires client certificate |
|
| boolean value | Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. |
|
| 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. |
|
| integer value | Request timeout value for communicating with Identity API server. |
|
| integer value | How many times are we trying to reconnect when communicating with Identity API Server. |
|
| 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. |
|
| boolean value | Verify HTTPS connections. |
|
| string value | Interface to use for the Identity API endpoint. Valid values are "public", "internal" (default) or "admin". |
|
| string value | Required if identity server requires client certificate |
|
| integer value | (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. |
|
| integer value | (Optional) Number of seconds memcached server is considered dead before it is tried again. |
|
| integer value | (Optional) Maximum total number of open connections to every memcached server. |
|
| integer value | (Optional) Socket timeout in seconds for communicating with a memcached server. |
|
| integer value | (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. |
|
| string value | (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. |
|
| 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. |
|
| boolean value | (Optional) Use the advanced (eventlet safe) memcached client pool. |
|
| list value | Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. |
|
| string value | The region in which the identity server can be found. |
|
| 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. |
|
| 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. |
|
| 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. |
|
| 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. |
|
| 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. |
8.7.9. nova
The following table outlines the options available under the [nova] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Authentication URL |
|
| string value | Authentication type to load |
|
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
|
| string value | PEM encoded client certificate cert file |
|
| boolean value | Collect per-API call timing information. |
|
| 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. |
|
| 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. |
|
| string value | Domain ID to scope to |
|
| string value | Domain name to scope to |
|
| string value | 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. |
|
| boolean value | Verify HTTPS connections. |
|
| string value | PEM encoded client certificate key file |
|
| string value | User’s password |
|
| string value | Domain ID containing project |
|
| string value | Domain name containing project |
|
| string value | Project ID to scope to |
|
| string value | Project name to scope to |
|
| string value | Name of nova region to use. Useful if keystone manages more than one region. |
|
| boolean value | Log requests to multiple loggers. |
|
| string value | Scope for system operations |
|
| string value | Tenant ID |
|
| string value | Tenant Name |
|
| integer value | Timeout value for http requests |
|
| string value | ID of the trust to use as a trustee use |
|
| string value | User’s domain id |
|
| string value | User’s domain name |
|
| string value | User id |
|
| string value | Username |
8.7.10. oslo_concurrency
The following table outlines the options available under the [oslo_concurrency] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | Enables or disables inter-process locks. |
|
| 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. |
8.7.11. oslo_messaging_amqp
The following table outlines the options available under the [oslo_messaging_amqp] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| 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 |
|
| 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. |
|
| string value | address prefix used when broadcasting to all servers |
|
| integer value | Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt. |
|
| integer value | Seconds to pause before attempting to re-connect. |
|
| integer value | Maximum limit for connection_retry_interval + connection_retry_backoff |
|
| string value | Name for the AMQP container. must be globally unique. Defaults to a generated UUID |
|
| 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 |
|
| integer value | The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry. |
|
| integer value | The maximum number of attempts to re-send a reply message which failed due to a recoverable error. |
|
| integer value | The deadline for an rpc reply message delivery. |
|
| 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 |
|
| integer value | The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry. |
|
| integer value | The duration to schedule a purge of idle sender links. Detach link after expiry. |
|
| string value | address prefix when sending to any server in group |
|
| integer value | Timeout for inactive connections (in seconds) |
|
| integer value | Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error. |
|
| string value | Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages. |
|
| string value | Address prefix for all generated Notification addresses |
|
| integer value | Window size for incoming Notification messages |
|
| 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 |
|
| 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. |
|
| integer value | Window size for incoming RPC Reply messages. |
|
| string value | Address prefix for all generated RPC addresses |
|
| 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 |
|
| string value | address prefix used when sending to a specific server |
|
| 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) |
|
| string value | Password for decrypting ssl_key_file (if encrypted) |
|
| 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. |
|
| boolean value | Debug: dump AMQP frames to stdout |
|
| 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. |
8.7.12. oslo_messaging_kafka
The following table outlines the options available under the [oslo_messaging_kafka] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| 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 |
|
| integer value | The pool size limit for connections expiration policy |
|
| integer value | The time-to-live in sec of idle connections in the pool |
|
| string value | Group id for Kafka consumer. Consumers in one group will coordinate message consumption |
|
| boolean value | Enable asynchronous consumer commits |
|
| floating point value | Default timeout(s) for Kafka consumers |
|
| integer value | Max fetch bytes of Kafka consumer |
|
| integer value | The maximum number of records returned in a poll call |
|
| integer value | Pool Size for Kafka Consumers |
|
| integer value | Size of batch for the producer async send |
|
| floating point value | Upper bound on the delay for KafkaProducer batching in seconds |
|
| string value | Mechanism when security protocol is SASL |
|
| 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. |
8.7.13. oslo_messaging_notifications
The following table outlines the options available under the [oslo_messaging_notifications] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| multi valued | The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop |
|
| 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 |
|
| list value | AMQP topic used for OpenStack notifications. |
|
| 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. |
8.7.14. oslo_messaging_rabbit
The following table outlines the options available under the [oslo_messaging_rabbit] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | Auto-delete queues in AMQP. |
|
| boolean value | Use durable queues in AMQP. If rabbit_quorum_queue is enabled, queues will be durable and this value will be ignored. |
|
| 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 |
|
| boolean value | Enable x-cancel-on-ha-failover flag so that rabbitmq server will cancel and notify consumerswhen queue is down |
|
| 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. |
|
| integer value | How often times during the heartbeat_timeout_threshold we check the heartbeat. |
|
| integer value | Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat). |
|
| 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. |
|
| 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. |
|
| 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. |
|
| floating point value | How long to wait (in seconds) before reconnecting in response to an AMQP consumer cancel notification. |
|
| 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"} " |
|
| integer value | Maximum interval of RabbitMQ connection retries. Default is 30 seconds. |
|
| string value | The RabbitMQ login method. |
|
| integer value | Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. |
|
| integer value | Each time a message is redelivered to a consumer, a counter is incremented. Once the redelivery count exceeds the delivery limit the message gets dropped or dead-lettered (if a DLX exchange has been configured) Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit. |
|
| integer value | By default all messages are maintained in memory if a quorum queue grows in length it can put memory pressure on a cluster. This option can limit the number of memory bytes used by the quorum queue. Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit. |
|
| integer value | By default all messages are maintained in memory if a quorum queue grows in length it can put memory pressure on a cluster. This option can limit the number of messages in the quorum queue. Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit. |
|
| boolean value |
Use quorum queues in RabbitMQ (x-queue-type: quorum). The quorum queue is a modern queue type for RabbitMQ implementing a durable, replicated FIFO queue based on the Raft consensus algorithm. It is available as of RabbitMQ 3.8.0. If set this option will conflict with the HA queues ( |
|
| integer value | How long to backoff for between retries when connecting to RabbitMQ. |
|
| integer value | How frequently to retry connecting with RabbitMQ. |
|
| 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. |
|
| 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). |
|
| boolean value | Global toggle for enforcing the OpenSSL FIPS mode. This feature requires Python support. This is available in Python 3.9 in all environments and may have been backported to older Python versions on select environments. If the Python executable used does not support OpenSSL FIPS mode, an exception will be raised. |
| `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. |
8.7.15. oslo_middleware
The following table outlines the options available under the [oslo_middleware] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not. |
8.7.16. oslo_policy
The following table outlines the options available under the [oslo_policy] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value |
This option controls whether or not to use old deprecated defaults when evaluating policies. If |
|
| boolean value |
This option controls whether or not to enforce scope when evaluating policies. If |
|
| string value | Default rule. Enforced when a requested rule is not found. |
|
| 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. |
|
| 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. |
|
| string value | Content Type to send and receive data for REST based policy check |
|
| string value | Absolute path to ca cert file for REST based policy check |
|
| string value | Absolute path to client cert for REST based policy check |
|
| string value | Absolute path client key file REST based policy check |
|
| boolean value | server identity verification for REST based policy check |
8.7.17. oslo_reports
The following table outlines the options available under the [oslo_reports] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| 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. |
|
| integer value | How many seconds to wait between polls when file_event_handler is set |
|
| string value | Path to a log directory where to create a file |
8.7.18. placement
The following table outlines the options available under the [placement] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Authentication URL |
|
| string value | Authentication type to load |
|
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
|
| string value | PEM encoded client certificate cert file |
|
| boolean value | Collect per-API call timing information. |
|
| 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. |
|
| 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. |
|
| string value | Domain ID to scope to |
|
| string value | Domain name to scope to |
|
| string value | Type of the placement endpoint to use. This endpoint will be looked up in the keystone catalog and should be one of public, internal or admin. |
|
| boolean value | Verify HTTPS connections. |
|
| string value | PEM encoded client certificate key file |
|
| string value | User’s password |
|
| string value | Domain ID containing project |
|
| string value | Domain name containing project |
|
| string value | Project ID to scope to |
|
| string value | Project name to scope to |
|
| string value | Name of placement region to use. Useful if keystone manages more than one region. |
|
| boolean value | Log requests to multiple loggers. |
|
| string value | Scope for system operations |
|
| string value | Tenant ID |
|
| string value | Tenant Name |
|
| integer value | Timeout value for http requests |
|
| string value | ID of the trust to use as a trustee use |
|
| string value | User’s domain id |
|
| string value | User’s domain name |
|
| string value | User id |
|
| string value | Username |
8.7.19. privsep
The following table outlines the options available under the [privsep] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| list value | List of Linux capabilities retained by the privsep daemon. |
|
| string value | Group that the privsep daemon should run as. |
|
| string value | Command to invoke to start the privsep daemon if not using the "fork" method. If not specified, a default is generated using "sudo privsep-helper" and arguments designed to recreate the current configuration. This command must accept suitable --privsep_context and --privsep_sock_path arguments. |
|
| string value | Logger name to use for this privsep context. By default all contexts log with oslo_privsep.daemon. |
|
| integer value | The number of threads available for privsep to concurrently run processes. Defaults to the number of CPU cores in the system. |
|
| string value | User that the privsep daemon should run as. |
8.7.20. profiler
The following table outlines the options available under the [profiler] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Connection string for a notifier backend.
Default value is Examples of possible values:
|
|
| boolean value | Enable the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values:
|
|
| string value | Document type for notification indexing in elasticsearch. |
|
| integer value | Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000). |
|
| string value | This parameter is a time value parameter (for example: es_scroll_time=2m), indicating for how long the nodes that participate in the search will maintain relevant resources in order to continue and support it. |
|
| boolean value | Enable filter traces that contain error/exception to a separated place. Default value is set to False. Possible values:
|
|
| string value | Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: <key1>[,<key2>,…<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project. Both "enabled" flag and "hmac_keys" config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources. |
|
| string value |
Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example: |
|
| floating point value | Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1). |
|
| boolean value | Enable SQL requests profiling in services. Default value is False (SQL requests won’t be traced). Possible values:
|
8.7.21. quotas
The following table outlines the options available under the [quotas] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| integer value | Default number of resource allowed per tenant. A negative value means unlimited. |
|
| string value | Default driver to use for quota checks. |
|
| integer value | Number of floating IPs allowed per tenant. A negative value means unlimited. |
|
| integer value | Number of networks allowed per tenant. A negative value means unlimited. |
|
| integer value | Number of ports allowed per tenant. A negative value means unlimited. |
|
| integer value | Number of routers allowed per tenant. A negative value means unlimited. |
|
| integer value | Number of security groups allowed per tenant. A negative value means unlimited. |
|
| integer value | Number of security rules allowed per tenant. A negative value means unlimited. |
|
| integer value | Number of subnets allowed per tenant, A negative value means unlimited. |
|
| boolean value | Keep in track in the database of current resource quota usage. Plugins which do not leverage the neutron database should set this flag to False. |
8.7.22. ssl
The following table outlines the options available under the [ssl] group in the /etc/neutron/neutron.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | CA certificate file to use to verify connecting clients. |
|
| string value | Certificate file to use when starting the server securely. |
|
| string value | Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format. |
|
| string value | Private key file to use when starting the server securely. |
|
| 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. |
8.8. openvswitch_agent.ini
This section contains options for the /etc/neutron/plugins/ml2/openvswitch_agent.ini file.
8.8.1. DEFAULT
The following table outlines the options available under the [DEFAULT] group in the /etc/neutron/plugins/ml2/openvswitch_agent.ini file.
.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
|
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
|
| boolean value | Enables or disables fatal status of deprecations. |
| `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. |
|
| 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). |
|
| 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. |
|
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
|
| 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. |
|
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to "interval". |
|
| 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. |
|
| string value | Log rotation type. |
|
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
|
| integer value | Maximum number of rotated log files. |
|
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
|
| boolean value | Enables or disables publication of error events. |
|
| integer value | Maximum number of logged messages per rate_limit_interval. |
|
| 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. |
|
| integer value | Interval, number of seconds, of log rate limiting. |
|
| integer value | Maximum seconds to wait for a response from an RPC call. |
|
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Log output to Windows Event Log. |
|
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
|
| 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. |
8.8.2. agent
The following table outlines the options available under the [agent] group in the /etc/neutron/plugins/ml2/openvswitch_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | 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. NOTE: If enable_distributed_routing is set to True then arp_responder will automatically be set to True in the agent, regardless of the setting in the config file. |
|
| boolean value | Enable the agent to process Smart NIC ports. |
|
| boolean value | Set or un-set the don’t fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel. |
|
| boolean value | Reset flow table on start. Setting this to True will cause brief traffic interruption. |
|
| boolean value | Make the l2 agent run in DVR mode. |
|
| boolean value | When set to True, the accepted egress unicast traffic will not use action NORMAL. The accepted egress packets will be taken care of in the final egress tables direct output flows for unicast traffic. This will aslo change the pipleline for ingress traffic to ports without security, the final output action will be hit in table 94. |
|
| list value | Extensions list to use |
|
| boolean value | Use ML2 l2population mechanism driver to learn remote MAC and IPs and improve tunnel scalability. |
|
| boolean value | Minimize polling by monitoring ovsdb for interface changes. |
|
| integer value | The number of seconds to wait before respawning the ovsdb monitor after losing communication with it. |
|
| boolean value | Set or un-set the tunnel header checksum on outgoing IP packet carrying GRE/VXLAN tunnel. |
|
| list value | Network types supported by the agent (gre, vxlan and/or geneve). |
|
| integer value | MTU size of veth interfaces Deprecated since: Yoga *Reason:*This parameter has had no effect since the Wallaby release. |
|
| port value | The UDP port to use for VXLAN tunnels. |
8.8.3. dhcp
The following table outlines the options available under the [dhcp] group in the /etc/neutron/plugins/ml2/openvswitch_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| integer value | DHCP rebinding time T2 (in seconds). If set to 0, it will default to 7/8 of the lease time. |
|
| integer value | DHCP renewal time T1 (in seconds). If set to 0, it will default to half of the lease time. |
|
| boolean value | When set to True, the OVS agent DHCP extension will add related flows for DHCPv6 packets. |
8.8.4. network_log
The following table outlines the options available under the [network_log] group in the /etc/neutron/plugins/ml2/openvswitch_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| integer value | Maximum number of packets per rate_limit. |
|
| string value | Output logfile path on agent side, default syslog file. |
|
| integer value | Maximum packets logging per second. |
8.8.5. ovs
The following table outlines the options available under the [ovs] group in the /etc/neutron/plugins/ml2/openvswitch_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| list value | 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. |
|
| string value | 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. |
|
| string value | Peer patch port in integration bridge for tunnel bridge. |
|
| string value | 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. |
|
| IP address value | IP address of local overlay (tunnel) network endpoint. Use either an IPv4 or IPv6 address that resides on one of the host network interfaces. The IP version of this value must match the value of the overlay_ip_version option in the ML2 plug-in configuration file on the neutron server node(s). |
|
| integer value | Timeout in seconds to wait for the local switch connecting the controller. |
|
| integer value | The inactivity_probe interval in seconds for the local switch connection to the controller. A value of 0 disables inactivity probes. |
|
| IP address value | Address to listen on for OpenFlow connections. |
|
| port value | Port to listen on for OpenFlow connections. |
|
| integer value | Timeout in seconds to wait for a single OpenFlow request. |
|
| boolean value |
If enabled, all OpenFlow rules associated to a port are processed at once, in one single transaction. That avoids possible inconsistencies during OVS agent restart and port updates. If disabled, the flows will be processed in batches of |
|
| string value | The connection string for the OVSDB backend. Will be used for all ovsdb commands and by ovsdb-client when monitoring |
|
| boolean value | Enable OVSDB debug logs |
|
| list value | Comma-separated list of <bridge>:<egress_bw>:<ingress_bw> tuples, showing the available bandwidth for the given bridge in the given direction. The direction is meant from VM perspective. Bandwidth is measured in kilobits per second (kbps). The bridge must appear in bridge_mappings as the value. But not all bridges in bridge_mappings must be listed here. For a bridge not listed here we neither create a resource provider in placement nor report inventories against. An omitted direction means we do not report an inventory for the corresponding class. |
|
| string value | The default hypervisor name used to locate the parent of the resource provider. If this option is not set, canonical name is used |
|
| dict value | Mapping of bridges to hypervisors: <bridge>:<hypervisor>,… hypervisor name is used to locate the parent of the resource provider tree. Only needs to be set in the rare case when the hypervisor name is different from the resource_provider_default_hypervisor config option value as known by the nova-compute managing that hypervisor. |
|
| dict value | Key:value pairs to specify defaults used while reporting resource provider inventories. Possible keys with their types: allocation_ratio:float, max_unit:int, min_unit:int, reserved:int, step_size:int, See also: https://docs.openstack.org/api-ref/placement/#update-resource-provider-inventories |
|
| dict value | Key:value pairs to specify defaults used while reporting packet rate inventories. Possible keys with their types: allocation_ratio:float, max_unit:int, min_unit:int, reserved:int, step_size:int, See also: https://docs.openstack.org/api-ref/placement/#update-resource-provider-inventories |
|
| list value | Similar to the resource_provider_packet_processing_without_direction but used in case the OVS backend has hardware offload capabilities. In this case the format is <hypervisor>:<egress_pkt_rate>:<ingress_pkt_rate> which allows defining packet processing capacity per traffic direction. The direction is meant from the VM perspective. Note that the resource_provider_packet_processing_without_direction and the resource_provider_packet_processing_with_direction are mutually exclusive options. |
|
| list value | Comma-separated list of <hypervisor>:<packet_rate> tuples, defining the minimum packet rate the OVS backend can guarantee in kilo (1000) packet per second. The hypervisor name is used to locate the parent of the resource provider tree. Only needs to be set in the rare case when the hypervisor name is different from the DEFAULT.host config option value as known by the nova-compute managing that hypervisor or if multiple hypervisors are served by the same OVS backend. The default is :0 which means no packet processing capacity is guaranteed on the hypervisor named according to DEFAULT.host. |
|
| string value | The Certificate Authority (CA) certificate to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
|
| string value | The SSL certificate file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
|
| string value | The SSL private key file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
|
| string value | Peer patch port in tunnel bridge for integration bridge. |
|
| string value | Tunnel bridge to use. |
|
| string value | OVS vhost-user socket directory. |
8.8.6. securitygroup
The following table outlines the options available under the [securitygroup] group in the /etc/neutron/plugins/ml2/openvswitch_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | Use ipset to speed-up the iptables based security groups. Enabling ipset support requires that ipset is installed on L2 agent node. |
|
| boolean value | 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. |
|
| string value | Driver for security groups firewall in the L2 agent |
|
| list value | Comma-separated list of ethertypes to be permitted, in hexadecimal (starting with "0x"). For example, "0x4008" to permit InfiniBand. |
8.9. sriov_agent.ini
This section contains options for the /etc/neutron/plugins/ml2/sriov_agent.ini file.
8.9.1. DEFAULT
The following table outlines the options available under the [DEFAULT] group in the /etc/neutron/plugins/ml2/sriov_agent.ini file.
.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
|
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
|
| boolean value | Enables or disables fatal status of deprecations. |
| `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. |
|
| 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). |
|
| 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. |
|
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
|
| 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. |
|
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to "interval". |
|
| 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. |
|
| string value | Log rotation type. |
|
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
|
| integer value | Maximum number of rotated log files. |
|
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
|
| boolean value | Enables or disables publication of error events. |
|
| integer value | Maximum number of logged messages per rate_limit_interval. |
|
| 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. |
|
| integer value | Interval, number of seconds, of log rate limiting. |
|
| integer value | Maximum seconds to wait for a response from an RPC call. |
|
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
|
| 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. |
|
| boolean value | Log output to Windows Event Log. |
|
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
|
| 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. |
8.9.2. agent
The following table outlines the options available under the [agent] group in the /etc/neutron/plugins/ml2/sriov_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| list value | Extensions list to use |
8.9.3. sriov_nic
The following table outlines the options available under the [sriov_nic] group in the /etc/neutron/plugins/ml2/sriov_agent.ini file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| list value | Comma-separated list of <network_device>:<vfs_to_exclude> tuples, mapping network_device to the agent’s node-specific list of virtual functions that should not be used for virtual networking. vfs_to_exclude is a semicolon-separated list of virtual functions to exclude from network_device. The network_device in the mapping should appear in the physical_device_mappings list. |
|
| list value | Comma-separated list of <physical_network>:<network_device> tuples mapping physical network names to the agent’s node-specific physical network device interfaces of SR-IOV physical function to be used for VLAN networks. All physical networks listed in network_vlan_ranges on the server should have mappings to appropriate interfaces on each agent. |
|
| list value | Comma-separated list of <network_device>:<egress_bw>:<ingress_bw> tuples, showing the available bandwidth for the given device in the given direction. The direction is meant from VM perspective. Bandwidth is measured in kilobits per second (kbps). The device must appear in physical_device_mappings as the value. But not all devices in physical_device_mappings must be listed here. For a device not listed here we neither create a resource provider in placement nor report inventories against. An omitted direction means we do not report an inventory for the corresponding class. |
|
| string value | The default hypervisor name used to locate the parent of the resource provider. If this option is not set, canonical name is used |
|
| dict value | Mapping of network devices to hypervisors: <network_device>:<hypervisor>,… hypervisor name is used to locate the parent of the resource provider tree. Only needs to be set in the rare case when the hypervisor name is different from the resource_provider_default_hypervisor config option value as known by the nova-compute managing that hypervisor. |
|
| dict value | Key:value pairs to specify defaults used while reporting resource provider inventories. Possible keys with their types: allocation_ratio:float, max_unit:int, min_unit:int, reserved:int, step_size:int, See also: https://docs.openstack.org/api-ref/placement/#update-resource-provider-inventories |
