docs: add RPC health checker documentation by DevipriyaS17 · Pull Request #880 · device-management-toolkit/docs

DevipriyaS17 · 2026-09-22T08:34:25Z

What are you changing?

This PR adds a new RPC guide that explains how to use rpc status/health to assess Intel® AMT device readiness before activation and manageability after activation. The document includes Linux and Windows command examples, ACM and CCM readiness options, optional management endpoint reachability checks, AMT password behavior for WSMAN-dependent checks, health check result categories, JSON output structure, and troubleshooting guidance.

amarnath-ac · 2026-09-22T16:05:13Z

+=== "Windows"
+    ```cmd
+    rpc.exe status
+    rpc.exe health


Suggestion: add an example output or list out all the checks, with this user will know what all details will be displayed.

added the output screenshot

sudhir-intc · 2026-09-24T11:29:22Z

Can you place health checker under v3(Beta) as this is available only for v3

moved the file under v3

sudhir-intc · 2026-09-24T11:29:48Z

    - Remote Provisioning Client:
      - Overview: Reference/RPC/overview.md
      - Build RPC-Go Manually: Reference/RPC/buildRPC_Manual.md
+      - RPC Health Checker: Reference/RPC/healthChecker.md


Please this under V3(Beta)

sudhir-intc · 2026-09-24T11:31:39Z

 For more information,
 see [Wireless Activation](../../../Tutorials/createWiFiConfig.md).

+### status


Please move this under v3(Beta) its not part of v2

sudhir-intc · 2026-09-24T11:32:54Z

@@ -0,0 +1,216 @@
+# RPC Health and Readiness Checker


Suggested change

# RPC Health and Readiness Checker

# RPC Health Checker

We call every where as RPC Health Checker, we could keep it the same

updated accordingly

sudhir-intc · 2026-09-24T11:33:45Z

@@ -0,0 +1,216 @@
+# RPC Health and Readiness Checker
+
+Use the RPC Health and Readiness Checker to assess an Intel® AMT device before or after activation. The report identifies configured prerequisites, outstanding requirements, and conditions that may prevent AMT management operations from working as expected.


Suggested change

Use the RPC Health and Readiness Checker to assess an Intel® AMT device before or after activation. The report identifies configured prerequisites, outstanding requirements, and conditions that may prevent AMT management operations from working as expected.

Use the RPC Health Checker to assess the readiness of an Intel® AMT device before or after activation. The report identifies configured prerequisites, outstanding requirements, and conditions that may prevent AMT management operations from working as expected.

sudhir-intc · 2026-09-24T11:35:55Z

+
+## Post-activation checks and the AMT password
+
+The checker does not prompt for an AMT password. For an activated device, provide `--password` when you want RPC to run the additional WSMAN checks that require the password:


could you provide the list of WSMAN checks that would be done.

updated with the list

sudhir-intc · 2026-09-24T11:38:45Z

+
+Each item in `checks` contains a check name, status, and optional message. Status values are `pass`, `warn`, `fail`, `skip`, or `unavailable`.
+
+Example:


can you provide the same earlier three examples in text format in json over here.

updated with examples in json format

sudhir-intc · 2026-09-24T11:44:52Z

instead of images it might be better to place the command output as it also helps to modify information easily

sudhir-intc · 2026-09-24T11:44:57Z

instead of images it might be better to place the command output as it also helps to modify information easily

sudhir-intc · 2026-09-24T11:45:01Z

instead of images it might be better to place the command output as it also helps to modify information easily

sudhir-intc · 2026-09-24T12:14:39Z

@DevipriyaS17 : As there were too many modifications with the text, I created an proposal in this branch rpc_health_impr , diff can be seen here : https://github.com/device-management-toolkit/docs/compare/rpc_health..rpc_health_impr
Please see if that looks good, you can take in the content.

Copilot

Copilot review overview

🟡 Changes recommended

Resolve credential-handling guidance and align the documented JSON examples and schema descriptions.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 · 3

Open (4)

Literal password exposes the secret in Bash history · New
sudo drops AMT_PASSWORD unless environment preservation is configured · New
Unquoted cmd.exe password assignment mishandles metacharacters · New
JSON example counts and checks do not match the text example · New

What changed in this PR

Adds v3 RPC health-checker documentation covering readiness checks, credentials, endpoint reachability, output formats, and troubleshooting.

Changes:

Adds the health-checker guide with Linux and Windows examples.
Documents ACM/CCM checks, password handling, result categories, and JSON output.
Adds navigation and overview links.

File	Summary
`mkdocs.yml`	Adds the health-checker page to v3 navigation.
`docs/Reference/RPC/v3/healthChecker.md`	Adds comprehensive health-checker documentation and examples.
`docs/Reference/RPC/overview.md`	Links to the new guide.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Copilot

Copilot review overview

🟡 Changes recommended

The documented commands are unavailable in the shipped v3 CLI, and credential-handling and result-status issues remain unresolved.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 · 3 · 1

Open (5)

Document the released CLI command instead of unavailable status · New
Prevent AMT password exposure through sudo and env arguments · New
Clear AMT_PASSWORD after the Windows command · New
Distinguish not-applicable checks from incomplete checks · New
Identify the network-link check as CCM, not ACM · New

Resolved since last review (4)

Literal password exposes the secret in Bash history
JSON example counts and checks do not match the text example
Unquoted cmd.exe password assignment mishandles metacharacters
sudo drops AMT_PASSWORD unless environment preservation is configured

Copilot

Copilot review overview

🟡 Changes recommended

Unresolved command-reference inconsistencies and credential-exposure issues remain in the documentation.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1

Open (1)

Windows example exposes the AMT password on the command line · New

Resolved since last review (5)

Document the released CLI command instead of unavailable status
Distinguish not-applicable checks from incomplete checks
Clear AMT_PASSWORD after the Windows command
Prevent AMT password exposure through sudo and env arguments
Identify the network-link check as CCM, not ACM

+    set "AMT_PASSWORD=<AMT-password>"
+    rpc.exe status
+    set "AMT_PASSWORD="


sinchubhat · 2026-09-28T03:02:08Z

+
+## Run the health checker
+
+=== "Linux"


Do we need both linux/windows commands everywhere, generic rpc status is sufficient. If there is difference we can add as a note. ex: On Linux, use sudo. On Windows, open an Administrator Command Prompt. as note is sufficient.

DevipriyaS17 mentioned this pull request Sep 22, 2026

Document RPC Health Checker Usage and Troubleshooting device-management-toolkit/rpc-go#1489

Open

amarnath-ac reviewed Sep 22, 2026

View reviewed changes

DevipriyaS17 force-pushed the rpc_health branch from 808b1c0 to 66c8335 Compare September 24, 2026 09:21

DevipriyaS17 requested a review from amarnath-ac September 24, 2026 09:22

sudhir-intc reviewed Sep 24, 2026

View reviewed changes

DevipriyaS17 added 2 commits September 25, 2026 14:12

docs: add RPC health checker documentation

148d95e

docs: address review comment

b022440

DevipriyaS17 force-pushed the rpc_health branch 2 times, most recently from ae85aac to ad8682e Compare September 25, 2026 16:48

DevipriyaS17 requested a lite review from Copilot September 25, 2026 16:49

Copilot started reviewing on behalf of DevipriyaS17 September 25, 2026 16:49 View session

Copilot AI reviewed Sep 25, 2026

View reviewed changes

Comment thread docs/Reference/RPC/v3/healthChecker.md Outdated

Comment thread docs/Reference/RPC/v3/healthChecker.md Outdated

Comment thread docs/Reference/RPC/v3/healthChecker.md Outdated

Comment thread docs/Reference/RPC/v3/healthChecker.md Outdated

DevipriyaS17 force-pushed the rpc_health branch from ad8682e to ee3f757 Compare September 25, 2026 16:58

DevipriyaS17 requested a lite review from Copilot September 25, 2026 16:59

Copilot started reviewing on behalf of DevipriyaS17 September 25, 2026 16:59 View session

Copilot AI reviewed Sep 25, 2026

View reviewed changes

Comment thread docs/Reference/RPC/v3/healthChecker.md

Comment thread docs/Reference/RPC/v3/healthChecker.md Outdated

Comment thread docs/Reference/RPC/v3/healthChecker.md

Comment thread docs/Reference/RPC/v3/healthChecker.md Outdated

Comment thread docs/Reference/RPC/v3/healthChecker.md Outdated

DevipriyaS17 force-pushed the rpc_health branch from ee3f757 to 645be5f Compare September 25, 2026 17:14

DevipriyaS17 requested a lite review from Copilot September 25, 2026 17:15

Copilot started reviewing on behalf of DevipriyaS17 September 25, 2026 17:15 View session

docs: address review comments

645be5f

Copilot AI reviewed Sep 25, 2026

View reviewed changes

Comment thread docs/Reference/RPC/v3/healthChecker.md

Comment on lines +131 to +133

set "AMT_PASSWORD=<AMT-password>"

rpc.exe status

set "AMT_PASSWORD="

DevipriyaS17 marked this pull request as ready for review September 25, 2026 17:58

DevipriyaS17 requested review from madhavilosetty-intel and rsdmike September 25, 2026 17:58

sinchubhat reviewed Sep 28, 2026

View reviewed changes

		@@ -0,0 +1,216 @@
		# RPC Health and Readiness Checker

		Use the RPC Health and Readiness Checker to assess an Intel® AMT device before or after activation. The report identifies configured prerequisites, outstanding requirements, and conditions that may prevent AMT management operations from working as expected.

	Use the RPC Health and Readiness Checker to assess an Intel® AMT device before or after activation. The report identifies configured prerequisites, outstanding requirements, and conditions that may prevent AMT management operations from working as expected.
	Use the RPC Health Checker to assess the readiness of an Intel® AMT device before or after activation. The report identifies configured prerequisites, outstanding requirements, and conditions that may prevent AMT management operations from working as expected.


		## Post-activation checks and the AMT password

		The checker does not prompt for an AMT password. For an activated device, provide `--password` when you want RPC to run the additional WSMAN checks that require the password:


		Each item in `checks` contains a check name, status, and optional message. Status values are `pass`, `warn`, `fail`, `skip`, or `unavailable`.

		Example:

Conversation

DevipriyaS17 commented Sep 22, 2026

What are you changing?

Uh oh!

amarnath-ac Sep 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sudhir-intc Sep 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sudhir-intc commented Sep 24, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

amarnath-ac Sep 22, 2026 •

edited

Loading

sudhir-intc Sep 24, 2026 •

edited

Loading