Skip to content

network_spec.yml Reference

File path: /opt/omnia/input/project_default/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: eno1

subnet

string / required

The subnet address for the admin network. Default: 172.16.0.0

netmask_bits

string / required

The number of bits in the subnet mask. Default: 24

primary_oim_admin_ip

string / required

The admin IP address of the OIM server which is configured. Default: 172.16.107.254

primary_oim_bmc_ip

string / required

The iDRAC IP address of the OIM server. Mandatory only if idrac_telemetry is enabled and telemetry data needs to be collected from the OIM server.

dynamic_range

string / required

The range of dynamic IP addresses available on the admin network. Default: 172.16.107.201-172.16.107.250

dns

list / elements=string

List of external DNS server IP addresses for the admin network. Default: []

ntp_servers

list / elements=dict

List of NTP servers for the admin network. Each entry includes address (IP or hostname) and type (server or pool). Default: []

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: 192.168.0.0

netmask_bits

string / required

The number of bits in the subnet mask. Must be same as admin_network netmask_bits. Default: 24

dns

list / elements=string

External DNS server IP addresses for the InfiniBand network. Default: []

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 managed via DHCP relay. Leave empty array for single-subnet deployments. Default: []

subnet

string / required

The network address of the additional subnet.

netmask_bits

string / required

The CIDR prefix length for the additional subnet.

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: ""
      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