Back to the list of connectors[1]

WMI - Network

Description

This connector enables the monitoring of network cards on all Windows-based systems through the WMI layer (root/WMI namespace).

This connector is superseded by:

community[3] hardware[4] windows[5]

Source[6]

Target

Typical platform: Any system

Operating system: Microsoft Windows

Prerequisites

Leverages: WMI

Technology and protocols: WMI/WinRM

Examples

CLI

metricshub HOSTNAME -t win -c +WBEMGenNetwork --wmi -u USER

metricshub.yaml

resourceGroups:
  <RESOURCE_GROUP>:
    resources:
      <HOSTNAME-ID>:
        attributes:
          host.name: <HOSTNAME> # Change with actual host name
          host.type: win
        connectors: [ +WBEMGenNetwork ] # Optional, to load only this connector
        protocols:
          wmi:
            username: <USERNAME> # Change with actual credentials
            password: <PASSWORD> # Encrypted using metricshub-encrypt

Connector Activation Criteria

The WMI - Network connector will be automatically activated, and its status will be reported as OK if all the below criteria are met:

  • Operating System is Microsoft Windows
  • The Windows service WINMGMT is running
  • The WMI query below to the managed host succeeds:
    • Namespace: root\wmi
    • WQL Query: SELECT InstanceName FROM MSNdis_MediaConnectStatus
  • The WMI query below to the managed host succeeds:
    • Namespace: root\cimv2
    • WQL Query: SELECT AdapterType FROM Win32_NetworkAdapter
    • Result contains: ^Ethernet 802\.3;$ (regex)

Metrics

Type Collected Metrics Specific Attributes
network
  • hw.errors{hw.type="network"}
  • hw.network.bandwidth.limit
  • hw.network.io{direction="receive"}
  • hw.network.io{direction="transmit"}
  • hw.network.packets{direction="receive"}
  • hw.network.packets{direction="transmit"}
  • hw.network.up
  • hw.status{hw.type="network", state="degraded|failed|ok"}
  • hw.status{hw.type="network", state="present"}
  • hw.parent.type
  • id
  • info
  • model
  • name
  • physical_address
  • physical_address_type
No results.