Red Hat Training

A Red Hat training course is available for Red Hat CloudForms

Redfish physical infrastructure provider for Red Hat CloudForms User Guide

Red Hat CloudForms 4.7

User Guide

Red Hat CloudForms Documentation Team

Matej Artač

Abstract

This documentation includes the instructions on adding and using Redfish physical infrastructure provider in Red Hat CloudForms.
Functionality covered by CloudForms plug-in for Redfish is described in Relese Notes.

Chapter 1. Overview

DMTF’s Redfish is a standard for Out-Of-Band (OOB) management of physical infrastructure.

This documentation provides configuration steps required by Redfish physical infrastructure provider for Red Hat CloudForms. Functionality covered is described in Chapter 2, Redfish Physical Infrastructure Provider Release Notes section.

Chapter 2. Redfish Physical Infrastructure Provider Release Notes

The Red Hat CloudForms supports the following Redfish physical infrastructure provider functionality:

  • Inventory
  • LED Identification Operations
  • Power Operations
  • Events

2.1. Inventory

Redfish physical infrastructure provider collects the inventory on all of the discoverable systems, populating the database behind the scenes. The first inventory operation is automatic, while the subsequent ones occur either regularly or manually. The inventory is currently not updated upon Redfish events.

Depending on the capabilities of the systems under inventory, the Redfish may distinguish between entities such as blocks, racks, sleds, chassis, physical servers and others. These categories are mapped into Red Hat CloudForms categories as follows:

CloudForms Convention.Redfish Convention.

Physical Rack

Rack

Physical Chassis

Block, Sled, Chassis

Physical Server

System

2.2. LED Identification Operations

Physical systems may support identification through remotly manipulating a dedicated identification LED located somewhere on the enclosure. Red Hat CloudForms provides the following identification LED operations:

Identity action.Expected LED state after action.

Turn LED On

On

Turn LED Off

Off

Blink LED

Blinking

2.3. Power Operations

Power operations change the status of the power supply of the system and can also trigger a reboot of the target physical system. It is always possible to request any power operation regardless of the system’s current power state. However, depending on the vendor’s implementation, some operations may not have any effect if the system is in a wrong state at the time when it receives the request.

Power operation.Expected power state after action.

Power On

Powering On, On

Power Off

Powering Off, Off

Power Off Immediately

Powering Off, Off

Restart

Powering Off, Off, Powering On, On

Restart Immediately

Powering Off, Off, Powering On, On

The following power actions are not supported:

  • Restart to System Setup
  • Restart Management Controller

2.4. Events

Red Hat CloudForms supports Redfish events from the vendors that support the Server-Side Events (SSE) technology. The events received are then completely dependent on the vendor’s implementation and the Baseboard Management Controller (BMC) configuration.

Chapter 3. Prerequisites

The following preprequisites must be met to start using Redfish physical infrastructure provider for Red Hat CloudForms:

  • One or more physical systems with an embedded BMC that supports Redfish.
  • Administrator credentials for the BMC.
  • CloudForms appliance must be able to reach Redfish server on the physical system’s BMC network interface through at least one of the appliance’s own network interface.
  • For Redfish events to work, the BMC must support the Server-Side Events (SSE) technology.

Chapter 4. Tested Systems

We have tested the Redfish physical infrastructure provider against the following systems:

  • Dell DSS 9620 with iDRAC9
  • Dell PowerEdge R470 with iDRAC9
  • HPE CloudLine CL21000 with AMI MegaRAC SP-X (30810600 1.11.0 2018-6-21)
  • Lenovo SR 650 with XClarity Controller (CDI320S 1.70 2018-02-28)

Chapter 5. Installing Red Hat CloudForms

To install Red Hat CloudForms please refer to Red Hat CloudForms Installation Guide.

Chapter 6. Adding a new Redfish Physical Infrastructure Provider to Red Hat CloudForms

This section describes how to add a new Redfish physical infrastructure provider to Red Hat CloudForms using CloudForms graphical interface. First step is to log in. Then navigate to Compute → Physical Infrastructure → Providers page from the main navigation on the left.

Open physical infrastructure providers

In the Configuration drop-down, select Add a New Physical Infrastructure Provider:

Add a new Redfish physical infrastructure provider

Type in the name of the new Redfish physical infrastructure provider in the Name field and select Redfish in the Type drop-down:

Name and type of Redfish physical infrastructure provider

This will reveal fields to describe the endpoint of the new Redfish physical infrastructure provider for Red Hat CloudForms. Populate them as needed:

Endpoint details of Redfish physical infrastructure provider

To proceed, click Validate. If the credential validation was successful, click Add. The Physical Infrastructure Providers list will display the new provider:

List of physical infrastructure providers showing the newly added Redfish physical infrastructure provider

It takes about a minute before the inventory gets populated for the first time, so use the browser’s refresh function to obtain an updated status.

