Data Collection Setup

Metrics are collected via Cisco UCS Central and Manager REST APIs

📘
LDAP / Domain Username Format
If your UCSC/UCSM credentials are for a Domain User, they should follow the ucs-{LDAP source}{LDAP username} format.

Network Requirements

Port: 80 (TCP) HTTP or 443 (TCP) HTTPS to the UCS Fabric Interconnect or UCS Central server.

Least Privileged User

Assigning Cisco UCS User Privileges

To create a least-privileged user (LPU), you must assign the read-only role in UCS Manager/Central to the Cisco UCSM and/or UCSC user you plan to use as your credentials.

UCS Manager

Log in to UCS Manager as an administrator, then navigate to Settings > User Management > User Services > Locally Authenticated Users (or Remotely Authenticated Users for domain users), then select the user you plan to use for your monitoring credentials.
In the General tab, under Roles, ensure that the read-only role is selected.
Click Save.

UCS Central

Log in to UCS Central as an administrator, then navigate to Settings > User Settings.
In the UCS Central Users Administration window that appears, click the Local Users (or Remote Users for domain users) tab, then select the user you plan to use for your monitoring credentials.
Click the Roles tab and ensure the Read Only role is selected.
Click Save.

Supported Versions

Cisco UCS Central (UCSC): 1.5.1+
Cisco UCS Manager (UCSM): 2.1 - 4.0+

Connection Parameters

Name	Required?	Description
Host	Required	The Cisco UCS Host to connect to.
Port		The port for communication to the Cisco UCS Host.
Username	Required
Password	Required
SSL Configuration		The SSL mode to use when connecting to the target. Can be configured to not use SSL (No SSL), use SSL but do not verify the target's certificate (No Verify), and use SSL and verify the target's certificate (Verify).
Collect Events		Controls whether events are collected and returned.
Max Events		The maximum number of events to collect.
Event Cutoff Time		Events before this time will not be collected.
Request Timeout (seconds)		The number of seconds to allow for the API to return a response.
Maximum Connections Per Host
Turned Off Resources		A comma-separated list of resource kinds that will not be discovered
Object Naming Convention		The naming convention to be used for displaying the resource name.

Metrics

Blade

Name
Admin State
Available Memory (Mebibytes)
BIOS Firmware Version
Board Controller Firmware Version
CIMC Controller Firmware Version
Distinguished Name
Event Count
Host
Manufacturing Date
Memory Speed (Megahertz)
Memory Usage (%)
Model
Name
Operability
Operating Power State
Operating State
Powered On
Revision
Scaled Mode
Serial Number
Service Profile
Slot Size
Total Memory (Mebibytes)
User Defined Name
User Label
UUID

Chassis

Name
Admin State
Configuration State
Distinguished Name
Event Count
Host
Input Power (Watts)
License State
Manufacturing Date
Model
Name
Number of Slots
Operability
Operating State
Output Power (Watts)
Power State
Powered On
Revision
Serial Number
Slots Being Used
Thermal State
Total Output Current (Amperes)
User Defined Name
User Label

Ethernet Port

Name
Data Received (Bits)
Data Sent (Bits)
Distinguished Name
Endpoint Name
Errors Received (Errors)
Event Count
Frame Check Sequence Errors (Errors)
Host
Name
Packets Received (Packets)
Packets Sent (Packets)
Peer Name
Rated Port Speed (Gigabits per Second)
User Defined Name
User Label

Fabric Interconnect

Name
Available Memory (Mebibytes)
Cached Memory (Mebibytes)
CPU Load (%)
Distinguished Name
Event Count
Host
Kernel Firmware Version
Management IP
Name
Operability
Powered On
Serial Number
Software Firmware Version
Thermal State
User Defined Name
User Label

Fan

Name
Distinguished Name
Event Count
Host
Name
Operability
Operating State
Power State
Powered On
Speed (Rotations per Minute)
Speed for Fabric Fan (Rotations per Minute)
Speed For Rack Fan (Rotations per Minute)
Thermal State
User Defined Name
User Label
Voltage State

Fibre Channel Port

Name
Data Received (Bits)
Data Sent (Bits)
Distinguished Name
Endpoint Name
Event Count
Host
Maximum Speed (Gigabits per Second)
Name
Packets Received (Packets)
Packets Sent (Packets)
User Defined Name
User Label

