az arcappliance prepare
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 prepare command. Learn more about extensions.
Command group for preparing for an Arc resource bridge deployment. This downloads the necessary images to build the on-premises appliance VM and uploads it to the private cloud gallery.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az arcappliance prepare hci |
Command to prepare the on-premises Azure Stack HCI environment for an Arc resource bridge deployment. This downloads the necessary images to build the on-premises appliance VM and uploads it to the private cloud gallery. |
Extension | GA |
| az arcappliance prepare scvmm |
Command to prepare for an Arc resource bridge deployment on SCVMM for Arc-enabled SCVMM. This downloads the necessary images to build the on-premises appliance VM and uploads it to the private cloud gallery. |
Extension | GA |
| az arcappliance prepare vmware |
Command to prepare for an Arc resource bridge deployment on VMware for Arc-enabled VMware. This downloads the necessary images to build the on-premises appliance VM and uploads it to the private cloud gallery. |
Extension | GA |
az arcappliance prepare hci
Command to prepare the on-premises Azure Stack HCI environment for an Arc resource bridge deployment. This downloads the necessary images to build the on-premises appliance VM and uploads it to the private cloud gallery.
az arcappliance prepare hci --config-file
[--cloudagent]
[--location]
[--loginconfigfile]
[--name]
[--resource-group]Examples
Prepare Azure Stack HCI for Arc resource bridge deployment.
az arcappliance prepare hci --config-file [REQUIRED] --cloudagent [OPTIONAL] --loginconfigfile [OPTIONAL]Required Parameters
Path to the Arc resource bridge appliance config file, -appliance.yaml.
Optional Parameters
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. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
File path for the Azure Stack HCI login configuration file, kvatoken.tok. By default, it is stored locally on the HCI cluster.
Name of the Arc resource bridge.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az arcappliance prepare scvmm
Command to prepare for an Arc resource bridge deployment on SCVMM for Arc-enabled SCVMM. This downloads the necessary images to build the on-premises appliance VM and uploads it to the private cloud gallery.
az arcappliance prepare scvmm --config-file
[--address]
[--location]
[--name]
[--password]
[--port]
[--resource-group]
[--username]Examples
Prepare SCVMM environment for Arc resource bridge deployment
az arcappliance prepare scvmm --config-file [REQUIRED] --address [OPTIONAL] --port [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]Required Parameters
Path to the Arc resource bridge appliance config file, -appliance.yaml.
Optional Parameters
SCVMM Server FQDN (e.g. vmmuser001.contoso.lab) or IPv4 address. If you have a Highly Available VMM setup, enter the role name.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
Name of the Arc resource bridge.
SCVMM Administrator Password.
SCVMM server port number (Default: 8100).
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
SCVMM Administrator Username in the format domain\username where 'domain' should be the NetBIOS name of the domain (e.g. contoso\administrator).
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az arcappliance prepare vmware
Command to prepare for an Arc resource bridge deployment on VMware for Arc-enabled VMware. This downloads the necessary images to build the on-premises appliance VM and uploads it to the private cloud gallery.
az arcappliance prepare vmware --config-file
[--address]
[--location]
[--name]
[--password]
[--resource-group]
[--username]Examples
Prepare VMware environment for Arc resource bridge deployment
az arcappliance prepare vmware --config-file [REQUIRED] --address [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]Required Parameters
Path to the Arc resource bridge appliance config file, -appliance.yaml.
Optional Parameters
FQDN or IP address for vCenter Server instance. Ex: 10.160.0.1.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
Name of the Arc resource bridge.
Password for vSphere account that Arc resource bridge uses for on-premises infrastructure guest management.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Username for vSphere account that Arc resource bridge uses for on-premises infrastructure guest management.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for