ZenPack:Cisco UCS

From Zenoss Wiki
This is the approved revision of this page, as well as being the most recent.
Jump to: navigation, search


Note: This ZenPack is available in commercial versions of Zenoss. Click here to request more information about this commercial ZenPack. Click here to see all commercial ZenPacks.

Organization
Zenoss, Inc.
ZenPack name
ZenPacks.zenoss.CiscoUCS

Devices Monitored:

Applications Monitored: 



Cisco UCS ZenPack

The CiscoUCS ZenPack enables Resource Manager to use HTTP to monitor Cisco Unified Computing System (UCS) devices.

Warning

The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks as of January 17, 2017. The following information may be out of date, and this page will eventually be removed.

Support

This ZenPack is included with commercial versions of Zenoss and enterprise support for this ZenPack is provided to Zenoss customers with an active subscription.

Releases

Version 2.5.4- Download
Released on 2017/01/10
Requires Dynamic Service View ZenPack,PythonCollector ZenPack
Compatible with Zenoss Resource Manager 4.2.x, Zenoss Resource Manager 5.0.x, Zenoss Resource Manager 5.1.x, Zenoss Resource Manager 5.x.x
Version 2.4.5- Download
Released on 2017/01/10
Requires Dynamic Service View ZenPack,PythonCollector ZenPack
Compatible with Zenoss Resource Manager 4.2.x, Zenoss Resource Manager 5.0.x, Zenoss Resource Manager 5.1.x
Version 2.3.4- Download
Released on 2016/03/10
Requires Dynamic Service View ZenPack,PythonCollector ZenPack
Compatible with Zenoss Resource Manager 4.2.x, Zenoss Resource Manager 5.0.x
Version 2.2.1- Download
Released on 2015/10/14
Requires Dynamic Service View ZenPack,PythonCollector ZenPack
Compatible with Zenoss Resource Manager 4.2.x, Zenoss Resource Manager 5.0.x
Version 2.1.1- Download
Released on 2015/04/30
Requires Dynamic Service View ZenPack,PythonCollector ZenPack
Compatible with Zenoss Resource Manager 4.2.x, Zenoss Resource Manager 5.0.x
Version 1.9.3- Download
Released on 2015/03/04
Requires Dynamic Service View ZenPack,PythonCollector ZenPack
Compatible with Zenoss Resource Manager 4.1.x, Zenoss Resource Manager 4.2.x
Version 1.8.4- Download
Released on 2014/03/27
Requires Dynamic Service View ZenPack
Compatible with Zenoss Resource Manager 4.1.x, Zenoss Resource Manager 4.2.x

Background

This ZenPack provides support for monitoring Cisco Unified Computing Systems (UCS). UCS Manager, UCS-M and UCS-Mini, stand-alone C-Series rack-mount servers and E-Series servers are supported.

Gallery

UCS Manager Features

UCS Manager monitoring data is collected using the UCS Manager XML API. When adding a UCS Manager to Zenoss it is important to provide the shared virtual IP address of your UCS domain's fabric interconnects. This allows Zenoss to continue monitoring when one fabric interconnect is undergoing maintenance or fails. Your Zenoss collector must be able to connect to the UCS Manager application on port 443/tcp.

UCS Manager Discovery

The following components will be automatically discovered through the Cisco UCS Manager host, user and password you provide. The properties and relationships will be periodically remodeled to provide automatically up-to-date monitoring when the system configuration changes.


UCS Manager Overview
UCS Manager (Device)
Properties: None
Relationships: Service Profiles, Management Interfaces, Fabric Interconnects, Chassis, Fabric Extenders, Rack Servers


UCS Manager Adaptor Units Overview
Adaptor Units
Properties: DN, Manufacturer, Model, Serial Number
Relationships: Server Blade, Host Ethernet Interfaces


UCS Manager Backplane Ports Overview
Backplane Ports
Properties: DN, WWN, Operational Speed
Relationships: IO Module


UCS Manager Blade Servers Overview
Blade Servers
Properties: DN, Manufacturer, Model, Serial Number, Presence, Operational State, Operational Power, Availability
Relationships: Chassis, Memory Arrays, Processor Units, Adaptor Units, Bound Service Profile


UCS Manager Cartridge Server Overview
Cartridge Servers
Properties: DN, Manufacturer, Model, Serial Number, Presence, Operational State, Operational Power, Availability
Relationships: Chassis, Memory Arrays, Processor Units, Adaptor Units, Bound Service Profile


UCS Manager Chassis Overview
Chassis
Properties: DN, Manufacturer, Model, Serial Number, Operational State
Relationships: UCS Manager, IO Modules, Servers, Fan Modules, Power Supply Units


UCS Manager Ethernet Ports Overview
Ethernet Ports
Properties: DN, Switch ID, Slot ID, Port ID, MAC Address, Role, Type, Transport, Administrative State, Endpoint DN, Peer DN, Peer Slot ID, Peer Port ID
Relationships: Switch Card, Fabric Ethernet LAN Port Channels, Fabric Fibre Channel Over Ethernet SAN Port Channels


UCS Manager Fabric Interconnects Overview
Fabric Interconnects
Properties: DN, Manufacturer, Model, Serial Number, Total Memory
Relationships: UCS Manager, Switch Cards, Power Supply Units


UCS Manager Fabric Ethernet LAN Port Channel Overview
Fabric Ethernet LAN Port Channels
Properties: DN, Port ID, Switch ID, Locale, Transport, Type, Admin State, Bandwidth, Operational State, Interface Role, Number of Members
Relationships: Ethernet Ports


UCS Manager Fabric Extenders Overview
Fabric Extenders
Properties: DN, Manufacturer, Model, Serial Number, Total Memory
Relationships: UCS Manager, Fabric Interconnects, IO Modules, Power Supply Units


UCS Manager Fabric Fibre Channel SAN Port Channel Overview
Fabric Fibre Channel SAN Port Channels
Properties: DN, Port ID, Switch ID, Locale, Transport, Type, Admin State, Config State, Operational State, Interface Role, Number of Members
Relationships: Fibre Channel Ports


