Back to the list of connectors[1]

IBM XIV (xcli)

Description

This connector enables hardware monitoring for IBM XIV Storage Systems through the xcli command line utility.

This connector supersedes:

enterprise[3] hardware[4] ibm[5] storage[6]

Target

Typical platform: IBM XiV Storage System

Operating system: Storage System

Prerequisites

Leverages: xcli command line utility

Technology and protocols: Command Lines

This connector is not available for the local host (it is applicable to remote hosts only).

Examples

CLI

metricshub HOSTNAME -t storage -c +IBMxcli --ssh -u USER

metricshub.yaml

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

Connector Activation Criteria

The IBM XIV (xcli) connector will be automatically activated, and its status will be reported as OK if all the below criteria are met:

  • Operating System is Storage System
  • The command below succeeds on the agent host
    • Command: xcli -v
    • Output contains: xcli version: (regex)
  • The command below succeeds on the agent host
    • Command: xcli -u %{USERNAME} -p %{PASSWORD} -m %{HOSTNAME} -x -t all cod_list
    • Output contains: system_name (regex)

Metrics

Type Collected Metrics Specific Attributes
enclosure
  • hw.status{hw.type="enclosure", state="degraded|failed|ok"}
  • hw.status{hw.type="enclosure", state="present"}
  • bios_version
  • id
  • info
  • model
  • name
  • serial_number
  • type
  • vendor
fan
  • hw.status{hw.type="fan", state="degraded|failed|ok"}
  • hw.status{hw.type="fan", state="present"}
  • hw.parent.id
  • hw.parent.type
  • id
  • name
memory
  • hw.memory.limit
  • hw.status{hw.type="memory", state="degraded|failed|ok"}
  • hw.status{hw.type="memory", state="present"}
  • hw.parent.id
  • hw.parent.type
  • id
  • info
  • name
  • serial_number
  • vendor
network
  • hw.network.bandwidth.limit
  • hw.network.up
  • hw.status{hw.type="network", state="degraded|failed|ok"}
  • hw.status{hw.type="network", state="present"}
  • device_type
  • hw.parent.id
  • hw.parent.type
  • id
  • info
  • model
  • name
  • physical_address
  • physical_address_type
  • serial_number
other_device
  • hw.status{hw.type="other_device", state="degraded|failed|ok"}
  • hw.status{hw.type="other_device", state="present"}
  • device_type
  • hw.parent.id
  • hw.parent.type
  • id
  • info
  • name
physical_disk
  • hw.physical_disk.size
  • hw.status{hw.type="physical_disk", state="degraded|failed|ok"}
  • hw.status{hw.type="physical_disk", state="present"}
  • firmware_version
  • hw.parent.id
  • hw.parent.type
  • id
  • model
  • name
  • serial_number
  • vendor
power_supply
  • hw.status{hw.type="power_supply", state="degraded|failed|ok"}
  • hw.status{hw.type="power_supply", state="present"}
  • hw.parent.id
  • hw.parent.type
  • id
  • info
  • name
No results.