Common configuration options for all device drivers¶
This page describes configuration options that is common to all networking- baremetal device drivers. Individual drivers may have independent configuration requirements depending on the implementation, refer to the device driver specific documentation.
Configuration options¶
common-example¶
- driver¶
- Type
string
- Default
<None>
The driver to use when configuring the device
- switch_id¶
- Type
string
- Default
<None>
The switch ID, MAC address of the device.
- switch_info¶
- Type
string
- Default
<None>
Optional string field to be used to store any vendor-specific information.
- physical_networks¶
- Type
list
- Default
[]
A list of physical networks mapped to this device.
- manage_vlans¶
- Type
boolean
- Default
True
Set this to False for the device if VLANs should not be create and deleted on the device.
networking_baremetal¶
- enabled_devices¶
- Type
list
- Default
['common-example', 'netconf-openconfig-example']
This option has a sample default set, which means that its actual default value may vary from the one documented above.
Enabled devices for which the plugin should manageconfiguration. Driver specific configuration for each device must be added in separate sections.
Sample Configuration File¶
The following is a sample configuration section that would be added to
/etc/neutron/plugins/ml2/ml2_conf.ini
.
The sample configuration can also be viewed in file form
.
Important
The sample configuration file is auto-generated from networking-baremetal when this documentation is built. You must ensure your version of networking-baremetal matches the version of this documentation.
[DEFAULT]
[common-example]
#
# From common-device-driver-opts
#
# The driver to use when configuring the device (string value)
#driver = <None>
# The switch ID, MAC address of the device. (string value)
#switch_id = <None>
# Optional string field to be used to store any vendor-specific information.
# (string value)
#switch_info = <None>
# A list of physical networks mapped to this device. (list value)
#physical_networks =
# Set this to False for the device if VLANs should not be create and deleted on
# the device. (boolean value)
#manage_vlans = true
[networking_baremetal]
#
# From common-device-driver-opts
#
# Enabled devices for which the plugin should manageconfiguration. Driver
# specific configuration for each device must be added in separate sections.
# (list value)
#
# This option has a sample default set, which means that
# its actual default value may vary from the one documented
# below.
#enabled_devices = common-example,netconf-openconfig-example