|
| 1 | +--- |
| 2 | +title: How to append custom suffix to interface descriptions in Azure Operator Nexus Network Fabric |
| 3 | +description: Learn how to append and remove custom suffix from interface descriptions in Azure Operator Nexus Network Fabric for enhanced operational annotations. |
| 4 | +author: sushantjrao |
| 5 | +ms.author: sushrao |
| 6 | +ms.service: azure-operator-nexus |
| 7 | +ms.topic: how-to |
| 8 | +ms.date: 02/24/2025 |
| 9 | +ms.custom: template-how-to |
| 10 | +--- |
| 11 | + |
| 12 | +# Append custom suffix to interface descriptions in Azure Operator Nexus Network Fabric |
| 13 | + |
| 14 | +This guide explains how to append a user-defined suffix (`additionalDescription`) to interface descriptions in Azure Operator Nexus Network Fabric. This feature provides enhanced flexibility for operational annotations, allowing users to customize interface descriptions for specific maintenance or operational requirements. |
| 15 | + |
| 16 | +## Prerequisites |
| 17 | + |
| 18 | +- **Azure CLI**: Version 2.61 or higher |
| 19 | + |
| 20 | +## Steps to append a custom suffix |
| 21 | + |
| 22 | +### 1. Check the current interface description |
| 23 | + |
| 24 | +Before making changes, verify the existing interface description using the following command: |
| 25 | + |
| 26 | +```Azure CLI |
| 27 | +az networkfabric interface show -g "example-rg" \ |
| 28 | + --network-device-name "example-device" \ |
| 29 | + --resource-name "example-interface" --query description |
| 30 | +``` |
| 31 | + |
| 32 | +### Parameter Details |
| 33 | + |
| 34 | +| Parameter | Short Form | Description | |
| 35 | +|--------------------------------|-----------|-------------| |
| 36 | +| `az networkfabric interface show` | N/A | Displays details of a specified network fabric interface. | |
| 37 | +| `-g, --resource-group` | `-g` | Name of the resource group where the network device resides. | |
| 38 | +| `--network-device-name` | N/A | Name of the Network Fabric device. | |
| 39 | +| `--resource-name` | N/A | Name of the network interface resource. | |
| 40 | +| `--query` | N/A | Filters the output to show only the specified field (e.g., `description`). | |
| 41 | + |
| 42 | +### 2. Append a suffix to the interface description |
| 43 | + |
| 44 | +To add a custom suffix, use the following command: |
| 45 | + |
| 46 | +```Azure CLI |
| 47 | +az networkfabric interface update --additional-description "example-description" \ |
| 48 | + --device "example-device" \ |
| 49 | + -g "example-resource-group" \ |
| 50 | + --resource-name "example-interface" |
| 51 | +``` |
| 52 | + |
| 53 | +### Parameter Details |
| 54 | + |
| 55 | +| Parameter | Description | Constraints | |
| 56 | +|--------------------------|--------------------------------------------------|-------------| |
| 57 | +| `--additional-description` | Provides an additional description for the interface update. | Alphanumeric (`A-Z`, `a-z`, `0-9`), `-`, and `_` allowed. Max 64 characters. Can be an empty string with a space or null. | |
| 58 | +| `--device` | Specifies the name of the Network Fabric device. | No specific constraints. | |
| 59 | +| `-g, --resource-group` | Defines the name of the resource group where the device is located. | No specific constraints. | |
| 60 | +| `--resource-name` | Indicates the name of the network interface resource. | No specific constraints. | |
| 61 | + |
| 62 | +### 3. Commit the configuration |
| 63 | + |
| 64 | +After updating the description, apply the changes to the Fabric: |
| 65 | + |
| 66 | +```Azure CLI |
| 67 | +az networkfabric fabric commit-configuration --resource-group "example-rg" --resource-name "example-fabric" |
| 68 | +``` |
| 69 | +Parameter Details: |
| 70 | + |
| 71 | +| Parameter | Short Form | Description | |
| 72 | +|----------------------|-----------|-------------| |
| 73 | +| `--resource-group` | `-g` | Name of the resource group. | |
| 74 | +| `--resource-name` | N/A | Name of the Network Fabric. | |
| 75 | + |
| 76 | +### Example |
| 77 | + |
| 78 | +#### **Original interface description:** |
| 79 | + |
| 80 | +```Azure CLI |
| 81 | +AR-CE2(Fab3-AR-CE2):Et1/1 to CR1-TOR1(Fab3-CP1-TOR1)-Port23 |
| 82 | +``` |
| 83 | + |
| 84 | +#### **Updated Description:** |
| 85 | +```Azure CLI |
| 86 | +AR-CE2(Fab3-AR-CE2):Et1/1 to CR1-TOR1(Fab3-CP1-TOR1)-Port23-Additional_description-1234 |
| 87 | +``` |
| 88 | + |
| 89 | +## Removing the interface description |
| 90 | + |
| 91 | +To restore the default description, set `additionalDescription` to an empty string with a space (`" "`) or null: |
| 92 | + |
| 93 | +```Azure CLI |
| 94 | +az networkfabric interface update --additional-description "example-description" \ |
| 95 | + --device "example-device" \ |
| 96 | + -g "example-resource-group" \ |
| 97 | + --resource-name "example-interface" |
| 98 | +``` |
| 99 | + |
| 100 | +### Parameter Details |
| 101 | + |
| 102 | +| Parameter | Description | Constraints | |
| 103 | +|--------------------------|--------------------------------------------------|-------------| |
| 104 | +| `--additional-description` | Provides an additional description for the interface update. | Alphanumeric (`A-Z`, `a-z`, `0-9`), `-`, and `_` allowed. Max 64 characters. Can be an empty string with a space or null. | |
| 105 | +| `--device` | Specifies the name of the Network Fabric device. | No specific constraints. | |
| 106 | +| `-g, --resource-group` | Defines the name of the resource group where the device is located. | No specific constraints. | |
| 107 | +| `--resource-name` | Indicates the name of the network interface resource. | No specific constraints. | |
| 108 | + |
| 109 | +### 3. Commit the configuration |
| 110 | + |
| 111 | +After removing the suffix, apply the changes to the Fabric: |
| 112 | + |
| 113 | +```Azure CLI |
| 114 | +az networkfabric fabric commit-configuration --resource-group "example-rg" --resource-name "example-fabric" |
| 115 | +``` |
| 116 | + |
| 117 | +Parameter Details: |
| 118 | + |
| 119 | +| Parameter | Short Form | Description | |
| 120 | +|----------------------|-----------|-------------| |
| 121 | +| `--resource-group` | `-g` | Name of the resource group. | |
| 122 | +| `--resource-name` | N/A | Name of the Network Fabric. | |
| 123 | + |
| 124 | +Once committed, the interface description reverts to its original state: |
| 125 | + |
| 126 | +``` |
| 127 | +AR-CE2(Fab3-AR-CE2):Et1/1 to CR1-TOR1(Fab3-CP1-TOR1)-Port23 |
| 128 | +``` |
| 129 | + |
| 130 | +## Supported interface types |
| 131 | + |
| 132 | +This feature is available for the following interface types: |
| 133 | + |
| 134 | +- **Agg Rack CE** |
| 135 | +- **Agg Rack Management** |
| 136 | +- **Comp Rack TOR** |
| 137 | +- **Comp Rack Management** |
| 138 | +- **NPB Device** |
| 139 | + |
| 140 | +> [!Note] |
| 141 | +> **Existing deployments** will retain their **current descriptions** until Fabric instances are **migrated to Release 8.0**. After migration, users must update descriptions via the **API**. |
0 commit comments