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
title: "Azure Operator Nexus: Bare Metal Machine platform commands"
3
3
description: Learn how to manage bare metal machines (BMM).
4
4
author: eak13
5
5
ms.author: ekarandjeff
@@ -9,32 +9,32 @@ ms.date: 07/19/2024
9
9
ms.custom: template-how-to, devx-track-azurecli
10
10
---
11
11
12
-
# BareMetal Machine Platform Commands
12
+
# Bare Metal Machine Platform Commands
13
13
14
-
This article describes how to perform lifecycle management operations on bare metal machines (BMM).
14
+
This article describes how to perform lifecycle management operations on Bare Metal Machines (BMM).
15
15
These steps should be used for troubleshooting purposes to recover from failures or when taking maintenance actions.
16
16
17
-
First, read the advice in the article [Best Practices for BareMetal Machine Operations](./howto-baremetal-best-practices.md) before proceeding with operations.
17
+
First, read the advice in the article [Best Practices for Bare Metal Machine Operations](./howto-bare-metal-best-practices.md) before proceeding with operations.
18
18
19
19
The bolded actions listed are considered disruptive (Power off, Restart, Reimage, Replace).
20
20
The Cordon action without the `evacuate` parameter isn't considered disruptive while Cordon with the `evacuate` parameter is considered disruptive.
21
21
22
-
-**Power off a BMM**
23
-
- Start a BMM
24
-
-**Restart a BMM**
25
-
- Make a BMM unschedulable (cordon without evacuate, doesn't drain the node)
26
-
-**Make a BMM unschedulable (cordon with evacuate, drains the node)**
27
-
- Make a BMM schedulable (uncordon)
28
-
-**Reimage a BMM**
29
-
-**Replace a BMM**
22
+
-**Power off a Bare Metal Machine**
23
+
- Start a Bare Metal Machine
24
+
-**Restart a Bare Metal Machine**
25
+
- Make a Bare Metal Machine unschedulable (cordon without evacuate, doesn't drain the node)
26
+
-**Make a Bare Metal Machine unschedulable (cordon with evacuate, drains the node)**
27
+
- Make a Bare Metal Machine schedulable (uncordon)
This command will `power-off` the specified `bareMetalMachineName`.
40
40
@@ -45,7 +45,7 @@ az networkcloud baremetalmachine power-off \
45
45
--subscription <subscriptionID>
46
46
```
47
47
48
-
## Start a BMM
48
+
## Start a Bare Metal Machine
49
49
50
50
This command will `start` the specified `bareMetalMachineName`.
51
51
@@ -56,7 +56,7 @@ az networkcloud baremetalmachine start \
56
56
--subscription <subscriptionID>
57
57
```
58
58
59
-
## Restart a BMM
59
+
## Restart a Bare Metal Machine
60
60
61
61
This command will `restart` the specified `bareMetalMachineName`.
62
62
@@ -67,24 +67,24 @@ az networkcloud baremetalmachine restart \
67
67
--subscription <subscriptionID>
68
68
```
69
69
70
-
## Make a BMM Unschedulable (cordon)
70
+
## Make a Bare Metal Machine unschedulable (cordon)
71
71
72
-
You can make a BMM unschedulable by executing the [`cordon`](#make-a-bmm-unschedulable-cordon) command.
73
-
On the execution of the `cordon` command, Operator Nexus workloads aren't scheduled on the BMM when `cordon` is set.
74
-
Any attempt to create a workload on a `cordoned`BMM results in the workload being set to `pending` state.
75
-
Existing workloads continue to run on the BMM unless the workloads are drained.
72
+
You can make a Bare Metal Machine unschedulable by executing the [`cordon`](#make-a-bmm-unschedulable-cordon) command.
73
+
On the execution of the `cordon` command, Operator Nexus workloads aren't scheduled on the Bare Metal Machine when `cordon` is set.
74
+
Any attempt to create a workload on a `cordoned`Bare Metal Machine results in the workload being set to `pending` state.
75
+
Existing workloads continue to run on the Bare Metal Machine unless the workloads are drained.
76
76
77
-
### Drain Workloads from the BMM
77
+
### Drain Bare Metal Machine workloads
78
78
79
79
The cordon command supports the `evacuate` parameter which its default value `False` means that the `cordon` command prevents scheduling new workloads.
80
80
To drain workloads with the `cordon` command, the `evacuate` parameter must be set to `True`.
81
-
The workloads running on the BMM are `stopped` and the BMM is set to `pending` state.
81
+
The workloads running on the Bare Metal Machine are `stopped` and the Bare Metal Machine is set to `pending` state.
82
82
83
83
> [!NOTE]
84
-
> Nexus Management Workloads continue to run on the BMM even when the server is cordoned and evacuated.
84
+
> Nexus Management Workloads continue to run on the Bare Metal Machine even when the server is cordoned and evacuated.
85
85
86
-
It's a best practice to set the `evacuate` value to `True` when attempting to do any maintenance operations on the BMM server.
87
-
For more best practices to follow, read through [Best Practices for BareMetal Machine Operations](./howto-baremetal-best-practices.md).
86
+
It's a best practice to set the `evacuate` value to `True` when attempting to do any maintenance operations on the Bare Metal server.
87
+
For more best practices to follow, read through [Best Practices for Bare Metal Machine Operations](./howto-bare-metal-best-practices.md).
88
88
89
89
```azurecli
90
90
az networkcloud baremetalmachine cordon \
@@ -94,7 +94,7 @@ az networkcloud baremetalmachine cordon \
94
94
--subscription <subscriptionID>
95
95
```
96
96
97
-
### To identify if any workloads are currently running on a BMM, run the following command:
97
+
### To identify if any workloads are currently running on a Bare Metal Machine, run the following command:
98
98
99
99
For Virtual Machines:
100
100
@@ -110,10 +110,10 @@ For Nexus Kubernetes cluster nodes: (Requires logging into the Nexus Kubernetes
110
110
kubectl get nodes <resourceName> -ojson |jq '.metadata.labels."topology.kubernetes.io/baremetalmachine"'
111
111
```
112
112
113
-
## Make a BMM Schedulable (uncordon)
113
+
## Make a Bare Metal Machine schedulable (uncordon)
114
114
115
-
You can make a BMM "schedulable" (the server can host workloads) by executing the [`uncordon`](#make-a-bmm-schedulable-uncordon) command.
116
-
All workloads in a `pending` state on the BMM are `restarted` when the BMM is `uncordoned`.
115
+
You can make a Bare Metal Machine "schedulable" (the server can host workloads) by executing the [`uncordon`](#make-a-bmm-schedulable-uncordon) command.
116
+
All workloads in a `pending` state on the Bare Metal Machine are `restarted` when the Bare Metal Machine is `uncordoned`.
117
117
118
118
```azurecli
119
119
az networkcloud baremetalmachine uncordon \
@@ -122,19 +122,19 @@ az networkcloud baremetalmachine uncordon \
122
122
--subscription <subscriptionID>
123
123
```
124
124
125
-
## Reimage a BMM
125
+
## Reimage a Bare Metal Machine
126
126
127
-
You can restore the runtime version on a BMM by executing `reimage` command. The `reimage` action doesn't affect the tenant workload files on the BMM.
128
-
This process **redeploys** the runtime image on the target BMM and executes the steps to rejoin the cluster with the same identifiers.
127
+
You can restore the runtime version on a Bare Metal Machine by executing `reimage` command. The `reimage` action doesn't affect the tenant workload files on the Bare Metal Machine.
128
+
This process **redeploys** the runtime image on the target Bare Metal Machine and executes the steps to rejoin the cluster with the same identifiers.
129
129
130
-
As a best practice, ensure the BMM's workloads are drained using the [`cordon`](#make-a-bmm-unschedulable-cordon) command, with `evacuate` set to `True`, before executing the `reimage` command.
131
-
For more best practices to follow, read through [Best Practices for BareMetal Machine Operations](./howto-baremetal-best-practices.md).
130
+
As a best practice, ensure the Bare Metal Machine's workloads are drained using the [`cordon`](#make-a-bmm-unschedulable-cordon) command, with `evacuate` set to `True`, before executing the `reimage` command.
131
+
For more best practices to follow, read through [Best Practices for Bare Metal Machine Operations](./howto-bare-metal-best-practices.md).
132
132
133
133
> [!IMPORTANT]
134
-
> Avoid write or edit actions performed on the node via BMM access.
135
-
> The `reimage` action is required to restore Microsoft support and any changes done to the BMM are lost while restoring the node to it's expected state.
134
+
> Avoid write or edit actions performed on the node via Bare Metal Machine access.
135
+
> The `reimage` action is required to restore Microsoft support and any changes done to the Bare Metal Machine are lost while restoring the node to it's expected state.
@@ -143,13 +143,13 @@ az networkcloud baremetalmachine reimage \
143
143
--subscription <subscriptionID>
144
144
```
145
145
146
-
## Replace a BMM
146
+
## Replace a Bare Metal Machine
147
147
148
148
Use the `replace` command when a server encounters hardware issues requiring a complete or partial hardware replacement.
149
-
After the replacing components such as motherboard or Network Interface Card (NIC), the MAC address of BMM will change; however, the iDRAC IP address and hostname will remain the same.
150
-
A `replace`**must** be executed after each hardware maintenance operation, read through [Best Practices for BareMetal Machine Operations](./howto-baremetal-best-practices.md) for more details.
149
+
After the replacing components such as motherboard or Network Interface Card (NIC), the MAC address of Bare Metal Machine will change; however, the iDRAC IP address and hostname will remain the same.
150
+
A `replace`**must** be executed after each hardware maintenance operation, read through [Best Practices for Bare Metal Machine Operations](./howto-bare-metal-best-practices.md) for more details.
0 commit comments