Go to main content

Customizing Automated Installations With Manifests and Profiles

Exit Print View

Updated: November 2020
 
 

Network Properties

This appendix provides an overview of the properties and property groups that can be used in a system configuration profile to define a network. The appendix covers the following topics:


Note -  For detailed information about the properties, refer to the dladm(8) and ipadm(8) man pages.

Datalink Service Instance

Use the network/datalink-management:default service instance to configure datalink networks, flows and WLANs. You can configure each network type, using the property groups and properties described in this section.

Datalink Properties

The following section covers all of the properties and property groups that are part of the datalinks property group in the network/datalink-management:default service. These values are defined within per-datalink property groups nested within the datalinks property group. The property group name is the name of the datalink, for example net0, and the property group type is the datalink class.

Properties for the following datalink classes are included:

Shared Datalink Properties

The following table provides a description of properties that are common to most datalink classes. These properties are defined in per-datalink property groups nested within the datalinks property group. The property group name is the name of the datalink, for example net0, and the property group type is the datalink class, for example datalink-phys.

Table 3  Properties Shared By Many Datalink Property Groups
Property
Type
Description
autopush
astring
STREAM modules to push on stream for link.
allowed-dhcp-cids
astring
Outbound packet allowed DHCP client ids for non-global zones.
allowed-ips
astring
Outbound packet allowed source IP addresses for non-global zones.
bridge
astring
Bridge that link is member of.
bw-share
astring
Minimum percentage share of bandwidth.
cos
count
802.1p priority associated with the link. Range is 0 to 7.
cpus
astring
Bind packet processing to specific CPUs for link.
forward
boolean
Forwarding for a VLAN. Set the value to true to enable; false to disable.
mtu
count
Maximum client send data unit (SDU) supported by the device. Valid range is 68-65536.
mac-address
astring
Primary MAC address for the datalink.
max-bw
count
Full duplex bandwidth. The bandwidth is specified as an integer with one of the scale suffixes (K, M, or G for Kbps, Mbps, and Gbps). The default is no bandwidth limit.
pool
astring
Bind packet processing to a specified processor pool.
priority
astring
Relative priority of the link. Set the value to low, medium or high.
protection
astring
Link protection. The value can be dhcp-nospoof for DHCP client ID (DUID for DHCPv6) and hardware address anti-spoof, ip-nospoof for IP address anti-spoof; mac-nospoof for MAC address anti-spoof; and restricted to restrict outgoing packet types to just IPv4, IPv6, and ARP.
rx-fanout
astring
Number of receive-side fan out threads.
rx-rings
astring
Number of receive rings for a MAC client.
tx-rings
astring
Number of transmit rings for a MAC client.

Aggregation Datalink Properties

This datalink class is for Link Aggregation as either Datalink Multipathing (dlmp) or IEEE 802.3ad trunk. For more information see Chapter 2, Configuring High Availability by Using Link Aggregations in Managing Network Datalinks in Oracle Solaris 11.4. In addition to the class specific properties listed below, any system configuration profile including the datalink-aggr property group type may also include the shared datalink properties. See Shared Datalink Properties.

A sample system configuration profile using the datalink-aggr property group type can be seen in /usr/share/auto_install/sc_profiles/vnic_network.xml.

