Appendix D. Network Interface Parameters

The following table defines the Heat template parameters for network interface types.

Table D.1. Interface options

Option
Default
Description
name
Name of the Interface
use_dhcp
False
Use DHCP to get an IP address
use_dhcpv6
False
Use DHCP to get a v6 IP address
addresses
A sequence of IP addresses assigned to the interface
routes
A sequence of routes assigned to the interface
mtu
1500
The maximum transmission unit (MTU) of the connection
primary
False
Defines the interface as the primary interface
defroute
True
Use this interface as the default route
persist_mapping
False
Write the device alias configuration instead of the system names
dhclient_args
None
Arguments to pass to the DHCP client
dns_servers
None
List of DNS servers to use for the interface

Table D.2. VLAN options

Option
Default
Description
vlan_id
The VLAN ID
device
The VLAN's parent device to attach the VLAN. For example, use this parameter to attach the VLAN to a bonded interface device.
use_dhcp
False
Use DHCP to get an IP address
use_dhcpv6
False
Use DHCP to get a v6 IP address
addresses
A sequence of IP addresses assigned to the VLAN
routes
A sequence of routes assigned to the VLAN
mtu
1500
The maximum transmission unit (MTU) of the connection
primary
False
Defines the VLAN as the primary interface
defroute
True
Use this interface as the default route
persist_mapping
False
Write the device alias configuration instead of the system names
dhclient_args
None
Arguments to pass to the DHCP client
dns_servers
None
List of DNS servers to use for the VLAN

Table D.3. OVS Bond options

Option
Default
Description
name
Name of the bond
use_dhcp
False
Use DHCP to get an IP address
use_dhcpv6
False
Use DHCP to get a v6 IP address
addresses
A sequence of IP addresses assigned to the bond
routes
A sequence of routes assigned to the bond
mtu
1500
The maximum transmission unit (MTU) of the connection
primary
False
Defines the interface as the primary interface
members
A sequence of interface objects to use in the bond
ovs_options
A set of options to pass to OVS when creating the bond
ovs_extra
A set of options to to set as the OVS_EXTRA parameter in the bond's network configuration file
defroute
True
Use this interface as the default route
persist_mapping
False
Write the device alias configuration instead of the system names
dhclient_args
None
Arguments to pass to the DHCP client
dns_servers
None
List of DNS servers to use for the bond

Table D.4. OVS Bridge options

Option
Default
Description
name
Name of the bridge
use_dhcp
False
Use DHCP to get an IP address
use_dhcpv6
False
Use DHCP to get a v6 IP address
addresses
A sequence of IP addresses assigned to the bridge
routes
A sequence of routes assigned to the bridge
mtu
1500
The maximum transmission unit (MTU) of the connection
members
A sequence of interface, VLAN, and bond objects to use in the bridge
ovs_options
A set of options to pass to OVS when creating the bridge
ovs_extra
A set of options to to set as the OVS_EXTRA parameter in the bridge's  network configuration file
defroute
True
Use this interface as the default route
persist_mapping
False
Write the device alias configuration instead of the system names
dhclient_args
None
Arguments to pass to the DHCP client
dns_servers
None
List of DNS servers to use for the bridge

Table D.5. Linux Bond options

Option
Default
Description
name
Name of the bond
use_dhcp
False
Use DHCP to get an IP address
use_dhcpv6
False
Use DHCP to get a v6 IP address
addresses
A sequence of IP addresses assigned to the bond
routes
A sequence of routes assigned to the bond
mtu
1500
The maximum transmission unit (MTU) of the connection
primary
False
Defines the interface as the primary interface
members
A sequence of interface objects to use in the bond
bonding_options
A set of options when creating the bond. For more information on Linux bonding options, see 4.5.1. Bonding Module Directives in the Red Hat Enterprise Linux 7 Networking Guide.
defroute
True
Use this interface as the default route
persist_mapping
False
Write the device alias configuration instead of the system names
dhclient_args
None
Arguments to pass to the DHCP client
dns_servers
None
List of DNS servers to use for the bond

Table D.6. Linux Bridge options

Option
Default
Description
name
Name of the bridge
use_dhcp
False
Use DHCP to get an IP address
use_dhcpv6
False
Use DHCP to get a v6 IP address
addresses
A sequence of IP addresses assigned to the bridge
routes
A sequence of routes assigned to the bridge
mtu
1500
The maximum transmission unit (MTU) of the connection
members
A sequence of interface, VLAN, and bond objects to use in the bridge
defroute
True
Use this interface as the default route
persist_mapping
False
Write the device alias configuration instead of the system names
dhclient_args
None
Arguments to pass to the DHCP client
dns_servers
None
List of DNS servers to use for the bridge