az arcappliance logs

  • 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 logs command. Learn more about extensions.

Command group for collecting logs for Arc resource bridge. Run get-credentials command before running logs command.

Commands

Name Description Type Status
az arcappliance logs hci

Command to collect logs for an Appliance on Azure Stack HCI.

 Extension GA
az arcappliance logs scvmm

Command to collect logs for Arc resource bridge on SCVMM (Arc-enabled SCVMM).

 Extension GA
az arcappliance logs vmware

Command to collect logs for Appliance on VMware.

 Extension GA

az arcappliance logs hci

Command to collect logs for an Appliance on Azure Stack HCI.

az arcappliance logs hci [--cloudagent]
                         [--credentials-dir]
                         [--ip]
                         [--kubeconfig]
                         [--loginconfigfile]
                         [--out-dir]

Examples

Collect Appliance logs on HCI using IP

az arcappliance logs hci --ip [REQUIRED] --kubeconfig [OPTIONAL] --out-dir [OPTIONAL] --credentials-dir [OPTIONAL]

Collect Appliance logs on HCI using kubeconfig

az arcappliance logs hci --ip [OPTIONAL] --kubeconfig [REQUIRED] --out-dir [OPTIONAL] --credentials-dir [OPTIONAL]

Collect Appliance logs using noninteractive feature on HCI using HCI credentials as parameters

az arcappliance logs hci --ip [REQUIRED] --kubeconfig [OPTIONAL] --out-dir [OPTIONAL] --cloudagent [REQUIRED] --loginconfigfile [REQUIRED] --credentials-dir [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.

--credentials-dir

Folder to read logging key and certificate from. If no value specified, defaults to .kva/.ssh for Darwin and Linux and C:\ProgramData\kva.ssh for Windows.

--ip

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

--kubeconfig

Path to kubeconfig, output from deploy command.

--loginconfigfile

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

--out-dir

Output directory for on-premises appliance VM log files, defaults to ./ (current directory).

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 logs scvmm

Command to collect logs for Arc resource bridge on SCVMM (Arc-enabled SCVMM).

az arcappliance logs scvmm [--address]
                           [--credentials-dir]
                           [--ip]
                           [--kubeconfig]
                           [--out-dir]
                           [--password]
                           [--port]
                           [--username]

Examples

Collect Arc resource bridge logs on SCVMM using IP

az arcappliance logs scvmm --ip [REQUIRED] --kubeconfig [OPTIONAL] --out-dir [OPTIONAL] --credentials-dir [OPTIONAL]

Collect Arc resource bridge logs on SCVMM using kubeconfig

az arcappliance logs scvmm --ip [OPTIONAL] --kubeconfig [REQUIRED] --out-dir [OPTIONAL] --credentials-dir [OPTIONAL]

Collect Arc resource bridge logs using noninteractive feature on SCVMM using SCVMM credentials as parameters

az arcappliance logs scvmm --ip [REQUIRED] --kubeconfig [OPTIONAL] --out-dir [OPTIONAL] --credentials-dir [OPTIONAL] --address [REQUIRED] --port [REQUIRED] --username [REQUIRED] --password [REQUIRED]

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.

--credentials-dir

Folder to read logging key and certificate from. If no value specified, defaults to .kva/.ssh for Darwin and Linux and C:\ProgramData\kva.ssh for Windows.

--ip

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

--kubeconfig

Path to kubeconfig, output from deploy command.

--out-dir

Output directory for on-premises appliance VM log files, defaults to ./ (current directory).

--password

SCVMM Administrator Password.

--port

SCVMM server port number (Default: 8100).

--username

SCVMM Administrator Username in the format domain\username where 'domain' should be the NetBIOS name of the domain (e.g. contoso\administrator).

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 logs vmware

Command to collect logs for Appliance on VMware.

az arcappliance logs vmware [--address]
                            [--credentials-dir]
                            [--ip]
                            [--kubeconfig]
                            [--out-dir]
                            [--password]
                            [--username]

Examples

Collect Appliance logs on VMware using IP

az arcappliance logs vmware --ip [REQUIRED] --kubeconfig [OPTIONAL] --out-dir [OPTIONAL] --credentials-dir [OPTIONAL]

Collect Appliance logs on VMware using kubeconfig

az arcappliance logs vmware --ip [OPTIONAL] --kubeconfig [REQUIRED] --out-dir [OPTIONAL] --credentials-dir [OPTIONAL]

Collect Appliance logs using noninteractive feature on VMware using vmware credentials parameters

az arcappliance logs vmware --ip [REQUIRED] --kubeconfig [OPTIONAL] --out-dir [OPTIONAL] --credentials-dir [OPTIONAL] --address [REQUIRED] --username [REQUIRED] --password [REQUIRED]

Optional Parameters

--address

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

--credentials-dir

Folder to read logging key and certificate from. If no value specified, defaults to .kva/.ssh for Darwin and Linux and C:\ProgramData\kva.ssh for Windows.

--ip

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

--kubeconfig

Path to kubeconfig, output from deploy command.

--out-dir

Output directory for on-premises appliance VM log files, defaults to ./ (current directory).

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