Merge pull request #274687 from tonyyam23/main

Update AON How-To-Guides and Troubleshooting Documentation

Author: Stacyrch140

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

@@ -21,7 +21,7 @@ If the User Principal Name for a user isn't a member of the supplied group, the
 > [!NOTE]
 > 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.
 
-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.
+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.
 
 There's no limit to the number of users in a group.
 
@@ -56,21 +56,21 @@ The command syntax is:
 
 ```azurecli
 az networkcloud cluster baremetalmachinekeyset create \
-  --name <bare metal machine Keyset Name> \
-  --extended-location name=<Extended Location ARM ID> \
+  --name "<bare metal machine Keyset Name>" \
+  --extended-location name="<Extended Location ARM ID>" \
     type="CustomLocation" \
-  --location <Azure Region> \
-  --azure-group-id <Azure Group ID> \
-  --expiration <Expiration Timestamp> \
-  --jump-hosts-allowed <List of jump server IP addresses> \
-  --os-group-name <Name of the Operating System Group> \
-  --privilege-level <"Standard" or "Superuser"> \
+  --location "<Azure Region>" \
+  --azure-group-id "<Azure Group ID>" \
+  --expiration "<Expiration Timestamp>" \
+  --jump-hosts-allowed "<List of jump server IP addresses>" \
+  --os-group-name "<Name of the Operating System Group>" \
+  --privilege-level "<"Standard" or "Superuser">" \
   --user-list '[{"description":"<User List Description>","azureUserName":"<User Name>",\
     "sshPublicKey":{"keyData":"<SSH Public Key>"}, \
     "userPrincipalName":""}]', \
-  --tags key1=<Key Value> key2=<Key Value> \
-  --cluster-name <Cluster Name> \
-  --resource-group <Resource Group>
+  --tags key1="<Key Value>" key2="<Key Value>" \
+  --cluster-name "<Cluster Name>" \
+  --resource-group "<cluster_RG>"
 ```
 
 ### Create Arguments
@@ -100,7 +100,7 @@ az networkcloud cluster baremetalmachinekeyset create \
   --privilege-level                           [Required] : The access level allowed for the users
                                                            in this key set.  Allowed values:
                                                            "Standard" or "Superuser".
-  --resource-group -g                         [Required] : Name of resource group. Optional if
+  --resource-group -g                         [Required] : Name of cluster resource group. Optional if
                                                            configuring the default group using `az
                                                            configure --defaults group=<name>`.
   --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
 ```azurecli
 az networkcloud cluster baremetalmachinekeyset create \
   --name "bareMetalMachineKeySetName" \
-  --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" \
+  --extended-location name="/subscriptions/subscriptionId/resourceGroups/cluster_RG/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" \
     type="CustomLocation" \
-  --location "location" \
+  --location "eastus" \
   --azure-group-id "f110271b-XXXX-4163-9b99-214d91660f0e" \
   --expiration "2022-12-31T23:59:59.008Z" \
   --jump-hosts-allowed "192.0.2.1" "192.0.2.5" \
@@ -161,7 +161,7 @@ az networkcloud cluster baremetalmachinekeyset create \
   {"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]"}]' \
   --tags key1="myvalue1" key2="myvalue2" \
   --cluster-name "clusterName"
-  --resource-group "resourceGroupName"
+  --resource-group "cluster_RG"
 ```
 
 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:
 
 ```azurecli
 az networkcloud cluster baremetalmachinekeyset delete \
-  --name <bare metal machine Keyset Name> \
-  --cluster-name <Cluster Name> \
-  --resource-group <Resource Group Name>
+  --name "<bare metal machine Keyset Name>" \
+  --cluster-name "<Cluster Name>" \
+  --resource-group "<cluster_RG>"
 ```
 
 ### Delete Arguments
@@ -185,7 +185,7 @@ az networkcloud cluster baremetalmachinekeyset delete \
     --bare-metal-machine-key-set-name --name -n [Required] : The name of the bare metal machine key set to be
                                                              deleted.
     --cluster-name                              [Required] : The name of the cluster.
-    --resource-group -g                         [Required] : Name of resource group. Optional if configuring the
+    --resource-group -g                         [Required] : Name of cluster resource group. Optional if configuring the
                                                              default group using `az configure --defaults
                                                              group=<name>`.
     --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
 az networkcloud cluster baremetalmachinekeyset delete \
   --name "bareMetalMachineKeySetName" \
   --cluster-name "clusterName" \
