Network Interface

A Node object whose type is NETWORK_INTERFACE.

Configuration

NetworkInterfaceNodeConfig
{
    "hostname" : String,
    "ip" : NetInterfaceIPConfig
}

Member name	Type	Description
hostname	String	Host name for the device on this interface
ip	NetInterfaceIPConfig	Internet Protocol (IP) configuration

Network interface IP configuration

NetInterfaceIPConfig
{
    "address" : String,
    "mode" : String,
    "mask" : String,
    "gateway" : String
}

Member name	Type	Description
address	String	IP address
mode	String	One of the following: MANUAL Internet Protocol configuration is fixed and configured manually. DHCP Internet Protocol configuration is obtained from a DHCP server, with fallback on auto-IP if no DHCP server is available. AUTO_IP Internet Protocol configuration is obtained using auto-IP, whether or not a DHCP server is present.
mask	String	IP subnet mask
gateway	String	IP address of default gateway

Status

NetworkInterfaceNodeStatus
{
    "mac_address" : String,
    "ip" : NetInterfaceIPStatus
}

Member name	Type	Description
mac_address	String	MAC address for this interface
ip	NetInterfaceIPStatus	Internet Protocol (IP) status

Network interface IP status

NetInterfaceIPStatus
{
    "address" : String
}

Member name	Type	Description
address	String	IP address

Inputs

None

Example

As returned by get device:

{
    "type" : "NETWORK_INTERFACE",
    "index" : 0,
    "configuration" : {
        "hostname" : "PHILIPPE_TX68",
        "ip" : {
            "address" : "10.1.1.37",
            "mode" : "DHCP",
            "mask" : "255.255.255.0",
            "gateway" : "10.1.1.1"
        }
    },
    "status" : {
        "mac_address" : "001ec0f03668",
        "ip" : {
            "address" : "10.1.1.37"
        }
    },
    "inputs" : []
}