Table 4  Aggregation Datalink Properties
Property
Type
Description
aggr-mode
astring
IEEE 802.3ad complaint link aggregation mode.
default-tag
astring
Default VLAN ID. The range for the ID is from 0 to 4094.
force
boolean
Force creation even if underlying MAC does not support link update notification. Set the value to true to enable; false to disable.
gvrp-timeout
count
Wait between VID announcment broadcasts in milliseconds. Also see vlan-announce.
key
count
Aggregation key.
lacp-mode
astring
Link aggregation control protocol (LACP) activation mode.
lacp-timer
astring
LACP timer.
learn-decay
count
Decay rate for source changes limited by learn-limit.
learn-limit
count
Number of MAC sources to be learned over a bridge.
num-ports
count
Number of aggregate ports.
ofport
count
OpenFlow port assigned to the datalink.
openvswitch
astring
Switching on the physical datalink is managed by Open vSwitch (OVS). The value can be on or off.
policy
astring
Aggregation policies.
poll
astring
Poll mode. The value can be auto to select the default poll setting; on to enable polling; or off to disable polling.
ports
astring
Port names.
probe-ip
astring
Source IP addresses for ICMP probing.
probe-fdt
astring
Fault detection time.
probe-vlan-id
count
VLAN ID for ICMP and transitive probing.
pvlan-tag-mode
astring
Determines how outbound packets are tagged. Allowed values are primary to use the primary VID or secondary to use the secondary VID.
stp
boolean
Spanning Tree Protocol (STP) on a bridge. Set the value to true to enable, or false to disable.
stp-cost
count
STP and RSTP cost.
stp-edge
count
Bridge edge port detection. Set the value to 1 to enable, or 0 to disable.
stp-mcheck
boolean
RSTP Force BPDU migration check. Set the value to true to enable, or false to disable.
stp-p2p
astring
Bridge point-to-point operation mode. If the value is true, port mode is forced to use point-to-point. If the value is false, port mode is forced to use normal multipoint mode. If the value is auto, point-to-point connections are automatically discovered.
stp-priority
count
STP and RSTP port priority value. The range can be between 0 and 255.
tag
astring
Tag associated with link.
tag-mode
astring
802.1Q VLAN tag control. If the value is normal, the service will add a VLAN tag if the outgoing packet belongs to a VLAN or if the user \selected priority tagging. If the value is vlanonly then the service will add a VLAN tag when the outgoing packet belongs to a VLAN.
tph
astring
Transaction processing hints (TPH) that allowed I/O devices to populate data. Set the value to on to turn TPH on, off to turn TPH off, or auto for the OS to decide whether to enable TPH on link.
virtual-switching
astring
Inter-VM communication policy. Set the value to auto to automatically configure inter-VM communication with LLDP, locale to select that inter-VM communication to be switched locally; and remote to configure switches as pass-through.
vlan-announce
astring
Automatic VLAN ID announcement control. The value is off by default. This is enabled by default. The value can be off, or gvrp to select announcements sent using GVRP protocol, as defined in 802.1D. Also see gvrp-timeout.

Bridge Datalink Properties

The bridge datalink class is for a bridge datalink instance. The datalink-bridge property group type only uses shared datalink properties. See Shared Datalink Properties.

Packet Capture Datalink Properties

The cap datalink class is for a packet capture datalink instance. The datalink-cap property group type only uses shared datalink properties. See Shared Datalink Properties.

Ethernet Over InfiniBand Datalink Properties

In addition to the class specific properties listed below, any system configuration profile including the datalink-eoib property group type may also include the shared datalink properties. See Shared Datalink Properties.

Table 5  Properties for EOIB
Property
Type
Description
default-tag
astring
Default VLAN ID. The range for the ID is from 0 to 4094.
gvrp-timeout
count
Wait between VID announcement broadcasts in milliseconds. Also see vlan-announce.
gwname
astring
InfiniBand gateway name.
gwport
astring
InfiniBand gateway port.
ibport
astring
InfiniBand port.
learn-decay
count
Decay rate for source changes limited by learn-limit.
learn-limit
count
Number of MAC sources to be learned over a bridge.
speed
count
Link speed of physical Ethernet over InfiniBand datalink.
stp
boolean
Spanning Tree Protocol (STP) on a bridge. Set the value to true to enable, false to disable.
stp-cost
count
STP and RSTP cost.
stp-edge
count
Bridge edge port detection. Set the value to 1 to enable, 0 to disable.
stp-mcheck
boolean
RSTP force BPDU migration check. Set the value to true to enable, false to disable.
stp-p2p
astring
Bridge point-to-point operation mode. If the value is true, port mode is forced to use point-to-point. If the value is false, port mode is forced to use normal multipoint mode. If the value is auto, point-to-point connections are automatically discovered.
stp-priority
count
STP and RSTP port priority value. The range can be between 0 and 255.
tag-mode
astring
802.1Q VLAN tag control. If the value is normal, the service will add a VLAN tag if the outgoing packet belongs to a VLAN or if the user selected priority tagging. If the value is vlanonly then the service will add a VLAN tag when the outgoing packet belongs to a VLAN.
vlan-announce
astring
Automatic VLAN ID announcement control. The value is off by default. The value can be off, or gvrp to select announcements sent using GVRP protocol, as defined in 802.1D. Also see gvrp-timeout.