-  --resource-group "resourceGroupName"
+  --resource-group "cluster_RG"
 ```
 
 ## Updating a Bare Metal Machine Keyset
@@ -210,15 +210,15 @@ The command syntax is:
 
 ```azurecli
 az networkcloud cluster baremetalmachinekeyset update \
-  --name <bare metal machine Keyset Name> \
-  --jump-hosts-allowed <List of jump server IP addresses> \
-  --privilege-level <"Standard" or "Superuser"> \
+  --name "<bare metal machine Keyset Name>" \
+  --jump-hosts-allowed "<List of jump server IP addresses>" \
+  --privilege-level "<"Standard" or "Superuser">" \
   --user-list '[{"description":"<User List Description>","azureUserName":"<User Name>",\
    "sshPublicKey":{"keyData":"<SSH Public Key>"}, \
    "userPrincipalName":""}]', \
-  --tags key1=<Key Value> key2=<Key Value> \
-  --cluster-name <Cluster Name> \
-  --resource-group <Resource Group>
+  --tags key1="<Key Value>" key2="<Key Value> "\
+  --cluster-name "<Cluster Name>" \
+  --resource-group "<cluster_RG>"
 ```
 
 ### Update Arguments
@@ -245,7 +245,7 @@ az networkcloud cluster baremetalmachinekeyset update \
       userPrincipalName: Optional. The User Principal Name of the User.
 
       Multiple users can be specified by using more than one --user-list argument.
-  --resource-group -g                         [Required] : Name of resource group. Optional if
+  --resource-group -g                         [Required] : Name of cluster resource group. Optional if
                                                            configuring the default group using `az
                                                            configure --defaults group=<name>`.
   --tags                                                 : Space-separated tags: key[=value]
@@ -270,7 +270,7 @@ az networkcloud cluster baremetalmachinekeyset update \
     "sshPublicKey":{"keyData":"ssh-rsa  AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXTSTRnIDpcf5qytjs1XoyYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"}, \
     "userPrincipalName":"[email protected]"}]' \
    --cluster-name "clusterName" \
-  --resource-group "resourceGroupName"
+  --resource-group "cluster_RG"
 ```
 
 ## Listing Bare Metal Machine Keysets
@@ -281,15 +281,15 @@ The command syntax is:
 
 ```azurecli
 az networkcloud cluster baremetalmachinekeyset list \
-  --cluster-name <Cluster Name> \
-  --resource-group <Resource Group>
+  --cluster-name "<Cluster Name>" \
+  --resource-group "<cluster_RG>"
 ```
 
 ### List Arguments
 
 ```azurecli
   --cluster-name                              [Required] : The name of the cluster.
-  --resource-group -g                         [Required] : Name of resource group. Optional if
+  --resource-group -g                         [Required] : Name of cluster resource group. Optional if
                                                            configuring the default group using `az
                                                            configure --defaults group=<name>`.
 ```
@@ -302,8 +302,8 @@ The command syntax is:
 
 ```azurecli
 az networkcloud cluster baremetalmachinekeyset show \
-  --cluster-name <Cluster Name> \
-  --resource-group <Resource Group>
+  --cluster-name "<Cluster Name>" \
+  --resource-group "<cluster_RG>"
 ```
 
 ### Show Arguments
@@ -312,7 +312,7 @@ az networkcloud cluster baremetalmachinekeyset show \
   --bare-metal-machine-key-set-name --name -n [Required] : The name of the bare metal machine key
                                                            set.
   --cluster-name                              [Required] : The name of the cluster.
-  --resource-group -g                         [Required] : Name of resource group. You can
+  --resource-group -g                         [Required] : Name of cluster resource group. You can
                                                            configure the default group using `az
                                                            configure --defaults group=<name>`.
 ```

articles/operator-nexus/howto-baremetal-functions.md

@@ -36,7 +36,7 @@ This article describes how to perform lifecycle management operations on bare me
 
 1. Install the latest version of the
    [appropriate CLI extensions](./howto-install-cli-extensions.md).
-1. Get the name of the resource group for the BMM.
+1. Get the name of the resource group for the BMM - Cluster managed resource group name (cluster_MRG) .
 1. Get the name of the bare metal machine that requires a lifecycle management operation.
 1. Ensure that the target bare metal machine `poweredState` set to `On` and `readyState` set to `True`.
    1. This prerequisite isn't applicable for the `start` command.
@@ -48,7 +48,7 @@ This command will `power-off` the specified `bareMetalMachineName`.
 ```azurecli
 az networkcloud baremetalmachine power-off \
   --name "bareMetalMachineName"  \
