Skip to content

Commit 7945efb

Browse files
authored
Update howto-baremetal-bmm-ssh.md
Updates doc with more descriptive(specific) labels to be used in the az cli parameters.
1 parent 2abfaa3 commit 7945efb

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

articles/operator-nexus/howto-baremetal-bmm-ssh.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ If the User Principal Name for a user isn't a member of the supplied group, the
2121
> [!NOTE]
2222
> There is currently a transitional period where specifying User Principal Names is optional. In a future release, it will become mandatory and Microsoft Entra ID validation will be enforced for all users. Users are encouraged to add User Principal Names to their keysets before the transitional period ends (planned for July 2024) to avoid keysets being invalidated. Note that if any User Principal Names are added to a keyset, even if they are not added for all users, Microsoft Entra ID validation will be enabled, and this will result in the entire keyset being invalidated if the Group ID specified is not valid.
2323
24-
When the command runs, it executes on each bare metal machine in the Cluster with an active Kubernetes node. There's a reconciliation process that runs periodically that retries the command on any bare metal machine that wasn't available at the time of the original command. Also, any bare metal machine that returns to the cluster via an `az networkcloud baremetalmachine actionreimage` or `az networkcloud baremetalmachine actionreplace` command (see [BareMetal functions](./howto-baremetal-functions.md)) sends a signal causing any active keysets to be sent to the machine as soon as it returns to the cluster. Multiple commands execute in the order received.
24+
When the command runs, it executes on each bare metal machine in the Cluster with an active Kubernetes node. There's a reconciliation process that runs periodically that retries the command on any bare metal machine that wasn't available at the time of the original command. Also, any bare metal machine that returns to the cluster via an `az networkcloud baremetalmachine reimage` or `az networkcloud baremetalmachine replace` command (see [BareMetal functions](./howto-baremetal-functions.md)) sends a signal causing any active keysets to be sent to the machine as soon as it returns to the cluster. Multiple commands execute in the order received.
2525

2626
There's no limit to the number of users in a group.
2727

@@ -56,21 +56,21 @@ The command syntax is:
5656

5757
```azurecli
5858
az networkcloud cluster baremetalmachinekeyset create \
59-
--name <bare metal machine Keyset Name> \
60-
--extended-location name=<Extended Location ARM ID> \
59+
--name "<bare metal machine Keyset Name>" \
60+
--extended-location name="<Extended Location ARM ID>" \
6161
type="CustomLocation" \
62-
--location <Azure Region> \
63-
--azure-group-id <Azure Group ID> \
64-
--expiration <Expiration Timestamp> \
65-
--jump-hosts-allowed <List of jump server IP addresses> \
66-
--os-group-name <Name of the Operating System Group> \
67-
--privilege-level <"Standard" or "Superuser"> \
62+
--location "<Azure Region>" \
63+
--azure-group-id "<Azure Group ID>" \
64+
--expiration "<Expiration Timestamp>" \
65+
--jump-hosts-allowed "<List of jump server IP addresses>" \
66+
--os-group-name "<Name of the Operating System Group>" \
67+
--privilege-level "<"Standard" or "Superuser">" \
6868
--user-list '[{"description":"<User List Description>","azureUserName":"<User Name>",\
6969
"sshPublicKey":{"keyData":"<SSH Public Key>"}, \
7070
"userPrincipalName":""}]', \
71-
--tags key1=<Key Value> key2=<Key Value> \
72-
--cluster-name <Cluster Name> \
73-
--resource-group <Resource Group>
71+
--tags key1="<Key Value>" key2="<Key Value>" \
72+
--cluster-name "<Cluster Name>" \
73+
--resource-group "<cluster_RG>"
7474
```
7575

7676
### Create Arguments
@@ -100,7 +100,7 @@ az networkcloud cluster baremetalmachinekeyset create \
100100
--privilege-level [Required] : The access level allowed for the users
101101
in this key set. Allowed values:
102102
"Standard" or "Superuser".
103-
--resource-group -g [Required] : Name of resource group. Optional if
103+
--resource-group -g [Required] : Name of cluster resource group. Optional if
104104
configuring the default group using `az
105105
configure --defaults group=<name>`.
106106
--user-list [Required] : The unique list of permitted users.
@@ -149,9 +149,9 @@ This example creates a new keyset with two users that have standard access from
149149
```azurecli
150150
az networkcloud cluster baremetalmachinekeyset create \
151151
--name "bareMetalMachineKeySetName" \
152-
--extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" \
152+
--extended-location name="/subscriptions/subscriptionId/resourceGroups/cluster_RG/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" \
153153
type="CustomLocation" \
154-
--location "location" \
154+
--location "eastus" \
155155
--azure-group-id "f110271b-XXXX-4163-9b99-214d91660f0e" \
156156
--expiration "2022-12-31T23:59:59.008Z" \
157157
--jump-hosts-allowed "192.0.2.1" "192.0.2.5" \
@@ -161,7 +161,7 @@ az networkcloud cluster baremetalmachinekeyset create \
161161
{"description":"Needs access for troubleshooting as a part of the support team","azureUserName":"userXYZ","sshPublicKey":{"keyData":"ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXTSTRnIDpcf5qytjs1XoyYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"}, "userPrincipalName":"[email protected]"}]' \
162162
--tags key1="myvalue1" key2="myvalue2" \
163163
--cluster-name "clusterName"
164-
--resource-group "resourceGroupName"
164+
--resource-group "cluster_RG"
165165
```
166166

