Skip to main content

IBM XIV (xcli)

Description

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

hardware ibm storage

Enterprise Connector

This connector requires the Enterprise edition of MetricsHub.

Supersedes

This connector supersedes:

Target

Typical platform: IBM XiV

Operating system: Storage System

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

Prerequisites

Leverages: xcli command line utility

Technology and protocols: Commands

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:

  • The device type must be one of: Storage
  • 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

TypeCollected MetricsSpecific Attributes
enclosurehw.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
fanhw.status{hw.type="fan", state="degraded|failed|ok"}
hw.status{hw.type="fan", state="present"}
hw.parent.id
hw.parent.type
id
name
memoryhw.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
networkhw.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_devicehw.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_diskhw.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_supplyhw.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