-  --resource-group "resourceGroupName"
+  --resource-group "cluster_MRG"
 ```
 
 ## Start the BMM
@@ -58,7 +58,7 @@ This command will `start` the specified `bareMetalMachineName`.
 ```azurecli
 az networkcloud baremetalmachine start \
   --name "bareMetalMachineName" \
-  --resource-group "resourceGroupName"
+  --resource-group "cluster_MRG"
 ```
 
 ## Restart the BMM
@@ -68,7 +68,7 @@ This command will `restart` the specified `bareMetalMachineName`.
 ```azurecli
 az networkcloud baremetalmachine restart \
   --name "bareMetalMachineName" \
-  --resource-group "resourceGroupName"
+  --resource-group "cluster_MRG"
 ```
 
 ## Make a BMM unschedulable (cordon)
@@ -85,7 +85,7 @@ parameter, the workloads that are running on the BMM are `stopped` and the BMM i
 az networkcloud baremetalmachine cordon \
   --evacuate "True" \
   --name "bareMetalMachineName" \
-  --resource-group "resourceGroupName"
+  --resource-group "cluster_MRG"
 ```
 
 The `evacuate "True"` removes workloads from that node while `evacuate "False"` only prevents the scheduling of new workloads.
@@ -98,7 +98,7 @@ state on the BMM are `restarted` when the BMM is `uncordoned`.
 ```azurecli
 az networkcloud baremetalmachine uncordon \
   --name "bareMetalMachineName" \
-  --resource-group "resourceGroupName"
+  --resource-group "cluster_MRG"
 ```
 
 ## Reimage a BMM
@@ -115,7 +115,7 @@ command, with `evacuate "True"`, before executing the `reimage` command.
 ```azurecli
 az networkcloud baremetalmachine reimage \
   –-name "bareMetalMachineName"  \
-  --resource-group "resourceGroupName"
+  --resource-group "cluster_MRG"
 ```
 
 ## Replace BMM
@@ -130,10 +130,10 @@ Use the `replace` command when a server encounters hardware issues requiring a c
 ```azurecli
 az networkcloud baremetalmachine replace \
   --name "bareMetalMachineName" \
-  --resource-group "resourceGroupName" \
+  --resource-group "cluster_MRG" \
   --bmc-credentials password="{password}" username="{user}" \
   --bmc-mac-address "00:00:4f:00:57:ad" \
   --boot-mac-address "00:00:4e:00:58:af" \
-  --machine-name "name" \
+  --machine-name "OS_hostname" \
   --serial-number "BM1219XXX"
 ```

articles/operator-nexus/howto-baremetal-run-data-extract.md

@@ -20,6 +20,7 @@ The command produces an output file containing the results of the data extract l
 - This article assumes that you've installed the Azure command line interface and the `networkcloud` command line interface extension. For more information, see [How to Install CLI Extensions](./howto-install-cli-extensions.md).
 - The target bare metal machine is on and has readyState set to True.
 - The syntax for these commands is based on the 0.3.0+ version of the `az networkcloud` CLI.
+- Get the Cluster Managed Resource group name (cluster_MRG) that you created for Cluster resource.
 
 ## Executing a run command
 
