Share via

az arcappliance run

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

Command group for consecutively running the Arc resource bridge commands required for deployment. This command is idempotent.

Commands

Name Description Type Status
az arcappliance run hci

Command to consecutively run the Arc resource bridge commands required for deployment on Azure Stack HCI. This command is idempotent.

 Extension GA
az arcappliance run scvmm

Command to consecutively run the Arc resource bridge commands required for deployment on SCVMM. This command is idempotent.

 Extension GA
az arcappliance run vmware

Command to consecutively run the Arc resource bridge commands required for deployment on VMware (Arc-enabled VMware). This command is idempotent.

 Extension GA

az arcappliance run hci

Command to consecutively run the Arc resource bridge commands required for deployment on Azure Stack HCI. This command is idempotent.

az arcappliance run hci --location
                        --name
                        --resource-group
                        [--cloudagent]
                        [--force]
                        [--loginconfigfile]
                        [--out-dir]
                        [--tags]
                        [--working-dir]

Examples

Use the 'run' command to deploy Arc resource bridge on Azure Stack HCI

az arcappliance run hci --resource-group [REQUIRED] --name [REQUIRED] --location [REQUIRED] --out-dir [OPTIONAL] --cloudagent [OPTIONAL] --loginconfigfile [OPTIONAL]

Required Parameters

--location -l

The Azure location where the Arc resource bridge Azure resource will be deployed. Must be set to the same location as the resource group.

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

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.

--force

Delete Arc resource bridge on-premises appliance VM and Azure resource with the same name/id (if it exists) before continuing to the run command.

Default value: False
--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).

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--working-dir

Local directory path to store image & files downloaded for Arc resource bridge on-premises appliance VM deployment. If not specified, a default temp directory is used.

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

Command to consecutively run the Arc resource bridge commands required for deployment on SCVMM. This command is idempotent.

az arcappliance run scvmm --location
                          --name
                          --resource-group
                          [--address]
                          [--force]
                          [--out-dir]
                          [--password]
                          [--port]
                          [--tags]
                          [--username]
                          [--working-dir]

Examples

Use the 'run' command to deploy Arc resource bridge on SCVMM

az arcappliance run scvmm --resource-group [REQUIRED] --name [REQUIRED] --location [REQUIRED] --out-dir [OPTIONAL] --address [OPTIONAL] --port [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]

Required Parameters

--location -l

The Azure location where the Arc resource bridge Azure resource will be deployed. Must be set to the same location as the resource group.

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

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.

--force

Delete Arc resource bridge on-premises appliance VM and Azure resource with the same name/id (if it exists) before continuing to the run command.

Default value: False
--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).

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--username

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

--working-dir

Local directory path to store image & files downloaded for Arc resource bridge on-premises appliance VM deployment. If not specified, a default temp directory is used.

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

Command to consecutively run the Arc resource bridge commands required for deployment on VMware (Arc-enabled VMware). This command is idempotent.

az arcappliance run vmware --location
                           --name
                           --resource-group
                           [--address]
                           [--force]
                           [--out-dir]
                           [--password]
                           [--tags]
                           [--username]
                           [--working-dir]

Examples

Use the 'run' command to deploy Arc resource bridge on VMware

az arcappliance run vmware --resource-group [REQUIRED] --name [REQUIRED] --location [REQUIRED] --out-dir [OPTIONAL] --address [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]

Required Parameters

--location -l

The Azure location where the Arc resource bridge Azure resource will be deployed. Must be set to the same location as the resource group.

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

Optional Parameters

--address

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

--force

Delete Arc resource bridge on-premises appliance VM and Azure resource with the same name/id (if it exists) before continuing to the run command.

Default value: False
--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.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--username

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

--working-dir

Local directory path to store image & files downloaded for Arc resource bridge on-premises appliance VM deployment. If not specified, a default temp directory is used.

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.