Interface¶
An Interface represents a network interface on the DRP server. Interface objects are read-only and reflect the actual network state of the host; they cannot be created, updated, or deleted through the API.
Each Interface is keyed by its Name (for example eth0, ens192) and
carries an Index for OS-level identification. The Addresses list
contains all IPv4 and IPv6 addresses bound to the interface, while
ActiveAddress is DRP's best guess at the primary address for incoming
traffic. Gateway indicates the default route for forwarded traffic, and
DnsServers / DnsDomain provide DNS resolver configuration.
Interface objects are primarily used by the UX to help administrators generate Subnet configurations. The Subnets section of the Portal reads the available Interfaces to populate the list of possible subnets to create, pre-filling address ranges and network masks from the interface data.
Fields¶
| Field | Definition |
|---|---|
| ActiveAddress | ActiveAddress is our best guess at the address that should be used for "normal" incoming traffic on this interface. |
| Addresses | Addresses contains the IPv4 and IPv6 addresses bound to this interface in no particular order. required: true |
| DnsDomain | DnsDomain is the domain that this system appears to be in on this interface. |
| DnsServers | DnsServers is a list of DNS server that hsould be used when resolving addresses via this interface. |
| Gateway | Gateway is our best guess about the IP address that traffic forwarded through this interface should be sent to. |
| Index | Index of the interface. This is OS specific. |
| Meta | Meta contains the meta data of the object. The type of this field is a key / value map/dictionary. The key type is string. The value type is also string. The general content of the field is undefined and can be an arbritary store. There are some common known keys: color - The color the UX uses when displaying icon - The icon the UX uses when displaying * title - The UX uses this for additional display information. Often the source of the object. Specific Object types use additional meta data fields. These are described at: https://docs.rackn.io/stable/redirect/?ref=rs_object_metadata |
| Name | Name of the interface required: true |