Skip to content

Commit a22050b

Browse files
authored
Update how-to-validate-cables.md
Acrolinx recommendations.
1 parent 9cec667 commit a22050b

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

articles/operator-nexus/how-to-validate-cables.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.date: 04/15/2024
1111
---
1212
# Validate Cables for Nexus Network Fabric
1313

14-
This article explains the Fabric cable validation, where the primary function of the diagnostic API is to check all fabric devices for potential cabling issues. The Diagnostic API assesses whether the interconnected devices adhere to the Bill of Materials (BOM), classifying them as compliant or noncompliant. The results are presented in a JSON format, encompassing details such as validation status, errors, identifier type, and neighbor device ID. These results are stored in a customer-provided Storage account. It's vital to the overall deployment that errors identified in this report are resolved before moving onto the Cluster deployment step.
14+
This article explains the Fabric cable validation, where the primary function of the diagnostic API is to check all fabric devices for potential cabling issues. The Diagnostic API assesses whether the interconnected devices adhere to the Bill of Materials (BOM) and according to the resource Stock Keeping Unit (SKU), classifying them as compliant or noncompliant. DEvice types include Customer Edge (CE), Top of Rack (TOR), Management (MGMT) and Network Packet Broker (NPB) devices. The results are presented in a JSON format, encompassing details such as validation status, errors, identifier type, and neighbor device ID. These results are stored in a customer-provided Storage account. It's vital to the overall deployment that errors identified in this report are resolved before moving onto the Cluster deployment step.
1515

1616
For BOM details, refer to [Azure Operator Nexus SKUs](./reference-operator-nexus-skus.md)
1717

