> For the complete documentation index, see [llms.txt](https://doc.engenius.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.engenius.ai/smartnic-redfish-user-guide/getting-started/about-this-guide.md).

# About This Guide

## Overview

Welcome to the EnGenius SmartNIC Redfish user guide. This task-oriented guide shows you how to manage and monitor the SmartNIC through the Redfish API using the onboard Management Interface (e.g., IPMI/BMC). You’ll access well-defined Redfish endpoints, run authenticated `curl` requests, and interpret JSON responses to operate the SmartNIC reliably across your data center **Node**, **Chassis**, and **Rack**.

### **Who this guide is for**

This guide is for system administrators, developers, and integration engineers who understand networking and server management but are new to Redfish-based interfaces. It focuses on practical API workflows with minimal hardware discussion. You’ll learn how to:

* Discover available Redfish resources and schemas.
* Send authenticated requests using tools such as `curl`.
* Retrieve and control power and thermal data, Firmware and BIOS settings, and network configuration.
* Perform management tasks such as Firmware updates and telemetry monitoring.

### **What you'll learn**

By following this guide, you’ll learn how to:

* Connect securely to the SmartNIC BMC (AST2600) through Redfish over HTTPS.
* Authenticate and run API commands to query system and sensor data.
* Monitor power, thermal, and network status, and perform firmware updates.
* Parse JSON responses and integrate the SmartNIC into data center automation workflows.

### How this guide is organized

To help you find the information you need quickly, this guide is divided into several parts:

#### :notebook\_with\_decorative\_cover: Part 1: Getting Started

Security prerequisites, first Redfish access, and service root.

* [About This Guide](https://doc.engenius.ai/smartnic-redfish-user-guide/getting-started/about-this-guide.md)
* [Before You Begin](https://doc.engenius.ai/smartnic-redfish-user-guide/getting-started/before-you-begin.md)

#### :notebook\_with\_decorative\_cover: Part 2: Redfish Core Services

Sessions, accounts and roles, certificates, schemas, and message registries.

* [Service Root & Account Service](https://doc.engenius.ai/smartnic-redfish-user-guide/redfish-core-services/service-root-and-account-service.md)
* [User Account Management](https://doc.engenius.ai/smartnic-redfish-user-guide/redfish-core-services/user-account-management.md)
* [User Roles and Privileges](https://doc.engenius.ai/smartnic-redfish-user-guide/redfish-core-services/user-roles-and-privileges.md)
* [Certificate Management](https://doc.engenius.ai/smartnic-redfish-user-guide/redfish-core-services/certificate-management.md)
* [Chassis and Assembly](https://doc.engenius.ai/smartnic-redfish-user-guide/redfish-core-services/chassis-and-assembly.md)
* [Power & Thermal Monitoring](https://doc.engenius.ai/smartnic-redfish-user-guide/redfish-core-services/power-and-thermal-monitoring.md)
* [JSON Schema Files](https://doc.engenius.ai/smartnic-redfish-user-guide/redfish-core-services/json-schema-files.md)
* [Manager and Management Overview](https://doc.engenius.ai/smartnic-redfish-user-guide/redfish-core-services/manager-and-management-overview.md)

#### :notebook\_with\_decorative\_cover: Part 3: System Configuration & Operations

Configure, monitor, and update your SmartNIC through Redfish. Topics include network setup, BIOS control, telemetry, and firmware updates—all designed for real data center workflows.

* [Manager & System Control](https://doc.engenius.ai/smartnic-redfish-user-guide/system-configuration-and-operations/manager-and-system-control.md)&#x20;
* [Network & Connectivity](https://doc.engenius.ai/smartnic-redfish-user-guide/system-configuration-and-operations/network-and-connectivity.md)&#x20;
* [Monitoring & Logging](https://doc.engenius.ai/smartnic-redfish-user-guide/system-configuration-and-operations/monitoring-and-logging.md)&#x20;
* [Storage & Media Management ](https://doc.engenius.ai/smartnic-redfish-user-guide/system-configuration-and-operations/storage-and-media-management.md)
* [Performance & Maintenance](https://doc.engenius.ai/smartnic-redfish-user-guide/system-configuration-and-operations/performance-and-maintenance.md)&#x20;
* [Security & Access Control](https://doc.engenius.ai/smartnic-redfish-user-guide/system-configuration-and-operations/security-and-access-control.md)&#x20;

#### :notebook\_with\_decorative\_cover: Part 4: Integration & Troubleshooting

Connect Redfish with automation tools, analyze logs, and resolve common API issues. This part helps you maintain stable SmartNIC operations and streamline management tasks.

* [Firmware Update Workflow Examples](https://doc.engenius.ai/smartnic-redfish-user-guide/integration-and-troubleshooting/firmware-update-workflow-examples.md)
* [Diagnostics & Post Codes Reference](https://doc.engenius.ai/smartnic-redfish-user-guide/integration-and-troubleshooting/diagnostics-and-post-codes-reference.md)
* [Common Redfish Error Codes and Fixes](https://doc.engenius.ai/smartnic-redfish-user-guide/integration-and-troubleshooting/common-redfish-error-codes-and-fixes.md)

#### :notebook\_with\_decorative\_cover: Part 5: Reference

Your complete Redfish command library. Quickly find endpoint paths, parameters, and JSON examples for precise API reference and troubleshooting.

* [Redfish Endpoint Summary](https://doc.engenius.ai/smartnic-redfish-user-guide/reference/redfish-endpoint-summary.md)
* [Command Syntax Reference](https://doc.engenius.ai/smartnic-redfish-user-guide/reference/command-syntax-reference.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://doc.engenius.ai/smartnic-redfish-user-guide/getting-started/about-this-guide.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
