docs: Document nico-admin-cli boot-interface commands#3606
Open
kfelternv wants to merge 1 commit into
Open
Conversation
Add the boot-interface command family (show, candidates, set) introduced in NVIDIA#3341 to the boot/DPU guide's admin-cli reference table, and point to it from the troubleshooting section. boot-interface set is the same SetPrimaryInterface operation as managed-host set-primary-interface; show and candidates are read-only views over the GetMachineBootInterfaces RPC that surface the predicted/managed/explored/retained stores the guide already documents. Source PR reviewed: NVIDIA#3341
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
Contributor
WalkthroughThe documentation adds two read-only admin CLI commands for inspecting boot-interface state and candidates, and updates troubleshooting guidance to use them for comparing stores and identifying discrepancies. ChangesBoot interface inspection
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
kfelternv
marked this pull request as ready for review
July 16, 2026 17:22
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3606.docs.buildwithfern.com/infra-controller |
🔍 Container Scan SummaryNo Grype artifacts were found to aggregate. |
This was referenced Jul 16, 2026
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.
What this PR does
Adds the
nico-admin-cli boot-interfacecommand family todocs/provisioning/boot-interfaces-and-dpu-modes.md:show,candidates, andsetwith their actual Core RPCs and argument shapes.showandcandidatesviews.The commands landed in #3341 but were missing from this hand-maintained guide. This change complements #3270, which documents the older hidden
machine boot-interfacesalias and the broader data model, and #3410, which adds the generated command-reference pages.Also checked for docs impact: #3509 (the renamed field is not referenced), #3294 (the guide does not claim OS image fields are mutable), #3237 (the REST-first guidance is confined to error text), and the recent metrics/refactor PRs (documented in their owning changes).
How we verified it
Revision:
9fca9570bceefa5ab47240388c50aa1193b805f2on macOS 26.5.1 with Rust 1.96.0, Fern CLI 5.57.0, and rumdl 0.2.34.cargo build -p nico-admin-clipassed.boot-interface show --help,boot-interface candidates --help, andboot-interface set --helpoutput matched every command name, positional argument,--rebootoption, read-only claim, and RPC mapping in the guide.cargo test -p nico-admin-cli boot_interfacepassed all 17 focused tests.uvx rumdl check --config docs/.rumdl.toml docs/provisioning/boot-interfaces-and-dpu-modes.mdreported only the two pre-existing MD029 findings at lines 267-268, outside this diff.npx -y fern-api@5.57.0 docs md checkvalidated all 116 MDX files.npx -y fern-api@5.57.0 checkreported 0 errors and the expected unauthenticated missing-redirects warning.fern docs devpreview returned HTTP 200 for the Boot Interfaces and DPU Modes page. The rendered HTML contained all three new command rows and a working Section 4 anchor.git diff --check f5887367067413d95b2ef8197f0dae658638f762...HEADpassed.How to reproduce the verification
Prerequisites: Rust from the repository's pinned toolchain, Node.js 20 or newer,
uvx, andrg.Expected results: the build and 17 focused tests pass; each help page exposes the command and arguments documented in the guide; Fern reports 0 errors; rumdl reports only the two existing MD029 findings outside the diff; and the diff check is silent.
Start the local preview in one terminal:
Then verify the rendered page in another terminal:
Expected result: HTTP 200 and all four assertions succeed.