docs: added redfish user-guide - #771
Open
sudhir-intc wants to merge 3 commits into
Open
sudhir-intc wants to merge 3 commits into
sudhir-intc wants to merge 3 commits into
Conversation
sudhir-intc
marked this pull request as draft
March 3, 2026 14:43
sudhir-intc
requested review from
DevipriyaS17,
amarnath-ac,
graikhel-intel and
nmgaston
March 3, 2026 14:43
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Redfish tutorial to the documentation site and wires it into the MkDocs navigation so users can find a Redfish setup/config/test walkthrough for DMT Console.
Changes:
- Adds a new “Redfish User Guide” tutorial page under
Tutorials/Redfish/. - Updates
mkdocs.ymlnav to include a new “Redfish” section under Tutorials.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 11 comments.
| File | Description |
|---|---|
| mkdocs.yml | Adds the new Redfish tutorial page into the Tutorials navigation tree. |
| docs/Tutorials/Redfish/redfishUserGuide.md | New Redfish user guide covering prerequisites, testing via Redfishtool/curl, and troubleshooting. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
sudhir-intc
marked this pull request as ready for review
October 1, 2026 14:30
Validate every documented command against a live Console deployment and
fix what the responses contradicted.
Corrections:
- Replace invented error payloads with real ones. The guide cited the
Base.1.8 message registry; this build emits Base.1.22.0.
- Add the 409 (reset to current power state) and 500 (device unreachable)
error examples, and drop the 403/412/503 status rows that no endpoint
returns.
- Fix the redfishtool logout command, which aborted with "Invalid mix of
--Auth and --token options" without -A Session.
- Drop the claim that redfishtool rejects self-signed certificates and
the claim that it cannot create sessions; neither holds.
- Correct the prerequisite to redfishtool 1.1.5. The 1.1.8 it asked for
has never been released.
- Align the system-details example with the real response: add
MemorySummary, drop ProcessorSummary.Status, use the absolute wss://
ConsoleURI, and note the null inventory fields.
- Document that consent actions return 400 on ACM devices, and that
redirection tokens live five minutes.
- Limit ResetType to the four supported values (On, ForceOff,
ForceRestart, PowerCycle) and switch Use Case 4 off GracefulShutdown.
Usability:
- Drive every curl and redfishtool example from CONSOLE_HOST,
CONSOLE_PORT, ADMIN_USER, ADMIN_PASSWORD, and SYSTEM_ID, exported once
up front, using the ${VAR} form that bash and PowerShell share.
- Pipe JSON-returning commands to jq. XML, 204, and capture-into-variable
commands are left alone.
- Convert the remaining blockquote to an admonition.
Redact the lab IP addresses, credentials, and device GUIDs that the
examples had been carrying.
Verified with zensical build --strict.
sudhir-intc
changed the title
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Several PowerShell commands are nonfunctional, and multiple API response descriptions differ from the preview implementation.
Review effort: Balanced
Findings: 7
Open (7)
Comment on lines
+158
to
+162
| $env:CONSOLE_HOST = "localhost" | ||
| $env:CONSOLE_PORT = "8181" | ||
| $env:ADMIN_USER = "<admin-user-name>" | ||
| $env:ADMIN_PASSWORD = "<admin-password>" | ||
| $env:SYSTEM_ID = "<system-id>" |
|
|
||
| **Reference Successful Response:** | ||
|
|
||
| A power action is asynchronous, so the service replies with `202 Accepted`, a `Location` header pointing at the task, and a Task resource in the body: |
|
|
||
| ```json | ||
| { | ||
| "@odata.type": "#Task.v1_7_3.Task", |
|
|
||
| - ✓ Response contains Members array | ||
| - ✓ Members@odata.count shows number of active sessions | ||
| - ✓ Each session has @odata.id and UserName properties |
| ### Using Sessions (X-Auth-Token) | ||
|
|
||
| !!! note | ||
| `redfishtool` cannot use session tokens for most operations. Use `curl` with X-Auth-Token header for session-based requests. |
| # Create session and get response with headers (credentials go in the body, not -u) | ||
| $RESPONSE = curl.exe -sk -X POST ` | ||
| -H "Content-Type: application/json" ` | ||
| -d "{\"UserName\":\"${ADMIN_USER}\",\"Password\":\"${ADMIN_PASSWORD}\"}" ` |
Comment on lines
+1094
to
+1103
| { | ||
| "@Message.ExtendedInfo": [ | ||
| { | ||
| "MessageId": "Base.1.22.0.Success", | ||
| "Message": "Successfully Completed Request", | ||
| "Severity": "OK", | ||
| "Resolution": "None" | ||
| } | ||
| ] | ||
| } |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Checklist
What are you changing?
Added the redfish user guide under the tutorial section. The redfish tutorial demonstrates how to set up, configure, and test the DMT Console Redfish API implementation.
Anything the reviewer should know when reviewing this PR?