Interface

The Interface Object is a read-only object that is used to identify local interfaces and their addresses on the Digital Rebar Provision server. This is useful for determining what subnets to create and with what address ranges. The Subnets part of the Portal uses this to populate possible subnets to create.

Interface objects are provided by DRP as an easy means for the UX and the CLI to enumerate the network interfaces on the DRP server and provide some basic information for building local subnets.

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