UCS Manager Fabric Fibre Channel Over Ethernet SAN Port Channel Overview
Fabric Fibre Channel Over Ethernet SAN Port Channels
Properties: DN, Port ID, Switch ID, Locale, Transport, Type, Config State, Operational State, Interface Role, Number of Members
Relationships: Ethernet Ports


UCS Manager Fabric Ports Overview
Fabric Ports
Properties: DN, Switch ID, Slot ID, Port ID, MAC Address, Role, Type, Transport, Administrative State, Endpoint DN, Peer DN, Peer Slot ID, Peer Port ID
Relationships: IO Module


UCS Manager Fans Overview
Fans
Properties: DN, Manufacturer, Model, Serial Number, Tray
Relationships: Fan Module


UCS Manager Fan Modules Overview
Fan Modules
Properties: DN, Manufacturer, Model, Serial Number, Tray
Relationships: Equipment


UCS Manager FI-IO Module Overview
FI-IO Modules
Properties: DN, Description, Revision, Slot, Manufacturer, Model
Relationships: Chassis, Fabric Extender


UCS Manager Fibre Channel Ports Overview
Fibre Channel Ports
Properties: DN, WWN, Operational Speed
Relationships: Switch Card, Fabric Fibre Channel SAN Port Channels


UCS Manager Host Bus Adaptors Overview
Host Bus Adaptors
Properties: DN, Manufacturer, Model, MAC Address, PCI Address
Relationships: Adaptor Unit


UCS Manager Host Ethernet Interfaces Overview
Host Ethernet Interfaces
Properties: DN, Manufacturer, Model, MAC Address, PCI Address
Relationships: Adaptor Unit


UCS Manager IO Modules Overview
IO Modules
Properties: DN, Description, Revision, Slot, Manufacturer, Model
Relationships: Chassis, Fabric Extender


UCS Manager Management Interfaces Overview
Management Interfaces
Properties: Name, Type, MAC Address, Administrative Status, Operational Status
Relationships: UCS Manager, IP Addresses


UCS Manager Memory Arrays Overview
Memory Arrays
Properties: DN, Serial Number, Revision, Error Correction, CPU ID, Max Devices, Populated Devices, Max Capacity, Current Capacity
Relationships: Server Blade


UCS Manager Organizations Overview
Organizations
Properties: DN, Description, Level, Permanent Access
Relationships: UCS Manager, Service Profiles, Organizations


UCS Manager Power Supply Units Overview
Power Supply Units
Properties: DN, Manufacturer, Model, Serial Number, Revision, Performance Threshold Sensor Status, Power State, Thermal Threshold Sensor Status, Voltage Threshold Sensor State
Relationships: Equipment


UCS Manager Processor Units Overview
Processor Units
Properties: DN, Manufacturer, Model, Serial Number, Revision, Socket, Architecture, Cores, Threads, Stepping, Speed, Voltage
Relationships: Server Blade


UCS Manager Rack Servers Overview
Rack Servers
Properties: DN, Manufacturer, Model, Serial Number, Presence, Operational State, Operational Power, Availability
Relationships: UCS Manager, Fabric Extenders, Fabric Interconnects, Memory Arrays, Processor Units, Adaptor Units, Bound Service Profile


UCS Manager Service Profiles Overview
Service Profiles
Properties: DN, Type, Description
Relationships: UCS Manager, Virtual Ethernet NICs, Bound Server


UCS Manager Shared Adaptor Overview
Shared Adaptors
Properties: DN, Description, Revision, Slot, Manufacturer, Model
Relationships: Chassis, Fabric Extender


UCS Manager Switch Cards Overview
Switch Cards
Properties: DN, Description, Revision, Slot, Manufacturer, Model
Relationships: Fabric Interconnect, Ethernet Ports, Fibre Channel Ports


UCS Manager Virtual HBAs Overview
Virtual HBAs
Properties: DN, MAC Address
Relationships: Service Profile, Bound Equipment


UCS Manager Virtual NICs Overview
Virtual NICs
Properties: DN, MAC Address
Relationships: Service Profile, Bound Equipment


UCS Manager Performance Monitoring

The following metrics will be collected every 5 minutes by default. This interval can be changed with the zCiscoUCSManagerPerfInterval configuration property. For best results this should be configured to match UCS Manager's collection interval.

Backplane Ports
  • Port Utilization: Sent, Received (Bytes / Sec)
  • Sent Packets: Total, Jumbo, Unicast, Broadcast, Multicast (packets/sec)
  • Received Packets: Total, Jumbo, Unicast, Broadcast, Multicast (packets/sec)
  • Loss Stats: Carrier Sense, Excess Collision, Giants, Late Collision, Multi Collision, Single Collision (losses/sec)
  • Pause Stats: Transmit, Receive, Resets (pauses/sec)
  • Errors: Transmit, Receive, Deferred Tx, Out Discard, Under Size, Align, FCS, Int Mac Rx, Int Mac Tx (errors/sec)
Blade Servers
  • Voltage: Input (volts)
  • Temperatures: IO, Rear (degrees C)
  • Power: Consumed (watts)
  • Current: Input (amps)
Cartridge Servers
  • Voltage: Input (volts)
  • Temperatures: IO, Rear (degrees C)
  • Power: Consumed (watts)
  • Current: Input (amps)
Chassis
  • Power: Input, Output (watts) (Not available for C3260)
Ethernet Ports
  • Throughput: Sent, Received (bits/sec)
  • Sent Packets: Total, Jumbo, Unicast, Broadcast, Multicast (packets/sec)
  • Received Packets: Total, Jumbo, Unicast, Broadcast, Multicast (packets/sec)
  • Loss Stats: Carrier Sense, Excess Collision, Giants, Late Collision, Multi Collision, Single Collision (losses/sec)
  • Pause Stats: Transmit, Receive, Resets (pauses/sec)
  • Errors: Transmit, Receive, Deferred Tx, Out Discard, Under Size, Align, FCS, Int Mac Rx, Int Mac Tx (errors/sec)
