Default language.

Important This documentation space contains information about the SaaS version of BMC Helix Discovery. If you are using the on-premises version of BMC Helix Discovery, see BMC Helix Discovery 25.2 (On-Premises).

Network Interface node

A Network Interface 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.

Network Interface node lifecycle

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

Creation

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

Update

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

Removal

To remove a Network Interface node manually, find the necessary Network Interface node, select it in the list and pick Destroy from the Actions list.

A Network Interface 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 Network Interface 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.

Attributes and relationships of the NetworkInterface node

The attributes of the NetworkInterface node are described in the following table:

UI Name
Attribute Name and Type

Description

Key
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

Operational Status
operational_status : string

Current operational status of the Network Interface

Admin Status
admin_status : string

The desired state of the Network Interface

Last Status Change
last_status_change : date

The date and time when interface entered its current operational status

Duplex
duplex : string

Duplex setting

Negotiation
negotiation : string

Negotiation setting

Bonded
bonded : boolean

A flag which indicates that this interface represents a bonded

Aggregation Mode
aggregation_mode : string

Shows what mode the aggregation is running in

Aggregates
aggregates : list:string

The interfaces aggregated by this interface

Aggregated By
aggregated_by : list: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

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

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

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

Service Name
service_name : string

Windows

Index
index : int

Windows

DNS Hostname
dns_hostname : string

DNS Hostname for this interface

Database Path
database_path : string

Windows

DNS Servers
dns_servers : list:string

DNS Servers for this interface

Default Gateway
default_gateway : list: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

Driver Version
driver_version : string

Network driver version

Driver Date
driver_date : string

Network driver date

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

Number of Neighbors
num_neighbours : int

The number of neighbor MAC addresses for this interface

Neighbor MAC Addresses
neighbour_mac_addresses : list:string

The list of neighbor MAC addresses for this interface

VLAN IDs
vlan_ids : list:int

The list of VLAN IDs for this interface

VRF Name
vrf_name : string

The name of the VRF instance this interface is in

The relationships of the NetworkInterface node are described in the following table:

UI Name

Relationship

Description

Storage Processor

Contained:
 Containment:
 Container:
 StorageProcessor

Containing Storage Processor

Details

ElementWithDetail:
 Detail:
 Detail:
 Detail

Details belonging to this Network Interface

Hardware Details

ElementWithDetail:
 Detail:
 Detail:
 HardwareDetail

Hardware Details belonging to this Network Interface

Host

InterfaceOfDevice:
 DeviceInterface:
 DeviceWithInterface:
 Host

Host with this Network Interface

Management Controller

InterfaceOfDevice:
 DeviceInterface:
 DeviceWithInterface:
 ManagementController

Management Controller with this Network Interface

Printer

InterfaceOfDevice:
 DeviceInterface:
 DeviceWithInterface:
 Printer

Printer with this Network Interface

SNMP Managed Device

InterfaceOfDevice:
 DeviceInterface:
 DeviceWithInterface:
 SNMPManagedDevice

SNMP Managed Device with this Network Interface

Storage Device

InterfaceOfDevice:
 DeviceInterface:
 DeviceWithInterface:
 StorageDevice

Storage Device with this Network Interface

Storage System

InterfaceOfDevice:
 DeviceInterface:
 DeviceWithInterface:
 StorageSystem

Storage System with this Network Interface

Storage System Group

InterfaceOfDevice:
 DeviceInterface:
 DeviceWithInterface:
 StorageSystemGroup

Storage System Group with this Network Interface

Storage Processor

InterfaceOfDevice:
 DeviceInterface:
 DeviceWithInterface:
 StorageProcessor

Storage Processor with this Network Interface

Network Device

InterfaceOfDevice:
 DeviceInterface:
 DeviceWithInterface:
 NetworkDevice

Network Device with this Network Interface

Stack Member

InterfaceOfStack:
 DeviceInterface:
 DeviceWithInterface:
 NetworkDevice

The stack member that this Network Interface belongs to

Virtual Machine

InterfaceOfVirtualMachine:
 DeviceInterface:
 DeviceWithInterface:
 VirtualMachine

Virtual Machine with this Network Interface

Primary Business Application

InferredElement:
 Inference:
 Primary:
 BusinessApplicationInstance

Business Application from which the existence of this Network Interface was inferred

Primary Business Service

InferredElement:
 Inference:
 Primary:
 BusinessService

Business Service from which the existence of this Network Interface was inferred

Primary Technical Service

InferredElement:
 Inference:
 Primary:
 TechnicalService

Technical Service from which the existence of this Network Interface was inferred

Primary Device Info

InferredElement:
 Inference:
 Primary:
 DeviceInfo

Device Info from which the existence of this Network Interface was inferred

Primary Discovered Application Component

InferredElement:
 Inference:
 Primary:
 DiscoveredApplicationComponent

Discovered Application Component from which the existence of this Network Interface was inferred

Primary Discovered Cloud API Result List

InferredElement:
 Inference:
 Primary:
 DiscoveredCloudAPIResultList

Discovered Cloud API Result List from which the existence of this Network Interface was inferred

Primary Discovered Coupling Facility

InferredElement:
 Inference:
 Primary:
 DiscoveredCouplingFacility

Discovered Coupling Facility from which the existence of this Network Interface was inferred

Primary Discovered Database

InferredElement:
 Inference:
 Primary:
 DiscoveredDatabase

Discovered Database from which the existence of this Network Interface was inferred

Primary Discovered Database Detail

InferredElement:
 Inference:
 Primary:
 DiscoveredDatabaseDetail

