az arcappliance logs

Note

This reference is part of the arcappliance extension for the Azure CLI (version 2.70.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]
                         [--name]
                         [--out-dir]
                         [--resource-group]

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

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

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

--name -n

Name of the Arc resource bridge.

--out-dir

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

--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 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]
                           [--name]
                           [--out-dir]
                           [--password]
                           [--port]
                           [--resource-group]
                           [--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

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

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

--name -n

Name of the Arc resource bridge.

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

--resource-group -g

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

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

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

Command to collect logs for Appliance on VMware.

az arcappliance logs vmware [--address]
                            [--credentials-dir]
                            [--ip]
                            [--kubeconfig]
                            [--name]
                            [--out-dir]
                            [--password]
                            [--resource-group]
                            [--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

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

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

--name -n

Name of the Arc resource bridge.

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

--resource-group -g

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

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

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

Share via

az arcappliance logs

Commands

az arcappliance logs hci

Examples

Optional Parameters

az arcappliance logs scvmm

Examples

Optional Parameters

az arcappliance logs vmware

Examples

Optional Parameters

Feedback