Fabric Interconnects
  • CPU Utilization: Used (percent)
  • Memory Utilization: Available, Cached (bytes)
  • Temperatures: PSU Inlet 1, PSU Inlet 2, Fan Inlet 1, Fan Inlet 2, Fan Inlet 3, Fan Inlet 4, Main Outlet 1, Main Outlet 2 (degrees C)
Fabric Ethernet LAN Port Channels
  • Channel Utilization: Sent, Received (bytes/sec)
  • Transmit Packets: Total, Jumbo, Unicast, Broadcast, Multicast (packets/sec)
  • Received Packets: Total, Jumbo, Unicast, Broadcast, Multicast (packets/sec)
  • Transmit Errors: Deferred Tx, Int Mac Tx, Transmit (errors/sec)
  • Receive Errors: Int Mac Rx, Receive (errors/sec)
  • Pause Stats: Transmit, Receive, Resets (pauses/sec)
  • Collision Stats: Excess Collision, Late Collision, Multi Collision, Single Collision (collisions/sec)
  • Misc Errors: Out Discard, Under Size, Align, FCS (errors/sec)
  • Misc Loss Stats: Carrier Sense, SQETest, Giants, Symbol(losses/sec)
Fabric Extender
  • Temperature: Inlet, Outlet (degrees C)
Fabric Fibre Channel SAN Port Channels
  • Channel Utilization: Sent, Received (bytes/sec)
  • Packet Stats: Received, Sent (packets/sec)
  • Transmit Errors: Discard Tx, Transmit (errors/sec)
  • Receive Errors: Discard Rx, Too Long Rx, CRC Rx, Receive, Too Short Rx (errors/sec)
  • Misc Errors: Link Failures, Signal Losses, Sync Losses (errors/sec)
Fabric Fibre Channel over Ethernet SAN Port Channels
  • Channel Utilization: Sent, Received (errors/sec)
  • Port Channel Errors: Receive, Sent (packets/sec)
  • Packet Stats: Receive, Sent (packets/sec)
  • Dropped Stats: Receive, Sent (dropped/sec)
Fan Modules (Chassis only)
  • Temperature: Ambient (degrees C)
  • Fan Speeds: Fan 1, Fan 2 (RPM)
FI-IO Modules (Chassis only)
  • Temperature: Ambient, Temp (degrees C)
Fibre Channel Ports
  • Throughput: Sent, Received (bits/sec)
  • Errors: Transmit, Receive, Discard Tx, Discard Rx, Too Long Rx, Too Short Rx, CRC Rx, Link Failures, Signal Losses, Sync Losses (errors/sec)
Host Ethernet Interfaces
  • Sent Packets: Total, Good, VLAN, PPP, Pause, Priority Pause (packets/sec)
  • Received Packets: Total, Good, VLAN, PPP, Pause, Priority Pause (packets/sec)
  • Sent Bytes: Bytes, Errors, Dropped (Bytes / Sec)
  • Received Bytes: Bytes, Errors, Dropped (Bytes / Sec)
Host Bus Adaptors
  • Sent Bytes: Bytes, Errors, Dropped (Bytes / Sec)
  • Received Bytes: Bytes, Errors, Dropped (Bytes / Sec)
IO Modules (Chassis only)
  • Temperature: Ambient, Temp (degrees C)
Power Supply Units
  • Voltages: 210V Input, 12V Output, 3V3 Output (volts)
  • Temperatures: Ambient (degrees C)
  • Power: Output (watts)
  • Current: Output (amps)
Processor Units
  • Temperature: Processor (degrees C)
  • Current: Input (amps)

UCS Manager Event Management

Zenoss will create events for all UCS faults collected through the management API. The UCS fault life-cycle closely matches that of the Zenoss event life-cycle. When a UCS fault clears, the equivalent events will be cleared in Zenoss.

Upon initially connecting to the UCS Manager Zenoss will process the full list of open faults. Subsequently it will subscribe to and only receive new faults and updates to existing faults. Initial connections to UCS Manager can occur on a restart of UCS Manager, Zenoss or after a temporary connectivity issue between the two is resolved.

The following fields will be populated for each event.

Standard Zenoss Event Fields
  • device (set to the UCS Manager device in the /CiscoUCS device class)
  • component
  • eventKey
  • summary
  • message
  • severity
  • eventClassKey
  • agent (zenucsevents)
  • eventGroup (ucs)
  • monitor
Additional Event Fields
  • ucs-code
  • ucs-dn
  • ucs-id
  • user
  • originaltime

UCS Manager Dynamic View

When the Dynamic View ZenPack is installed, a Dynamic View screen will be available on UCS Manager devices. This view shows a simplified topology of the more important elements being managed and how they're related. The view will show slightly different types of elements for UCS Classic, Mini and Modular.

UCS Classic
  • Domains
  • Fabric Interconnects
  • IO Cards
  • Fabric Extenders
  • Chassis
  • Blades
  • Racks
  • Service Profiles (only those bound to servers)


UCS Mini
  • UCS Domains
  • UCS FI-IO Modules
  • UCS Chassis
  • UCS Blades
  • UCS Racks
  • UCS Service Profiles (only those bound to servers)


UCS Modular
  • UCS Domains
  • UCS Fabric Interconnects
  • UCS Shared Adapters
  • UCS Chassis
  • UCS Cartridge Servers
  • UCS Service Profiles (only those bound to servers)


UCS Manager Service Impact and Root Cause Analysis

When combined with the Zenoss Service Dynamics product, this ZenPack adds built-in service impact and root cause analysis capabilities for services running on Cisco UCS Manager. The service impact relationships described below are automatically added. These will be included in any services that contain one or more of the explicitly mentioned components.

Impact Relationship Diagram
Compute Impact Relationships
  • Service profiles impact their associated guest operating system.
