Skip to main content
assistive.skiplink.to.breadcrumbs
assistive.skiplink.to.header.menu
assistive.skiplink.to.action.menu
assistive.skiplink.to.quick.search

Spaces

Collections

Hit enter to search

Network Interface node

Created by Duncan Tweed, last modified by Svitlana Koshelyeva on Nov 05, 2013

A NetworkInterface node represents the network interface of an inferred device.

The loopback interface lo (IPv4 address 127.0.0.1, IPv6 address ::1) is never modeled.

NetworkInterface node lifecycle

The following section describes the scenarios in which a NetworkInterface node is created, updated or destroyed.

Creation

A NetworkInterface node is created in the datastore when a host, network device, printer, or SNMP managed device is scanned successfully. The new NetworkInterface node will only be created if one with the same key does not already exist as a child of that node.

Update

A NetworkInterface node is updated every time the parent host or device is scanned successfully with sufficient credentials to run the discovery command.

Removal

A NetworkInterface node is automatically destroyed if it is not seen on a subsequent scan of its parent host or device. This is an Authoritative Removal type, see Authoritative Removal. The NetworkInterface node is also destroyed when its parent host or device is destroyed. This is a Containment Removal type because a NetworkInterface cannot exist without its parent host or device, see Containment Removal. For information on the destruction of Host Nodes, see Host Node lifecycle.

NetworkInterface Node Attributes

The attributes and relationships on a NetworkInterface node are described in the tables below.

UI Name `Attribute Name` and `Type`	Description
Not displayed in UI `key string`	Unique key.
Name `name string`	Full name of the network interface.
Interface Name `interface_name string`	Interface name of the network interface.
MAC Address `mac_addr string`	Physical (MAC) Address.
Speed (Mbps) `speed int`	Current speed in Mbps.
Speed (bps) `raw_speed int`	Current speed in bps.
Duplex `duplex string`	Duplex setting (Full/Half).
Negotiation `negotiation string`	Negotiation setting.
Bonded `bonded boolean`	A flag which indicates that this interface represents a bonded (teamed/aggregated) interface.
Aggregation Mode `aggregation_mode string`	Shows which mode the aggregation is in.
Aggregates `aggregates list:string`	The interfaces aggregated by this interface.
Aggregated By `aggregated_by string`	The interface which aggregates this interface.
Aggregated With `aggregated_with list:string`	The interfaces aggregated with this interface.
ifIndex `ifindex int`	The ifIndex value.
ifName `ifname string`	The ifName value.
ifAlias `ifalias string`	The ifAlias value.
Console `is_console boolean`	A flag which indicates that this interface represents the service console for an ESX host.
Interface Type `interface_type string`	Type of interface where it is known.
Description `description string`	The SNMP\WMI description for the interface.
Group Name `group_name string`	The name of the IPMP group this interface is in.
Virtual Adapters `virtual_adapters list:string`	The virtual adapters dependent on this physical adapter.
Physical Adapters `physical_adapters list:string`	The physical adapters supporting this virtual adapter.
Shared Adapters `shared_adapters list:string`	The shared adapters this physical or virtual adapter depends on.
Physical Location `physical_location string`	The AIX adapter location.
Device ID `device_id string`	Windows: network device ID.
Adapter Type `adapter_type string`	The type of this network adapter.
DHCP Enabled `dhcp_enabled boolean`	Indicates if this interface is configured by DHCP.
Setting GUID `setting_id string`	Windows: Setting GUID.
Service Name `service_name string`	Windows: Service Name.
Index `index int`	Windows: Interface index, used as zoneid for IPv6.
DNS Hostname `dns_hostname string`	DNS Hostname for this interface.
Database Path `database_path string`	Windows: path to the network database files.
DNS Servers `dns_servers list:string`	DNS Servers for this interface.
Default Gateway `default_gateway string`	Default gateway.
Manufacturer `manufacturer string`	Network adapter manufacturer.
DNS Domain `dns_domain string`	DNS Domain for this interface.
DHCP Server `dhcp_server string`	DHCP server for this interface.
Primary WINS Server `primary_wins_server string`	Primary WINS server for this interface.
Secondary WINS Server `secondary_wins_server string`	Secondary WINS server for this interface.
Index `ppa string`	The index number of the interface.

NetworkInterface node relationships

The relationships on a NetworkInterface node are described in the table below.

Destination	Relationship	Description
Host	`NetworkInterface: InterfaceOfDevice: DeviceInterface: DeviceWithInterface: Host`	The host that this network interface belongs to.
Network Device	`NetworkInterface: InterfaceOfDevice: DeviceInterface: DeviceWithInterface: NetworkDevice`	The network device that this network interface belongs to.
Printer	`NetworkInterface: InterfaceOfDevice: DeviceInterface: DeviceWithInterface: Printer`	The printer that this network interface belongs to.
SNMP Managed Device	`NetworkInterface: InterfaceOfDevice: DeviceInterface: DeviceWithInterface: SNMPManagedDevice`	The SNMP managed device that this network interface belongs to.
IP Address	`NetworkInterface: InterfaceWithAddress: InterfaceAddress: IPv4Address: IPAddress`	The IPv4 address of this network interface.
IP Address	`NetworkInterface: InterfaceWithAddress: InterfaceAddress: IPv6Address: IPAddress`	The IPv6 address of this network interface.
Edge Device	`NetworkInterface: EdgeClient: NetworkLink: EdgeDevice: NetworkInterface`	The edge device interface that this client interface is connected to.
Edge Client	`NetworkInterface: EdgeDevice: NetworkLink: EdgeClient: NetworkInterface`	The client interface that this edge device interface is connected to.
Not displayed in UI	`NetworkInterface: InferredElement: Inference: Primary: DiscoveredInterface`	Primary Inference.

No labels