Share via

az networkcloud baremetalmachine

Note

This reference is part of the networkcloud extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az networkcloud baremetalmachine command. Learn more about extensions.

Manage bare metal machine.

Commands

Name Description Type Status
az networkcloud baremetalmachine cordon

Cordon the provided bare metal machine's Kubernetes node.

 Extension GA
az networkcloud baremetalmachine list

List bare metal machines in the provided resource group or subscription.

 Extension GA
az networkcloud baremetalmachine power-off

Power off the provided bare metal machine.

 Extension GA
az networkcloud baremetalmachine reimage

Reimage the provided bare metal machine.

 Extension GA
az networkcloud baremetalmachine replace

Replace the provided bare metal machine.

 Extension GA
az networkcloud baremetalmachine restart

Restart the provided bare metal machine.

 Extension GA
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 GA
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 GA
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 GA
az networkcloud baremetalmachine show

Get properties of the provided bare metal machine.

 Extension GA
az networkcloud baremetalmachine start

Start the provided bare metal machine.

 Extension GA
az networkcloud baremetalmachine uncordon

Uncordon the provided bare metal machine's Kubernetes node.

 Extension GA
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 GA
az networkcloud baremetalmachine wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az networkcloud baremetalmachine cordon

Cordon the provided bare metal machine's Kubernetes node.

az networkcloud baremetalmachine cordon [--bare-metal-machine-name --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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-name --name -n

The name of the bare metal machine.

Property Value
Parameter group: Resource Id Arguments
--evacuate

The indicator of whether to evacuate the node workload when the bare metal machine is cordoned.

Property Value
Parameter group: BareMetalMachineCordonParameters Arguments
Default value: False
Accepted values: False, True
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud baremetalmachine list

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 list

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

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.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud baremetalmachine power-off

Power off the provided bare metal machine.

az networkcloud baremetalmachine power-off [--bare-metal-machine-name --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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-name --name -n

The name of the bare metal machine.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--skip-shutdown

The indicator of whether to skip the graceful OS shutdown and power off the bare metal machine immediately.

Property Value
Parameter group: BareMetalMachinePowerOffParameters Arguments
Default value: False
Accepted values: False, True
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud baremetalmachine reimage

Reimage the provided bare metal machine.

az networkcloud baremetalmachine reimage [--bare-metal-machine-name --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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-name --name -n

The name of the bare metal machine.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud baremetalmachine replace

Replace the provided bare metal machine.

az networkcloud baremetalmachine replace [--bare-metal-machine-name --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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-name --name -n

The name of the bare metal machine.

Property Value
Parameter group: Resource Id Arguments
--bmc-credentials

The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: BareMetalMachineReplaceParameters Arguments
--bmc-mac-address

The MAC address of the BMC device.

Property Value
Parameter group: BareMetalMachineReplaceParameters Arguments
--boot-mac-address

The MAC address of a NIC connected to the PXE network.

Property Value
Parameter group: BareMetalMachineReplaceParameters Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--machine-name

The OS-level hostname assigned to this machine.

Property Value
Parameter group: BareMetalMachineReplaceParameters Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--serial-number

The serial number of the bare metal machine.

Property Value
Parameter group: BareMetalMachineReplaceParameters Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud baremetalmachine restart

Restart the provided bare metal machine.

az networkcloud baremetalmachine restart [--bare-metal-machine-name --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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-name --name -n

The name of the bare metal machine.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

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.

az networkcloud baremetalmachine run-command --limit-time-seconds
                                             --script
                                             [--arguments]
                                             [--bare-metal-machine-name --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

--limit-time-seconds

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).

Property Value
Parameter group: BareMetalMachineRunCommandParameters Arguments
--script

The base64 encoded script to execute on the bare metal machine.

Property Value
Parameter group: BareMetalMachineRunCommandParameters Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--arguments

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.

Property Value
Parameter group: BareMetalMachineRunCommandParameters Arguments
--bare-metal-machine-name --name -n

The name of the bare metal machine.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--output-directory

The output directory where the script execution results will bedownloaded to from storage blob. Accepts relative or qualified directory path.

Property Value
Parameter group: BareMetalMachineRunCommandParameters Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

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.

az networkcloud baremetalmachine run-data-extract --commands
                                                  --limit-time-seconds
                                                  [--bare-metal-machine-name --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

--commands

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.

Property Value
Parameter group: BareMetalMachineRunDataExtractsParameters Arguments
--limit-time-seconds

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).

Property Value
Parameter group: BareMetalMachineRunDataExtractsParameters Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-name --name -n

The name of the bare metal machine.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--output-directory

The output directory where the script execution results will bedownloaded to from storage blob. Accepts relative or qualified directory path.

Property Value
Parameter group: BareMetalMachineRunDataExtractsParameters Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

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.

az networkcloud baremetalmachine run-read-command --commands
                                                  --limit-time-seconds
                                                  [--bare-metal-machine-name --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

--commands

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.

Property Value
Parameter group: BareMetalMachineRunReadCommandsParameters Arguments
--limit-time-seconds

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).

Property Value
Parameter group: BareMetalMachineRunReadCommandsParameters Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-name --name -n

The name of the bare metal machine.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--output-directory

The output directory where the script execution results will bedownloaded to from storage blob. Accepts relative or qualified directory path.

Property Value
Parameter group: BareMetalMachineRunReadCommandsParameters Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud baremetalmachine show

Get properties of the provided bare metal machine.

az networkcloud baremetalmachine show [--bare-metal-machine-name --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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-name --name -n

The name of the bare metal machine.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud baremetalmachine start

Start the provided bare metal machine.

az networkcloud baremetalmachine start [--bare-metal-machine-name --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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-name --name -n

The name of the bare metal machine.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud baremetalmachine uncordon

Uncordon the provided bare metal machine's Kubernetes node.

az networkcloud baremetalmachine uncordon [--bare-metal-machine-name --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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-name --name -n

The name of the bare metal machine.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

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.

az networkcloud baremetalmachine update [--bare-metal-machine-name --name]
                                        [--ids]
                                        [--if-match]
                                        [--if-none-match]
                                        [--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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-name --name -n

The name of the bare metal machine.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

--machine-details

The details provided by the customer during the creation of rack manifests that allows for custom data to be associated with this machine.

Property Value
Parameter group: Properties Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--tags

The Azure resource tags that will replace the existing ones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: BareMetalMachineUpdateParameters Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud baremetalmachine wait

Place the CLI in a waiting state until a condition is met.

az networkcloud baremetalmachine wait [--bare-metal-machine-name --name]
                                      [--created]
                                      [--custom]
                                      [--deleted]
                                      [--exists]
                                      [--ids]
                                      [--interval]
                                      [--resource-group]
                                      [--subscription]
                                      [--timeout]
                                      [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-name --name -n

The name of the bare metal machine.

Property Value
Parameter group: Resource Id Arguments
--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False