Network Impact Relationships
  • Virtual NICs and HBAs impact their service profile.
  • Host ethernet interfaces impact their bound virtual NIC.
  • Host bus adapters impact their bound virtual HBA.
  • Backplane ports impact their peer host ethernet interfaces and host bus adaptors.
  • Fabric ports impact their downstream backplane ports.
  • Ethernet Ports (server) impact their peer fabric port.
  • Ethernet Ports (network) impact their downstream server ethernet ports if unaggregated, or their port channel if aggregated.
  • Fibre channel ports impact their downstream server ethernet ports if unaggregated, or their port channel if aggregated.
  • Port channels impact their downstream server ethernet ports.
Hardware Impact Relationships
  • Adaptor units impact their host ethernet interfaces and host bus adapters.
  • Blade, cartridge and rack servers impact their adaptor units.
  • Processor units impact their blade, cartridge and rack servers.
  • Memory arrays impact their blade, cartridge and rack servers.
  • Power supply units impact their fabric interconnect, fabric extender, chassis, or rack server.
  • Fans impact their fabric interconnect, fabric extender, chassis or rack server.
  • Fan modules impact their fans.
  • Chassis impact their blade and cartridge servers, and their IO modules.
  • IO modules impact their fabric and backplane ports.
  • Fabric extenders impact their IO modules.
  • Switch cards impact their ethernet and fibre channel ports.
  • Fabric interconnects impact their switch cards.
Management Impact Relationships
  • UCS Manager impacts the fabric interconnects for UCS classic, and the chassis for UCS Mini.

The impacts described above follow the default policy of a node being in the worst state of the nodes that impact it. For example, a switch card failure will imply that all related ports are also failed.


UCS Manager Operational Reports

The following operational reports are included with this ZenPack. They can be found in the Cisco UCS Reports report organizer.

Operational Reports
  • Hardware Inventory
  • Free Memory Slots

UCS Manager Configuration Notes

In order to avoid monitoring and modeling issues, you have to use unique MAC addresses within your network, it can be configured over MAC Pools component on Cisco UCS Manager instance.

The Cisco UCS C3260 Rack Server is only supported by the UCS Manager XML API. There is no CIMC API support for the C3260 at this time.

MAC Pools

A MAC pool is a collection of network identities, or MAC addresses, that are unique in their layer 2 environment and are available to be assigned to vNICs on a server. If you use MAC pools in service profiles, you do not have to manually configure the MAC addresses to be used by the server associated with the service profile.

In a system that implements multi-tenancy, you can use the organizational hierarchy to ensure that MAC pools can only be used by specific applications or business services. Cisco UCS Manager uses the name resolution policy to assign MAC addresses from the pool.

You can specify your own MAC addresses or use a group of MAC addresses provided by Cisco. To assign a MAC address to a server, you must include the MAC pool in a vNIC policy. The vNIC policy is then included in the service profile assigned to that server.

You can read more about MAC Pools on the official Cisco website.

UCS C-Series and E-Series Features

Stand-alone C-Series and E-Series monitoring data is collected using UCS Rack-Mount Servers CIMC XML API and E-Series Servers CIMC XML API respectively. These APIs are nearly-identical and therefore provide roughly the same monitoring functionality.

Bulbgraph.png Note: CIMC firmware version 1.5 is the minimum supported version.

UCS C-Series and E-Series Discovery

The following components will be automatically discovered. The properties and relationships will be periodically remodeled to provide automatically up-to-date monitoring when the system configuration changes.

Model Diagram
Servers (Device)
Properties: Name, Mode, User Label, Number of CPUs, Number of CPU Cores, Number of CPU Cores Enabled, Number of CPU Threads, Memory Speed, Number of Adaptors, Number of Ethernet Host Interfaces, Number of Fibre Channel Host Interfaces, DN, UUID, Original UUID
Relationships: Power Supplies, Fan Modules, CPUs, Memory Arrays, Network Adapters, VIC Adapters, Storage Controllers
Power Supplies
Properties: Presence, Power, Operability, Voltage Status, Thermal Status
Fan Modules
Properties: Tray, Presence, Power, Operability, Voltage Status, Thermal Status
Relationships: Fans
Fans
Properties: Tray, Presence, Power Status, Operability Status, Voltage Status, Thermal Status
Relationships: Fan Module
CPUs
Properties: Socket Designation, Cores, Cores Enabled, Threads, Speed, Stepping, Presence, Operability
Memory Arrays
Properties: Maximum Devices, Populated, Current Capacity, Presence
Relationships: Memory Units
Memory Units
Properties: Form Factor, Width, Location, Type, Capacity, Clock, Visibility, Presence, Operability, Operational State
Relationships: Memory Array
Network Adapters
Properties: Slot, Number of Interfaces
Relationships: External Interfaces
VIC Adapters
Properties: Description, PCI Slot, PCI Address, Presence, Administrative State, CIMC Management Enabled
Relationships: VIC External Interfaces, VIC vNICs, VIC vHBAs.
VIC External Interfaces
Properties: Port ID, Interface Type, Transport, MAC Address, Administrative Speed, Operational Speed, Link State
Relationships: VIC Adapter, Downlink vNICs, Downlink vHBAs.
VIC vNICs
Properties: Interface Type, PXE Boot, iSCSI Boot, Port Profile, usNIC Count, MAC Address, MTU, Channel Number, Class of Service
Relationships: VIC Adapter, Uplink VIC External Interface
VIC vHBAs
Properties: Interface Type, Persistent Bindings, SAN Boot, Port Profile, WWNN, WWPN, Channel Number
Relationships: VIC Adapter, Uplink VIC External Interface
Storage Controller
Properties: Type, PCI Slot, RAID Support, Presence
Relationships: RAID Batteries, Virtual Drives, Local Disks
RAID Batteries
Properties: Type, Charging State, Absolute State of Charge, Relative State of Charge, Firmware Version, Date of Manufacture, Learn Mode, Learn Cycle Requested, Learn Cycle Status, Next Learn Cycle, Present, Health, Status
Relationships: Storage Controller
Virtual Drives
Properties: Size, RAID Level, Strip Size, Drives Per Span, Span Depth, Auto-Snapshot, Auto-Delete Oldest, Disk Cache Policy, Read-Ahead Policy, Access Policy, Allow Background Init, Health, Status, Drive State
Relationships: Storage Controller, Local Disks
Local Disks
Properties: Media Type, Interface Type, Link Speed, Firmware, Health, Status, Drive State, Online
Relationships: Storage Controller, Virtual Drive


