Back to the list of connectors

IBM XIV (xcli)

Description

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

Connector ID: IBMxcli

This connector supersedes:

Target

Typical platform: IBM XiV Storage System

Operating system: Storage System

Prerequisites

Leverages: xcli command line utility

Technology and protocols: System Commands

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

Examples

CLI

hws HOSTNAME -t storage -f IBMxcli --ssh -u USER

hws-config.yaml

hosts:
- host:
    hostname: <HOSTNAME> # Change with actual host name
    type: storage
  selectedConnectors: [ IBMxcli ] # Optional, to load only this connector
  ssh:
    username: <USERNAME> # Change with actual credentials
    password: <PASSWORD> # Encrypted using hws-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 (Labels)
Enclosure
  • hw.status{hw.type="enclosure",state="ok|degraded|failed"}
  • hw.status{hw.type="enclosure",state="present"}
  • info
  • bios_version
  • model
  • serial_number
  • type
  • vendor
Fan
  • hw.status{hw.type="fan",state="ok|degraded|failed"}
  • hw.status{hw.type="fan",state="present"}
    Memory Module
    • hw.memory.limit
    • hw.status{hw.type="memory",state="ok|degraded|failed"}
    • hw.status{hw.type="memory",state="present"}
    • info
    • serial_number
    • vendor
    Network Card, FC Port
    • hw.network.bandwidth.limit
    • hw.network.up
    • hw.status{hw.type="network",state="ok|degraded|failed"}
    • hw.status{hw.type="network",state="present"}
    • info
    • model
    • physical_address
    • serial_number
    Other Device
    • hw.status{hw.type="other_device",state="ok|degraded|failed"}
    • hw.status{hw.type="other_device",state="present"}
    • info
    • device_type
    Physical Disk
    • hw.physical_disk.size
    • hw.status{hw.type="physical_disk",state="ok|degraded|failed"}
    • hw.status{hw.type="physical_disk",state="present"}
    • firmware_version
    • model
    • serial_number
    • vendor
    Power Supply
    • hw.status{hw.type="power_supply",state="ok|degraded|failed"}
    • hw.status{hw.type="power_supply",state="present"}
    • info
    No results.