Share via


az arcappliance validate

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

Command group to perform validations on Arc resource bridge configuration files and network settings.

Commands

Name Description Type Status
az arcappliance validate hci

Command to validate Arc resource bridge configuration files and network settings on Azure Stack HCI - should be done before 'prepare' command.

Extension GA
az arcappliance validate scvmm

Command to validate Arc resource bridge configuration files and network settings for Arc-enabled SCVMM - should be done before 'prepare' command.

Extension GA
az arcappliance validate vmware

Command to validate Arc resource bridge configuration files and network settings for Arc-enabled VMware - should be done before 'prepare' command.

Extension GA

az arcappliance validate hci

Command to validate Arc resource bridge configuration files and network settings on Azure Stack HCI - should be done before 'prepare' command.

az arcappliance validate hci --config-file
                             [--cloudagent]
                             [--location]
                             [--loginconfigfile]
                             [--name]
                             [--resource-group]

Examples

Validate Arc resource bridge configuration and network settings for Azure Stack HCI

az arcappliance validate hci --config-file [REQUIRED] --cloudagent [OPTIONAL] --loginconfigfile [OPTIONAL]

Required Parameters

--config-file

Path to the Arc resource bridge appliance config file, -appliance.yaml.

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.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

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

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

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

Command to validate Arc resource bridge configuration files and network settings for Arc-enabled SCVMM - should be done before 'prepare' command.

az arcappliance validate scvmm --config-file
                               [--address]
                               [--location]
                               [--name]
                               [--password]
                               [--port]
                               [--resource-group]
                               [--username]

Examples

Validate Arc resource bridge configuration files and network settings for Arc-enabled SCVMM

az arcappliance validate scvmm --config-file [REQUIRED] --address [OPTIONAL] --port [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]

Required Parameters

--config-file

Path to the Arc resource bridge appliance config file, -appliance.yaml.

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.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name -n

Name of the Arc resource bridge.

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

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

Command to validate Arc resource bridge configuration files and network settings for Arc-enabled VMware - should be done before 'prepare' command.

az arcappliance validate vmware --config-file
                                [--address]
                                [--location]
                                [--name]
                                [--password]
                                [--resource-group]
                                [--username]

Examples

Validate Arc resource bridge configuration and network settings for Arc-enabled VMware

az arcappliance validate vmware --config-file [REQUIRED] --address [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]

Required Parameters

--config-file

Path to the Arc resource bridge appliance config file, -appliance.yaml.

Optional Parameters

--address

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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name -n

Name of the Arc resource bridge.

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

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