Chapter 16. Networking (neutron) Parameters

CertificateKeySize

Specifies the private key size used when creating the certificate. The default value is 2048.

ContainerOvnCertificateKeySize

Override the private key size used when creating the certificate for this service.

DhcpAgentNotification

Enables DHCP agent notifications. The default value is False.

DockerAdditionalSockets

Additional domain sockets for the docker daemon to bind to (useful for mounting into containers that launch other containers). The default value is ['/var/lib/openstack/docker.sock'].

DockerInsecureRegistryAddress

Optional. The IP Address and Port of an insecure docker namespace that will be configured in /etc/sysconfig/docker. The value can be multiple addresses separated by commas.

EnableVLANTransparency

If True, then allow plugins that support it to create VLAN transparent networks. The default value is False.

MemcacheUseAdvancedPool

Use the advanced (eventlet safe) memcached client pool. The default value is True.

NeutronAgentDownTime

Seconds to regard the agent as down; should be at least twice NeutronGlobalReportInterval, to be sure the agent is down for good. The default value is 600.

NeutronAllowL3AgentFailover

Allow automatic l3-agent failover. The default value is True.

NeutronApiOptEnvVars

Hash of optional environment variables.

NeutronApiOptVolumes

List of optional volumes to be mounted.

NeutronBridgeMappings

The logical to physical bridge mappings to use. The default (datacentre:br-ex) maps br-ex (the external bridge on hosts) to a physical name datacentre, which provider networks can use (for example, the default floating network). If changing this, either use different post-install network scripts or be sure to keep datacentre as a mapping network name. The default value is datacentre:br-ex.

NeutronCertificateKeySize

Override the private key size used when creating the certificate for this service.

NeutronCorePlugin

The core plugin for networking. The value should be the entrypoint to be loaded from neutron.core_plugins namespace. The default value is ml2.

NeutronDBSyncExtraParams

String of extra command line parameters to append to the neutron-db-manage upgrade head command.

NeutronDefaultAvailabilityZones

Comma-separated list of default network availability zones to be used by OpenStack Networking (neutron) if its resource is created without availability zone hints. If not set, no AZs will be configured for OpenStack Networking (neutron) network services.

NeutronDhcpAgentsPerNetwork

The number of DHCP agents to schedule per network. The default value is 0.

NeutronDhcpLoadType

Additional to the availability zones aware network scheduler. The default value is networks.

NeutronDnsDomain

Domain to use for building the hostnames. The default value is openstacklocal.

NeutronEnableDVR

Enable Distributed Virtual Router.

NeutronEnableIgmpSnooping

Enable IGMP Snooping. The default value is False.

NeutronFirewallDriver

Firewall driver for realizing OpenStack Networking (neutron) security group function. The default value is iptables_hybrid.

NeutronFlatNetworks

Sets the flat network name to configure in plugins. The default value is datacentre.

NeutronGeneveMaxHeaderSize

Geneve encapsulation header size. The default value is 38.

NeutronGlobalPhysnetMtu

MTU of the underlying physical network. OpenStack Networking (neutron) uses this value to calculate MTU for all virtual network components. For flat and VLAN networks, OpenStack Networking uses this value without modification. For overlay networks such as VXLAN, OpenStack Networking automatically subtracts the overlay protocol overhead from this value. The default value is 0.

NeutronGlobalReportInterval

Seconds between nodes reporting state to server; should be less than NeutronAgentDownTime, best if it is half or less than NeutronAgentDownTime. The default value is 300.

NeutronMechanismDrivers

The mechanism drivers for the OpenStack Networking (neutron) tenant network. The default value is ovn.

NeutronMetadataProxySharedSecret

Shared secret to prevent spoofing.

NeutronMetadataWorkers

Sets the number of worker processes for the OpenStack Networking (neutron) OVN metadata agent. The default value results in the configuration being left unset and a system-dependent default will be chosen (usually the number of processors). Please note that this can result in a large number of processes and memory consumption on systems with a large core count. On such systems it is recommended that a non-default value be selected that matches the load requirements.

NeutronML2PhysicalNetworkMtus

A list of mappings of physical networks to MTU values. The format of the mapping is <physnet>:<mtu val>. This mapping allows you to specify a physical network MTU value that differs from the default segment_mtu value in ML2 plugin and overwrites values from global_physnet_mtu for the selected network.

NeutronNetworkSchedulerDriver

The network schedule driver to use for availability zones. The default value is neutron.scheduler.dhcp_agent_scheduler.AZAwareWeightScheduler.

NeutronNetworkType

The tenant network type for OpenStack Networking (neutron). The default value is geneve. If you change this value, make sure the new value matches the parameter OVNEncapType. For example, if you want to use VXLAN instead of Geneve in an ML2/OVN environment, ensure that both NeutronNetworkType and OVNEncapType are set to vxlan.

NeutronNetworkVLANRanges

The OpenStack Networking (neutron) ML2 and Open vSwitch VLAN mapping range to support. Defaults to permitting any VLAN on the datacentre physical network (See NeutronBridgeMappings). The default value is datacentre:1:1000.

NeutronOverlayIPVersion

IP version used for all overlay network endpoints. The default value is 4.

NeutronOVNLoggingBurstLimit

Maximum number of packets per rate_limit. The default value is 25.

NeutronOVNLoggingLocalOutputLogBase

