az networkcloud baremetalmachine
Note
This reference is part of the networkcloud extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az networkcloud baremetalmachine command. Learn more about extensions.
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage bare metal machine.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az networkcloud baremetalmachine cordon |
Cordon the provided bare metal machine's Kubernetes node. |
Extension | Preview |
| az networkcloud baremetalmachine list |
List bare metal machines in the provided resource group or subscription. |
Extension | Preview |
| az networkcloud baremetalmachine power-off |
Power off the provided bare metal machine. |
Extension | Preview |
| az networkcloud baremetalmachine reimage |
Reimage the provided bare metal machine. |
Extension | Preview |
| az networkcloud baremetalmachine replace |
Replace the provided bare metal machine. |
Extension | Preview |
| az networkcloud baremetalmachine restart |
Restart the provided bare metal machine. |
Extension | Preview |
| az networkcloud baremetalmachine run-command |
Run the command or the script on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available. |
Extension | Preview |
| az networkcloud baremetalmachine run-data-extract |
Run one or more data extractions on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available. |
Extension | Preview |
| az networkcloud baremetalmachine run-read-command |
Run one or more read-only commands on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available. |
Extension | Preview |
| az networkcloud baremetalmachine show |
Get properties of the provided bare metal machine. |
Extension | Preview |
| az networkcloud baremetalmachine start |
Start the provided bare metal machine. |
Extension | Preview |
| az networkcloud baremetalmachine uncordon |
Uncordon the provided bare metal machine's Kubernetes node. |
Extension | Preview |
| az networkcloud baremetalmachine update |
Update properties of the provided bare metal machine, or update tags associated with the bare metal machine. Properties and tag updates can be done independently. |
Extension | Preview |
| az networkcloud baremetalmachine wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az networkcloud baremetalmachine cordon
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Cordon the provided bare metal machine's Kubernetes node.
az networkcloud baremetalmachine cordon [--bare-metal-machine-name]
[--evacuate {False, True}]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]Examples
Cordon bare metal machine
az networkcloud baremetalmachine cordon --evacuate "True" --bare-metal-machine-name "bareMetalMachineName" --resource-group "resourceGroupName"Optional Parameters
The name of the bare metal machine.
The indicator of whether to evacuate the node workload when the bare metal machine is cordoned.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud baremetalmachine list
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List bare metal machines in the provided resource group or subscription.
az networkcloud baremetalmachine list [--max-items]
[--next-token]
[--resource-group]Examples
List bare metal machines for resource group
az networkcloud baremetalmachine list --resource-group "resourceGroupName"List bare metal machines for subscription
az networkcloud baremetalmachine listOptional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud baremetalmachine power-off
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Power off the provided bare metal machine.
az networkcloud baremetalmachine power-off [--bare-metal-machine-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--skip-shutdown {False, True}]
[--subscription]Examples
Power off bare metal machine
az networkcloud baremetalmachine power-off --bare-metal-machine-name "bareMetalMachineName" --skip-shutdown "True" --resource-group "resourceGroupName"Optional Parameters
The name of the bare metal machine.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The indicator of whether to skip the graceful OS shutdown and power off the bare metal machine immediately.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud baremetalmachine reimage
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Reimage the provided bare metal machine.
az networkcloud baremetalmachine reimage [--bare-metal-machine-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]Examples
Reimage bare metal machine
az networkcloud baremetalmachine reimage --bare-metal-machine-name "bareMetalMachineName" --resource-group "resourceGroupName"Optional Parameters
The name of the bare metal machine.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud baremetalmachine replace
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Replace the provided bare metal machine.
az networkcloud baremetalmachine replace [--bare-metal-machine-name]
[--bmc-credentials]
[--bmc-mac-address]
[--boot-mac-address]
[--ids]
[--machine-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--serial-number]
[--subscription]Examples
Replace bare metal machine
az networkcloud baremetalmachine replace --bare-metal-machine-name "bareMetalMachineName" --bmc-credentials password="{password}" username="bmcuser" --bmc-mac-address "00:00:4f:00:57:ad" --boot-mac-address "00:00:4e:00:58:af" --machine-name "name" --serial-number "BM1219XXX" --resource-group "resourceGroupName"Optional Parameters
The name of the bare metal machine.
The credentials of the baseboard management controller on this bare metal machine. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The MAC address of the BMC device.
The MAC address of a NIC connected to the PXE network.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The OS-level hostname assigned to this machine.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The serial number of the bare metal machine.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud baremetalmachine restart
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Restart the provided bare metal machine.
az networkcloud baremetalmachine restart [--bare-metal-machine-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]Examples
Restart bare metal machine
az networkcloud baremetalmachine restart --bare-metal-machine-name "bareMetalMachineName" --resource-group "resourceGroupName"Optional Parameters
The name of the bare metal machine.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud baremetalmachine run-command
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Run the command or the script on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.
az networkcloud baremetalmachine run-command --limit-time-seconds
--script
[--arguments]
[--bare-metal-machine-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--output-directory]
[--resource-group]
[--subscription]Examples
Run command on bare metal machine
az networkcloud baremetalmachine run-command --bare-metal-machine-name "bareMetalMachineName" --arguments "--argument1" "argument2" --limit-time-seconds 60 --script "cHdkCg==" --resource-group "resourceGroupName"Required Parameters
The maximum time the script is allowed to run. If the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252).
The base64 encoded script to execute on the bare metal machine.
Optional Parameters
The list of string arguments that will be passed to the script in order as separate arguments. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the bare metal machine.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
The output directory where the script execution results will bedownloaded to from storage blob. Accepts relative or qualified directory path.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud baremetalmachine run-data-extract
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Run one or more data extractions on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.
az networkcloud baremetalmachine run-data-extract --commands
--limit-time-seconds
[--bare-metal-machine-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--output-directory]
[--resource-group]
[--subscription]Examples
Run data extraction on bare metal machine
az networkcloud baremetalmachine run-data-extract --bare-metal-machine-name "bareMetalMachineName" --limit-time-seconds 360 --commands "[{arguments:['SysInfo','TTYLog'],command:'hardware-support-data-collection'}]" --resource-group "resourceGroupName"Required Parameters
The list of curated data extraction commands to be executed directly against the target machine. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The maximum time the commands are allowed to run. If the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252).
Optional Parameters
The name of the bare metal machine.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
The output directory where the script execution results will be downloaded to from storage blob. Accepts relative or qualified directory path.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud baremetalmachine run-read-command
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Run one or more read-only commands on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.
az networkcloud baremetalmachine run-read-command --commands
--limit-time-seconds
[--bare-metal-machine-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--output-directory]
[--resource-group]
[--subscription]Examples
Run and retrieve output from read only commands on bare metal machine
az networkcloud baremetalmachine run-read-command --bare-metal-machine-name "bareMetalMachineName" --limit-time-seconds 60 --commands '[{"command":"kubectl get","arguments":["pods","-A"]},{"command":"ping", "arguments":["192.168.0.99","-c","3"]}]' --resource-group "resourceGroupName"Required Parameters
The list of read-only commands to be executed directly against the target machine. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The maximum time the commands are allowed to run. If the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252).
Optional Parameters
The name of the bare metal machine.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
The output directory where the script execution results will be downloaded to from storage blob. Accepts relative or qualified directory path.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud baremetalmachine show
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get properties of the provided bare metal machine.
az networkcloud baremetalmachine show [--bare-metal-machine-name]
[--ids]
[--resource-group]
[--subscription]Examples
Get bare metal machine
az networkcloud baremetalmachine show --bare-metal-machine-name "bareMetalMachineName" --resource-group "resourceGroupName"Optional Parameters
The name of the bare metal machine.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud baremetalmachine start
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Start the provided bare metal machine.
az networkcloud baremetalmachine start [--bare-metal-machine-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]Examples
Start bare metal machine
az networkcloud baremetalmachine start --bare-metal-machine-name "bareMetalMachineName" --resource-group "resourceGroupName"Optional Parameters
The name of the bare metal machine.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud baremetalmachine uncordon
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Uncordon the provided bare metal machine's Kubernetes node.
az networkcloud baremetalmachine uncordon [--bare-metal-machine-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]Examples
Uncordon bare metal machine
az networkcloud baremetalmachine uncordon --bare-metal-machine-name "bareMetalMachineName" --resource-group "resourceGroupName"Optional Parameters
The name of the bare metal machine.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud baremetalmachine update
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update properties of the provided bare metal machine, or update tags associated with the bare metal machine. Properties and tag updates can be done independently.
az networkcloud baremetalmachine update [--bare-metal-machine-name]
[--ids]
[--machine-details]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--tags]Examples
Patch bare metal machine
az networkcloud baremetalmachine update --bare-metal-machine-name "bareMetalMachineName" --machine-details "machinedetails" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName"Optional Parameters
The name of the bare metal machine.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The details provided by the customer during the creation of rack manifests that allows for custom data to be associated with this machine.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The Azure resource tags that will replace the existing ones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud baremetalmachine wait
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Place the CLI in a waiting state until a condition is met.
az networkcloud baremetalmachine wait [--bare-metal-machine-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
The name of the bare metal machine.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for