Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

HPE Onboard Administrator

Monitor HPE Compute Chassis and Virtual Networking

Data Collection Setup

Metrics are collected via the HPE Compute Chassis Onboard Administrator (OA)
and HPE Virtual Connect Manager (VCM) for virtual networking on HPE Chassis.

Network Requirements

Port: 22 (TCP) to connect to the OA and VCM.

Least Privileged User

Assiging HP OA User Permissions via UI

  1. Log in to your HP BladeSystem Onboard Administrator console as an administrator, then navigate to Systems and Devices -> User/Authentication -> Local Users, and select the user you plan to use for your management pack credentials.
  1. Ensure the following settings are configured:

Privilege Level: Select user.
User Enabled: Ensure this checkbox is selected.
Device & Interconnect Bay Access: Ensure all bays are selected.

  1. Click Update User to save your settings.

Assigning HP OA User Permissions via CLI

To create your OA user with "User" Privilege Level from the command-line interface:

  1. Log in to your HP BladeSystem Onboard Administrator as an administrator.
  2. Run the following commands:
ADD USER <username> <password>
SET USER ACCESS "<username>" USER

Assigning HP VCM Permission via GUI

  1. Log in to your HPE Virtual Connect Manager console as an administrator, then navigate to Domain Settings > User/Authentication > Local Users.

  2. Click +Add. In the Add Local User window that appears, enter the following information:

Username
Password
Confirm Password

🚧

Do not select any roles

Under Roles, do not select any options. A read-only user will be created by default if no role is selected.

  1. Click Add & Close to save your read-only user.

Assigning HP VCM Permissions via CLI

  1. Log in to your HPE VCM as an administrator.
  2. Run the following commands to create a read-only VCM user:

add user ROuser

  1. At the prompts, enter and verify the password you want associated with your read-only user:
  1. After you have successfully created your read-only user, you can view details about it by using the following command:

show user ROuser

Output:

By default no specific roles or role operations are assigned to a read-only user.

Supported Versions

  • HPE ProLiant Servers: Gen 8, 9, or 10 (Blade or Rack), with one of the following:
  • HPE Onboard Administrator (OA): Command Line Interface (CLI), 4.50+
  • HPE Virtual Connect Manager (VCM): CLI, 4.50+

Connection Parameters

NameRequired?Description
Onboard Administrator HostRequiredComma-separated list of Onboard Administrator hosts or CIDR notation IP range.
Onboard Administrator UsernameRequired
Onboard Administrator PasswordRequired
Virtual Connect Manager Username
Virtual Connect Manager Password
Collect EventsControls whether events are collected and returned.
Minimum Event SeverityEvents with a severity level below this minimum will not be returned.
Connection Timeout (seconds)The number of seconds to allow for connecting to the target.
Thread Pool SizeMaximum number of threads used to perform collection.
Use SHA-2/SHA-256 in SSH Key ExchangesWhether or not we should force using SHA-2/SHA-256 in SSH key exchanges.

Metrics

Blade