Ethernet Stub Datalink Properties

In addition to the class specific properties listed below, any system configuration profile including the datalink-etherstub property group type may also include the shared datalink properties. See Shared Datalink Properties.

Table 6  Ethernet Stub Datalink Properties
Property
Type
Description
default-tag
count
Default VLAN ID. The range for the ID is from 0 to 4094.
learn-decay
count
Decay rate for source changes limited by learn-limit. See also learn-limit.
learn-limit
count
Number of MAC sources to be learned over a bridge.
mac-address-len
count
MAC address length.
mac-address-prefix-len
count
MAC address prefix length.
mac-address-slot
count
Factory MAC address slot.
mac-address-type
astring
MAC address type. You can set the following values: factory, fixed, random, and unknown. Also, a value of auto selects to automatically obtain the MAC address; primary uses the address of the primary MAC client; and vrid uses the VRRP VID to calculate the MAC address. See the vrid property.
ofport
count
OpenFlow port assigned to the datalink.
openvswitch
astring
Switching on the physical datalink is managed by Open vSwitch (OVS). The value can be on or off.
stp
boolean
Spanning Tree Protocol (STP) on a bridge. Set the value to true to enable, false to disable.
stp-cost
count
STP and RSTP cost. Allowed range 0 to 65535.
stp-edge
count
Bridge edge port detection. Set the value to 1 to enable, 0 to disable.
stp-mcheck
boolean
RSTP force BPDU migration check. Set the value to true to enable, false to disable.
stp-p2p
astring
Bridge point-to-point operation mode. If the value is true, port mode is forced to use point-to-point. If the value is false, port mode is forced to use normal multipoint mode. If the value is auto, point-to-point connections are automatically discovered.
stp-priority
count
STP and RSTP port priority. Allowed range 0 to 255.
vraf
astring
VRRP address family. Values are inet for IPv4 VRRP address family and inet6 for IPv6 VRRP address family.
vrid
count
VRRP VLAN identifier.

IP Tunnel Datalink Properties

In addition to the class specific properties listed below, any system configuration profile including the datalink-iptun property group type may also include the shared datalink properties. See Shared Datalink Properties.

Table 7  IP Tunnel Datalink Properties
Property
Type
Description
encap-limit
count
IPv6 encapsulation limit.
hop-limit
count
IPv4 TTL or IPv6 hop limit.
local
astring
IP tunnel local address.
remote
astring
IP tunnel remote address.
type
astring
IP tunnel type. The value can be set to ipv4, ipv6 or 6to4.

InfiniBand Datalink Properties

In addition to the class specific properties listed below, any system configuration profile including the datalink-part property group type may also include the shared datalink properties. See Shared Datalink Properties.

A sample system configuration profile using the datalink-part property group type can be seen in /usr/share/auto_install/sc_profiles/ib_network.xml.

Table 8  InfiniBand Datalink Properties
Property
Type
Description
broadcast-group
astring
Broadcast group state. The value can be set to absent, joined, unknown, or unsuccessful.
force
boolean
Force creation even if underlying MAC does not support link update notification. Set the value to true to enable, false to disable.
link-mode
astring
Link transport service type. Value can be set to cm for connected mode or ud for unreliable datagram mode.
linkover
astring
Parent link.
pkey
astring
InfiniBand partition key.

Physical Datalink Properties

In addition to the class specific properties listed below, any system configuration profile including the datalink-phys property group type may also include the shared datalink properties. See Shared Datalink Properties.

A sample system configuration profile using the datalink-phys property group type can be seen in /usr/share/auto_install/sc_profiles/custom_network.xml.

