Skip to content

Commit 801ddc1

Browse files
committed
Update concepts-network-fabric-read-only-commands.md
1 parent bf4f6cf commit 801ddc1

File tree

1 file changed

+40
-5
lines changed

1 file changed

+40
-5
lines changed

articles/operator-nexus/concepts-network-fabric-read-only-commands.md

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@ Azure Operator Nexus supports execution of read-only show commands on fabric dev
7070

7171
You can use the az networkfabric device run-ro command to issue supported show commands. Below is a sample command demonstrating how to query a device for its version details:
7272

73+
**Scenario 1:** Response under 4000 characters (Correct JSON formatting)
74+
7375
```Azure CLI
7476
az networkfabric device run-ro \
7577
--resource-group "resource-group-name" \
@@ -85,19 +87,52 @@ Expected Output
8587
```json
8688
{
8789
"configurationState": "Succeeded",
88-
"deviceConfigurationPreview": "{\n \"architecture\": \"x86_64\",\n \"bootupTimestamp\": 1745356755.0055325,\n \"configMacAddress\": \"00:00:00:00:00:00\",\n \"hardwareRevision\": \"\",\n \"hwMacAddress\": \"00:00:00:00:00:00\",\n \"imageFormatVersion\": \"1.0\",\n \"imageOptimization\": \"None\",\n \"internalBuildId\": \"b502bfe1-xxxx-xxxx-xxxx-8b78b1fd6e29\",\n \"internalVersion\": \"4.32.2FX-NX-xxxxxxxxx.xxxxxxxxx\",\n \"isIntlVersion\": false,\n \"kernelVersion\": \"5.15.176.3-3.cm2\",\n \"memFree\": 109383608,\n \"memTotal\": 131643632,\n \"mfgName\": \"\",\n \"modelName\": \"cEOSLab\",\n \"serialNumber\": \"538C4BE142B0B5D2727B8F412EE68B1B\",\n \"systemMacAddress\": \"28:b3:de:ad:ce:e6\",\n \"uptime\": 85639.49509215355,\n \"version\": \"4.32.2FX-NX-xxxxxxxxx.xxxxxxxxx (engineering build)\"\n}",
89-
"outputUrl": "https://<your-storage-account>.blob.core.windows.net/<your-container>"
90+
"deviceConfigurationPreview": {
91+
"architecture": "x86_64",
92+
"bootupTimestamp": 1742470725.3758163,
93+
"configMacAddress": "00:00:00:00:00:00",
94+
"hardwareRevision": "12.05",
95+
"hwMacAddress": "c4:ca:xx:xx:xx:35",
96+
"imageFormatVersion": "3.0",
97+
"imageOptimization": "Default",
98+
"internalBuildId": "2b2210fa-xxxx-xxxx-xxxx-f120aa00xxxx",
99+
"internalVersion": "4.xx.1F-39879738.xxxxx",
100+
"isIntlVersion": false,
101+
"memFree": 3760128,
102+
"memTotal": 8099732,
103+
"mfgName": "vendor",
104+
"modelName": "xxx-xxxxx-xx-x",
105+
"serialNumber": "JPA2303P3FH",
106+
"systemMacAddress": "c4:ca:xx:xx:xx:35",
107+
"uptime": 3648004.37,
108+
"version": "4.xx.1F"
109+
},
110+
"outputUrl": "https://<blob-url>/show_version.json"
111+
}
112+
```
113+
> [Note]
114+
> This output is well-formatted JSON because the total content is within the 4000-character boundary.
115+
116+
Scenario 2: Response exceeds 4000 characters (Incorrect formatting)
117+
118+
Truncated output
119+
```json
120+
{
121+
"configurationState": "Succeeded",
122+
"deviceConfigurationPreview": "{\n \"lldpNeighbors\": {\n \"Ethernet1/1\": {\n \"lldpNeighborInfo\": [\n {\n \"chassisId\": \"c4ca.2b62.19b5\",\n \"chassisIdType\": \"macAddress\",\n \"lastChangeTime\": 1742470988.8675177,\n ...
123+
}\n ]\n },\n ...
124+
}",
125+
"outputUrl": "https://<blob-url>/lldp_neighbors_detail.json"
90126
}
91127
```
92128

93-
deviceConfigurationPreview: Returns the parsed result of the show command.
129+
>[Note]
130+
> The field deviceConfigurationPreview is not a JSON object, but rather a string containing escaped JSON. This happens because the actual output is larger than 4000 characters. In such cases, the formatting is lost in the CLI output.
94131
95-
outputUrl: Contains a link to the raw output stored in your designated storage account.
96132

97133
> [!Note]
98134
> The output structure may vary depending on the specific show command issued.<br>
99135
> Ensure the storage account URL (provided during setup) is accessible for the platform to write the output securely.<br>
100-
> Output is delivered in a secure, JSON format suitable for logging and automation systems.<br>
101136
102137
## Command restrictions
103138

0 commit comments

Comments
 (0)