167167
For assistance in creating the `--user-list` structure, see [Azure CLI Shorthand](https://github.com/Azure/azure-cli/blob/dev/doc/shorthand_syntax.md).
@@ -174,9 +174,9 @@ The command syntax is:
174174

175175
```azurecli
176176
az networkcloud cluster baremetalmachinekeyset delete \
177-
--name <bare metal machine Keyset Name> \
178-
--cluster-name <Cluster Name> \
179-
--resource-group <Resource Group Name>
177+
--name "<bare metal machine Keyset Name>" \
178+
--cluster-name "<Cluster Name>" \
179+
--resource-group "<cluster_RG>"
180180
```
181181

182182
### Delete Arguments
@@ -185,7 +185,7 @@ az networkcloud cluster baremetalmachinekeyset delete \
185185
--bare-metal-machine-key-set-name --name -n [Required] : The name of the bare metal machine key set to be
186186
deleted.
187187
--cluster-name [Required] : The name of the cluster.
188-
--resource-group -g [Required] : Name of resource group. Optional if configuring the
188+
--resource-group -g [Required] : Name of cluster resource group. Optional if configuring the
189189
default group using `az configure --defaults
190190
group=<name>`.
191191
--no-wait : Do not wait for the long-running operation to
@@ -199,7 +199,7 @@ This example removes the "bareMetalMachineKeysetName" keyset group in the "clust
199199
az networkcloud cluster baremetalmachinekeyset delete \
200200
--name "bareMetalMachineKeySetName" \
201201
--cluster-name "clusterName" \
202-
--resource-group "resourceGroupName"
202+
--resource-group "cluster_RG"
203203
```
204204

205205
## Updating a Bare Metal Machine Keyset
@@ -210,15 +210,15 @@ The command syntax is:
210210

211211
```azurecli
212212
az networkcloud cluster baremetalmachinekeyset update \
213-
--name <bare metal machine Keyset Name> \
214-
--jump-hosts-allowed <List of jump server IP addresses> \
215-
--privilege-level <"Standard" or "Superuser"> \
213+
--name "<bare metal machine Keyset Name>" \
214+
--jump-hosts-allowed "<List of jump server IP addresses>" \
215+
--privilege-level "<"Standard" or "Superuser">" \
216216
--user-list '[{"description":"<User List Description>","azureUserName":"<User Name>",\
217217
"sshPublicKey":{"keyData":"<SSH Public Key>"}, \
218218
"userPrincipalName":""}]', \
219-
--tags key1=<Key Value> key2=<Key Value> \
220-
--cluster-name <Cluster Name> \
221-
--resource-group <Resource Group>
219+
--tags key1="<Key Value>" key2="<Key Value> "\
220+
--cluster-name "<Cluster Name>" \
221+
--resource-group "<cluster_RG>"
222222
```
223223

224224
### Update Arguments
@@ -245,7 +245,7 @@ az networkcloud cluster baremetalmachinekeyset update \
245245
userPrincipalName: Optional. The User Principal Name of the User.
246246
247247
Multiple users can be specified by using more than one --user-list argument.
248-
--resource-group -g [Required] : Name of resource group. Optional if
248+
--resource-group -g [Required] : Name of cluster resource group. Optional if
249249
configuring the default group using `az
250250
configure --defaults group=<name>`.
251251
--tags : Space-separated tags: key[=value]
@@ -270,7 +270,7 @@ az networkcloud cluster baremetalmachinekeyset update \
270270
"sshPublicKey":{"keyData":"ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXTSTRnIDpcf5qytjs1XoyYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"}, \
271271
"userPrincipalName":"[email protected]"}]' \
272272
--cluster-name "clusterName" \
273-
--resource-group "resourceGroupName"
273+
--resource-group "cluster_RG"
274274
```
275275

276276
## Listing Bare Metal Machine Keysets
@@ -281,15 +281,15 @@ The command syntax is:
281281

282282
```azurecli
283283
az networkcloud cluster baremetalmachinekeyset list \
284-
--cluster-name <Cluster Name> \
285-
--resource-group <Resource Group>
284+
--cluster-name "<Cluster Name>" \
285+
--resource-group "<cluster_RG>"
286286
```
287287

288288
### List Arguments
289289

290290
```azurecli
291291
--cluster-name [Required] : The name of the cluster.
292-
--resource-group -g [Required] : Name of resource group. Optional if
292+
--resource-group -g [Required] : Name of cluster resource group. Optional if
293293
configuring the default group using `az
294294
configure --defaults group=<name>`.
295295
```
@@ -302,8 +302,8 @@ The command syntax is:
302302

303303
```azurecli
304304
az networkcloud cluster baremetalmachinekeyset show \
305-
--cluster-name <Cluster Name> \
306-
--resource-group <Resource Group>
305+
--cluster-name "<Cluster Name>" \
306+
--resource-group "<cluster_RG>"
307307
```
308308

309309
### Show Arguments
@@ -312,7 +312,7 @@ az networkcloud cluster baremetalmachinekeyset show \
312312
--bare-metal-machine-key-set-name --name -n [Required] : The name of the bare metal machine key
313313
set.
314314
--cluster-name [Required] : The name of the cluster.
315-
--resource-group -g [Required] : Name of resource group. You can
315+
--resource-group -g [Required] : Name of cluster resource group. You can
316316
configure the default group using `az
317317
configure --defaults group=<name>`.
318318
```

0 commit comments

Comments
 (0)