UCS C-Series and E-Series Performance Monitoring

The following metrics will be collected every 5 minutes by default. This can be controlled with the zCiscoUCSCIMCPerfInterval configuration property. Unless specifically noted these metrics are available from C-Series and E-Series servers.

CIMC Server Overview
Servers (Device)
  • Fault Count: Faults (faults)
  • Component Counts: CPUs, CPU Cores, Enabled Cores, CPU Threads, VICs, vNICs, vHBAs (components)
C-Series Servers (Device)
  • Memory Availability: Total, Available (bytes)
  • Consumed Power: Compute Board (watts)
  • Input Current: Compute Board (amps)
  • Input Voltage: Compute Board (volts)
  • Temperature: Ambient, Front, Read, IOH 1 (degrees C.)


CIMC Server Overview
Power Supplies
  • Severity History: Operability, Power, Presence, Thermal, Voltage (severity)


CIMC Server Overview
Fan Modules
  • Severity History: Operability, Power, Presence, Thermal, Voltage (severity)


CIMC Server Overview
Fans
  • Severity History: Operability, Power, Presence, Thermal, Voltage (severity)


CIMC Server Overview
CPUs
  • Severity History: Operability, Presence (severity)


CIMC Server Overview
Memory Arrays (C-Series)
  • Severity History: Presence (severity)
  • Memory Capacity: Capacity (bytes)
  • Memory Units: Maximum, Populated (devices)
Memory Arrays (E-Series)
  • Severity History: Presence (severity)
  • Memory Units: Maximum, Populated (devices)


CIMC Server Overview
Memory Units
  • Severity History: Operability, Presence (severity)


CIMC Server Overview
Network Adapters
  • None


CIMC Server Overview
External Interfaces
  • None


CIMC Server Overview
VIC Adapters
  • Severity History: Presence (severity)


CIMC Server Overview
VIC External Interfaces
  • Severity History: Link State (severity)


CIMC Server Overview
VIC vNICs
  • None


CIMC Server Overview
VIC vHBAs
  • None


CIMC Server Overview
Storage Controllers
  • Severity History: Presence (severity)


CIMC Server Overview
RAID Batteries
  • Severity History: Present, Status, Health, Charging State, Relative Charge, Absolute Charge, Learn Cycle, High Temperature (severity)
  • Current: Current (amps)
  • Voltage: Design Limit, Voltage (volts)
  • Temperature: Temperature (degrees C.)


CIMC Server Overview
Virtual Drives
  • Severity History: State, Health (severity)


CIMC Server Overview
Local Disks
  • Severity History: State, Online (severity)
  • Predictive Failure Count: Count (count)
  • Size: Coerced (bytes)
  • Link Speed: Speed (bps)


UCS C-Series and E-Series Event Management

Zenoss will create events for all UCS faults collected through the CIMC API. Most CIMC faults disappear from the API after they're cleared. Zenoss will clear the corresponding Zenoss events when this occurs. The timestamp of corresponding Zenoss events will match the UCS fault's timestamp. So it is important that both Zenoss servers and the UCS servers have relatively accurate clocks.

The CIMC API doesn't provide a timezone offset for when faults occurred, so Zenoss has to assume that the time is UTC. If the server is configured to a timezone other than UTC, it will result in Zenoss misreporting the time events occurred by the opposite of the server's timezone offset.

Faults are collected from the CIMC interface once every 60 seconds by default. This can be changed using the zCiscoUCSCIMCEventsInterval configuration property.

The following fields will be populated for each event.

