You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/operator-nexus/howto-baremetal-bmc-ssh.md
+12-11Lines changed: 12 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,15 +16,16 @@ Please note this process is used in emergency situations when all other troubles
16
16
17
17
There are rare situations where a user needs to investigate & resolve issues with a BMM and all other ways have been exhausted via Azure. Operator Nexus provides the `az networkcloud cluster bmckeyset` command so users can manage SSH access to the baseboard management controller (BMC) on these BMMs.
18
18
19
-
When the command runs, it executes on each of BMM in the Cluster. If a BMM is unavailable or powered off at the time of command execution, the status of the command will reflect which BMMs couldn't have the command executed. There's a reconciliation process that runs periodically that will retry the command on any BMM that wasn't available at the time of the original command. Multiple commands execute in the order received.
19
+
When the command runs, it executes on each of BMM in the Cluster. If a BMM is unavailable or powered off at the time of command execution, the status of the command reflects which BMMs couldn't have the command executed. There's a reconciliation process that runs periodically that retries the command on any BMM that wasn't available at the time of the original command. Multiple commands execute in the order received.
20
20
21
-
There's a maximum number of 12 users defined per Cluster. Attempts to add more than 12 users will result in an error. Delete a user before adding another one when 12 already exists.
21
+
There's a maximum number of 12 users defined per Cluster. Attempts to add more than 12 users results in an error. Delete a user before adding another one when 12 already exists.
- The on-premise Cluster must have connectivity to Azure.
27
+
- The on-premises Cluster must have connectivity to Azure.
28
+
- Get the Resource group name that you created for `Cluster` resource
28
29
- The process applies keysets to all running BMMs.
29
30
- The users added must be part of an Azure Active Directory (Azure AD) group. For more information, see [How to Manage Groups](../active-directory/fundamentals/how-to-manage-groups.md).
30
31
- To restrict access for managing keysets, create a custom role. For more information, see [Azure Custom Roles](../role-based-access-control/custom-roles.md). In this instance, add or exclude permissions for `Microsoft.NetworkCloud/clusters/bmcKeySets`. The options are `/read`, `/write` and `/delete`.
@@ -58,18 +59,18 @@ az networkcloud cluster bmckeyset create \
58
59
--azure-group-id [Required] : The object ID of Azure Active Directory
59
60
group that all users in the list must
60
61
be in for access to be granted. Users
61
-
that are not in the group will not have
62
+
that are not in the group do not have
62
63
access.
63
64
--bmc-key-set-name --name -n [Required] : The name of the BMC key set.
64
65
--cluster-name [Required] : The name of the cluster.
65
66
--expiration [Required] : The date and time after which the users
66
-
in this key set will be removed from
67
+
in this key set are removed from
67
68
the BMCs. The limit is up to 1 year from creation.
68
69
Format is "YYYY-MM-DDTHH:MM:SS.000Z"
69
70
--extended-location [Required] : The extended location of the cluster
70
71
associated with the resource.
71
72
Usage: --extended-location name=XX type=XX
72
-
name: Required. The resource ID of the extended location on which the resource will be created.
73
+
name: Required. The resource ID of the extended location on which the resource is created.
73
74
type: Required. The extended location type: "CustomLocation".
74
75
--privilege-level [Required] : The access level allowed for the users
75
76
in this key set. Allowed values:
@@ -115,7 +116,7 @@ az networkcloud cluster bmckeyset create \
115
116
for full debug logs.
116
117
```
117
118
118
-
This example will create a new keyset with two users that have standard access from two jump hosts.
119
+
This example creates a new keyset with two users that have standard access from two jump hosts.
119
120
120
121
```azurecli
121
122
az networkcloud cluster bmckeyset create \
@@ -162,7 +163,7 @@ az networkcloud cluster bmckeyset delete \
162
163
--yes -y : Do not prompt for confirmation.
163
164
```
164
165
165
-
This example will remove the "bmcKeysetName" keyset group in the "clusterName" Cluster.
166
+
This example removes the "bmcKeysetName" keyset group in the "clusterName" Cluster.
166
167
167
168
```azurecli
168
169
az networkcloud cluster bmckeyset delete \
@@ -196,12 +197,12 @@ az networkcloud cluster bmckeyset update \
196
197
--bmc-key-set-name --name -n [Required] : The name of the BMC key set.
197
198
--cluster-name [Required] : The name of the cluster.
198
199
--expiration : The date and time after which the users
199
-
in this key set will be removed from
200
+
in this key set are removed from
200
201
the BMCs. Format is:
201
202
"YYYY-MM-DDTHH:MM:SS.000Z"
202
203
--jump-hosts-allowed : The list of IP addresses of jump hosts
203
204
with management network access from
204
-
which a login will be allowed for the
205
+
which a login is allowed for the
205
206
users. Supports IPv4 or IPv6 addresses.
206
207
--privilege-level : The access level allowed for the users
207
208
in this key set. Allowed values:
@@ -223,7 +224,7 @@ az networkcloud cluster bmckeyset update \
223
224
operation to finish.
224
225
```
225
226
226
-
This example will add two new users to the "bmcKeySetName" group and will change the expiry time for the group.
227
+
This example adds two new users to the "bmcKeySetName" group and changes the expiry time for the group.
Copy file name to clipboardExpand all lines: articles/operator-nexus/howto-baremetal-bmm-ssh.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Please note this process is used in emergency situations when all other troubles
16
16
17
17
There are rare situations where a user needs to investigate & resolve issues with a BMM and all other ways have been exhausted via Azure. Azure Operator Nexus provides the `az networkcloud cluster baremetalmachinekeyset` command so users can manage SSH access to these BMM.
18
18
19
-
When the command runs, it executes on each BMM in the Cluster. If a BMM is unavailable or powered off at the time of command execution, the status of the command will reflect which BMMs couldn't have the command executed. There is a reconciliation process that runs periodically that will retry the command on any BMM that wasn't available at the time of the original command. Multiple commands execute in the order received.
19
+
When the command runs, it executes on each BMM in the Cluster. If a BMM is unavailable or powered off at the time of command execution, the status of the command reflects which BMMs couldn't have the command executed. There is a reconciliation process that runs periodically that retries the command on any BMM that wasn't available at the time of the original command. Multiple commands execute in the order received.
20
20
21
21
There's no limit to the number of users in a group.
22
22
@@ -25,13 +25,14 @@ Notes for jump host IP addresses
25
25
26
26
- The keyset create/update process adds the jump host IP addresses to the IP tables for the Cluster. The process adds these addresses to IP tables and restricts SSH access to only those IPs.
27
27
- It's important to specify the Cluster facing IP addresses for the jump hosts. These IP addresses may be different than the public facing IP address used to access the jump host.
28
-
- Once added, users will be able to access BMMs from any specified jump host IP including a jump host IP defined in another BMM keyset group.
28
+
- Once added, users are able to access BMMs from any specified jump host IP including a jump host IP defined in another BMM keyset group.
29
29
- Existing SSH access remains when adding first BMM keyset. However, the keyset command limits an existing user's SSH access to the specified jump host IPs in the keyset commands.
- The on-premises Cluster must have connectivity to Azure.
35
36
- Get the Resource group name that you created for `Cluster` resource
36
37
- The process applies keysets to all running BMMs.
37
38
- The added users must be part of an Azure Active Directory (Azure AD) group. For more information, see [How to Manage Groups](../active-directory/fundamentals/how-to-manage-groups.md).
@@ -68,23 +69,23 @@ az networkcloud cluster baremetalmachinekeyset create \
68
69
--azure-group-id [Required] : The object ID of Azure Active Directory
69
70
group that all users in the list must
70
71
be in for access to be granted. Users
71
-
that are not in the group will not have
72
+
that are not in the group do not have
72
73
access.
73
74
--bare-metal-machine-key-set-name --name -n [Required] : The name of the bare metal machine key
74
75
set.
75
76
--cluster-name [Required] : The name of the cluster.
76
77
--expiration [Required] : The date and time after which the users
77
-
in this key set will be removed from
78
+
in this key set are removed from
78
79
the bare metal machines. Format is:
79
80
"YYYY-MM-DDTHH:MM:SS.000Z"
80
81
--extended-location [Required] : The extended location of the cluster
81
82
associated with the resource.
82
83
Usage: --extended-location name=XX type=XX
83
-
name: Required. The resource ID of the extended location on which the resource will be created.
84
+
name: Required. The resource ID of the extended location on which the resource is created.
84
85
type: Required. The extended location type: "CustomLocation".
85
86
--jump-hosts-allowed [Required] : The list of IP addresses of jump hosts
86
87
with management network access from
87
-
which a login will be allowed for the
88
+
which a login is be allowed for the
88
89
users. Supports IPv4 or IPv6 addresses.
89
90
--privilege-level [Required] : The access level allowed for the users
90
91
in this key set. Allowed values:
@@ -99,9 +100,8 @@ az networkcloud cluster baremetalmachinekeyset create \
99
100
key-data: Required. The public ssh key of the user.
100
101
101
102
Multiple users can be specified by using more than one --user-list argument.
102
-
--os-group-name : The name of the group that users will
103
-
be assigned to on the operating system
104
-
of the machines.
103
+
--os-group-name : The name of the group that users are assigned
104
+
to on the operating system of the machines.
105
105
--tags : Space-separated tags: key[=value]
106
106
[key[=value] ...]. Use '' to clear
107
107
existing tags.
@@ -133,7 +133,7 @@ az networkcloud cluster baremetalmachinekeyset create \
133
133
for full debug logs.
134
134
```
135
135
136
-
This example will create a new keyset with two users that have standard access from two jump hosts.
136
+
This example creates a new keyset with two users that have standard access from two jump hosts.
137
137
138
138
```azurecli
139
139
az networkcloud cluster baremetalmachinekeyset create \
@@ -157,7 +157,7 @@ For assistance in creating the `--user-list` structure, see [Azure CLI Shorthand
157
157
158
158
## Deleting a bare metal machine keyset
159
159
160
-
The `baremetalmachinekeyset delete` command removes SSH access to the BMM for a group of users. All members of the group will no longer have SSH access to any of the BMM in the Cluster.
160
+
The `baremetalmachinekeyset delete` command removes SSH access to the BMM for a group of users. All members of the group no longer have SSH access to any of the BMM in the Cluster.
161
161
162
162
The command syntax is:
163
163
@@ -182,7 +182,7 @@ az networkcloud cluster baremetalmachinekeyset delete \
182
182
--yes -y : Do not prompt for confirmation.
183
183
```
184
184
185
-
This example will remove the "bareMetalMachineKeysetName" keyset group in the "clusterName" Cluster.
185
+
This example removes the "bareMetalMachineKeysetName" keyset group in the "clusterName" Cluster.
186
186
187
187
```azurecli
188
188
az networkcloud cluster baremetalmachinekeyset delete \
@@ -215,12 +215,12 @@ az networkcloud cluster baremetalmachinekeyset update \
215
215
--bare-metal-machine-key-set-name --name -n [Required] : The name of the BMM key set.
216
216
--cluster-name [Required] : The name of the cluster.
217
217
--expiration : The date and time after which the users
218
-
in this key set will be removed from
218
+
in this key set are removed from
219
219
the BMMs. Format is:
220
220
"YYYY-MM-DDTHH:MM:SS.000Z"
221
221
--jump-hosts-allowed : The list of IP addresses of jump hosts
222
222
with management network access from
223
-
which a login will be allowed for the
223
+
which a login is allowed for the
224
224
users. Supports IPv4 or IPv6 addresses.
225
225
--privilege-level : The access level allowed for the users
226
226
in this key set. Allowed values:
@@ -242,7 +242,7 @@ az networkcloud cluster baremetalmachinekeyset update \
242
242
operation to finish.
243
243
```
244
244
245
-
This example will add two new users to the "baremetalMachineKeySetName" group and will change the expiry time for the group.
245
+
This example adds two new users to the "baremetalMachineKeySetName" group and changes the expiry time for the group.
246
246
247
247
```azurecli
248
248
az networkcloud cluster baremetalmachinekeyset update \
0 commit comments