NameDescription
Ambient Zone Temperature Sensors Above CautionNumber of Ambient Zone Temperature Sensors reported by the blade with values greater than the caution threshold
Ambient Zone Temperature Sensors Above CriticalNumber of Ambient Zone Temperature Sensors reported by the blade with values greater than the critical threshold
Average Ambient Zone Temperature (Celsius)Average Ambient Zone Temperature reported by the blade
Average Chassis Zone Temperature (Celsius)Average Chassis Zone Temperature reported by the blade
Average CPU Zone Temperature (Celsius)Average CPU Zone Temperature reported by the blade
Average Disk Zone Temperature (Celsius)Average Disk Zone Temperature reported by the blade
Average I/O Board Zone Temperature (Celsius)Average I/O Board Zone Temperature reported by the blade
Average Memory Zone Temperature (Celsius)Average Memory Zone Temperature reported by the blade
Average Power Supply Zone Temperature (Celsius)Average Power Supply Zone Temperature reported by the blade
Average System Zone Temperature (Celsius)Average System Zone Temperature reported by the blade
BIOS VersionBIOS Version of the blade
Blade NumberSlot number of the blade.
Chassis Zone Temperature Sensors Above CautionNumber of Chassis Zone Temperature Sensors reported by the blade with values greater than the caution threshold
Chassis Zone Temperature Sensors Above CriticalNumber of Chassis Zone Temperature Sensors reported by the blade with values greater than the critical threshold
Cooling StatusThe blade's cooling status
CPU Zone Temperature Sensors Above CautionNumber of CPU Zone Temperature Sensors reported by the blade with values greater than the caution threshold
CPU Zone Temperature Sensors Above CriticalNumber of CPU Zone Temperature Sensors reported by the blade with values greater than the critical threshold
Current Power Consumption (Watts)The blade's current power consumption
Device Degraded StatusThe blade's device degraded status
Device Failure StatusThe blade's device failure status
Disk Zone Temperature Sensors Above CautionNumber of Disk Zone Temperature Sensors reported by the blade with values greater than the caution threshold
Disk Zone Temperature Sensors Above CriticalNumber of Disk Zone Temperature Sensors reported by the blade with values greater than the critical threshold
HealthHealth of the blade
HostnameHostname of the blade.
iLO Network StatusThe blade's iLO network status
Internal Data StatusThe blade's internal data status
I/O Board Zone Temperature Sensors Above CautionNumber of I/O Board Zone Temperature Sensors reported by the blade with values greater than the caution threshold
I/O Board Zone Temperature Sensors Above CriticalNumber of I/O Board Zone Temperature Sensors reported by the blade with values greater than the critical threshold
I/O Configuration StatusThe blade's I/O configuration status
Location StatusThe blade's location status
Management Processor Firmware VersionThe blade's management processor's firmware version
Management Processor IP AddressThe blade's management processor's IP Address
Management Processor MAC AddressThe blade's management processor's MAC Address
Management Processor StatusStatus of the Management Processor on the blade
Management Processor TypeThe blade's management processor's type
ManufacturerManufacturer of the blade
Maximum Ambient Zone Temperature (Celsius)Maximum Ambient Zone Temperature reported by the blade
Maximum Chassis Zone Temperature (Celsius)Maximum Chassis Zone Temperature reported by the blade
Maximum CPU Zone Temperature (Celsius)Maximum CPU Zone Temperature reported by the blade
Maximum Disk Zone Temperature (Celsius)Maximum Disk Zone Temperature reported by the blade
Maximum I/O Board Zone Temperature (Celsius)Maximum I/O Board Zone Temperature reported by the blade
Maximum Memory Zone Temperature (Celsius)Maximum Memory Zone Temperature reported by the blade
Maximum Power Supply Zone Temperature (Celsius)Maximum Power Supply Zone Temperature reported by the blade
Maximum System Zone Temperature (Celsius)Maximum System Zone Temperature reported by the blade
Memory (Mebibytes)Memory on the blade
Memory Zone Temperature Sensors Above CautionNumber of Memory Zone Temperature Sensors reported by the blade with values greater than the caution threshold
Memory Zone Temperature Sensors Above CriticalNumber of Memory Zone Temperature Sensors reported by the blade with values greater than the critical threshold
Mezzanine Card StatusThe blade's mezzanine card status
Minimum Ambient Zone Temperature (Celsius)Minimum Ambient Zone Temperature reported by the blade
Minimum Chassis Zone Temperature (Celsius)Minimum Chassis Zone Temperature reported by the blade
Minimum CPU Zone Temperature (Celsius)Minimum CPU Zone Temperature reported by the blade
Minimum Disk Zone Temperature (Celsius)Minimum Disk Zone Temperature reported by the blade
Minimum I/O Board Zone Temperature (Celsius)Minimum I/O Board Zone Temperature reported by the blade
Minimum Memory Zone Temperature (Celsius)Minimum Memory Zone Temperature reported by the blade
Minimum Power Supply Zone Temperature (Celsius)Minimum Power Supply Zone Temperature reported by the blade
Minimum System Zone Temperature (Celsius)Minimum System Zone Temperature reported by the blade
ModelThe model of the blade.
Number of Ambient Zone Temperature SensorsNumber of Ambient Zone Temperature Sensors reported by the blade
Number of Chassis Zone Temperature SensorsNumber of Chassis Zone Temperature Sensors reported by the blade
Number of CPU Zone Temperature SensorsNumber of CPU Zone Temperature Sensors reported by the blade
Number of Disk Zone Temperature SensorsNumber of Disk Zone Temperature Sensors reported by the blade
Number of I/O Board Zone Temperature SensorsNumber of I/O Board Zone Temperature Sensors reported by the blade
Number of Memory Zone Temperature SensorsNumber of Memory Zone Temperature Sensors reported by the blade
Number of Power Supply Zone Temperature SensorsNumber of Power Supply Zone Temperature Sensors reported by the blade
Number of System Zone Temperature SensorsNumber of System Zone Temperature Sensors reported by the blade
Power Management Controller VersionPower Management Controller Version of the blade's management processor
Power StateThe on/off power state of the blade
Power StatusPower status of the blade
Power Supply Zone Temperature Sensors Above CautionNumber of Power Supply Zone Temperature Sensors reported by the blade with values greater than the caution threshold
Power Supply Zone Temperature Sensors Above CriticalNumber of Power Supply Zone Temperature Sensors reported by the blade with values greater than the critical threshold
Serial NumberSerial Number of the blade.
SKUThe blade's part number
System Zone Temperature Sensors Above CautionNumber of System Zone Temperature Sensors reported by the blade with values greater than the caution threshold
System Zone Temperature Sensors Above CriticalNumber of System Zone Temperature Sensors reported by the blade with values greater than the critical threshold
UUIDUUID of the blade.
VCM Configured StatusThe blade's VCM configured status
Virtual Fan (%)The blade's virtual fan usage