Standard Zenoss Event Fields
  • device: The UCS server device in the /CiscoUCS/CIMC/* device class.
  • component: The Zenoss modeled component related to the fault.
  • eventKey: The CIMC "dn" for the fault. Unique to the fault type.
  • summary: The CIMC "descr" for the fault truncated to 128 characters.
  • message: The CIMC "descr" for the fault.
  • severity: Mapped from the CIMC "severity" for the fault using the following table.
    • UCS critical = Zenoss critical
    • UCS major = Zenoss error
    • UCS minor = Zenoss warning
    • UCS warning = Zenoss warning
    • UCS condition = Zenoss info
    • UCS info = Zenoss info
    • UCS cleared = Zenoss clear
  • eventClassKey: Set to "ucs-cimc|code" where code is the CIMC code.
  • rcvtime: The CIMC "created" for the fault converted to UNIX timestamp.
  • count: The CIMC "occur" for the fault.

The following additional fields and potentially more will also be populated for each event. These are the fields native to a UCS CIMC fault record. If a fault occurs that has other fields, those will be added with the same ucs.cimc prefix.

Additional Event Fields
  • ucs.cimc.ack
  • ucs.cimc.affectedDN
  • ucs.cimc.cause
  • ucs.cimc.code
  • ucs.cimc.created
  • ucs.cimc.descr
  • ucs.cimc.dn
  • ucs.cimc.highestSeverity
  • ucs.cimc.id
  • ucs.cimc.ic
  • ucs.cimc.occur
  • ucs.cimc.origSeverity
  • ucs.cimc.prevSeverity
  • ucs.cimc.rule
  • ucs.cimc.severity
  • ucs.cimc.tags
  • ucs.cimc.type

UCS C-Series and E-Series Service Impact and Root Cause Analysis

When combined with the Zenoss Service Dynamics product, this ZenPack adds built-in service impact and root cause analysis capabilities for services running on Cisco UCS C-Series and E-Series servers. The service impact relationships described below are automatically added. These will be included in any services that contain one or more of the explicitly mentioned components.

Impact Relationship Diagram
Impact Relationships
  • Server failure impacts guest operating system devices including VMware vSphere hosts.
  • Power supply failure impacts the server.
  • Fan module failure impacts fans in the module.
  • Fan failure impacts the server.
  • CPU failure impacts the server.
  • Memory array failure impacts the memory units in the array.
  • Memory unit failure impacts the server.
  • Network adapter failure impacts external interfaces.
  • External interface failure impacts guest operating system interfaces including VMware vSphere host NICs.
  • VIC adapter failure impacts VIC external interfaces, vNICs and vHBAs.
  • VIC external interface failure impacts downlink vNICs and vHBAs.
  • VIC vNIC failure impacts guest operating system interfaces including VMware vSphere host NICs.
  • Storage controller failure impacts virtual drives and local disks.
  • RAID battery failure impacts virtual drives.
  • Local disk failure impacts the server if not used in a virtual drive, or the associated virtual drive.
  • Virtual drive failure impacts the server.


Linux Server on Stand-Alone UCS Server

The impacts described above follow the default policy of a node being in the worst state of the nodes that impact it. For example, a fan module failure will imply that all related fans are also failed.


Usage

Adding UCS Manager

Add Dialog

Use the following steps to start monitoring UCS Managers using the Zenoss web interface.

  1. Navigate to the Infrastructure page.
  2. Choose Add Cisco UCS from the add device button
  3. Fill out the form.
    • Choose UCS Manager as the UCS Type
    • Hostname or IP Address should be the floating IP address of the UCS Manager. It should not be the physical IP address of either fabric interconnect.
    • Username and Password should be a user with at least read-only permission to UCS Manager.
    • Collector should be the Zenoss collector that should discovery and monitor this system.
  4. Click ADD.

Alternatively you can use zenbatchload to add Cisco UCS Managers from the command line. To do this, you must create a file with contents similar to the following. Replace all values in angle brackets with your values minus the brackets. Multiple endpoints can be added under the same /Devices/CiscoUCS/UCS-Manager section.

/Devices/CiscoUCS/UCS-Manager
ucsm1 setManageIp='<address>', zCiscoUCSManagerUser='<username>', zCiscoUCSManagerPassword='<password>'

You can then load the endpoint(s) with the following command.

zenbatchload <filename>

Upgrading UCS Manager

The upgrade to 2.1.0 from previous versions will update the device class for UCS-Manager. As a consequence, without removing the device and re-adding the device, you may see an older device class.

In addition, the report Free Slots has now been renamed: Free Memory Slots.

Adding Stand-Alone UCS C-Series Servers

Use the following steps to start monitoring standalone UCS C-Series servers using the Zenoss web interface.

  1. Navigate to the Infrastructure page.
  2. Choose Add Cisco UCS from the add device button
  3. Fill out the form.
    • Choose C-Series as the UCS Type
    • Hostname or IP Address should be the resolvable name or IP address of the server's CIMC management interface. It should not be the address of the operating system running on the server.
    • Username and Password should be the CIMC management username and password. The default values for these are admin and password respectively.
    • Collector should be the Zenoss collector that should discovery and monitor this server.
  4. Click ADD.

Alternatively you can use zenbatchload to add stand-alone Cisco UCS C-Series servers from the command line. To do this, you must create a file with contents similar to the following. Replace all values in angle brackets with your values minus the brackets. Multiple servers can be added under the same /Devices/CiscoUCS/CIMC/C-Series section.

/Devices/CiscoUCS/CIMC/C-Series
server1 setManageIp='<address>', zCiscoUCSManagerUser='<username>', zCiscoUCSManagerPassword='<password>'

You can then load the endpoint(s) with the following command.

zenbatchload <filename>

Adding UCS E-Series Servers

Use the following steps to start monitoring UCS E-Series servers using the Zenoss web interface.

  1. Navigate to the Infrastructure page.
  2. Choose Add Cisco UCS from the add device button
  3. Fill out the form.
    • Choose E-Series as the UCS Type
    • Hostname or IP Address should be the resolvable name or IP address of the server's CIMC management interface. It should not be the address of the operating system running on the server.
    • Username and Password should be the CIMC management username and password. The default values for these are admin and password respectively.
    • Collector should be the Zenoss collector that should discovery and monitor this server.
  4. Click ADD.

Alternatively you can use zenbatchload to add Cisco UCS E-Series servers from the command line. To do this, you must create a file with contents similar to the following. Replace all values in angle brackets with your values minus the brackets. Multiple servers can be added under the same /Devices/CiscoUCS/CIMC/E-Series section.

/Devices/CiscoUCS/CIMC/E-Series
server1 setManageIp='<address>', zCiscoUCSManagerUser='<username>', zCiscoUCSManagerPassword='<password>'

You can then load the endpoint(s) with the following command.

zenbatchload <filename>


Installed Items

Configuration Properties
  • zCiscoUCSCIMCEventsInterval: Event collection interval in seconds. Default is 60.
  • zCiscoUCSCIMCPerfInterval: Metric collection interval in seconds. Default is 300.
  • zCiscoUCSManagerUser
  • zCiscoUCSManagerPassword
  • zCiscoUCSManagerPort: Port to use to connect to the UCS Manager or CIMC XML APIs. Default is 443 and typically should not be changed.
  • zCiscoUCSManagerUseSSL: Whether to use SSL when connecting to the UCS Manager or CIMC XML APIs. Default is true and typically should not be changed.
  • zCiscoUCSManagerPerfInterval: How often (in seconds) to collect statistics.
Device Classes
  • /CiscoUCS: Root Cisco UCS device class. Typically devices should not be put in this device class.
  • /CiscoUCS/UCS-Manager: Device class for UCS Manager endpoints.
  • /CiscoUCS/CIMC/C-Series: Device class for stand-alone UCS C-Series rack-mount servers.
  • /CiscoUCS/CIMC/E-Series: Device class for UCS E-Series servers.
Modeler Plugins
  • zenoss.ucs.CiscoUCSInstanceMap: UCS Manager modeler plugin.
  • zenoss.ucs.CIMCServer: Stand-alone C-Series and E-Series modeler plugin.
Datasource Types
  • Cisco UCS XML API: UCS Manager XML API datasource type. For UCS Manager.
  • UCS CIMC: CIMC XML API datasource type. For C-Series and E-Series.
Monitoring Templates
  • /CiscoUCS (used for UCS-Manager)
    • Device
    • UCSBladeServer
    • UCSCartridgeServer
    • UCSChassis
    • UCSEthPort
    • UCSFabricEthLanPc
    • UCSFabricFcoeSanPc
    • UCSFabricFcSanPc
    • UCSFabricInterconnect
    • UCSFanModule
    • UCSFcPort
    • UCSHostEthIf
    • UCSPowerSupplyUnit
    • UCSProcessorUnit
    • UCSSharedAdaptor
  • /CiscoUCS/CIMC (shared for C-Series and E-Series)
    • Device
    • Memory
    • PowerStats
    • TemperatureStats
    • PowerSupply
    • FanModule
    • Fan
    • CPU
    • MemoryArray
    • MemoryUnit
    • NetworkAdapter
    • ExternalInterface
    • VICAdapter
    • VICExternalInterface
    • VICvNIC
    • VICvBHA
    • StorageController
    • RAIDBattery
    • LocalDisk
    • VirtualDrive
  • /CiscoUCS/CIMC/E-Series
    • MemoryArray
Event Classes
  • /CiscoUCS
  • /CiscoUCS/Event
  • /CiscoUFS/Fault
  • /Status/Blade
  • /Status/Chassis
  • /Change/Set/UCS
Event Class Mappings
  • LOCAL0-3-SYSTEM_MSG (in /CiscoUCS): Handles syslog messages from UCS Manager.
  • UCS Events Default (in /CiscoUCS/Event): Handles events from UCS Manager XML API.
  • UCS Faults Default (in /CiscoUCS/Fault): Handles faults from UCS Manager XML API.
  • ucs-cimc-configResolveClass (in /Status): Handles polling failures from CIMC XML API.
  • ucs-cimc-defaultmapping (in /Status): Default handler for faults from CIMC XML API.
  • ucs-cimc-status (in /Status): Handles status events from CIMC XML API.
Collector Daemons
  • zenucsevents

Zenpack Installation notes

This ZenPack provides a collector daemon (zenucsevents) that must be stopped and removed manually within Control Center on Zenoss 5.x when updating from a previous version. In addition, all services must be restarted after the ZenPack is installed.

Zenoss Analytics

This ZenPack provides additional support for Zenoss Analytics. Perform the following steps to install extra reporting resources into Zenoss Analytics after installing the ZenPack.

  1. Copy analytics-cimc-bundle.zip and analytics-ucs-manager-bundle.zip from $ZENHOME/ZenPacks/ZenPacks.zenoss.CiscoUCS*/ZenPacks/zenoss/CiscoUCS/analytics/ on your Zenoss server.
  2. Navigate to Zenoss Analytics in your browser.
  3. Login as superuser.
  4. Remove any existing Cisco UCS ZenPack folder.
    1. Choose Repository from the View menu at the top of the page.
    2. Expand Public in the list of folders.
    3. Right-click on Cisco UCS ZenPack folder and choose Delete.
    4. Confirm deletion by clicking OK.
  5. Add the new Cisco UCS ZenPack folder.
    1. Choose Server Settings from the Manage' menu at the top of the page.
    2. Choose Import in the left page.
    3. Remove checks from all check boxes.
    4. Click Choose File to import the data files.
    5. Choose the analytics-cimc-bundle.zip file copied from your Zenoss server.
    6. Click Import.
    7. Choose the analytics-ucs-manager-bundle.zip file copied from your Zenoss server.
    8. Click Import.

