Skip to content

Commit 69fa878

Browse files
author
Eduardo Rivera
committed
added info about statuses for invalid groups
1 parent 4a7f65b commit 69fa878

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,15 @@ ms.custom: template-how-to, devx-track-azurecli
1414
> [!CAUTION]
1515
> Please note this process is used in emergency situations when all other troubleshooting options via Azure have been exhausted. SSH access to these bare metal machines is restricted to users managed via this method from the specified jump host list.
1616
17-
There are rare situations where a user needs to investigate & resolve issues with a bare metal machine and all other ways using Azure have been exhausted. Operator Nexus provides the `az networkcloud cluster bmckeyset` command so users can manage SSH access to the baseboard management controller (BMC) on these bare metal machines. On keyset creation, users are validated against Microsoft Entra ID for proper authorization by cross referencing the User Principal Name provided for a user against the supplied Azure Group ID `--azure-group-id <Azure AAD Group ID>`.
17+
There are rare situations where a user needs to investigate & resolve issues with a bare metal machine and all other ways using Azure have been exhausted. Operator Nexus provides the `az networkcloud cluster bmckeyset` command so users can manage SSH access to the baseboard management controller (BMC) on these bare metal machines. On keyset creation, users are validated against Microsoft Entra ID for proper authorization by cross referencing the User Principal Name provided for a user against the supplied Azure Group ID `--azure-group-id <Entra Group ID>`.
18+
19+
If an Azure Group ID is invalid on creation or update, each user supplied will have their Status set to `Invalid` and a corresponding Status Message of "AAD group doesn't exist."
20+
21+
> [!CAUTION]
22+
> In the scenario where an invalid Group ID is given, current implementation does not handle a list of users with a mixture of supplied and empty UPNs. In the scenario where UPNs are only supplied for some users, all users in the list will be marked `Invalid`. It is recommended to either specify UPNs for all users during keyset creation or update. However if Group ID validation needs to be ignored, do not supply an UPN for any user.
1823
1924
> [!NOTE]
20-
> Not supplying a UPN is currently supported during keyset creation and update. However in a future release enforcement of AAD validation is planned and if a UPN is not supplied for a user on keyset creation/update the user will marked invalid. A user marked invalid does not get deleted but, the user and the matching keyset will no longer be able to be used for SSH access. It is suggested that begin to follow steps to update or re-create keysets supplying UPN for users.
25+
> Not supplying a UPN is currently supported during keyset creation and update. In a future release, enforcement of AAD validation is planned. If an UPN is not supplied for a user on keyset creation/update, the user's Status will be set to `Invalid` and have a StatusMessage set to "Invalid because user does not have a UserPrincipalName specified in BareMetalMachineKeySet". A user marked invalid does not get deleted but, the user and the matching keyset will no longer be viable for SSH access. It is suggested to follow the steps to update or re-create keysets with UPN supplied for users.
2126
2227
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.
2328

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

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,15 @@ ms.custom: template-how-to, devx-track-azurecli
1414
> [!CAUTION]
1515
> Please note this process is used in emergency situations when all other troubleshooting options using Azure have been exhausted. SSH access to these bare metal machines is restricted to users managed via this method from the specified jump host list.
1616
17-
There are rare situations where a user needs to investigate & resolve issues with a bare metal machine 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 bare metal machines. On keyset creation, users are validated against Microsoft Entra ID for proper authorization by cross referencing the User Principal Name provided for a user against the supplied Azure Group ID `--azure-group-id <Azure AAD Group ID>`.
17+
There are rare situations where a user needs to investigate & resolve issues with a bare metal machine 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 bare metal machines. On keyset creation, users are validated against Microsoft Entra ID for proper authorization by cross referencing the User Principal Name provided for a user against the supplied Microsoft Entra ID `--azure-group-id <Entra Group ID>`.
18+
19+
If a Microsoft Entra Group ID is invalid on creation or update, each user supplied will have their Status set to `Invalid` and a corresponding Status Message of "AAD group doesn't exist."
20+
21+
> [!CAUTION]
22+
> In the scenario where an invalid Group ID is given, current implementation does not handle a list of users with a mixture of supplied and empty UPNs. In the scenario where UPNs are only supplied for some users, all users in the list will be marked `Invalid`. It is recommended to either specify UPNs for all users during keyset creation or update. However if Group ID validation needs to be ignored, do not supply an UPN for any user.
1823
1924
> [!NOTE]
20-
> Not supplying a UPN is currently supported during keyset creation and update. However in a future release enforcement of AAD validation is planned and if a UPN is not supplied for a user on keyset creation/update the user will marked invalid. A user marked invalid does not get deleted but, the user and the matching keyset will no longer be able to be used for SSH access. It is suggested that begin to follow steps to update or re-create keysets supplying UPN for users.
25+
> Not supplying a UPN is currently supported during keyset creation and update. In a future release, enforcement of AAD validation is planned. If an UPN is not supplied for a user on keyset creation/update, the user's Status will be set to `Invalid` and have a StatusMessage set to "Invalid because user does not have a UserPrincipalName specified". A user marked invalid does not get deleted but, the user and the matching keyset will no longer be viable for SSH access. It is suggested to follow the steps to update or re-create keysets with UPN supplied for users.
2126
2227
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.
2328

@@ -58,7 +63,7 @@ az networkcloud cluster baremetalmachinekeyset create \
5863
--extended-location name=<Extended Location ARM ID> \
5964
type="CustomLocation" \
6065
--location <Azure Region> \
61-
--azure-group-id <Azure AAD Group ID> \
66+
--azure-group-id <Azure Group ID> \
6267
--expiration <Expiration Timestamp> \
6368
--jump-hosts-allowed <List of jump server IP addresses> \
6469
--os-group-name <Name of the Operating System Group> \

0 commit comments

Comments
 (0)