Back to the list of connectors

Cisco UCS Manager (REST)

Description

This connector provides hardware monitoring for Cisco UCS Blade chassis (as well as the Cisco Fabric Interconnect Switch) through the REST UCS Manager (running on the Fabric Interconnect Switch).

Connector ID: CiscoUCSRest

This connector supersedes:

Target

Typical platform: Cisco UCS

Operating system: Out-of-Band

Prerequisites

Leverages: Cisco UCS Manager (REST XML API)

Technology and protocols: HTTP/REST

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

Examples

CLI

hws HOSTNAME -t management -f CiscoUCSRest --https --http-port 443 -u USERNAME

hws-config.yaml

hosts:
- host:
    hostname: <HOSTNAME> # Change with actual host name
    type: management
  selectedConnectors: [ CiscoUCSRest ] # Optional, to load only this connector
  http:
    https: true
    port: 443 # or probably something else
    username: <USERNAME> # Change with actual credentials
    password: <PASSWORD> # Encrypted using hws-encrypt

Connector Activation Criteria

The Cisco UCS Manager (REST) connector will be automatically activated, and its status will be reported as OK if all the below criteria are met:

  • The HTTP Request below to the managed host succeeds:
    • POST /nuova
    • Request Header:
      Content-Type: application/xml
    • Request Body:
    • The response body contains: Authentication failed (regex)

Metrics

Type Collected Metrics Specific Attributes (Labels)
Enclosure
  • hw.enclosure.energy
  • hw.status{hw.type="enclosure",state="ok|degraded|failed"}
  • hw.status{hw.type="enclosure",state="present"}
  • model
  • serial_number
  • type
  • vendor
Blade
  • hw.status{hw.type="blade",state="ok|degraded|failed"}
  • hw.status{hw.type="blade",state="present"}
  • info
  • model
  • blade_name
  • serial_number
Fan
  • hw.fan.speed
  • hw.status{hw.type="fan",state="ok|degraded|failed"}
  • hw.status{hw.type="fan",state="present"}
  • sensor_location
Network Card, FC Port
  • hw.network.bandwidth.limit
  • hw.network.bandwidth.utilization
  • hw.network.full_duplex
  • hw.network.io.receive
  • hw.network.io.transmit
  • hw.network.packets.receive
  • hw.network.packets.transmit
  • hw.network.up
  • hw.status{hw.type="network",state="ok|degraded|failed"}
  • hw.status{hw.type="network",state="present"}
  • info
  • model
  • physical_address
  • remote_physical_address
Power Supply
  • hw.status{hw.type="power_supply",state="ok|degraded|failed"}
  • hw.status{hw.type="power_supply",state="present"}
  • power_supply_type
Temperature Sensor
  • hw.status{hw.type="temperature",state="present"}
  • hw.temperature
  • sensor_location
No results.