@@ -50,10 +51,10 @@ The command syntax is:
 
 ```azurecli-interactive
 az networkcloud baremetalmachine run-data-extract --name "<machine-name>"  \
-  --resource-group "<resource-group>" \
+  --resource-group "<cluster_MRG>" \
   --subscription "<subscription>" \
   --commands '[{"arguments":["<arg1>","<arg2>"],"command":"<command1>"}]'  \
-  --limit-time-seconds <timeout>
+  --limit-time-seconds "<timeout>"
 ```
 
 Specify multiple commands using json format in `--commands` option. Each `command` specifies command and arguments. For a command with multiple arguments, provide as a list to the `arguments` parameter. See [Azure CLI Shorthand](https://github.com/Azure/azure-cli/blob/dev/doc/shorthand_syntax.md) for instructions on constructing the `--commands` structure.
@@ -68,7 +69,7 @@ This example executes the `hardware-support-data-collection` command and get `Sy
 
 ```azurecli
 az networkcloud baremetalmachine run-data-extract --name "bareMetalMachineName" \
-  --resource-group "resourceGroupName" \
+  --resource-group "cluster_MRG" \
   --subscription "subscription" \
   --commands '[{"arguments":["SysInfo", "TTYLog"],"command":"hardware-support-data-collection"}]' \
   --limit-time-seconds 600
@@ -136,7 +137,7 @@ This example executes the `mde-agent-information` command without arguments.
 
 ```azurecli
 az networkcloud baremetalmachine run-data-extract --name "bareMetalMachineName" \
-  --resource-group "resourceGroupName" \
+  --resource-group "cluster_MRG" \
   --subscription "subscription" \
   --commands '[{"command":"mde-agent-information"}]' \
   --limit-time-seconds 600
@@ -183,7 +184,7 @@ This example executes the `mde-support-diagnostics` command without arguments.
 
 ```azurecli
 az networkcloud baremetalmachine run-data-extract --name "bareMetalMachineName" \
-  --resource-group "resourceGroupName" \
+  --resource-group "cluster_MRG" \
   --subscription "subscription" \
   --commands '[{"command":"mde-support-diagnostics"}]' \
   --limit-time-seconds 600
@@ -241,7 +242,7 @@ This example executes the `hardware-rollup-status` command without arguments.
 
 ```azurecli
 az networkcloud baremetalmachine run-data-extract --name "bareMetalMachineName" \
-  --resource-group "resourceGroupName" \
+  --resource-group "clusete_MRG" \
   --subscription "subscription" \
   --commands '[{"command":"hardware-rollup-status"}]' \
   --limit-time-seconds 600

articles/operator-nexus/howto-baremetal-run-read.md

@@ -20,7 +20,7 @@ The command execution produces an output file containing the results that can be
 1. Install the latest version of the
   [appropriate CLI extensions](./howto-install-cli-extensions.md)
 1. Ensure that the target BMM must have its `poweredState` set to `On` and have its `readyState` set to `True`
-1. Get the Resource group name that you created for `Cluster` resource
+1. Get the Managed Resource group name (cluster_MRG) that you created for `Cluster` resource
 
 ## Executing a run-read command
 
@@ -207,10 +207,10 @@ The list below shows the commands you can use. Commands in `*italics*` cannot ha
 
 The command syntax is:
 ```azurecli
-az networkcloud baremetalmachine run-read-command --name <machine-name>
-    --limit-time-seconds <timeout> \
+az networkcloud baremetalmachine run-read-command --name "<machine-name>"
+    --limit-time-seconds "<timeout>" \
     --commands '[{"command":"<command1>"},{"command":"<command2>","arguments":["<arg1>","<arg2>"]}]' \
-    --resource-group "<resourceGroupName>" \
+    --resource-group "<cluster_MRG>" \
     --subscription "<subscription>"
 ```
 
@@ -230,7 +230,7 @@ When an optional argument `--output-directory` is provided, the output result is
 az networkcloud baremetalmachine run-read-command --name "<bareMetalMachineName>" \
     --limit-time-seconds 60 \
     --commands '[{"command":"hostname"},{"command":"ping","arguments":["198.51.102.1","-c","3"]}]' \
-    --resource-group "<resourceGroupName>" \
+    --resource-group "<cluster_MRG>" \
     --subscription "<subscription>"
 ```
 
@@ -240,7 +240,7 @@ az networkcloud baremetalmachine run-read-command --name "<bareMetalMachineName>
 az networkcloud baremetalmachine run-read-command --name "<bareMetalMachineName>" \
     --limit-time-seconds 60 \
     --commands '[{"command":"nc-toolbox nc-toolbox-runread racadm getsysinfo","arguments":["-c"]}]' \
-    --resource-group "<resourceGroupName>" \
+    --resource-group "<cluster_MRG>" \
     --subscription "<subscription>"
 ```
 
@@ -277,4 +277,4 @@ This guide walks you through accessing the output file that is created in the Cl
 
 1. Select the output file from the run-read command. The file name can be identified from the `az rest --method get` command. Additionally, the **Last modified** timestamp aligns with when the command was executed.
 
-1. You can manage & download the output file from the **Overview** pop-out.
+1. You can manage & download the output file from the **Overview** pop-out.