Chapter 7. Using Redfish Physical Infrastructure Provider for Red Hat CloudForms

7.1. Examining Redfish Physical Infrastructure Provider Inventory

The physical infrastructure provider’s dashboard provides an overview of the inventory at a glance. To view it, first navigate to Compute → Physical Infrastructure → Providers page from the main navigation on the left, then click your Redfish physical infrastructure provider.

Redfish physical infrastructure provider dashboard

Note

The Redfish physical infrastructure provider does not support targeted refreshing of the inventory. To make sure that the latest information is visible, please perform Configuration → Refresh Relationships and Power States. The statuses should be up-to-date after a few seconds.

To obtain a tabular view of the inventory, switch to the Summary View of the Redfish physical infrastructure provider’s dashboard:

Summary view of Redfish physical infrastructure provider dashboard

To view a list of the resources discovered through the inventory, click on the respective row of the Relationships table. For example, clicking on the Physical Servers row will take you to the list of physical servers:

Summary view of Redfish physical infrastructure provider dashboard

A graphical representation of the managed data center can be displayed by navigating to Compute → Physical Infrastructure → Topology:

Topology of Redfish physical infrastructure provider entities in the inventory

7.2. Identifying physical systems

Many physical servers are equipped with a LED for identifying it as a specific unit. Please use the server’s documentation to locate it on the server’s chassis.

Depending on previous operation, the states of the identify LEDs may be random. To make sure that only the selected system’s LED will be visible, we first make sure that all the physical servers' identify LEDs are off. To do this, we visit Compute → Physical Infrastructure → Servers from the navigation on the left. Here, we can see from the LED State column the current states of the identifying LED for the servers. To select all servers, we click on the Select All checkbox at the bottom of the page. Now the Identify menu becomes active:

Identify menu and current state of the identify LED for the servers in the inventory

From the Identify menu, we click the Turn LED Off. We confirm the action by clicking OK in the confirmation prompt that appears in the browser. Then we should see the status showing the success of sending the request:

Confirmation of successfully requesting to turn off the LED

The LEDs on the servers should be off within a few seconds. To see the updated status in the CloudForms graphical interface, use the Configuration → Refresh Relationships and Power States, wait a few seconds, then refresh the page in the browser.

Refreshing the inventory status

To control the LED for an individual server, we can first click on the physical server’s name in the table. We obtain the physical server’s summary view, which provides the same Identify menu as before. Here, we can also see the state of the identification LED:

Identify menu and current state of the identify LED

To make the server’s identification LED blink, we click Identify → Blink LED. We get a prompt for confirming the action. After clicking OK, the :product-gui: shows confirmation of the request sent. Shortly afterwards, the selected server’s LED should start blinking.

To see the status updated in the CloudForms graphical interface, we use the Configuration → Refresh Relationships and Power States function, then after a few seconds we refresh the page in the browser.

Please refer to the Chapter 2, Redfish Physical Infrastructure Provider Release Notes section for further information about the identify LED management actions and statuses.

7.3. Managing the Physical System’s Power Status

Physical servers may be powered off, powered on or restarted remotely through CloudForms graphical interface using Redfish physical infrastructure provider.

To power off a particular physical server, we first navigate Compute → Physical Infrastructure → Servers from the navigation on the left. On the server list, we click on the server’s name. This takes us to the server’s summary page, which provides the Power menu and displays the server’s current power state:

Power menu and current state of the power to the server

We can see that the server is currently powered on. To have it powered off, we click on Power → Power Off Immediately. We get a prompt to confirm the selected action. After we click Ok, we will see the status showing the success of sending the request:

Confirmation of successfully requesting to turn off the server immediately

The server should be powered off within a few seconds. To see the updated status in the CloudForms graphical interface, use the Configuration → Refresh Relationships and Power States, wait a few seconds, then refresh the page in the browser. Subject to server’s vendor’s Redfish implementation, the power status should cycle from On over PoweringOff to finally Off.

To turn on all the physical servers in a single batch operation, we visit Compute → Physical Infrastructure → Servers from the navigation on the left. Here, we can see from the Power State column the current states of the power supply for the servers. To select all servers, we click on the Select All checkbox at the bottom of the page. Now the Power menu becomes active:

Power menu and current power state of the servers in the inventory

From the Power menu, we click the Power On. We confirm the action by clicking OK in the confirmation prompt that appears in the browser. Then we should see the status showing the success of sending the request.

The servers should be powered on within a few seconds. To see the updated status in the CloudForms graphical interface, use the Configuration → Refresh Relationships and Power States, wait a few seconds, then refresh the page in the browser. Again depending on the Redfish implementation, the statuses will cycle from Off to PoweringOn and finally to On.

Please refer to the Chapter 2, Redfish Physical Infrastructure Provider Release Notes section for further information about the power management actions and statuses.