network_spec.yml¶

This file defines all network segments used by the Omnia cluster: admin, ib, and additional networks. Each network is described as an entry in the Networks list.

Top-level structure¶

network_spec.yml contains a single top-level key, Networks, which is a YAML list of network definitions.

File: /opt/omnia/input/project_default/network_spec.yml

Networks:
  - admin_network:
      ...
  - ib_network:
      ...
  - additional_subnets:
      ...

Admin Network Configuration Parameters¶

Parameter	Details
admin_network dict / required	Admin network configuration. Essential for PXE boot and host communication.
oim_nic_name string / required	The name of the interface on the OIM server associated with the admin network. Default value: `eno1`
subnet string / required	The subnet address for the admin network. Default value: `172.16.0.0`
netmask_bits string / required	The number of bits in the subnet mask. Default value: `24`
primary_oim_admin_ip string / required	The admin IP address of the OIM server which is configured. Default value: `172.16.107.254`
primary_oim_bmc_ip string / required	The iDRAC IP address of the OIM server. Mandatory only if idrac_telemetry is set to true and telemetry data needs to be collected from the OIM server. Optional - can be omitted if iDRAC telemetry for the OIM server is not required. Default value: `""`
router string / required	In connected deployments, the router field should typically be set to the external rack gateway, such as a SONiC switch, which provides connectivity beyond the rack network. In air-gapped deployments, the router field can be set to the OIM’s IP address if the OIM is acting as the rack gateway. If another dedicated router or gateway is available, its IP address should be specified instead. The configured value is advertised to nodes via DHCP as their default gateway. Default value: `172.16.107.254`
dynamic_range string / required	The range of dynamic IP addresses available on the admin network. Default value: `172.16.107.201-172.16.107.250`
dns list / elements=string	The list of external DNS server IP addresses for the admin network. Default value: `[]`
ntp_servers list / elements=dict	The list of NTP servers for the admin network. Each NTP server entry should include address (IP address or hostname) and type (server or pool). Default value: `[]`
address string / required	IP address or hostname of the NTP server.
type string / required	NTP source type. Accepted values: server, pool.

Infiniband Network Configuration Parameters (optional)¶

Parameter	Details
ib_network dict	InfiniBand network configuration.
subnet string / required	The subnet of the IB network. Default value: `192.168.0.0`
netmask_bits string / required	The number of bits in the subnet mask. This value must be same as the admin_network netmask_bits. Default value: `24`
dns list / elements=string	External DNS server IP addresses for the InfiniBand network. Default value: `[]`

Additional Subnets Configuration Parameters (optional)¶

Parameter	Details
additional_subnets list / elements=dict	Optional field for multi-RAC/multi-subnet PXE deployments. Each entry defines a separate subnet that the CoreDHCP server will manage via DHCP relay (giaddr-based routing). Requires coresmd v0.5+ with multi-subnet support. Leave empty array (`[]`) for single-subnet deployments. Default value: `[]` For more information about configuring Multi-Subnet DHCP, see Multi-Subnet DHCP.
subnet string / required	The network address of the additional subnet (e.g. "10.40.1.0").
netmask_bits string / required	The CIDR prefix length (e.g. "24").
router string / required	The gateway/router IP for this subnet (used as DHCP option 3).
dynamic_range string / required	The DHCP IP pool range in "start_ip-end_ip" format. Must fall within the subnet.

Usage example¶

File: /opt/omnia/input/project_default/network_spec.yml

---
Networks:
  - admin_network:
      oim_nic_name: "eno1"
      subnet: "172.16.0.0"
      netmask_bits: "24"
      primary_oim_admin_ip: "172.16.107.254"
      primary_oim_bmc_ip: ""
      router: "172.16.107.254"
      dynamic_range: "172.16.107.201-172.16.107.250"
      dns: []
      ntp_servers: []
      additional_subnets: []

  - ib_network:
      subnet: "192.168.0.0"
      netmask_bits: "24"
      dns: []

  - additional_subnets:
      - subnet: "10.40.1.0"
        netmask_bits: "24"
        router: "10.40.1.1"
        dynamic_range: "10.40.1.100-10.40.1.200"
      - subnet: "10.40.3.0"
        netmask_bits: "24"
        router: "10.40.3.1"
        dynamic_range: "10.40.3.100-10.40.3.200"

Note

In LOM topology, admin_network and bmc_network may share the same oim_nic_name with different vlan_id values.
The dynamic_range must not overlap with any static IPs assigned in the PXE mapping file.

Info

Network Topologies -- How topologies affect NIC and VLAN assignments.
Nics -- Supported NIC models.