Enclosure

NameDescription
Asset TagAsset Tag of the Enclosure for identification
Communication StatusCommunication Status of the Enclosure
DescriptionDescription of the Enclosure provided by HPE
IDThe ID of the Enclosure.
Import StatusImport Status of the Enclosure
ManufacturerManufacturer of the Enclosure
NameThe name of the Enclosure.
Number of Device BaysNumber of Device Bays
Number of I/O BaysNumber of I/O Bays
OA1 IP AddressIP Address of Onboard Administrator 1
OA1 IPv6 AddressIPv6 Address of Onboard Administrator 1
OA2 IP AddressIP Address of Onboard Administrator 2
OA2 IPv6 AddressIPv6 Address of Onboard Administrator 2
Onboard Administrator Firmware VersionFirmware Version of the Onboard Administrator
Onboard Administrator StatusOnboard Administrator Status
Operational StatusOperational Status of the Enclosure
Overall StatusOverall status of the Enclosure
Part NumberPart Number of the Enclosure
PrimaryWhether or not this is designated as the primary enclosure
Root CauseRoot Cause of the status
Serial NumberSerial Number of the Enclosure
Spare Part NumberSpare Part Number for the Enclosure
Spare Rack NameSpare Rack Name for the enclosure
Status CauseCause of the status
UUIDThe UUID of the Enclosure.

Fan

NameDescription
Device Degraded StatusDevice Degraded Diagnostic Status of the fan
Device Failure StatusDevice Failure Diagnostic Status of the fan
Enclosure UUIDUUID of related enclosure.
Fan NumberThe assigned Fan Number.
Internal Data StatusInternal Data Diagnostic Status of the fan
Location StatusLocation Diagnostic Status of the fan
Maximum speed (Rotations per Minute)Maximum speed of the fan
Minimum speed (Rotations per Minute)Minimum speed of the fan
Missing Device StatusMissing Device Diagnostic Status of the fan
Part NumberHPE assigned part number
Power Consumed (Watts)Power Consumed by the fan
Product NameHPE assigned product name
Spare Part NumberHPE assigned spare part number
Speed (%)Speed as a percent of Maximum speed
StatusStatus of the fan
VersionHPE assigned Version

Interconnect

Name
Average Received Data (Kibibits per Second)
Average Received Non Unicast Packets (Packets per Second)
Average Received Packets (Kibibits per Second)
Average Transmitted Data (Kibibits per Second)
Average Transmitted Non Unicast Packets (Packets per Second)
Average Transmitted Packets (Packets per Second)
Bay
Communication Status
Enclosure
Firmware Version
Hostname
ID
IP Address
IPv6 Address
MAC Address
Manufacturer
Node WWN
Onboard Administrator Status
Part Number
Power Status
Product Name
Rack Name
Role
Root Cause
Serial Number
Spare Part Number
Status
Status Cause
Total Received Data (Kibibits per Second)
Total Received Non Unicast Packets (Packets per Second)
Total Received Packets (Kibibits per Second)
Total Transmitted Data (Kibibits per Second)
Total Transmitted Non Unicast Packets (Packets per Second)
Total Transmitted Packets (Packets per Second)
Type
UID
VCM Host

Interconnect Port