You can now navigate back to the Cisco UCS ZenPack folder in the repository to see the following resources added by the bundle.

Domains
  • Cisco UCS CIMC Domain
  • Cisco UCS Manager Domain

Domains can be used to create ad hoc views using the following steps:

  1. Choose Ad Hoc View from the Create menu.
  2. Click View as list icon at the top of the data chooser dialog.
  3. Choose either the Cisco UCS CIMC Domain or Cisco UCS Manager domain depending on your reporting needs.

NOTE: Ad Hoc Views may require minimum 24 hours to populate data.

NOTE: For Zenoss 4.1.1 users, please use CiscoUCS 1.9.2. CiscoUCS 2.1.0 supports Zenoss version 4.2 and greater.

Tested Cisco UCS-Mini, B-Series, C-Series Releases

UCS-Mini

3.0, 3.1(1x), 3.1(2b)

B-Series

2.2, 3.1(1x)

C-Series

2.2, 3.1(1x)

Changes

2.5.3
  • Fix collection stall caused by interrupted connectivity. (ZPS-503)
2.5.1
  • Clarify and reduce chassis and server events (ZEN-25740)
  • Fix zCredentialsZProperties override warning on Zenoss 5.2 (ZEN-26164)
2.5.0
  • Added support for UCS Manager 3.1.
  • Added support for C3260 chassis managed by UCS Manager.
  • Added support for multiple chassis UCS Mini domains. (ZEN-24746)
  • Added UCSM Domain Type (Classic or Mini) to device overview.
  • Added DynamicView and Impact support for CIMC devices.
  • Added icons for UCS CIMC components. (ZEN-14383)
  • Added display of distinguished name for CIMC components. (ZEN-14384)
  • Added support for alternative port/SSL for CIMC device connections.
  • Separated "UCS Manager" and "UCS CIMC" Analytics bundles. (ZEN-24837)
  • Improved CIMC session handling support to reduce session exhaustion errors. (ZEN-15925)
  • Fixed many issues in "Cisco UCS Manager" and "Cisco UCS CIMC" Analytics domains.
  • Fixed unrecognized component statuses for CIMC components. (ZEN-16386)
  • Fixed "NoneType" errors in zenimpactstate update log. (ZEN-24872)
  • Fixed "zCredentialsZProperties" error on Zenoss 4. (ZEN-25521)
  • Fixed "failed converting" errors in zenucsevents log. (ZEN-25465)
  • Fixed OS/HW edit link on device overview. (ZEN-24791)
  • Associated blade server slot events with blade server. (ZEN-17539)
  • Fixed unnecessary updates being made during modeling. (ZEN-24420)
  • Removed passwords from debug log output. (ZEN-23587)
