Redfish is a standard that uses RESTful interface semantics to access a schema based data model to conduct management operations. The Redfish Scalable Platforms Management API is a standard defined by the Distributed Management Task Force (DMTF). Redfish is a next-generation systems management interface standard, which enables scalable, secure, and open server management. It is a new interface that uses RESTful interface semantics to access data that is defined in model format to perform out-of-band systems management. It is suitable for a wide range of servers ranging from stand-alone servers to rack mount and bladed environments and for large scale cloud environments

Being model-oriented, it can express the relationships between components and the semantics of the Redfish services and components within them. The model is also easy to extend and by requiring JSON representation, Redfish enables easy integration with programming environments. It is also easy to interpret by humans. An interoperable Redfish schema defines this model, which is freely available and published in OpenAPI YAML, OData CSDL, and JSON Schema formats.

Key Use Cases

Discovery Use Cases:

• Provides resource visibility to the administrator to view and manage resources available (Ex: Manager, Chassis, Systems, Network Adapters, PCIe Devices and PCIe Functions, Power, Thermals) under different resource types.
• Publishes relationships between resources to have a topological view and ease of maintenance.

Monitoring Use Cases:

• Provides metrics related to CPU Utilization, Memory Utilization, Performance Utilization and Health Monitoring and so on for different resources.
• Concern alerts will be generated for each metric to notify the administrator regarding the issue with the resource.

Prerequisites

• Ensure that the target server supports Redfish API and is reachable from the OpsRamp Gateway.
• The integration requires network connectivity on port 443 (HTTPS) or the custom Redfish port configured on the device.
• You must create a local user account on the target device to authenticate Redfish API calls.
• The local user should be assigned the Read only role or at minimum have the Login privilege.
  • These permissions are sufficient to fetch hardware metrics and event logs using the Redfish API.
  • Administrator-level access is not required.
• For HPE devices, refer to the official HPE documentation on Redfish user roles and privileges

Default Monitoring Configuration

Redfish has default Global Device Management Policies, Global Templates, Global Monitors and Global Metrics in OpsRamp. You can customize these default monitoring configurations as per your business requirement by cloning respective Global Templates and Global Device Management Policies. It is recommended to clone them before installing the application to avoid noise alerts and data.

1. Default Global Device Management Policies

   You can find the Device Management Policy for each Native Type at Setup > Resources > Device Management Policies. Search with suggested names in global scope:

   {appName nativeType - version}

   Ex: redfish-server Chassis - 1 (i.e, appName = redfish-server, nativeType =Chassis, version = 1)

2. Default Global Templates

   You can find the Global Templates for each Native Type at Setup > Monitoring > Templates. Search with suggested names in global scope. Each template adheres to the following naming convention:

   {appName nativeType 'Template' - version}

   Ex: redfish-server Chassis Template - 1 (i.e, appName = redfish-server, nativeType =Chassis, version = 1)

3. Default Global Monitors

   You can find the Global Monitors for each Native Type at Setup > Monitoring > Monitors. Search with suggested names in global scope. Each Monitors adheres to the following naming convention:

   {monitorKey appName nativeType - version}

   Ex: redfish-server Chassis Health Monitor redfish-server Chassis 1(i.e, monitorKey = Chassis Health, appName = redfish-server, nativeType = Chassis, version = 1)

Configure and Install the Redfish - Server Integration

1. From All Clients, select a client.
2. Go to Setup > Account.
3. Select the Integrations and Apps tab.
4. The Installed Integrations page, where all the installed applications are displayed.
   Note: If there are no installed applications, it will navigate to the Available Integrations and Apps page.
5. Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
   Note: Search for the application using the search option available. Also you can use the All Categories option to search.
6. Click ADD in the Redfish - Server application.
7. In the Configurations page, click + ADD. The Add Configuration page appears.
8. Enter the following BASIC INFORMATION:

9. CUSTOM ATTRIBUTES: Custom attributes are the user-defined data fields or properties that can be added to the preexisting attributes to configure the integration.

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

10. In the RESOURCE TYPE section, select:
    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
11. In the DISCOVERY SCHEDULE section, select recurrence pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
12. Click ADD.

Now the configuration is saved and displayed on the configurations page after you save it.
Note: From the same page, you may Edit and Remove the created configuration.

13. Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.

    Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.

14. Click NEXT.

15. (Optional) Click +ADD to create a new collector by providing a name or use the pre-populated name.

16. Select an existing registered profile.

17. Click FINISH.

The application is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

Modify the Configuration

• See Modify an Installed Integration or Application article.

  Note: Select the Redfish - Server application.

View the Redfish - Server Details

To discover resources for Redfish - Server:

1. Navigate to Infrastructure > Search > COMPUTE > Redfish - Server.
2. The REDFISH - SERVER page is displayed, select the application name.
3. The RESOURCE DETAILS page appears from the right.
4. Click the ellipsis (…) on the top right and select View details.

5. Navigate to the Attributes tab to view the discovery details.

6. Click the Metrics tab to view the metric details for Redfish - Server.

View resource metrics

To confirm Redfish - Server monitoring, review the following:

• Metric graphs: A graph is plotted for each metric that is enabled in the configuration.
• Alerts: Alerts are generated for metrics that are configured as defined for integration.

Resource Filter Input keys

Redfish application Resources are filtered and discovered based on below keys:

Supported Alert Custom Macros

Customize the alert subject and description with below macros then it will generate alerts based on customisation.

Risks, Limitations & Assumptions

• You can manage critical/recovery failure alerts for the following two scenarios by enabling App Failure Notifications in the settings:
  • Connectivity Exception
  • Authentication Exception
• Metrics are used to monitor resources and generate alerts when threshold values are breached.
• Redfish server does not support automatic monitoring pause/resume based on failure alerts.
• The Template Applied Time is displayed only if the collector profile (Classic or NextGen Gateway) is version 18.1.0 or higher.
• Redfish Event/Alert polling starts only if you enable Event/Alert Polling in the configuration.
• For some PowerSupply resources, the API may return the name as empty or null. In such cases, the name is provided as a combination of the string "PowerSupply" and its ID. Example: PowerSupply_0.
• If you are using an Edgeline EL8000 system, ensure the CLI Credentials checkbox is enabled and appropriate CLI credentials are provided.
• Power Control Metrics are available at the Chassis level.
• GPU discovery and monitoring are validated only on the HPE ProLiant DL380 Gen10 and NVIDIA DGX H100 models.
• The resource status is represented both as a custom attribute during discovery and as a metric during monitoring. The discovery attribute is updated less frequently, while the metric reflects near real-time status. Because of this difference in update frequency, discrepancies between the two values are expected.
• Event/Alert polling supports:
  • IML event logs for HPE ProLiant servers.
  • IPMI and BIOS logs for HPE Cray systems.
• IPMI and BIOS log collection has been validated only on the Cray XD670 model.
• By default, Redfish event severities are mapped to OpsRamp severity levels as part of the Alert Severity Mapping configuration.
• You can modify these severity mappings anytime from the integration’s configuration page. Supported OpsRamp severities include: Critical, Warning, Ok, and Info.

Version History

×