Table 9  Physical Datalink Properties
Property
Type
Description
authentication
astring
IEEE 802.1x complaint link authentication mode. Value is off by default.
authentication-state
astring
Datalink authentication state for IEEE 802.1X. Value can be succeeded, failed, in-progress, or off.
auto-connect
astring
Autoconnect to known WLANs.
auto-negotiation
boolean
Advertise autonegotiation capability. Set the value to true to enable, false to disable.
default-tag
count
Default VLAN ID. The range for the ID is from 0 to 4094.
devname
astring
Name of the physical device.
devname
astring
Device name associated with link.
ets-bw-local
count
ETS bandwidth configured on transmit side for a link.
ets-bw-remote-advice
count
ETS bandwidth value to recommend to peer.
extaddr
count
Anet ID associated with kernel zone implicit link.
flow-control
astring
Advertised flow-control modes.
gvrp-timeout
count
Wait between VID announcement broadcasts in milliseconds. Also see vlan-announce.
iov
astring
Single root I/O virtualization (SR-IOV) mode. Allowed values are on, off, and auto to apply the default IOV setting.
learn-decay
count
Decay rate for source changes limited by learn-limit. See also learn-limit.
learn-limit
count
Number of MAC sources to be learned over a bridge.
loc
astring
Datalink location (for example, MB).
lro
astring
Large-receive offload disposition. Allowed values are on, off, or auto to apply the default LRO setting.
mtu
count
Maximum client send data unit (SDU) supported by the device. Valid range is 68 to 65536.
pfcmap
astring
8-bit mask where each bit shows if priority-based flow control (PFC) is enabled for corresponding priority.
power-mode
astring
WiFi power management mode.
radio
astring
WiFi radio mode.
ring-group
astring
Hardware ring group type. This read-only value can be either exclusive or shared.
speed
count
Link speed of physical Ethernet over InfiniBand datalink.
speed-duplex
astring
Speed/duplex values, for example, 1g-f is 1 GigaBit full-duplex.
stp
boolean
Spanning Tree Protocol (STP) on a bridge. Set the value to true to enable, false to disable.
stp-cost
count
STP and RSTP cost. Allowed range 0 to 65535.
stp-edge
count
Bridge edge port detection. Set the value to 1 to enable, 0 to disable.
stp-mcheck
boolean
RSTP force BPDU migration check. Set the value to true to enable, false to disable.
stp-p2p
astring
Point-to-point operation mode. If the value is true, port mode is forced to use point-to-point. If the value is false, port mode is forced to use normal multipoint mode. If the value is auto, point-to-point connections are automatically discovered.
stp-priority
count
STP and RSTP port priority value. Allowed range is 0 to 255.
tag
astring
Tag associated with link.
tag-mode
astring
802.1Q VLAN tag control. If the value is normal, the service will add a VLAN tag if the outgoing packet belongs to a VLAN or if the user selected priority tagging. If the value is vlanonly then the service will add a VLAN tag when the outgoing packet belongs to a VLAN.
tph
astring
Transaction processing hints (TPH) that allowed I/O devices to populate data. Allowed values are on, off, and auto for the OS to decide whether to enable TPH on the link.
vlan-announce
astring
Automatic VLAN ID announcement control. The value is off by default. The value can be off, or gvrp to select announcements sent using GVRP protocol, as defined in 802.1D. Also see gvrp-timeout.
vsi-manager-id
astring
IP address of VSI manager.
vsi-manager-id-encoding
astring
Encoding associated with the physical link vsi-manager-id. The value can be set to none if vsi-typeid and vsi-ver are not automatically generated over this link for VNICs that do not have their vsi-mgrid explicitly set. The oracle_v1 value selects Oracle VSI Manager.

Virtual Ethernet Point-to-point Datalinks Properties

In addition to the class specific properties listed below, any system configuration profile including the datalink-veth property group type may also include the shared datalink properties. See Shared Datalink Properties.