Discovered Database Detail from which the existence of this Network Interface was inferred

Primary Discovered Directory Entry

InferredElement:
 Inference:
 Primary:
 DiscoveredDirectoryEntry

Discovered Directory Entry from which the existence of this Network Interface was inferred

Primary Discovered Disk Drive

InferredElement:
 Inference:
 Primary:
 DiscoveredDiskDrive

Discovered Disk Drive from which the existence of this Network Interface was inferred

Primary Discovered File

InferredElement:
 Inference:
 Primary:
 DiscoveredFile

Discovered File from which the existence of this Network Interface was inferred

Primary Discovered File System

InferredElement:
 Inference:
 Primary:
 DiscoveredFileSystem

Discovered File System from which the existence of this Network Interface was inferred

Primary Discovered HBA

InferredElement:
 Inference:
 Primary:
 DiscoveredHBA

Discovered HBA from which the existence of this Network Interface was inferred

Primary Discovered IP Address

InferredElement:
 Inference:
 Primary:
 DiscoveredIPAddress

Discovered IP Address from which the existence of this Network Interface was inferred

Primary Listening Port

InferredElement:
 Inference:
 Primary:
 DiscoveredListeningPort

Listening Port from which the existence of this Network Interface was inferred

Primary Discovered MFPart

InferredElement:
 Inference:
 Primary:
 DiscoveredMFPart

Discovered MFPart from which the existence of this Network Interface was inferred

Primary Discovered MQ Detail

InferredElement:
 Inference:
 Primary:
 DiscoveredMQDetail

Discovered MQ Detail from which the existence of this Network Interface was inferred

Primary Discovered Mainframe

InferredElement:
 Inference:
 Primary:
 DiscoveredMainframe

Discovered Mainframe from which the existence of this Network Interface was inferred

Primary Discovered Mainframe View Result

InferredElement:
 Inference:
 Primary:
 DiscoveredMainframeViewResult

Discovered Mainframe View Result from which the existence of this Network Interface was inferred

Primary Discovered Network Interface

InferredElement:
 Inference:
 Primary:
 DiscoveredNetworkInterface

Discovered Network Interface from which the existence of this Network Interface was inferred

Primary Discovered Process

InferredElement:
 Inference:
 Primary:
 DiscoveredProcess

Discovered Process from which the existence of this Network Interface was inferred

Primary Discovered Program

InferredElement:
 Inference:
 Primary:
 DiscoveredProgram

Discovered Program from which the existence of this Network Interface was inferred

Primary Discovered Registry Entry

InferredElement:
 Inference:
 Primary:
 DiscoveredRegistryEntry

Discovered Registry Entry from which the existence of this Network Interface was inferred

Primary Discovered Service

InferredElement:
 Inference:
 Primary:
 DiscoveredService

Discovered Service from which the existence of this Network Interface was inferred

Primary Discovered Software

InferredElement:
 Inference:
 Primary:
 DiscoveredSoftware

Discovered Software from which the existence of this Network Interface was inferred

Primary Discovered Storage Subsystem

InferredElement:
 Inference:
 Primary:
 DiscoveredStorageSubsystem

Discovered Storage Subsystem from which the existence of this Network Interface was inferred

Primary Discovered Sysplex

InferredElement:
 Inference:
 Primary:
 DiscoveredSysplex

Discovered Sysplex from which the existence of this Network Interface was inferred

Primary Discovered Tape Drive

InferredElement:
 Inference:
 Primary:
 DiscoveredTapeDrive

Discovered Tape Drive from which the existence of this Network Interface was inferred

Primary Discovered Transaction

InferredElement:
 Inference:
 Primary:
 DiscoveredTransaction

Discovered Transaction from which the existence of this Network Interface was inferred

Primary Discovered Virtual Machine

InferredElement:
 Inference:
 Primary:
 DiscoveredVirtualMachine

Discovered Virtual Machine from which the existence of this Network Interface was inferred

Primary Host Info

InferredElement:
 Inference:
 Primary:
 HostInfo

Host Info from which the existence of this Network Interface was inferred

Primary MF Part

InferredElement:
 Inference:
 Primary:
 MFPart

MF Part from which the existence of this Network Interface was inferred

Primary Network Connection List

InferredElement:
 Inference:
 Primary:
 NetworkConnectionList

Network Connection List from which the existence of this Network Interface was inferred

Primary Software Component

InferredElement:
 Inference:
 Primary:
 SoftwareComponent

Software Component from which the existence of this Network Interface was inferred

Primary Software Container

InferredElement:
 Inference:
 Primary:
 SoftwareContainer

Software Container from which the existence of this Network Interface was inferred

Primary Software Instance

InferredElement:
 Inference:
 Primary:
 SoftwareInstance

Software Instance from which the existence of this Network Interface was inferred

IPv4 Addresses

InterfaceWithAddress:
 InterfaceAddress:
 IPv4Address:
 IPAddress

IPv4 addresses of this Network Interface

IPv6 Addresses

InterfaceWithAddress:
 InterfaceAddress:
 IPv6Address:
 IPAddress

IPv6 addresses of this Network Interface

Edge Device

EdgeClient:
 NetworkLink:
 EdgeDevice:
 NetworkInterface

The edge device interface that this client interface is connected to

Edge Client

EdgeDevice:
 NetworkLink:
 EdgeClient:
 NetworkInterface

The client interface that this edge device interface is connected to

Peer Device

Peer:
 NetworkLink:
 Peer:
 NetworkInterface

The peer device interface that this interface is connected to

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*