Skip to content

Commit 0c9bab4

Browse files
First commit of Neighbor Group config article.
1 parent 3e011ad commit 0c9bab4

File tree

1 file changed

+116
-0
lines changed

1 file changed

+116
-0
lines changed
Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
title: Azure Operator Nexus neighbor group configuration
3+
description: Configuration details and examples for Azure Operator Nexus neighbor groups.
4+
author: joemarshallmsft
5+
ms.author: joemarshall
6+
ms.service: azure-operator-nexus
7+
ms.topic: reference
8+
ms.date: 02/19/2024
9+
ms.custom: template-reference
10+
---
11+
12+
# Neighbor Group Configuration Overview
13+
14+
A neighbor group allows you to group endpoints (either IPv4 or IPv6) under a single logical resource. A neighbor group can be used to send load-balanced filtered traffic across different probe endpoints. You can use the same Neighbor group across different Network TAPs & Network Tap rules.
15+
16+
## Parameters for a Neighbor Group
17+
18+
| Parameter | Description | Example | Required |
19+
|--|--|--|--|
20+
| resource-group | The resource group that contains the neighbor group. | ResourceGroupName | True |
21+
| resource-name | The name of the neighbor group. | example-Neighbor | True |
22+
| location | The Azure region that contains the neighbor group. | eastus | True |
23+
| destination | List of Ipv4 or Ipv6 destinations to forward traffic. | 10.10.10.10 | True |
24+
25+
## Creating a Neighbor Group
26+
27+
The following command creates a neighbor group:
28+
29+
```azurecli
30+
az networkfabric neighborgroup create \
31+
--resource-group "example-rg" \
32+
--location "westus3" \
33+
--resource-name "example-neighborgroup" \
34+
--destination "{ipv4Addresses:['10.10.10.10']}"
35+
```
36+
37+
Expected output:
38+
39+
```
40+
{
41+
"properties": {
42+
"networkTapIds": [
43+
],
44+
"networkTapRuleIds": [
45+
],
46+
"destination": {
47+
"ipv4Addresses": [
48+
"10.10.10.10",
49+
]
50+
},
51+
"provisioningState": "Succeeded",
52+
"annotation": "annotation"
53+
},
54+
"tags": {
55+
"keyID": "KeyValue"
56+
},
57+
"location": "eastus",
58+
"id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup",
59+
"name": "example-neighborGroup",
60+
"type": "microsoft.managednetworkfabric/neighborGroups",
61+
"systemData": {
62+
"createdBy": "[email protected]",
63+
"createdByType": "User",
64+
"createdAt": "2023-05-23T05:49:59.193Z",
65+
"lastModifiedBy": "[email protected]",
66+
"lastModifiedByType": "User",
67+
"lastModifiedAt": "2023-05-23T05:49:59.194Z"
68+
}
69+
}
70+
```
71+
72+
73+
## Show a Neighbor Group
74+
75+
This command displays an IP extended community resource:
76+
77+
```azcli
78+
az networkfabric neighborgroup show \
79+
--resource-group "example-rg" \
80+
--resource-name "example-neighborgroup"
81+
```
82+
83+
Expected output:
84+
85+
```
86+
{
87+
"properties": {
88+
"networkTapIds": [
89+
],
90+
"networkTapRuleIds": [
91+
],
92+
"destination": {
93+
"ipv4Addresses": [
94+
"10.10.10.10",
95+
]
96+
},
97+
"provisioningState": "Succeeded",
98+
"annotation": "annotation"
99+
},
100+
"tags": {
101+
"keyID": "KeyValue"
102+
},
103+
"location": "eastus",
104+
"id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup",
105+
"name": "example-neighborGroup",
106+
"type": "microsoft.managednetworkfabric/neighborGroups",
107+
"systemData": {
108+
"createdBy": "[email protected]",
109+
"createdByType": "User",
110+
"createdAt": "2023-05-23T05:49:59.193Z",
111+
"lastModifiedBy": "[email protected]",
112+
"lastModifiedByType": "User",
113+
"lastModifiedAt": "2023-05-23T05:49:59.194Z"
114+
}
115+
}
116+
```

0 commit comments

Comments
 (0)