@@ -29,12 +29,12 @@ For BOM details, refer to [Azure Operator Nexus SKUs](./reference-operator-nexus
2929
3030
## Generate the storage URL
3131

32-
Refer to [Create a container](../storage/blobs/blob-containers-portal.md#create-a-container) to create a container.
32+
To create a container in the storage account, refer to [Create a container](../storage/blobs/blob-containers-portal.md#create-a-container)
3333

3434
> [!NOTE]
3535
> Enter the name of the container using only lowercase letters.
3636
37-
Refer to [Generate a shared access signature](../storage/blobs/blob-containers-portal.md#generate-a-shared-access-signature) to create the SAS URL of the container. Provide Write permission for SAS.
37+
To generate a SAS URL for the container to provide write access to the Nexus fabric, refer to [Generate a shared access signature](../storage/blobs/blob-containers-portal.md#generate-a-shared-access-signature)
3838

3939
> [!NOTE]
4040
> SAS URLs are short lived. By default, it is set to expire in eight hours. If the SAS URL expires, then you must open a Microsoft support ticket to add a new URL.
@@ -53,7 +53,7 @@ Refer to [Generate a shared access signature](../storage/blobs/blob-containers-p
5353
cli.azure.cli.core.sdk.policies: 'Azure-AsyncOperation': '<Azure-AsyncOperation-endpoint url>'
5454
```
5555
56-
If the following error is returned, this typically indicates the Fabric has not been patched with a valid SAS URL:
56+
If the following error is returned, this indicates the Fabric isn't patched with a valid SAS URL:
5757
```azurecli
5858
azure.core.exceptions.HttpResponseError: Operation returned an invalid status 'OK'
5959
```
@@ -195,35 +195,35 @@ networkFabricInfoSkuId": "M8-A400-A100-C16-ab",
195195
|---------|---------|
196196
|Compliant | When the status is compliant with the BOM specification |
197197
|NonCompliant | When the status isn't compliant with the BOM specification |
198-
|Unknown | When the tool is unable to retrieve interface connection details or lldp data. This can occur when destintation device is powered off, missing or disconnected cables or if validation is not supported for this interface type. |
198+
|Unknown | When the tool is unable to retrieve interface connection details or lldp data such as when the destintation device is powered off, missing, disconnected, or if validation isn't supported for this interface type. |
199199

200200
#### Validation attributes
201201

202202
|Attribute |Definition |
203203
|---------|---------|
204-
|`deviceConfiguration` | Configuration that's available on the device. |
205-
|`error` | Error from the device |
204+
|`deviceConfiguration` | Configuration that's available on the device. |
205+
|`error` | Error from the device. |
206206
|`reason` | This field is populated when the status of the device is unknown. |
207-
|`validationType` | This parameter indicates what type of validation. (cable & cable specification validations) |
208-
|`deviceDestinationResourceId` | Azure Resource Manager ID of the connected Neighbor (destination device) |
209-
|`roleName` | The role of the Network Fabric Device (CE or TOR) |
207+
|`validationType` | This parameter indicates what type of validation. (cable & cable specification validations). |
208+
|`deviceDestinationResourceId` | Azure Resource Manager ID of the connected Neighbor (destination device). |
209+
|`roleName` | The role of the Network Fabric Device (CE or TOR). |
210210

211211
## Known issues and limitations in cable validation
212212

213-
- Cable Validation of connections between TORs and Compute Servers that are powered off or unprovisioned in the Nexus cluster are not supported. These interfaces will show `Unknown` status in the report.
214-
- Cable Validation of connections between MGMT interfaces and Compute Servers that are powered off or unprovisioned in the Nexus cluster or the Compute Server Controllers are not supported. These interfaces will show `Unknown` status in the report.
215-
- Cable Validation for NPB isn't supported for `loopback` and `nni-direct` interfaces because there is no vendor support currently for `show lldp neighbors`. These interfaces will show `Unknown` status in the report.
213+
- Cable Validation of connections between TORs and Compute Servers that are powered off or unprovisioned in the Nexus cluster aren't supported. These interfaces show `Unknown` status in the report.
214+
- Cable Validation of connections between MGMT interfaces and Compute Servers that are powered off or unprovisioned in the Nexus cluster or the Compute Server Controllers aren't supported. These interfaces show `Unknown` status in the report.
215+
- Cable Validation for NPB isn't supported for `loopback` and `nni-direct` interfaces because there's no vendor support currently for `show lldp neighbors`. These interfaces show `Unknown` status in the report.
216216
- The Storage URL must be in a different region from the Network Fabric. For instance, if the Fabric is hosted in East US, the storage URL should be outside of East US.
217217
- Cable validation supports both four rack wih 16 Computes per rack and eight rack wih 16 Computes per rack BOMs.
218-
- When destintation device is powered off, cables are missing or disconnected, or if validation is not supported for the interface type, then the inteface will show `Unknown` status. **It is important to evaluate all `Unknown` interfaces that are `Not-Connected` against the BOM to determine if repair action is required.**
218+
- When destintation device is powered off, cables are missing or disconnected, or if validation isn't supported for the interface type, then the inteface shows `Unknown` status. **It is important to evaluate all `Unknown` interfaces that are `Not-Connected` against the BOM to determine if repair action is required.**
219219

220220
## Typical cable validation `NonCompliant` and `Unknown` Issues
221221

222222
|validationType |Status |Error |Resolution |
223223
|---------------|-------|-------|------------|
224224
| CableValidation |`NonCompliant`|`Device cable connection is incorrect.` | Verify connections on the source and destination interfaces match the BOM. The `deviceConfiguration` can help identify the destination port date returned on the interface. |
225225
| CableValidation |`Unknown` |`Unable to fetch data from the device.` | Verify connections on the source and destination interfaces are connected and match the BOM |
226-
| CableValidation |`NonCompliant`|`Device cabling in <INTERFACE> incorrect.` | The interface is not connected. Verify connections on the source and destination interfaces are connected match the BOM. |
226+
| CableValidation |`NonCompliant`|`Device cabling in <INTERFACE> incorrect.` | The interface isn't connected. Verify connections on the source and destination interfaces are connected match the BOM. |
227227
| CableValidation |`Unknown` |`Port <INTERFACE> has no connections as per device response.` | Verify connections on the source and destination interfaces are connected and match the BOM. |
228228
| CableSpecificationValidation |`Unknown` |`Unable to fetch Interface Status for <INTERFACE>.` | Verify connections on the source and destination interfaces are connected and match the BOM. |
229229
| CableSpecificationValidation |`NonCompliant` |`Device cable connection is incorrect` | Verify interface card and cables match BOM specification in this interface. |

0 commit comments

Comments
 (0)