2.4.4
  • Fix migration issue related to ucsLayer2Catalog.
2.4.3
  • Fix for undefined componentType variable. (ZEN-23459)
2.4.2
  • Fix for all CIMC fault events occuring in August 2014. (ZEN-23438)
2.4.1
  • Optimization improvements for UCS Layer2 Linkable components. (ZEN-19856)
  • Status map for storageLocalDisk has been updated with JBOD and Global Hot Spare drive states. (ZEN-22829)
2.4.0
  • Show bound equipment stats for vNICs.
  • Fix UCS overview display issue on Zenoss 4. (ZEN-22862)
2.3.4
  • Fix re-opening of events when UCS deletes them. (ZEN-22420)
2.3.3
  • Fix potential Impact modeling performance issue.
2.3.2
  • Fix failure to receive UCS events. (ZEN-21847)
  • Fix modeling issues with more than 10 chassis. (ZEN-21483)
2.3.1
  • Add rack servers to hardware inventory report. (ZEN-20901)
  • Prevent adding invalid text as address for UCS domain. (ZEN-20825)
  • Fix potential ImportError when used with older vSphere versions. (ZEN-20789)
  • Fix potential unicode decode error during modeling. (ZEN-21164)
2.3.0
  • On Migration, replaces the following graphs if they exist (ZEN-19377):
    • Chassis: Power
    • Ethernet Port: Errors, Loss Stats, Pause Stats, Received Packets, Sent Packets, Throughput
    • Fabric Extender: Temperature
    • Fabric Interconnect: CPU Utilization, Memory Utilization, Temperatures
    • Fan Module: Fan Speeds, Temperature
    • Fibre Channel Port: Errors, Throughput
    • Host Ethernet Interface: Received Bytes, Received Packets, Sent Bytes, Sent Packets
    • Power Supply Unit: Temperatures, Voltages, Current, Power
    • Processor Unit: Temperature, Current
  • Add zCiscoUCSManagerPerfInterval property to configure stats collection interval. (ZEN-19932)
  • Move devices from /CiscoUCS and /CiscoUCS/UCS-M into /CiscoUCS/UCS-Manager. (ZEN-19887)
  • Add Racks to Dynamic View for Mini (ZEN-19792)
2.2.1
  • Fix relationship from HBAs to their adaptor.
  • Fix potential missed linkage of service profiles to vSphere hosts. (ZEN-18631)
2.2.0
  • Major upgrade adding new components:
    • Now supports M and Mini
    • Added FI-IO Modules, Shared Adpators, Cartridge Servers
    • Added Uplink Port Channel components for Fabric Ethernet LAN Port Channels, Fabric Fibre Channel SAN Port Channels and Fabric Fibre Channel over Ethernet SAN Port Channels
  • Updates model, monitoring and analytics
  • Now supported Zenoss >= 4.2
  • Replace /CiscoUCS/UCS-M device class with /CiscoUCS/UCS-Manager.
2.1.1
  • Fix potential '__dict__' modeling error. (ZEN-17195)
2.1.0
  • Major upgrade adding new components:
    • Backplane Ports, Fabric Extenders, Fabric Ports, Fans, IO Modules,
    • Host Bus Adaptors, Organizations, Rack Servers, Virtual HBAs
  • Updates model, monitoring and analytics
  • Now supported Zenoss >= 4.2
1.9.3
  • Remove unused Software link from UCS device navigation. (ZEN-14567)
1.9.2
  • Log CIMC API call details at DEBUG level. (ZEN-15770)
  • Handle missing CIMC classes gracefully. (ZEN-15924)
  • Add support for monitoring stats in Zenoss 5. (ZEN-15395)
  • Handle local disk "online" status correctly.
  • Use TLSv1 instead of SSLv3 for CIMC. (ZEN-16326)
  • Fix "FunctionCache" installation error on Zenoss 4.1. (ZEN-16339)
1.9.1
  • Change normal RAID battery statuses from error to clear. (ZEN-15531)
  • Stop sending events that will be immediately aged. (ZEN-15004)
1.9.0
  • Add support for C-Series and E-Series servers.
  • Default to monitoring over HTTPS instead of HTTP.
  • Make Free Slots and Hardware Inventory reports exportable.
1.8.5
  • Reconnect for events after 10 seconds. (ZEN-12858)
  • Improve model and performance ETL for Analytics.
  • Add support for zCredentialsZProperties.
1.8.4
  • Associate more events with modeled components. (ZEN-9955)
1.8.3
  • Fix collection issue introduced in 1.8.2. (ZEN-10211)
1.8.2
  • Fix y-axis scale on Chassis Power graph.
  • Reduce logins to UCS Manager to absolute minimum.
1.8.1
  • Fix clearing for UCS fault events.
  • Create events for all open faults upon initial connection.
  • Add description to UCS fault events with no description.
  • Add "--task" command line option to zenucsevents.
1.8.0
  • Add discovery of Management Interfaces.
  • Fix association of syslogs and SNMP traps for alternative management addresses.

Installation

Normal Installation (packaged egg)

  1. Download the appropriate egg file for the version of Zenoss you are running.
  2. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  3. Install the ZenPack:
    $ zenpack --install ZenPacks.zenoss.CiscoUCS-*.egg
  4. Restart these services:
    $ zenoss restart


Discuss

Purplemarker.png New: Don't forget to add yourself to the Zenoss User Map!

blog comments powered by Disqus