Table 10  Virtual Ethernet Point-to-point Datalinks Properties
Property
Type
Description
default-tag
count
Default VLAN ID. The value range for the ID is from 0 to 4094.
gvrp-timeout
count
Wait between VID announcement broadcasts in milliseconds. Also see vlan-announce.
learn-decay
count
Decay rate for source changes limited by learn-limit. See also learn-limit.
learn-limit
count
Number of MAC sources to be learned over a bridge.
ofport
count
OpenFlow port assigned to the datalink.
openvswitch
astring
Switching managed by Open vSwitch (OVS). The value can be on or off
stp
boolean
Spanning Tree Protocol (STP). Set the value to true to enable, false to disable.
stp-cost
count
STP and RSTP cost. The value range is 0 to 65535.
stp-edge
count
Bridge edge port detection. Set the value to 1 to enable, 0 to disable.
stp-mcheck
boolean
RSTP force BPDU migration check. Set the value to true to enable, false to disable.
stp-p2p
astring
Point-to-point operation mode. If the value is true, port mode is forced to use point-to-point. If the value is false, port mode is forced to use normal multipoint mode. If the value is auto, point-to-point connections are automatically discovered.
stp-priority
count
STP and RSTP port priority. The allowed value range is 0 to 255.
vethpeer
astring
Veth peer.
vlan-announce
astring
Automatic VLAN ID announcement control. The value is off by default. The value can be off, or gvrp to select announcements sent using GVRP protocol, as defined in 802.1D. Also see gvrp-timeout.

Virtual LAN Link Properties

In addition to the class specific properties listed below, any system configuration profile including the datalink-vlan property group type may also include the shared datalink properties. See Shared Datalink Properties.

Table 11  Virtual LAN Link Properties
Property
Type
Description
iov
astring
Single root I/O virtualization (SR-IOV) mode. Allowed values are on, off, and auto to apply the default IOV setting.
linkover
astring
Parent link.
mac-address-len
count
MAC address length.
mac-address-prefix-len
count
MAC address prefix length.
mac-address-slot
count
Factory MAC address slot.
mac-address-type
astring
MAC address type. You can set the following values: factory, fixed, random, and unknown. Also, a value of auto selects to automatically obtain the MAC address; primary uses the address of the primary MAC client; and vrid uses the VRRP VID to calculate the MAC address. See the vrid property.
ofport
count
OpenFlow port assigned to the datalink.
pkey
astring
InfiniBand partition key.
poll
astring
Poll mode. The value can be auto to select the default poll setting; on to enable polling; or off to disable polling.
ring-group
astring
Hardware ring group type. The value can be set at VNIC creation time. The value can be auto which specifies that the OS should decide whether exclusive or shared is used on a particular physical link; exclusive which specifies that VNIC creation should fail if an exclusive ring-group is not available; or shared which specifies that dedicated resources are not allocated. The default value is shared.
vid
astring
VLAN identifier.
vraf
astring
VRRP address family. Values are inet for IPv4 VRRP address family and inet6 for IPv6 VRRP address family.
vrid
count
VRRP VLAN identifier.

Virtual NIC Datalink Properties

In addition to the class specific properties listed below, any system configuration profile including the datalink-vnic property group type may also include the shared datalink properties. See Shared Datalink Properties.

A sample system configuration profile using the datalink-vnic property group type can be seen in /usr/share/auto_install/sc_profiles/vnic_network.xml.

Table 12  Virtual NIC Datalink Properties
Property
Type
Description
broadcast-group
astring
Broadcast group state. The value can be set to absent, joined, unknown, or unsuccessful.
ets-bw-local
count
ETS bandwidth configured on transmit side for a link.
ets-bw-remote-advice
count
ETS bandwidth value to recommend to peer.
iov
astring
Single root I/O virtualization (SR-IOV) mode. Allowed values are on, off, and auto to apply the default IOV setting.
lro
astring
Large-receive offload disposition. Allowed values are on, off, or auto to apply the default LRO setting.
ring-group
astring
Hardware ring group type. The value change be set toexclusive, shared or auto for the OS to decide on the ring-group type. .
vsi-manager-id
astring
IP address of VSI manager.