IO Module

Name
Ambient Temperature (Celsius)
ASIC Temperature (Celsius)
Configuration State
Distinguished Name
Event Count
Firmware Version
Host
Name
Operability
Operating State
Peer Communication Status
Power State
Powered On
Thermal State
User Defined Name
User Label
Voltage State

Memory Unit

Name
Distinguished Name
Event Count
Host
Name
Temperature (Celsius)
User Defined Name
User Label

Port Channel

Name
Admin Speed (Gigabits per Second)
Admin State
Alternate Distinguished Names
Bandwidth (Gigabits per Second)
Chassis ID
Description
Descriptive Name
Distinguished Name
Endpoint Name
Event Count
Flow Control Policy
Host
LACP Fast Timer
LACP Policy Name
LACP Suspended
Locale
Name
Operating LACP Policy Name
Operating Speed (Gigabits per Second)
Operating State
Overlapping VLANs
Peer Name
Port ID
Priority Flow Control
Receive Flow Control
Role
State Qualification
Switch ID
Traffic Monitoring Direction
Transport Type
Type
User Defined Name
User Label
VLAN Status
Warnings

Power Supply

Name
Ambient Temperature (Celsius)
Distinguished Name
Event Count
Firmware Version
Host
Input 210 Volt (Volts)
Input Current (Amperes)
Input Power (Watts)
Input Status
Input Voltage (Volts)
Name
Operability
Operating State
Output 12 Volt (Volts)
Output 3.3 Volt (Volts)
Output Current (Volts)
Output Power (Watts)
Power State
Powered On
Rack Input Power (Watts)
Thermal State
User Defined Name
User Label
Voltage State

Processor Unit

Name
Distinguished Name
Event Count
Host
Name
Temperature (Celsius)
User Defined Name
User Label

Rack Unit

Name
Ambient Temperature (Celsius)
Available Memory (Mebibytes)
BIOS Firmware Version
Board Controller Firmware Version
CIMC Controller Firmware Version
Distinguished Name
Event Count
Front Temperature (Celsius)
Host
IO Hub 1 Temperature (Celsius)
IO Hub 2 Temperature (Celsius)
Memory Usage (%)
Model
Name
Operability
Operating Power State
Operating State
Powered On
Rear Temperature (Celsius)
Revision
Serial Number
Service Profile
Total Memory (Mebibytes)
User Defined Name
User Label
UUID

UCS Central

Name
Distinguished Name
Event Count
Host
Name
System Up Time

UCS Domain

Name
Address
Average Blade Memory Usage (%)
Average CPU Load (%)
Distinguished Name
Event Count
Host
Name
Product Family
System Up Time

vHBA

Name
Configuration State
Data Received (Bits)
Data Sent (Bits)
Distinguished Name
Equipment Distinguished Name
Errors Received (Errors)
Errors Sent (Errors)
Event Count
Host
Identity Pool Name
Maximum Data Field Size (Bits)
Name
Operational Speed
Packets Received (Packets)
Packets Sent (Packets)
Receiving Packets Dropped (Packets)
Sent Packets Dropped (Packets)
Type
User Defined Name
User Label
World Wide Node Name
World Wide Port Name

vNIC

Name
Configuration State
Data Received (Bits)
Data Sent (Bits)
Distinguished Name
Endpoint Name
Equipment Distinguished Name
Errors Received (Errors)
Errors Sent (Errors)
Event Count
Host
Identity Pool Name
MAC Address
MTU (Bits)
Name
Operational Speed
Packets Received (Packets)
Packets Sent (Packets)
Receiving Packets Dropped (Packets)
Sent Packets Dropped (Packets)
Type
User Defined Name
User Label

Data Collection Setup

📘LDAP / Domain Username Format

Network Requirements

Least Privileged User

Assigning Cisco UCS User Privileges

UCS Manager

UCS Central

Supported Versions

Connection Parameters

Metrics

Blade

Chassis

Ethernet Port

Fabric Interconnect

Fan

Fibre Channel Port

IO Module

Memory Unit

Port Channel

Power Supply

Processor Unit

Rack Unit

UCS Central

UCS Domain

vHBA

vNIC

📘
LDAP / Domain Username Format