Output logfile path on agent side, default syslog file.

NeutronOVNLoggingRateLimit

Maximum number of packets logging per second. The default value is 100.

NeutronOvsIntegrationBridge

Name of Open vSwitch bridge to use.

NeutronOvsVnicTypeBlacklist

Comma-separated list of VNIC types for which support in OpenStack Networking (neutron) is administratively prohibited by the OVS mechanism driver.

NeutronPassword

The password for the OpenStack Networking (neutron) service and database account.

NeutronPluginExtensions

Comma-separated list of enabled extension plugins. The default value is qos,port_security,dns.

NeutronPluginMl2PuppetTags

Puppet resource tag names that are used to generate configuration files with puppet. The default value is neutron_plugin_ml2.

NeutronPortQuota

Number of ports allowed per tenant, and minus means unlimited. The default value is 500.

NeutronRouterSchedulerDriver

The router schedule driver to use for availability zones. The default value is neutron.scheduler.l3_agent_scheduler.AZLeastRoutersScheduler.

NeutronRpcWorkers

Sets the number of RPC workers for the OpenStack Networking (neutron) service. If not specified, it’ll take the value of NeutronWorkers and if this is not specified either, the default value results in the configuration being left unset and a system-dependent default will be chosen (usually 1).

NeutronServicePlugins

Comma-separated list of service plugin entrypoints. The default value is qos,ovn-router,trunk,segments,port_forwarding,log.

NeutronSriovVnicTypeBlacklist

Comma-separated list of VNIC types for which support in OpenStack Networking (neutron) is administratively prohibited by the SR-IOV mechanism driver.

NeutronTunnelIdRanges

Comma-separated list of <tun_min>:<tun_max> tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation. The default value is ['1:4094'].

NeutronTypeDrivers

Comma-separated list of network type driver entrypoints to be loaded. The default value is geneve,vxlan,vlan,flat.

NeutronVhostuserSocketDir

The vhost-user socket directory for OVS.

NeutronVniRanges

Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation. The default value is ['1:65536'].

NeutronWorkers

Sets the number of API and RPC workers for the OpenStack Networking service. Note that more workers creates a larger number of processes on systems, which results in excess memory consumption. It is recommended to choose a suitable non-default value on systems with high CPU core counts. 0 sets to the OpenStack internal default, which is equal to the number of CPU cores on the node.

NotificationDriver

Driver or drivers to handle sending notifications. The default value is noop.

OVNAvailabilityZone

The az options to configure in ovs db. eg. [az-0, az-1, az-2].

OVNCMSOptions

The CMS options to configure in ovs db.

OVNControllerImageUpdateTimeout

During update, how long we wait for the container image to be updated, in seconds. The default value is 600.

OVNControllerUpdateTimeout

During update, how long we wait for the container to be updated, in seconds. The default value is 600.

OVNDbConnectionTimeout

Timeout in seconds for the OVSDB connection transaction. The default value is 180.

OVNDnsServers

List of servers to use as as dns forwarders.

OVNEnableHaproxyDockerWrapper

Generate a wrapper script so that haproxy is launched in a separate container. The default value is True.

OVNEncapType

Type of encapsulation used in OVN. Type of encapsulation used in OVN. It can be geneve or vxlan. The default value is geneve. If you change this value, make sure the new value is also listed in the parameter NeutronNetworkType. For example, if you want to use VXLAN instead of Geneve in an ML2/OVN environment, ensure that both NeutronNetworkType and OVNEncapType are set to vxlan.

OVNIntegrationBridge

Name of the OVS bridge to use as integration bridge by OVN Controller. The default value is br-int.

OvnMetadataCertificateKeySize

Override the private key size used when creating the certificate for this service.

OVNMetadataEnabled

Whether Metadata Service has to be enabled. The default value is True.

OVNNeutronSyncMode

The synchronization mode of OVN with OpenStack Networking (neutron) DB. The default value is log.

OVNNorthboundServerPort

Port of the OVN Northbound DB server. The default value is 6641.

OVNOfctrlWaitBeforeClear

Sets the time ovn-controller will wait on startup before clearing all openflow rules and installing the new ones, in ms. The default value is 8000.

OVNOpenflowProbeInterval

The inactivity probe interval of the OpenFlow connection to the OpenvSwitch integration bridge, in seconds. The default value is 60.

OVNOvsdbProbeInterval

Probe interval in ms for the OVSDB session. The default value is 60000.

OVNQosDriver

OVN notification driver for OpenStack Networking (neutron) QOS service plugin. The default value is ovn-qos.

OVNRemoteProbeInterval

Probe interval in ms. The default value is 60000.

OVNSouthboundServerPort

Port of the OVN Southbound DB server. The default value is 6642.

OVNVifType

Type of VIF to be used for ports. The default value is ovs.

OvsHwOffload

Enable OVS Hardware Offload. This feature supported from OVS 2.8.0. The default value is False.

TenantNetPhysnetMtu

MTU of the underlying physical network. OpenStack Networking (neutron) uses this value to calculate MTU for all virtual network components. For flat and VLAN networks, OpenStack Networking (neutron) uses this value without modification. For overlay networks such as VXLAN, OpenStack Networking (neutron) automatically subtracts the overlay protocol overhead from this value. (The mtu setting of the Tenant network in network_data.yaml control’s this parameter.). The default value is 1500.