az arcappliance troubleshoot command

  • Reference

Note

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

Command group for troubleshooting an Appliance cluster by executing a shell command.

Commands

Name Description Type Status
az arcappliance troubleshoot command hci

Command to execute a shell command on an HCI cluster for troubleshooting. Either --ip or --kubeconfig must be provided. If both are passed in, --ip will be used.

 Extension GA
az arcappliance troubleshoot command scvmm

Command to execute a shell command on an SCVMM cluster for troubleshooting. Either --ip or --kubeconfig must be provided. If both are passed in, --ip will be used.

 Extension GA
az arcappliance troubleshoot command vmware

Command to execute a shell command on an VMWare cluster for troubleshooting. Either --ip or --kubeconfig must be provided. If both are passed in, --ip will be used.

 Extension GA

az arcappliance troubleshoot command hci

Command to execute a shell command on an HCI cluster for troubleshooting. Either --ip or --kubeconfig must be provided. If both are passed in, --ip will be used.

az arcappliance troubleshoot command hci [--cloudagent]
                                         [--command]
                                         [--credentials-dir]
                                         [--ip]
                                         [--kubeconfig]
                                         [--loginconfigfile]

Examples

Execute a troubleshooting command on an HCI cluster passing in ip

az arcappliance troubleshoot command hci --command [REQUIRED] --ip [REQUIRED] --credentials-dir [OPTIONAL]

Execute a troubleshooting command on an HCI cluster passing in kubeconfig

az arcappliance troubleshoot command hci --command [REQUIRED] --kubeconfig [REQUIRED] --credentials-dir [OPTIONAL]

Execute a troubleshooting command on an HCI cluster passing in --ip

az arcappliance troubleshoot command hci --command [REQUIRED] --ip [REQUIRED] --credentials-dir [OPTIONAL] --cloudagent [OPTIONAL] --loginconfigfile [OPTIONAL]

Optional Parameters

--cloudagent

FQDN or IP address of the Azure Stack HCI MOC cloud agent service used by Arc resource bridge. This can be found in the -infra.yaml configuration file stored locally on the HCI cluster.

--command

This is the shell command to be executed.

--credentials-dir

This is the path to the log key directory, which stores credentials for your Resource Bridge. Once a scoped access key has been generated, use the az arcappliance get-credentials command to download it.

--ip

Arc resource bridge on-premises appliance VM IP or its control plane IP.

--kubeconfig

Path to kubeconfig.

--loginconfigfile

File path for the Azure Stack HCI login configuration file, kvatoken.tok. By default, it is stored locally on the HCI cluster.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az arcappliance troubleshoot command scvmm

Command to execute a shell command on an SCVMM cluster for troubleshooting. Either --ip or --kubeconfig must be provided. If both are passed in, --ip will be used.

az arcappliance troubleshoot command scvmm [--address]
                                           [--command]
                                           [--credentials-dir]
                                           [--ip]
                                           [--kubeconfig]
                                           [--password]
                                           [--port]
                                           [--username]

Examples

Execute a troubleshooting command on an SCVMM cluster passing in ip

az arcappliance troubleshoot command scvmm --command [REQUIRED] --ip [REQUIRED] --credentials-dir [OPTIONAL]

Execute a troubleshooting command on an SCVMM cluster passing in kubeconfig

az arcappliance troubleshoot command scvmm --command [REQUIRED] --kubeconfig [REQUIRED] --credentials-dir [OPTIONAL]

Execute a troubleshooting command on an SCVMM cluster using noninteractive credentials parameters passing in --ip

az arcappliance troubleshoot command scvmm --command [REQUIRED] --ip [REQUIRED] --credentials-dir [OPTIONAL] --address [OPTIONAL] --port [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]

Optional Parameters

--address

SCVMM Server FQDN (e.g. vmmuser001.contoso.lab) or IPv4 address. If you have a Highly Available VMM setup, enter the role name.

--command

This is the shell command to be executed.

--credentials-dir

This is the path to the log key directory, which stores credentials for your Resource Bridge. Once a scoped access key has been generated, use the az arcappliance get-credentials command to download it.

--ip

Arc resource bridge on-premises appliance VM IP or its control plane IP.

--kubeconfig

Path to kubeconfig.

--password

SCVMM Administrator Password.

--port

SCVMM server port number (Default: 8100).

--username

SCVMM Administrator Username (domain\username).

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az arcappliance troubleshoot command vmware

Command to execute a shell command on an VMWare cluster for troubleshooting. Either --ip or --kubeconfig must be provided. If both are passed in, --ip will be used.

az arcappliance troubleshoot command vmware [--address]
                                            [--command]
                                            [--credentials-dir]
                                            [--ip]
                                            [--kubeconfig]
                                            [--password]
                                            [--username]

Examples

Execute a troubleshooting command on an VMWare cluster passing in ip

az arcappliance troubleshoot command vmware --command [REQUIRED] --ip [REQUIRED] --credentials-dir [OPTIONAL]

Execute a troubleshooting command on an VMWare cluster passing in kubeconfig

az arcappliance troubleshoot command vmware --command [REQUIRED] --kubeconfig [REQUIRED] --credentials-dir [OPTIONAL]

Execute a troubleshooting command on an VMWare cluster using noninteractive credentials parameters passing in --ip

az arcappliance troubleshoot command vmware --command [REQUIRED] --ip [REQUIRED] --credentials-dir [OPTIONAL] --address [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]

Optional Parameters

--address

FQDN or IP address for vCenter Server instance. Ex: 10.160.0.1.

--command

This is the shell command to be executed.

--credentials-dir

This is the path to the log key directory, which stores credentials for your Resource Bridge. Once a scoped access key has been generated, use the az arcappliance get-credentials command to download it.

--ip

Arc resource bridge on-premises appliance VM IP or its control plane IP.

--kubeconfig

Path to kubeconfig.

--password

Password for vSphere account that Arc resource bridge uses for on-premises infrastructure guest management.

--username

Username for vSphere account that Arc resource bridge uses for on-premises infrastructure guest management.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.