Skip to content

Commit 2594f2b

Browse files
committed
Update howto-append-a-custom-suffix-to-interface-descriptions.md
1 parent 600616c commit 2594f2b

File tree

1 file changed

+56
-21
lines changed

1 file changed

+56
-21
lines changed

articles/operator-nexus/howto-append-a-custom-suffix-to-interface-descriptions.md

Lines changed: 56 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -24,40 +24,59 @@ This guide explains how to append a user-defined suffix (`additionalDescription`
2424
Before making changes, verify the existing interface description using the following command:
2525

2626
```Azure CLI
27-
az networkfabric interface show --device nffab5-8-0-gf-AggrRack-CE1 \
28-
-g Fab5NF-8-0-GF \
29-
--resource-name Ethernet22-1 --query description
27+
az networkfabric interface show -g "example-rg" \
28+
--network-device-name "example-device" \
29+
--resource-name "example-interface" --query description
3030
```
3131

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+
3242
### 2. Append a suffix to the interface description
3343

3444
To add a custom suffix, use the following command:
3545

3646
```Azure CLI
37-
az networkfabric interface update --additional-description "support-ticket1234-jkl" \
38-
--device nffab5-8-0-gf-AggrRack-CE1 \
39-
-g Fab5NF-8-0-GF \
40-
--resource-name Ethernet22-1
47+
az networkfabric interface update --additional-description "example-description" \
48+
--device "example-device" \
49+
-g "example-resource-group" \
50+
--resource-name "example-interface"
4151
```
4252

43-
#### Parameter Details:
53+
### Parameter Details
4454

45-
| Parameter | Description | Constraints |
46-
|----------------------------|--------------------------------------------------|-------------|
47-
| `--additional-description` | Additional description for the interface update. | Alphanumeric (A-Za-z0-9), `-` and `_` allowed. Max 64 characters. |
48-
| `--device` | Name of the network fabric device. | No specific constraints provided. |
49-
| `-g, --resource-group` | Name of the resource group where the device resides. | No specific constraints provided. |
50-
| `--resource-name` | Name of the network interface resource. | No specific constraints provided. |
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+
Let me know if you'd like any further refinements! 🚀
5163

5264

5365
### 3. Commit the configuration
5466

5567
After updating the description, apply the changes to the fabric:
5668

5769
```Azure CLI
58-
az networkfabric fabric commit-configuration --resource-name nffab5-8-0-gf -g Fab5NF-8-0-GF
70+
az networkfabric fabric commit-configuration --resource-group "example-rg" --resource-name "example-fabric"
5971
```
72+
Parameter Details:
73+
74+
| Parameter | Short Form | Description |
75+
|----------------------|-----------|-------------|
76+
| `--resource-group` | `-g` | Name of the resource group. |
77+
| `--resource-name` | N/A | Name of the Network Fabric. |
6078

79+
Let me know if you need any modifications or additional parameters! 🚀
6180
### Example
6281

6382
#### **Original interface description:**
@@ -68,28 +87,44 @@ AR-CE2(Fab3-AR-CE2):Et1/1 to CR1-TOR1(Fab3-CP1-TOR1)-Port23
6887

6988
#### **Updated Description:**
7089
```Azure CLI
71-
AR-CE2(Fab3-AR-CE2):Et1/1 to CR1-TOR1(Fab3-CP1-TOR1)-Port23-support-ticket1234-jkl
90+
AR-CE2(Fab3-AR-CE2):Et1/1 to CR1-TOR1(Fab3-CP1-TOR1)-Port23-Additional_description-1234
7291
```
7392

7493
## Removing the interface description
7594

7695
To restore the default description, set `additionalDescription` to an empty string with a space (`" "`) or null:
7796

7897
```Azure CLI
79-
az networkfabric interface update --additional-description " " \
80-
--device nffab5-8-0-gf-AggrRack-CE1 \
81-
-g Fab5NF-8-0-GF \
82-
--resource-name Ethernet22-1
98+
az networkfabric interface update --additional-description "example-description" \
99+
--device "example-device" \
100+
-g "example-resource-group" \
101+
--resource-name "example-interface"
83102
```
84103

104+
### Parameter Details
105+
106+
| Parameter | Description | Constraints |
107+
|--------------------------|--------------------------------------------------|-------------|
108+
| `--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. |
109+
| `--device` | Specifies the name of the Network Fabric device. | No specific constraints. |
110+
| `-g, --resource-group` | Defines the name of the resource group where the device is located. | No specific constraints. |
111+
| `--resource-name` | Indicates the name of the network interface resource. | No specific constraints. |
112+
85113
### 3. Commit the configuration
86114

87115
After removing the suffix, apply the changes to the fabric:
88116

89117
```Azure CLI
90-
az networkfabric fabric commit-configuration --resource-name nffab5-8-0-gf -g Fab5NF-8-0-GF
118+
az networkfabric fabric commit-configuration --resource-group "example-rg" --resource-name "example-fabric"
91119
```
92120

121+
Parameter Details:
122+
123+
| Parameter | Short Form | Description |
124+
|----------------------|-----------|-------------|
125+
| `--resource-group` | `-g` | Name of the resource group. |
126+
| `--resource-name` | N/A | Name of the Network Fabric. |
127+
93128
Once committed, the interface description reverts to its original state:
94129

95130
```

0 commit comments

Comments
 (0)