Virtual eXtensible LAN Datalink Properties

In addition to the class specific properties listed below, any system configuration profile including the datalink-vxlan property group type may also include the shared datalink properties. See Shared Datalink Properties.

Table 13  Virtual eXtensible LAN Datalink Properties
Property
Type
Description
default-tag
count
Default VLAN ID. The range for the ID is from 0 to 4094.
ip-interface
astring
IP Interface for the VXLAN link.
ip-version
astring
IP version of the address to be automatically selected if the interface property is set. Set the value to v4 or v6.
local-ip
astring
IPv4 address, IPv6 address or a hostname of the VXLAN link.
multicast-group
astring
Multicast group associated with the VXLAN link.
ofport
count
OpenFlow port assigned to the datalink.
openvswitch
astring
Switching managed by Open vSwitch (OVS). The value can be on or off.
vni
count
The VXLAN segment number that to which the VXLAN link belongs.

Flow Datalink Properties

The following tables lists all of the properties that are part of the flows property group in the network/datalink-management:default service.

Table 14  Flows Datalink Properties
Property
Type
Description
arp-op
astring
ARP operation. The value can be set to request or response.
arp-sender
astring
Hardware address of the sender.
arp-sip
astring
IP address of the ARP sender.
arp-target
astring
Hardware target address.
arp-tip
astring
IP address of the ARP target.
destination-mac-address
astring
Destination MAC address.
direction
astring
Flow direction. Set the value to in for inbound, out for outbound, or bi for bidirectional.
dscp
count
Differentiated service code point.
dsfield
count
Differentiated services value for flow.
dsfield-mask
count
Differentiated services mask value for flow.
hw-flow
astring
Hardware flow. Allowed values are on to enable flow offload, off to disable flow offload and auto to apply the default flow offload setting.
icmp-code
count
ICMP packet code.
icmp-type
count
ICMP packet type.
linkover
astring
Parent link.
local-ip
astring
Local flow IP address.
local-port
astring
Flow local port.
max-bw
count
Maximum flow bandwidth. The bandwidth is specified as an integer with one of the scale suffixes (K, M, or G for Kbps, Mbps, and Gbps). The default is no bandwidth limit.
nd-sll
astring
Hardware address of source in IPv6 neighbor discovery (ND).
nd-tll
astring
Hardware address of target in IPv6 neighbor discovery (ND).
nd-target
astring
IP address of target in IPv6 neighbor discovery (ND).
ofaction
astring
OpenFlow action list.
priority
astring
Relative priority of the link. Set the value to low, medium or high.
rank
count
Flow rank. The allowed range is from 1 to 65535.
remote-ip
astring
Remote flow IP address
remote-port
astring
Flow remote port.
sap
astring
Ethertype.
source-mac-address
astring
Source MAC address.
source-port
count
OpenFlow source port.
tcp-flags
astring
TCP flags.
transport
astring
Flow transport. The value can be set to tcp, udp, sctp, icmp, or icmpv6.
ttl
astring
Time to live from the IP header.
tun-dsfield
count
Tunnel differentiated services value for flow.
tun-flags
astring
Tunnel flags.
tun-id
astring
Tunnel ID.
tun-local-ip
astring
IP address for tunnel local flow.
tun-remote-ip
astring
IP address for tunnel remote flow.
tun-ttl
astring
Tunnel time to live from the IP header.
vlan-tci
astring
VLAN header.

Known WLAN Properties

Information about visited WLANs is automatically stored in property groups in the known-wlans parent property group, but this information can also be specified at install time in a system configuration profile. The following tables lists all of the properties that can be included in the network/datalink-management:default service.

Table 15  Known WLAN Properties
Property
Type
Description
bssids
astring
Basic server set ID (BSSID) for the WiFi network.
key
astring
Secure object name to be associated with this known WLAN.
priority
count
Relative priority of the known WLAN. Set the value to 0 for the highest priority, and 1 for a lower priority, and so forth.
security-mode
astring
Encryption mode for the Wifi network for the known WLAN. Value can be set to none, wep, or wpa.