NameDescription
Autonegotiate
Connected From
Connected From Port
Connected To
Connected To Port
DiscardsFrames discarded for bridging functions
Discards Due To DelayFrames discarded due to excessive transit delay through the bridge for bridging functions
Discards Due To SizeFrames discarded due to excessive size for bridging functions
Enclosure
IDThe ID of the Interconnect Port.
Interface Broadcast Received (Packets)Total broadcast packets received for this sub-layer to a higher (sub-)layer.
Interface Broadcast Sent (Packets)Total broadcast packets requested by a higher (sub-)layer.
Interface Data Received (Bytes)Total octets received for this interface.
Interface Data Sent (Bytes)Total octets requested by a higher (sub-)layer.
Interface Multicast Received (Packets)Total multicast packets received for this sub-layer to a higher (sub-)layer.
Interface Multicast Sent (Packets)Total multicast packets requested by a higher (sub-)layer.
Interface Unicast Received (Packets)Total unicast packets received for this sub-layer to a higher (sub-)layer.
Interface Unicast Sent (Packets)Total unicast packets requested by a higher (sub-)layer.
Label
LAG ID
Paired With
PID LED State
Received Data (Kibibits per Second)
Received FramesFrames received for bridging functions
Received Non Unicast Packets (Packets per Second)Received Non Unicast Packets
Received Packets (Kibibits per Second)
Remote Broadcast Packets Received (Packets)Total good broadcast packets received
Remote CollisionsCollisions on this ethernet segment
Remote Data (Bytes)Total octets of data received on the network.
Remote Drop EventsTotal events in which packets were dropped due to lack of resources.
Remote Fragments (Packets)Total Packets received that were less than 64 octets in length.
Remote Jabbers (Packets)Total Packets received that were greater than 1518 octets in length.
Remote Multicast (Packets)Total Packets received that were directed to a multicast address.
Remote Oversize Packets (Packets)Total packets longer than 1518 received on the network.
Remote Packets (Packets)Total packets received on the network.
Remote Packets Received without Errors (Packets)Total packets with no errors received on the network.
Remote Packets Size 1024 to 1418 (Packets)Total packets between 1024 and 1418 octets received on the network.
Remote Packets Size 128 to 255 (Packets)Total packets between 128 and 255 octets received on the network.
Remote Packets Size 256 to 511 (Packets)Total packets between 256 and 511 octets received on the network.
Remote Packets Size 512 to 1023 (Packets)Total packets between 512 and 1023 octets received on the network.
Remote Packets Size 64 (Packets)Total packets sized 54 octets received on the network.
Remote Packets Size 65 to 127 (Packets)Total packets between 65 and 127 octets received on the network.
Remote Packets Transmitted without Errors (Packets)Total packets with no errors transmitted on the network.
Remote Received CRC Alignment Errors (Packets)Total packets received that had an alignment error
Remote Undersized Packets (Packets)Total packets less than 64 octets in size received on the network.
Sent FramesFrames sent for bridging functions
Speed
Status
TCP/IP Discarded Datagrams Received (Packets)
TCP/IP Discarded Inbound Packets (Packets)
TCP/IP Discarded Outbound Packets (Packets)
TCP/IP Forwarded Datagrams (Packets)
TCP/IP Header Error Datagrams Received (Packets)
TCP/IP Inbound Error Packets (Packets)Inbound Packets Undeliverable due to Errors
TCP/IP Inbound Non-Unicast Packets (Packets)
TCP/IP Outbound Error Packets (Packets)Outbound Packets Undeliverable due to Errors
TCP/IP Outbound Non-Unicast Packets (Packets)Outbound Non-Unicast Packets
TCP/IP Packet Outbound Queue Length
TCP/IP Received Datagrams (Packets)
TCP/IP Total Data Received (Bytes)
TCP/IP Total Data Sent (Bytes)
TCP/IP Unicast Packets Delivered (Packets)
TCP/IP Unicast Packets Received (Packets)
TCP/IP Unknown Protocols (Packets)Inbound packets discarded because of an unknown or unsupported protocol
Transmitted Data (Kibibits per Second)
Transmitted Non Unicast Packets (Packets per Second)
Transmitted Packets (Packets per Second)
Type
Used By

Port

Name
Bay
Bay Port Number
MAC Address
Mezzanine Device
Mezzanine Slot
Status

Power Supply

Name
AC Input Status
Current Power Output (Watts)
Device Failure Status
Internal Data Status
Output Capacity (Watts)
Part Number
Power Cord Status
Power Supply Number
Product Name
Serial Number
Spare Part Number
Status
Version

Updated 8 months ago

HPE Onboard Administrator


Monitor HPE Compute Chassis and Virtual Networking

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.