Redfish - Server | OpsRamp Documentation

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

OpsRamp Classic Gateway (Linux) version 14.0.0 and above.
Note: Integration is not supported in Windows gateway.
OpsRamp Nextgen Gateway version 14.0.0 and above.
Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.

Resource Hierarchy

HPE Servers

Supported Metrics

HPE Servers

NVIDIA

NVIDIA DGX H100

Dell

Dell IDRAC AX-650

Fujitsu

PRIMERGY RX2540 M5

Default Monitoring Configurations

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.

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)
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)
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

From All Clients, select a client.
Go to Setup > Account.
Select the Integrations and Apps tab.
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.
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.
Click ADD in the Redfish - Server application.
In the Configurations page, click + ADD. The Add Configuration page appears.
Enter the following BASIC INFORMATION:

Field Name	Description	Field Type
Name	Enter the name for the configuration.	String
IP Address/Host Name	Specify the IP address or hostname of the Redfish-enabled system (BMC endpoint).	String
Port	Enter the port number for Redfish API communication. Note: By default 443 is added.
Is Secure	Select this checkbox if you want the communication between your system and the specified endpoint to be secured using protocols such as HTTPS (HTTP over SSL/TLS). Default Selection: When selected, it signifies that the connection is encrypted, providing an added layer of security to the data being transmitted.	Checkbox
Credential	Select the stored credential to authenticate with the Redfish service. If you want to use the existing credentials, select them from the Select Credentials dropdown. Else, click +ADD to create credentials. The ADD CREDENTIAL window is displayed. Enter the following information. Name: Enter the credential name. Description: Enter the brief description of the credential. User Name: Enter the Username. Password: Enter the password. Confirm Password: Confirm your password Port:Select the port number from the dropdown. Connection Timeout (ms):Specify the connection timeout in milliseconds. Note Read-only Redfish API access. You must have privileges to access /redfish/v1/Systems, /Managers, and /Chassis endpoints.	Dropdown
CLI Credentials	Enable this option if CLI-based access (like SSH) is needed for extended data collection.	Checkbox
CLI Credential	Displayed when the CLI Credentials field is selected. Enable this option if CLI-based access (like SSH) is needed for extended data collection. Select the stored credential to authenticate with the Redfish service. If you want to use the existing credentials, select them from the Select Credentials dropdown. Else, click +ADD to create credentials. The ADD CREDENTIAL window is displayed. Enter the following information. Name: Enter the credential name. Description: Enter the brief description of the credential. User Name: Enter the Username. Password: Enter the password. Confirm Password: Confirm your password Port:Select the port number from the dropdown. Connection Timeout (ms):Specify the connection timeout in milliseconds.	Checkbox
App Failure Notifications	When selected, you will be notified in case of an application failure such as Connectivity Exception, Authentication Exception.	Checkbox
Alert Configuration	Enable alert configuration if Redfish event subscription and polling are required. NoteUser must have permission to subscribe to and retrieve Redfish event logs.	Checkbox
Alert On Root Resource	Appears when Alert Configuration checkbox is selected. Select this checkbox to generate event polling alerts on root resource.	Checkbox
Alert Severity Filters	Possible values of Alert Severity filter configuration property are ["Critical", "OK", "Warning"]	String
Alert Severity Map	Provides alert severity map configuration. Default values for Alert Severity Mapping configuration are ["Critical", "OK", "Warning"]	String

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

Field Name	Description	Field Type
Custom Attribute	Select the custom attribute from the dropdown. You can add attributes by clicking the Add icon (+).	Dropdown
Value	Select the value from the dropdown.	Dropdown

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).

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.
In the DISCOVERY SCHEDULE section, select recurrence pattern to add one of the following patterns:
- Minutes
- Hourly
- Daily
- Weekly
- Monthly
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.

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.
Click NEXT.
(Optional) Click +ADD to create a new collector by providing a name or use the pre-populated name.
Select an existing registered profile.
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:

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

Navigate to the Attributes tab to view the discovery details.

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:

Click here to view the Supported Input Keys

Resource Type	Supported Input Keys
All Types	resourceName
	hostName
	aliasName
	dnsName
	ipAddress
	macAddress
	os
	make
	model
	serialNumber
	Root Resource UUID
Manager	ManagerId
	ManagerType
	FirmwareVersion
	ManagerInterfaces
	Root Resource UUID
Manager Network Interface	InterfaceId
	PermanentMACAddress
	FQDN
	IPv6Addresses
	Description
	AutoNeg
	FullDuplex
	Root Resource UUID
Chassis	ChassisId
	ChassisType
	PartNumber
	AssetTag
	SKU
	EnvironmentalClass
	ChassisResourceSummary
	FirmwareVersion
	SystemProgrammableLogicDeviceVersion
	Description
	Root Resource UUID
Compute System	ComputeSystemId
	BiosVersion
	AssetTag
	SystemType
	PartNumber
	SKU
	SubModel
	OsType
	OsVersion
	PCAPartNumber
	PCASerialNumber
	ServerFQDN
	SystemResourceSummary
	ProcessorModel
	Description
	Root Resource UUID
System Ethernet Interface	EthernetInterfaceId
	IPv6Addresses
	EthernetInterfaceType
	UefiDevicePath
	FullDuplex
	SpeedMbps
	InterfaceEnabled
	Root Resource UUID
Processor	ProcessorId
	ProcessorType
	Socket
	PartNumber
	ProcessorArchitecture
	TotalCores
	TotalThreads
	MaxSpeedMHz
	RatedSpeedMHz
	AssetTag
	ExternalClockMHz
	Root Resource UUID
Drive	DriveId
	MediaType
	AssetTag
	ServiceLabel
	LocationType
	BlockSizeBytes
	DriveCapacity GB
	Revision
	Protocol
	WriteCacheEnabled
	Root Resource UUID
Volume	VolumeId
	DisplayName
	LogicalUnitNumber
	RAIDType
	VolumeCapacity GB
	BlockSizeBytes
	Encrypted
	Compressed
	Deduplicated
	WriteCachePolicy
	ReadCachePolicy
	Root Resource UUID
Memory	MemoryControllerId
	PartNumber
	MemoryType
	MemoryDeviceType
	VendorId
	DeviceLocator
	MemoryCapacity GB / CapacityMiB
	ErrorCorrection
	RankCount
	BusWidthBits
	OperatingSpeedMhz
	MemorySubsystemControllerManufacturerID
	MemorySubsystemControllerProductID
	ModuleManufacturerID
	ModuleProductID
	CacheSizeMiB
	DataWidthBits
	BaseModuleType
	VolatileSizeMiB
	Root Resource UUID
Device	DeviceId
	FirmwareVersion
	PartNumber
	Location
	ProductPartNumber
	ProductVersion
	Root Resource UUID
Network Adapter	NetworkAdapterId
	PartNumber
	LocationType
	ServiceLabel
	Root Resource UUID
Power Supply	Actual PowerControl Name
	FirmwareVersion
	PowerSupplyType
	SparePartNumber
	PowerCapacityWatts
	BayNumber
	MaxPowerOutputWatts
	Root Resource UUID
Fan	MemberId
	Location
	HotPluggable
	Redundant
	Root Resource UUID
Temperature Sensors	MemberId
	PhysicalContext
	SensorNumber
	UpperThresholdFatal
	UpperThresholdCritical
	Root Resource UUID
PCIe Device	Part Number
	FirmwareVersion
	Root Resource UUID
Assemblies	Part Number
	Producer
	Spare Part Number
	Root Resource UUID

Supported Alert Custom Macros

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

Click here to view the alert subject and description with macros

${resource.name}

${resource.ip}

${resource.mac}

${resource.aliasname}

${resource.os}

${resource.type}

${resource.dnsname}

${resource.alternateip}

${resource.make}

${resource.model}

${resource.serialnumber}

${resource.systemId}

${parent.resource.name}

${Custom attributes on the resource}

Risks, Limitations & Assumptions

The integration can manage critical/recovery failure alerts for the following two scenarios when the user activates App Failure Notifications in the settings:
- Connectivity Exception
- Authentication Exception
Using metrics for monitoring the resources and generating alerts when the threshold values are breached.
Redfish server cannot control monitoring pause/resume actions based on above alerts.
The Template Applied Time will only be displayed if the collector profile (Classic and NextGen Gateway) is version 18.1.0 or higher.
For few PowerSupply resources getting name as empty or null from the API response, So we are providing power supply name as a combination of string “PowerSupply” and Id.Eg : PowerSupply_0
For Edgeline EL8000 CLI Credentials check box should be enabled and the cli credentials need to be provided.
Power Control Metrics are given on Chassis.
GPU discovery & monitoring validated on ‘HPE Proliant DL380Gen10’ and NVIDIA DGX H100 models only.
The status of a resource is represented both as a custom attribute in discovery and as a metric. While the attribute provided during discovery is a static or less frequently updated, the metric reflects real-time updates based on the monitoring frequency. Due to the differences in the update intervals between discovery and monitoring, there is a potential for discrepancies between the attribute value and the metric value. These mismatches are expected and arise from the inherent variation in the frequency and timing of updates between the two mechanisms.

Version History


Application Version	Bug fixes / Enhancements
9.0.0	Added Root Resource UUID as custom attribute for child resources. Added support for Root Resource and Parent Resource Details for all the child resource.
8.0.1	Fixed Native Type “Fan” discovery in ProLiant Models.
8.0.0	Support added for Chassis, System, and Manager Level Event Log Monitoring for Cray XD-670 Servers. Added support for Root Resource and Parent Resource Details for all the child resource. To support Event Log Monitoring added some new metrics.
7.0.0	Included Activity Log, Debug Handler and Get Latest Metrics Support. Included ResourceState as a custom attribute for each nativetype. Updated Drive NativeType URL for iLO 6 models.
6.0.1	Support added for Dell PowerEdge MX7000 (Chassis Model) and Fujitsu PRIMERGY RX2540 M5.
6.0.0	Support added for HPE Cray XD 670 Model and IPMI Logs support.
5.0.0	Supported new nativetypes Firmware and Software.
4.0.1	Support Added for Dell IDRAC AX-650 model.
4.0.0	Added support for new model NVIDIA DGX H100 in Redfish Application. Added support for new native type 'GPU'.

Click here to view the earlier version updates


Application Version	Bug fixes / Enhancements
3.0.0	Added support for IML Event Logs for Proliant Models and added support for Power Metrics on chassis.
2.0.1	For Redfish Server App we are observing frequent Resource Not Found Exceptions. For this provided fix with retry logic.
2.0.0	Added support for new model HPE Edgeline EL8000 in Redfish Application.
1.0.1	Modified moid's to avoid resource reconciliation for different models.
1.0.0	Initial version with discovery, monitoring, alerts.